sbox-public/engine/Sandbox.Compiling/Compiler/Compiler.cs

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Emit;

namespace Sandbox;

/// <summary>
/// Given a folder of .cs files, this will produce (and load) an assembly
/// </summary>
[SkipHotload]
public sealed partial class Compiler : IDisposable
{
	private Logger log { get; set; }

	/// <summary>
	/// Each compiler must belong to a compile group
	/// </summary>
	public CompileGroup Group { get; private set; }

	/// <summary>
	/// The output from the previous build
	/// </summary>
	public CompilerOutput Output { get; set; }

	/// <summary>
	/// Is this compiler currently building?
	/// </summary>
	public bool IsBuilding => _compileTcs?.Task is { IsCompleted: false };

	/// <summary>
	/// Returns true if this compiler is pending a build, or currently building.
	/// </summary>
	public bool NeedsBuild => IsBuilding || Group.CompilerNeedsBuild( this );

	/// <summary>
	/// Name of the project this compiler was created for. This could be something like "base" or "org.ident".
	/// </summary>
	public string Name { get; }

	/// <summary>
	/// During development we use absolute source paths so that debugging works better. In a packed/release build it's
	/// good to use relative paths instead, just to avoid exposing the builder's file system.
	/// </summary>
	public bool UseAbsoluteSourcePaths { get; set; } = true;

	/// <summary>
	/// A list of warnings and errors created by the last build
	/// </summary>
	public Microsoft.CodeAnalysis.Diagnostic[] Diagnostics => Output?.Diagnostics.ToArray() ?? Array.Empty<Diagnostic>();

	/// <summary>
	/// Generated assembly name, without an extension. This will be "package.{Name}".
	/// </summary>
	public string AssemblyName { get; }

	/// <summary>
	/// Global namespaces
	/// </summary>
	public StringBuilder GeneratedCode { get; set; } = new();

	/// <summary>
	/// Directories to search for code
	/// </summary>
	private List<BaseFileSystem> SourceLocations { get; } = new();

	/// <summary>
	/// An aggregate of all the filesystem this compiler has
	/// </summary>
	public BaseFileSystem FileSystem { get; } = new AggregateFileSystem();

	/// <summary>
	/// After compile is completed successfully this will be non null.
	/// </summary>
	internal PortableExecutableReference MetadataReference;

	/// <summary>
	/// Keeps track of the most recent <see cref="MetadataReference"/> values,
	/// in case the current one is revoked because it was fast-hotloaded.
	/// This dictionary is cleared when a version is built that doesn't support
	/// fast hotload at all.
	/// </summary>
	private readonly Dictionary<Version, PortableExecutableReference> _recentMetadataReferences = new();

	private IncrementalCompileState incrementalState = new IncrementalCompileState();

	/// <summary>
	/// The compiler's settings. 
	/// </summary>
	private Compiler.Configuration config;

	/// <summary>
	/// Should only ever get called from CompileGroup.
	/// </summary>
	internal Compiler( CompileGroup group, string name, string fullPath, Compiler.Configuration settings )
	{
		Group = group;
		Name = name;
		log = new Logger( $"Compiler/{name}" );
		AssemblyName = $"package.{name}";

		if ( fullPath is not null )
		{
			AddSourcePath( fullPath );
		}

		SetConfiguration( settings );
	}

	/// <summary>
	/// Should only ever get called from CompileGroup.
	/// </summary>
	internal Compiler( CompileGroup group, string name )
	{
		Group = group;
		Name = name;
		log = new Logger( $"Compiler/{name}" );
		AssemblyName = $"package.{name}";
	}

	/// <summary>
	/// Add an extra source path. Useful for situations where you want to combine multiple addons into one.
	/// </summary>
	public void AddSourcePath( string fullPath )
	{
		AddSourceLocation( new LocalFileSystem( fullPath ) );
	}

	internal void AddSourceLocation( BaseFileSystem fileSystem )
	{
		fileSystem.TraceChanges = true;

		SourceLocations.Add( fileSystem );
		FileSystem.Mount( fileSystem );
	}

	public void SetConfiguration( Compiler.Configuration newConfig )
	{
		config = newConfig;
		incrementalState.Reset();
	}

	public Configuration GetConfiguration()
	{
		return config;
	}

	/// <summary>
	/// Results for the assembly build. This can contain warnings or errors.
	/// </summary>
	public EmitResult BuildResult { get; private set; }

	/// <summary>
	/// Accesses Output.Successful
	/// </summary>
	public bool BuildSuccess => Output?.Successful ?? false;

	/// <summary>
	/// Keep tabs of how many times we've compiled
	/// </summary>
	static int compileCounter = 100;

	public void NotifyFastHotload( Version fastHotloadedVersion )
	{
		log.Trace( $"{Name}@{fastHotloadedVersion} was fast hotloaded" );

		if ( !_recentMetadataReferences.Remove( fastHotloadedVersion, out var reference ) )
		{
			log.Trace( $"  Not found!!" );
			return;
		}

		//
		// MetadataReference shouldn't be a fast hotloaded version, otherwise other compilers
		// that reference this compiler can't be loaded properly!
		//

		if ( reference == MetadataReference )
		{
			var mostRecent = _recentMetadataReferences
				.MaxBy( x => x.Key );

			MetadataReference = mostRecent.Value;

			log.Trace( $"  Now using {Name}@{mostRecent.Key}" );
		}
	}

	/// <summary>
	/// Read text from a file while dealing with the fact that it might be being saved right 
	/// when we're loading it so it's likely to throw IOExceptions.
	/// </summary>
	private string ReadTextForgiving( string file, int retryCount = 10, int millisecondsBetweenChanges = 5 )
	{
		for ( var i = 0; i < retryCount; i++ )
		{
			try
			{
				return System.IO.File.ReadAllText( file );
			}
			catch ( System.IO.IOException )
			{
				System.Threading.Thread.Sleep( millisecondsBetweenChanges );
			}
		}

		return null;
	}

	internal async Task<IReadOnlyList<PortableExecutableReference>> BuildReferencesAsync( CodeArchive archive )
	{
		var output = new List<PortableExecutableReference>( FrameworkReferences.All.Values );
		var foundHash = new HashSet<string>( StringComparer.OrdinalIgnoreCase );

		foreach ( var name in archive.References )
		{
			// We already got it from a package reference
			// this is cool for when referencing something that includes package.base.dll
			if ( foundHash.Contains( name ) )
				continue;

			// FindReferenceAsync throws if not found

			if ( await Group.FindReferenceAsync( name, this ) is { } mr )
			{
				log.Trace( $"Found reference: {name}" );
				output.Add( mr );
			}
		}

		return output;
	}

	/// <summary>
	/// Waits for the current build to finish, then outputs that build's result.
	/// This is only valid during <see cref="CompileGroup.BuildAsync"/>.
	/// </summary>
	internal Task<CompilerOutput> GetCompileOutputAsync()
	{
		// Build hasn't started

		Assert.NotNull( _compileTcs, $"The containing group isn't currently compiling ({Name})" );

		return _compileTcs.Task;
	}

	/// <summary>
	/// Return this compiler and all child compilers
	/// </summary>
	internal IEnumerable<Compiler> GetReferencedCompilers()
	{
		var referenced = new HashSet<Compiler>();
		var queue = new Queue<Compiler>();

		referenced.Add( this );
		queue.Enqueue( this );

		while ( queue.TryDequeue( out var next ) )
		{
			foreach ( var reference in next._references )
			{
				if ( Group.FindCompilerByAssemblyName( reference ) is not { } otherCompiler ) continue;
				if ( !referenced.Add( otherCompiler ) ) continue;

				queue.Enqueue( otherCompiler );
			}
		}

		return referenced;
	}

	~Compiler()
	{
		Dispose( false );
	}

	public void Dispose()
	{
		Dispose( true );
		GC.SuppressFinalize( this );
	}

	private void Dispose( bool disposing )
	{
		if ( disposing )
		{
			Group?.OnCompilerDisposed( this );
			Group = null;
		}

		foreach ( var watcher in sourceWatchers ) watcher.Dispose();
		sourceWatchers.Clear();

		FileSystem?.Dispose();

		foreach ( var fs in SourceLocations ) fs.Dispose();

		SourceLocations.Clear();
	}

	public int DependencyIndex( int depth = 0 )
	{
		int index = 0;
		depth++;

		if ( depth > 10 )
			throw new System.Exception( "Cyclic references detected - aborting." );

		foreach ( var r in _references )
		{
			var g = Group.FindCompilerByAssemblyName( r );
			if ( g == null ) continue; // this is allowed - it might be Sandbox.Game or something
			if ( g == this ) continue;

			index = Math.Max( index, g.DependencyIndex( depth ) );
		}

		return index + 1;
	}

	/// <summary>
	/// Recompile this as soon as is appropriate
	/// </summary>
	public void MarkForRecompile()
	{
		Group.MarkForRecompile( this );
	}
}