Improvements around diagnostic controls (shader-slang#2414)

* #include an absolute path didn't work - because paths were taken to always be relative.

* Test for disabling warnings.

* Output diagnostic if argument parsing fails in render test.

* More improvements around disabling diagnostics.

* Add support for re enabling a warning.

* Add warning controls to help text.

* Tidy up around NameConventionUtil.

* Make NameConvention an enum.

* Handle leading underscores.

* Update comment, and remove intial handling of _ prefix.

Author: jsmall-zzz

source/compiler-core/slang-diagnostic-sink.cpp

@@ -667,45 +667,88 @@ void DiagnosticSink::diagnoseRaw(
     }
 }
 
-/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! DiagnosticLookup !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
-
-void DiagnosticsLookup::_add(const char* name, Index index)
+void DiagnosticSink::overrideDiagnosticSeverity(int diagnosticId, Severity overrideSeverity, const DiagnosticInfo* info)
 {
-    UnownedStringSlice nameSlice(name);
-    m_map.Add(nameSlice, index);
-
-    // Add a dashed version (KababCase)
+    if (info)
     {
-        m_work.Clear();
+        SLANG_ASSERT(info->id == diagnosticId);
 
-        NameConventionUtil::convert(NameConvention::Camel, nameSlice, CharCase::Lower, NameConvention::Kabab, m_work);
+        // If the override is the same as the default, we can just remove the override
+        if (info->severity == overrideSeverity)
+        {
+            m_severityOverrides.Remove(diagnosticId);
+            return;
+        }
+    }
 
-        UnownedStringSlice dashSlice(m_arena.allocateString(m_work.getBuffer(), m_work.getLength()), m_work.getLength());
+    // Set the override
+    m_severityOverrides[diagnosticId] = overrideSeverity;
+}
 
-        m_map.AddIfNotExists(dashSlice, index);
-    }
+/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! DiagnosticLookup !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
+
+Index DiagnosticsLookup::_findDiagnosticIndexByExactName(const UnownedStringSlice& slice) const
+{
+    const Index* indexPtr = m_nameMap.TryGetValue(slice);
+    return indexPtr ? *indexPtr : -1;
+}
+
+void DiagnosticsLookup::_addName(const char* name, Index diagnosticIndex)
+{
+    UnownedStringSlice nameSlice(name);
+    m_nameMap.Add(nameSlice, diagnosticIndex);
 }
+
 void DiagnosticsLookup::addAlias(const char* name, const char* diagnosticName)
 {
-    const Index index = _findDiagnosticIndex(UnownedStringSlice(diagnosticName));
+    const Index index = _findDiagnosticIndexByExactName(UnownedStringSlice(diagnosticName));
     SLANG_ASSERT(index >= 0);
     if (index >= 0)
     {
-        _add(name, index);
+        _addName(name, index);
     }
 }
 
+const DiagnosticInfo* DiagnosticsLookup::getDiagnosticById(Int id) const
+{
+    const auto indexPtr = m_idMap.TryGetValue(id);
+    return indexPtr ? m_diagnostics[*indexPtr] : nullptr;
+}
+
+const DiagnosticInfo* DiagnosticsLookup::findDiagnosticByExactName(const UnownedStringSlice& slice) const
+{
+    const Index* indexPtr = m_nameMap.TryGetValue(slice);
+    return indexPtr ? m_diagnostics[*indexPtr] : nullptr;
+}
+
+const DiagnosticInfo* DiagnosticsLookup::findDiagnosticByName(const UnownedStringSlice& slice) const
+{
+    const auto convention = NameConventionUtil::inferConventionFromText(slice);
+    switch (convention)
+    {
+        case NameConvention::Invalid:       return nullptr;
+        case NameConvention::LowerCamel:    return findDiagnosticByExactName(slice);
+        default:                            break;
+    }
+
+    StringBuilder buf;
+    NameConventionUtil::convert(getNameStyle(convention), slice, NameConvention::LowerCamel, buf);
+
+    return findDiagnosticByExactName(buf.getUnownedSlice());
+}
+
 Index DiagnosticsLookup::add(const DiagnosticInfo* info)
 {
     // Check it's not already added
     SLANG_ASSERT(m_diagnostics.indexOf(info) < 0);
 
-    const Index index = m_diagnostics.getCount();
-
-    _add(info->name, index);
-
+    const Index diagnosticIndex = m_diagnostics.getCount();
     m_diagnostics.add(info);
-    return index;
+
+    _addName(info->name, diagnosticIndex);
+    m_idMap.AddIfNotExists(info->id, diagnosticIndex);
+    
+    return diagnosticIndex;
 }
 
 void DiagnosticsLookup::add(const DiagnosticInfo*const* infos, Index infosCount)
@@ -724,21 +767,13 @@ DiagnosticsLookup::DiagnosticsLookup():
 DiagnosticsLookup::DiagnosticsLookup(const DiagnosticInfo*const* diagnostics, Index diagnosticsCount) :
     m_arena(kArenaInitialSize)
 {
-    m_diagnostics.addRange(diagnostics, diagnosticsCount);
-
     // TODO: We should eventually have a more formal system for associating individual
     // diagnostics, or groups of diagnostics, with user-exposed names for use when
     // enabling/disabling warnings (or turning warnings into errors, etc.).
     //
-    // For now we build a map from diagnostic name to it's entry. Two entries are typically
-    // added - the 'original name' as associated with the diagnostic in lowerCamel, and
-    // a dashified version.
+    // For now we build a map from diagnostic name to it's entry. 
 
-    for (Index i = 0; i < diagnosticsCount; ++i)
-    {
-        const DiagnosticInfo* diagnostic = diagnostics[i];
-        _add(diagnostic->name, i);
-    }
+    add(diagnostics, diagnosticsCount);
 }
 
 } // namespace Slang

source/compiler-core/slang-diagnostic-sink.h

@@ -227,10 +227,8 @@ class DiagnosticSink
     bool isFlagSet(Flag::Enum flag) { return (m_flags & Flags(flag)) != 0; }
 
         /// Sets an override on the severity of a specific diagnostic message (by numeric identifier)
-    void overrideDiagnosticSeverity(int messageID, Severity overrideSeverity)
-    {
-        m_severityOverrides[messageID] = overrideSeverity;
-    }
+        /// info can be set to nullptr if only to override 
+    void overrideDiagnosticSeverity(int diagnosticId, Severity overrideSeverity, const DiagnosticInfo* info = nullptr);
 
         /// 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
@@ -322,37 +320,46 @@ 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;
-    }
+        /// Will take into account the slice name could be using different conventions
+    const DiagnosticInfo* findDiagnosticByName(const UnownedStringSlice& slice) const;
+        /// The name must be as defined in the diagnostics exactly, typically lower camel
+    const DiagnosticInfo* findDiagnosticByExactName(const UnownedStringSlice& slice) const;
+
+        /// Get a diagnostic by it's id. 
+        /// NOTE! That it is possible for multiple diagnostics to have the same id. This will return 
+        /// the first added
+    const DiagnosticInfo* getDiagnosticById(Int id) const;
 
         /// info must stay in scope
     Index add(const DiagnosticInfo* info);
+        /// Infos referenced must remain in scope
     void add(const DiagnosticInfo*const* infos, Index infosCount);
 
+        /// NOTE! Name must stay in scope as long as the diagnostics lookup. 
+        /// If not possible add it to the arena to keep in scope.
     void addAlias(const char* name, const char* diagnosticName);
 
         /// Get the diagnostics held in this lookup
     const List<const DiagnosticInfo*>& getDiagnostics() const { return m_diagnostics; }
 
+        /// Get the associated arena
+    MemoryArena& getArena() { return m_arena; }
+
         /// 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);
+    void _addName(const char* name, Index diagnosticIndex);
+
+    Index _findDiagnosticIndexByExactName(const UnownedStringSlice& slice) const;
 
     List<const DiagnosticInfo*> m_diagnostics;
 
     StringBuilder m_work;
-    Dictionary<UnownedStringSlice, Index> m_map;
+    Dictionary<UnownedStringSlice, Index> m_nameMap;
+    Dictionary<Int, Index> m_idMap;
+
     MemoryArena m_arena;
 };