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, 9 insertions, 74 deletions

diff --git a/source/slang/slang-compiler.h b/source/slang/slang-compiler.h
index 9f75d94d3..6b79b2679 100755
--- a/source/slang/slang-compiler.h
+++ b/source/slang/slang-compiler.h
@@ -144,47 +144,6 @@ namespace Slang
     class Module;
     class TranslationUnitRequest;
 
-#if 0
-    // Result of compiling an entry point.
-    // Should only ever be string, binary or shared library
-    class CompileResult
-    {
-    public:
-        CompileResult() = default;
-        explicit CompileResult(String const& str, RefPtr<PostEmitMetadata> metadata)
-            : format(ResultFormat::Text)
-            , outputString(str)
-            , postEmitMetadata(metadata) {}
-
-        explicit CompileResult(ISlangBlob* inBlob)
-            : format(ResultFormat::Binary)
-            , blob(inBlob) {}
-
-        explicit CompileResult(DownstreamCompileResult* inDownstreamResult, RefPtr<PostEmitMetadata> metadata)
-            : format(ResultFormat::Binary)
-            , downstreamResult(inDownstreamResult)
-            , postEmitMetadata(metadata) {}
-
-        explicit CompileResult(const UnownedStringSlice& slice )
-            : format(ResultFormat::Text)
-            , outputString(slice) {}
-
-        SlangResult getBlob(ComPtr<ISlangBlob>& outBlob) const;
-        SlangResult getSharedLibrary(ComPtr<ISlangSharedLibrary>& outSharedLibrary);
-
-        SlangResult isParameterLocationUsed(SlangParameterCategory category, UInt spaceIndex, UInt registerIndex, bool& outUsed);
-                
-        ResultFormat format = ResultFormat::None;
-        String outputString;                    ///< Only set if result type is ResultFormat::Text
-
-        mutable ComPtr<ISlangBlob> blob;
-
-        RefPtr<DownstreamCompileResult> downstreamResult;
-
-        RefPtr<PostEmitMetadata> postEmitMetadata;
-    };
-#endif
-
         /// Information collected about global or entry-point shader parameters
     struct ShaderParamInfo
     {
@@ -2414,46 +2373,21 @@ namespace Slang
 
         SlangResult emitEntryPoints(ComPtr<IArtifact>& outArtifact);
 
-        SlangResult dissassembleWithDownstream(
-            const void* data,
-            size_t          dataSizeInBytes,
-            ISlangBlob** outBlob);
-
-        SlangResult dissassembleWithDownstream(
-            DownstreamCompileResult* downstreamResult,
-            ISlangBlob** outBlob);
+        void maybeDumpIntermediate(IArtifact* artifact);
 
     protected:
         CodeGenTarget m_targetFormat = CodeGenTarget::Unknown;
         ExtensionTracker* m_extensionTracker = nullptr;
 
-        void maybeDumpIntermediate(IArtifact* artifact);
+            /// Will output assembly as well as the artifact if appropriate for the artifact type for assembly output
+            /// and conversion is possible
+        void _dumpIntermediateMaybeWithAssembly(IArtifact* artifact);
 
-        // Helper to dump intermediate output when debugging
-        void maybeDumpIntermediate(
+        void _dumpIntermediate(IArtifact* artifact);
+        void _dumpIntermediate(
+            const ArtifactDesc& desc,
             void const* data,
             size_t      size);
-        void maybeDumpIntermediate(
-            char const* text);
-
-        void maybeDumpIntermediate(
-            DownstreamCompileResult* compileResult);
-
-        void dumpIntermediate(
-            void const* data,
-            size_t      size,
-            char const* ext,
-            bool        isBinary);
-
-        void dumpIntermediateText(
-            void const* data,
-            size_t      size,
-            char const* ext);
-
-        void dumpIntermediateBinary(
-            void const* data,
-            size_t      size,
-            char const* ext);
 
         /* Emits entry point source taking into account if a pass-through or not. Uses 'targetFormat' to determine
         the target (not targetReq) */
@@ -2687,6 +2621,7 @@ namespace Slang
             return m_specializedEntryPoints[index];
         }
         
+        void writeArtifactToStandardOutput(IArtifact* artifact, DiagnosticSink* sink);
 
         void generateOutput();
 
@@ -2865,7 +2800,7 @@ namespace Slang
         {
             return m_downstreamCompileTime;
         }
-
+        
             /// Get the downstream compiler for a transition
         DownstreamCompiler* getDownstreamCompiler(CodeGenTarget source, CodeGenTarget target);