1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
// slang-artifact-associated.h
#ifndef SLANG_ARTIFACT_ASSOCIATED_H
#define SLANG_ARTIFACT_ASSOCIATED_H
#include "slang-artifact.h"
namespace Slang
{
struct ArtifactDiagnostic
{
typedef ArtifactDiagnostic ThisType;
enum class Severity : uint8_t
{
Unknown,
Info,
Warning,
Error,
CountOf,
};
enum class Stage : uint8_t
{
Compile,
Link,
};
struct Location
{
typedef Location ThisType;
bool operator==(const ThisType& rhs) const
{
return line == rhs.line && column == rhs.column;
}
bool operator!=(const ThisType& rhs) const { return !(*this == rhs); }
Int line = 0; ///< One indexed line number. 0 if not defined
Int column = 0; ///< One indexed *character (not byte)* column number. 0 if not defined
};
bool operator==(const ThisType& rhs) const
{
return severity == rhs.severity && stage == rhs.stage && text == rhs.text &&
code == rhs.code && location == rhs.location;
}
bool operator!=(const ThisType& rhs) const { return !(*this == rhs); }
Severity severity = Severity::Unknown; ///< The severity of error
Stage stage = Stage::Compile; ///< The stage the error came from
TerminatedCharSlice text; ///< The text of the error
TerminatedCharSlice code; ///< The compiler specific error code
TerminatedCharSlice filePath; ///< The path the error originated from
Location location; ///< The location of the diagnostic in the filePath
};
/* Artifact diagnostics interface.
IArtifactDiagnostics are added as associated types on an IArtifact typically.
*/
class IArtifactDiagnostics : public IClonable
{
public:
SLANG_COM_INTERFACE(
0x91f9b857,
0xcd6b,
0x45ca,
{0x8e, 0x3, 0x8f, 0xa3, 0x3c, 0x5c, 0xf0, 0x1a});
typedef ArtifactDiagnostic Diagnostic;
/// Get the diagnostic at the index
SLANG_NO_THROW virtual const Diagnostic* SLANG_MCALL getAt(Index i) = 0;
/// Get the amount of diangostics
SLANG_NO_THROW virtual Count SLANG_MCALL getCount() = 0;
/// Add a diagnostic
SLANG_NO_THROW virtual void SLANG_MCALL add(const Diagnostic& diagnostic) = 0;
/// Remove the diagnostic at the index
SLANG_NO_THROW virtual void SLANG_MCALL removeAt(Index i) = 0;
/// Get raw diagnostics information
SLANG_NO_THROW virtual TerminatedCharSlice SLANG_MCALL getRaw() = 0;
/// Set the raw diagnostic info
SLANG_NO_THROW virtual void SLANG_MCALL setRaw(const CharSlice& slice) = 0;
/// Append to the raw diagnostic
SLANG_NO_THROW virtual void SLANG_MCALL appendRaw(const CharSlice& slice) = 0;
/// Get the result for a compilation
SLANG_NO_THROW virtual SlangResult SLANG_MCALL getResult() = 0;
/// Set the result
SLANG_NO_THROW virtual void SLANG_MCALL setResult(SlangResult res) = 0;
/// Reset all state
SLANG_NO_THROW virtual void SLANG_MCALL reset() = 0;
/// Count the number of diagnostics which have 'severity' or greater
SLANG_NO_THROW virtual Count SLANG_MCALL
getCountAtLeastSeverity(Diagnostic::Severity severity) = 0;
/// Get the number of diagnostics by severity
SLANG_NO_THROW virtual Count SLANG_MCALL getCountBySeverity(Diagnostic::Severity severity) = 0;
/// True if there are any diagnostics of severity or worse
SLANG_NO_THROW virtual bool SLANG_MCALL hasOfAtLeastSeverity(Diagnostic::Severity severity) = 0;
/// Stores in outCounts, the amount of diagnostics for the stage of each severity
SLANG_NO_THROW virtual Count SLANG_MCALL getCountByStage(
Diagnostic::Stage stage,
Count outCounts[Int(Diagnostic::Severity::CountOf)]) = 0;
/// Remove all diagnostics of the type
SLANG_NO_THROW virtual void SLANG_MCALL removeBySeverity(Diagnostic::Severity severity) = 0;
/// Add a note
SLANG_NO_THROW virtual void SLANG_MCALL maybeAddNote(const CharSlice& in) = 0;
/// If there are no error diagnostics, adds a generic error diagnostic
SLANG_NO_THROW virtual void SLANG_MCALL requireErrorDiagnostic() = 0;
/// Creates summary text and place in outBlob
SLANG_NO_THROW virtual void SLANG_MCALL calcSummary(ISlangBlob** outBlob) = 0;
/// Creates a simplified summary text and places it in out blob
SLANG_NO_THROW virtual void SLANG_MCALL calcSimplifiedSummary(ISlangBlob** outBlob) = 0;
};
struct ShaderBindingRange;
class IArtifactPostEmitMetadata : public slang::IMetadata
{
public:
SLANG_COM_INTERFACE(
0x5d03bce9,
0xafb1,
0x4fc8,
{0xa4, 0x6f, 0x3c, 0xe0, 0x7b, 0x6, 0x1b, 0x1b});
/// Get the binding ranges
SLANG_NO_THROW virtual Slice<ShaderBindingRange> SLANG_MCALL getUsedBindingRanges() = 0;
/// Get the list of functions that were exported in the linked IR
SLANG_NO_THROW virtual Slice<String> SLANG_MCALL getExportedFunctionMangledNames() = 0;
/// Get the debug build identifier for a base and debug spirv pair
SLANG_NO_THROW virtual const char* SLANG_MCALL getDebugBuildIdentifier() = 0;
};
} // namespace Slang
#endif
|
