path: root/source/compiler-core/slang-diagnostic-sink.h

#ifndef SLANG_DIAGNOSTIC_SINK_H
#define SLANG_DIAGNOSTIC_SINK_H

#include "../core/slang-basic.h"
#include "../core/slang-writer.h"
#include "../core/slang-memory-arena.h"

#include "slang-source-loc.h"
#include "slang-token.h"

#include "../../slang.h"

namespace Slang
{

enum class Severity
{
    Note,
    Warning,
    Error,
    Fatal,
    Internal,
};

// TODO(tfoley): move this into a source file...
inline const char* getSeverityName(Severity severity)
{
    switch (severity)
    {
    case Severity::Note:        return "note";
    case Severity::Warning:     return "warning";
    case Severity::Error:       return "error";
    case Severity::Fatal:       return "fatal error";
    case Severity::Internal:    return "internal error";
    default:                    return "unknown error";
    }
}

// A structure to be used in static data describing different
// diagnostic messages.
struct DiagnosticInfo
{
    int id;
    Severity severity;
    char const* name;               ///< Unique name
    char const* messageFormat;
};

class Diagnostic
{
public:
    String Message;
    SourceLoc loc;
    int ErrorID;
    Severity severity;

    Diagnostic()
    {
        ErrorID = -1;
    }
    Diagnostic(
        const String & msg,
        int id,
        const SourceLoc & pos,
        Severity severity)
        : severity(severity)
    {
        Message = msg;
        ErrorID = id;
        loc = pos;
    }
};

class Name;

void printDiagnosticArg(StringBuilder& sb, char const* str);

void printDiagnosticArg(StringBuilder& sb, int32_t val);
void printDiagnosticArg(StringBuilder& sb, uint32_t val);

void printDiagnosticArg(StringBuilder& sb, int64_t val);
void printDiagnosticArg(StringBuilder& sb, uint64_t val);

void printDiagnosticArg(StringBuilder& sb, double val);

void printDiagnosticArg(StringBuilder& sb, Slang::String const& str);
void printDiagnosticArg(StringBuilder& sb, Slang::UnownedStringSlice const& str);
void printDiagnosticArg(StringBuilder& sb, Name* name);

void printDiagnosticArg(StringBuilder& sb, TokenType tokenType);
void printDiagnosticArg(StringBuilder& sb, Token const& token);

struct IRInst;
void printDiagnosticArg(StringBuilder& sb, IRInst* irObject);
    
template<typename T>
void printDiagnosticArg(StringBuilder& sb, RefPtr<T> ptr)
{
    printDiagnosticArg(sb, ptr.Ptr());
}

inline SourceLoc const& getDiagnosticPos(SourceLoc const& pos) { return pos;  }

SourceLoc const& getDiagnosticPos(Token const& token);
    

template<typename T>
SourceLoc getDiagnosticPos(RefPtr<T> const& ptr)
{
    return getDiagnosticPos(ptr.Ptr());
}

struct DiagnosticArg
{
    void* data;
    void (*printFunc)(StringBuilder&, void*);

    template<typename T>
    struct Helper
    {
        static void printFunc(StringBuilder& sb, void* data) { printDiagnosticArg(sb, *(T*)data); }
    };

    template<typename T>
    DiagnosticArg(T const& arg)
        : data((void*)&arg)
        , printFunc(&Helper<T>::printFunc)
    {}
};

    
class DiagnosticSink
{
public:
        /// Flags to control some aspects of Diagnostic sink behavior
    typedef uint32_t Flags;
    struct Flag 
    {
        enum Enum: Flags
        {
            VerbosePath         = 0x1,           ///< Will display a more verbose path (if available) - such as a canonical or absolute path
            SourceLocationLine  = 0x2,           ///< If set will display the location line if source is available
            HumaneLoc           = 0x4,           ///< If set will display humane locs (filename/line number) information
        };
    };

        /// Used by diagnostic sink to be able to underline tokens. If not defined on the DiagnosticSink,
        /// will only display a caret at the SourceLoc
    typedef UnownedStringSlice(*SourceLocationLexer)(const UnownedStringSlice& text);

        /// Get the total amount of errors that have taken place on this DiagnosticSink
    SLANG_FORCE_INLINE int getErrorCount() { return m_errorCount; }

    void diagnoseDispatch(SourceLoc const& pos, DiagnosticInfo const& info)
    {
        diagnoseImpl(pos, info, 0, nullptr);
    }

    void diagnoseDispatch(SourceLoc const& pos, DiagnosticInfo const& info, DiagnosticArg const& arg0)
    {
        DiagnosticArg const* args[] = { &arg0 };
        diagnoseImpl(pos, info, 1, args);
    }

    void diagnoseDispatch(SourceLoc const& pos, DiagnosticInfo const& info, DiagnosticArg const& arg0, DiagnosticArg const& arg1)
    {
        DiagnosticArg const* args[] = { &arg0, &arg1 };
        diagnoseImpl(pos, info, 2, args);
    }

    void diagnoseDispatch(SourceLoc const& pos, DiagnosticInfo const& info, DiagnosticArg const& arg0, DiagnosticArg const& arg1, DiagnosticArg const& arg2)
    {
        DiagnosticArg const* args[] = { &arg0, &arg1, &arg2 };
        diagnoseImpl(pos, info, 3, args);
    }

    void diagnoseDispatch(SourceLoc const& pos, DiagnosticInfo const& info, DiagnosticArg const& arg0, DiagnosticArg const& arg1, DiagnosticArg const& arg2, DiagnosticArg const& arg3)
    {
        DiagnosticArg const* args[] = { &arg0, &arg1, &arg2, &arg3 };
        diagnoseImpl(pos, info, 4, args);
    }

    template<typename P, typename... Args>
    void diagnose(P const& pos, DiagnosticInfo const& info, Args const&... args )
    {
        diagnoseDispatch(getDiagnosticPos(pos), info, args...);
    }

        // Add a diagnostic with raw text
        // (used when we get errors from a downstream compiler)
    void diagnoseRaw(Severity severity, char const* message);
    void diagnoseRaw(Severity severity, const UnownedStringSlice& message);

        /// During propagation of an exception for an internal
        /// error, note that this source location was involved
    void noteInternalErrorLoc(SourceLoc const& loc);

        /// Create a blob containing diagnostics if there were any errors.
        /// *note* only works if writer is not set, the blob is created from outputBuffer
    SlangResult getBlobIfNeeded(ISlangBlob** outBlob);

        /// Get the source manager used 
    SourceManager* getSourceManager() const { return m_sourceManager; }
        /// Set the source manager used for lookup of source locs
    void setSourceManager(SourceManager* inSourceManager) { m_sourceManager = inSourceManager; }

        /// Set the flags
    void setFlags(Flags flags) { m_flags = flags; } 
        /// Get the flags
    Flags getFlags() const { return m_flags; }
        /// Set a flag
    void setFlag(Flag::Enum flag) { m_flags |= Flags(flag); }
        /// Reset a flag
    void resetFlag(Flag::Enum flag) { m_flags &= ~Flags(flag); }
        /// Test if flag is set
    bool isFlagSet(Flag::Enum flag) { return (m_flags & Flags(flag)) != 0; }

        /// Get the (optional) diagnostic sink lexer. This is used to
        /// improve quality of highlighting a locations token. If not set, will just have a single
        /// character caret at location
    SourceLocationLexer getSourceLocationLexer() const { return m_sourceLocationLexer; }

        /// Set the maximum length (in chars) of a source line displayed. Set to 0 for no limit
    void setSourceLineMaxLength(Index length) { m_sourceLineMaxLength = length; }
    Index getSourceLineMaxLength() const { return m_sourceLineMaxLength; }

        /// The parent sink is another sink that will receive diagnostics from this sink.
    void setParentSink(DiagnosticSink* parentSink) { m_parentSink = parentSink; }
    DiagnosticSink* getParentSink() const { return m_parentSink; }

        /// Reset state.
        /// Resets error counts. Resets the output buffer.
    void reset();

        /// Initialize state. 
    void init(SourceManager* sourceManager, SourceLocationLexer sourceLocationLexer);

        /// Ctor
    DiagnosticSink(SourceManager* sourceManager, SourceLocationLexer sourceLocationLexer) { init(sourceManager, sourceLocationLexer); }
        /// Default Ctor
    DiagnosticSink():
        m_sourceManager(nullptr),
        m_sourceLocationLexer (nullptr)
    {
    }

    // Public members

        /// The outputBuffer will contain any diagnostics *iff* the writer is *not* set
    StringBuilder outputBuffer;
        /// If a writer is set output will *not* be written to the outputBuffer
    ISlangWriter* writer = nullptr;

protected:
    void diagnoseImpl(SourceLoc const& pos, DiagnosticInfo const& info, int argCount, DiagnosticArg const* const* args);
    void diagnoseImpl(DiagnosticInfo const& info, const UnownedStringSlice& formattedMessage);

        /// If set all diagnostics (as formatted by *this* sink, will be routed to the parent).
    DiagnosticSink* m_parentSink = nullptr;

    int m_errorCount = 0;
    int m_internalErrorLocsNoted = 0;

    /// If 0, then there is no limit, otherwise max amount of chars of the source line location
    /// We don't know the size of a terminal in general, but for now we'll guess 120.
    Index m_sourceLineMaxLength = 120;            

    Flags m_flags = 0;

    // The source manager to use when mapping source locations to file+line info
    SourceManager* m_sourceManager = nullptr;

    SourceLocationLexer m_sourceLocationLexer;
};

    /// An `ISlangWriter` that writes directly to a diagnostic sink.
class DiagnosticSinkWriter : public AppendBufferWriter
{
public:
    typedef AppendBufferWriter Super;

    DiagnosticSinkWriter(DiagnosticSink* sink)
        : Super(WriterFlag::IsStatic)
        , m_sink(sink)
    {}

    // ISlangWriter
    SLANG_NO_THROW virtual SlangResult SLANG_MCALL write(const char* chars, size_t numChars) SLANG_OVERRIDE
    {
        m_sink->diagnoseRaw(Severity::Note, UnownedStringSlice(chars, chars+numChars));
        return SLANG_OK;
    }

private:
    DiagnosticSink* m_sink = nullptr;
};

class DiagnosticsLookup : public RefObject
{
public:
    static const Index kArenaInitialSize = 2048;

    const DiagnosticInfo* findDiagostic(const UnownedStringSlice& slice) const
    {
        const Index* indexPtr = m_map.TryGetValue(slice);
        return indexPtr ? m_diagnostics[*indexPtr] : nullptr;
    }
    Index _findDiagnosticIndex(const UnownedStringSlice& slice) const
    {
        const Index* indexPtr = m_map.TryGetValue(slice);
        return indexPtr ? *indexPtr : 0;
    }

        /// info must stay in scope
    Index add(const DiagnosticInfo* info);
    void add(const DiagnosticInfo*const* infos, Index infosCount);

    void addAlias(const char* name, const char* diagnosticName);

        /// Get the diagnostics held in this lookup
    const List<const DiagnosticInfo*>& getDiagnostics() const { return m_diagnostics; }

        /// NOTE! diagnostics must stay in scope for lifetime of lookup
    DiagnosticsLookup(const DiagnosticInfo*const* diagnostics, Index diagnosticsCount);
    DiagnosticsLookup();

protected:  
    void _add(const char* name, Index index);

    List<const DiagnosticInfo*> m_diagnostics;

    StringBuilder m_work;
    Dictionary<UnownedStringSlice, Index> m_map;
    MemoryArena m_arena;
};

}

#endif