Move metadata/diagnostics to associated types (#2358)

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

* WIP with hierarchical enums.

* Some small fixes and improvements around artifact desc related types.

* Improvements around hierarchical enum.

* Fixes to get Artifact types refactor to be able to execute tests.

* Attempt to better categorize PTX.

* Work around for potentially unused function warning.

* Typo fix.

* Simplify Artifact header.

* Small improvements around Artifact kind/payload/style.

* Added IDestroyable/ICastable

* Add IArtifactList.

* First impl of IArtifactUtil.

* Use the ICastable interface for IArtifactRepresentation.

* Added IArtifactRepresentation & IArtifactAssociated.

* Add SLANG_OVERRIDE to avoid gcc/clang warning.

* Fix calling convention issue on win32.

* Fix missing SLANG_OVERRIDE.

* First attempt at file abstraction around Artifact.

* Added creation of lock file.

* Move functionality for determining file paths to the IArtifactUtil.
Add casting to ICastable.

* Added some casting/finding mechanisms.

* Simplify IArtifact interface, and use Items for file reps.

* Fix problem with libraries on DXIL.

* Split out ArtifactRepresentation.

* Move ArtifactDesc functionality to ArtifactDescUtil. ArtifactInfoUtil becomes ArtifactDescUtil.

* Split implementations from the interfaces for Artifact.

* Use TypeTextUtil for target name outputting.

* Add artifact impls.

* Add ICastableList

* Added UnknownCastableAdapter

* Make ISlangSharedLibrary derive from ICastable, and remain backwards compatible with slang-llvm.

* Refactor Representation on Artifact.

* Make our ISlangBlobs also derive from ICastable.
Make ISlangBlob atomic ref counted.

* Split out CastableList and related types, and placed in core.

* Small fixes around IArtifact.
Improve IArtifact docs.
First impl of getChildren for IArtifact.

* Documentation improvements for Artifact related types.

* Fix typo.

* Special case adding a ICastableList to a LazyCastableList.

* Small simplification of LazyCastableList, by adding State member.

* Removed the ILockFile interface because IFileArtifactRepresentation can be used.

* Implement DiagnosticsArtifactRepresentation.

* Added PostEmitMetadataArtifactRepresentation

* Add searching by predicate.
Added handling of accessing Artifact as ISharedLibrary

* Fix typo.

* Add find to IArtifacgtList.
Fix some missing SLANG_NO_THROW.

* Small improvements around ArtifactDesc types.

* Another small change around ArtifactKind.

* Some more shuffling of ArtifactDesc.

* Make IArtifact castable
Remove IArtifactList
Made IArtifactContainer derive from IArtifact
Made ModuleLibrary atomic ref counted/given IModuleLibrary interface.

* Must call _requireChildren before any children access.

* Fix missing SLANG_MCALL on castAs.

* Fix missing SLANG_OVERRIDE.

* Added IArtifactHandler

* Use ICastable for basis of scope/lookup.

* WIP first attempt to remove CompileResult.

* Fix support for for downstream compiler shared library adapter.

* Fix issues found when replacing CompileResult.

* Fix typo.

* Fix getting items form 'significant' member of an Artifact.

* Split out ArtifactUtil & ArtifactHandler.

* Work around for problem on Visual studio.

* Improve searching.

* Add missing files.

* Split out Artifact associated types.
Don't produce a container by default - use associated for 'metadata'.

* Remove no longer used ArtifactPayload type.

* Generalized converting representations.
Small improvements to artifacts.

* Fix intermediate dumping issue.

* Removed #if 0 out CompileResult.
Remove DownstreamCompileResult maybeDumpIntermediate.

* Pull out functionality for dumping artifact output into ArtifactOutputUtil
Fixed a bug in naming files based on ArtifactDesc.

* std::atomic issue.

* Fix outputting as text bug.
Some small improvements.

* Add fix around prefix for dumping.
Improved how handling for extensions work form ArtifactDesc.

* Dump assembly if available.

1 files changed, 144 insertions, 0 deletions

diff --git a/source/compiler-core/slang-artifact-associated-impl.h b/source/compiler-core/slang-artifact-associated-impl.h
new file mode 100644
index 000000000..dcd796c1e
--- /dev/null
+++ b/source/compiler-core/slang-artifact-associated-impl.h
@@ -0,0 +1,144 @@
+// slang-artifact-associated-impl.h
+#ifndef SLANG_ARTIFACT_ASSOCIATED_IMPL_H
+#define SLANG_ARTIFACT_ASSOCIATED_IMPL_H
+
+#include "../../slang-com-helper.h"
+#include "../../slang-com-ptr.h"
+
+#include "../core/slang-com-object.h"
+#include "../core/slang-memory-arena.h"
+
+#include "slang-artifact-associated.h"
+
+namespace Slang
+{
+
+class ArtifactDiagnostics : public ComBaseObject, public IDiagnostics
+{
+public:
+    SLANG_COM_BASE_IUNKNOWN_ALL
+
+    // ICastable
+    SLANG_NO_THROW void* SLANG_MCALL castAs(const Guid& guid) SLANG_OVERRIDE;
+    // IDiagnostic
+    SLANG_NO_THROW virtual const Diagnostic* SLANG_MCALL getAt(Index i) SLANG_OVERRIDE { return &m_diagnostics[i]; }
+    SLANG_NO_THROW virtual Count SLANG_MCALL getCount() SLANG_OVERRIDE { return m_diagnostics.getCount(); }
+    SLANG_NO_THROW virtual void SLANG_MCALL add(const Diagnostic& diagnostic) SLANG_OVERRIDE; 
+    SLANG_NO_THROW virtual void SLANG_MCALL removeAt(Index i) SLANG_OVERRIDE { m_diagnostics.removeAt(i); }
+    SLANG_NO_THROW virtual SlangResult SLANG_MCALL getResult() SLANG_OVERRIDE { return m_result; }
+    SLANG_NO_THROW virtual void SLANG_MCALL setResult(SlangResult res) SLANG_OVERRIDE { m_result = res; }
+
+    ArtifactDiagnostics():
+        m_arena(1024)
+    {
+    }
+
+protected:
+    void* getInterface(const Guid& uuid);
+    void* getObject(const Guid& uuid);
+
+    ZeroTerminatedCharSlice _allocateSlice(const Slice<char>& in);
+
+    // We could consider storing paths, codes in StringSlicePool, but for now we just allocate all 'string type things'
+    // in the arena.
+    MemoryArena m_arena;
+
+    List<Diagnostic> m_diagnostics;
+    SlangResult m_result = SLANG_OK;
+    
+    ZeroTerminatedCharSlice m_raw;
+};
+
+/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!! PostEmitMetadata !!!!!!!!!!!!!!!!!!!!!!!!!! */
+
+struct ShaderBindingRange
+{
+    slang::ParameterCategory category = slang::ParameterCategory::None;
+    UInt spaceIndex = 0;
+    UInt registerIndex = 0;
+    UInt registerCount = 0; // 0 for unsized
+
+    bool isInfinite() const
+    {
+        return registerCount == 0;
+    }
+
+    bool containsBinding(slang::ParameterCategory _category, UInt _spaceIndex, UInt _registerIndex) const
+    {
+        return category == _category
+            && spaceIndex == _spaceIndex
+            && registerIndex <= _registerIndex
+            && (isInfinite() || registerCount + registerIndex > _registerIndex);
+    }
+
+    bool intersectsWith(const ShaderBindingRange& other) const
+    {
+        if (category != other.category || spaceIndex != other.spaceIndex)
+            return false;
+
+        const bool leftIntersection = (registerIndex < other.registerIndex + other.registerCount) || other.isInfinite();
+        const bool rightIntersection = (other.registerIndex < registerIndex + registerCount) || isInfinite();
+
+        return leftIntersection && rightIntersection;
+    }
+
+    bool adjacentTo(const ShaderBindingRange& other) const
+    {
+        if (category != other.category || spaceIndex != other.spaceIndex)
+            return false;
+
+        const bool leftIntersection = (registerIndex <= other.registerIndex + other.registerCount) || other.isInfinite();
+        const bool rightIntersection = (other.registerIndex <= registerIndex + registerCount) || isInfinite();
+
+        return leftIntersection && rightIntersection;
+    }
+
+    void mergeWith(const ShaderBindingRange other)
+    {
+        UInt newRegisterIndex = Math::Min(registerIndex, other.registerIndex);
+
+        if (other.isInfinite())
+            registerCount = 0;
+        else if (!isInfinite())
+            registerCount = Math::Max(registerIndex + registerCount, other.registerIndex + other.registerCount) - newRegisterIndex;
+
+        registerIndex = newRegisterIndex;
+    }
+
+    static bool isUsageTracked(slang::ParameterCategory category)
+    {
+        switch (category)
+        {
+        case slang::ConstantBuffer:
+        case slang::ShaderResource:
+        case slang::UnorderedAccess:
+        case slang::SamplerState:
+            return true;
+        default:
+            return false;
+        }
+    }
+};
+
+class PostEmitMetadata : public ComBaseObject, public IPostEmitMetadata
+{
+public:
+    SLANG_CLASS_GUID(0x6f82509f, 0xe48b, 0x4b83, { 0xa3, 0x84, 0x5d, 0x70, 0x83, 0x19, 0x83, 0xcc })
+
+    SLANG_COM_BASE_IUNKNOWN_ALL
+
+    // ICastable
+    SLANG_NO_THROW void* SLANG_MCALL castAs(const Guid& guid) SLANG_OVERRIDE;
+    
+    // IPostEmitMetadata
+    SLANG_NO_THROW virtual Slice<ShaderBindingRange> SLANG_MCALL getBindingRanges() SLANG_OVERRIDE;
+    
+    void* getInterface(const Guid& uuid);
+    void* getObject(const Guid& uuid);
+
+    List<ShaderBindingRange> m_usedBindings;
+};
+
+} // namespace Slang
+
+#endif