IKVM.Tools.Runner.IkvmToolLauncher Class Reference

Inheritance diagram for IKVM.Tools.Runner.IkvmToolLauncher:

Public Member Functions
	IkvmToolLauncher (string toolName, string toolPath, IIkvmToolDiagnosticEventListener listener)
	Initializes a new instance.
string?	GetToolExe ()
	Gets the path to executable for the given environment.

Protected Member Functions
ValueTask	LogEventAsync (in IkvmToolDiagnosticEvent @event, CancellationToken cancellationToken)
	Logs an event if a listener is provided.
ValueTask	LogEventAsync (IkvmToolDiagnosticEventLevel level, string message, string[] args, CancellationToken cancellationToken)
	Logs an anonymous event if a listener is provided.
ValueTask	ParseAndLogEventAsync (string line, CancellationToken cancellationToken)
	Parses the line and logs it.
IkvmToolDiagnosticEvent	ParseEvent (string line)
	Parse a line of JSON tool output into a diagnostic event.

Detailed Description

Definition at line 14 of file IkvmToolLauncher.cs.

Constructor & Destructor Documentation

IkvmToolLauncher()

IKVM.Tools.Runner.IkvmToolLauncher.IkvmToolLauncher	(	string	toolName,
		string	toolPath,
		IIkvmToolDiagnosticEventListener	listener )

Initializes a new instance.

Parameters

toolName
toolPath
listener

Definition at line 27 of file IkvmToolLauncher.cs.

        {
            this.toolName = toolName ?? throw new ArgumentNullException(nameof(toolName));
            this.toolPath = toolPath ?? throw new ArgumentNullException(nameof(toolPath));
            this.listener = listener;
 
            if (Directory.Exists(toolPath) == false)
                throw new DirectoryNotFoundException($"Could not locate tool path {toolPath}.");
        }

Member Function Documentation

GetToolExe()

string? IKVM.Tools.Runner.IkvmToolLauncher.GetToolExe

(

)

Gets the path to executable for the given environment.

Returns

Exceptions

ArgumentNullException
NotImplementedException

Definition at line 98 of file IkvmToolLauncher.cs.

        {
            foreach (var name in (Span<string>)[toolName + ".exe", toolName])
                if (File.Exists(Path.Combine(toolPath, name)))
                    return Path.Combine(toolPath, name);
 
            return null;
        }

LogEventAsync() [1/2]

ValueTask IKVM.Tools.Runner.IkvmToolLauncher.LogEventAsync ( IkvmToolDiagnosticEventLevel level, string message, string[] args, CancellationToken cancellationToken )

protected

Logs an anonymous event if a listener is provided.

Parameters

level
message
args

Returns

Definition at line 54 of file IkvmToolLauncher.cs.

        {
            return LogEventAsync(new IkvmToolDiagnosticEvent(-1, level, message, args), cancellationToken);
        }

LogEventAsync() [2/2]

ValueTask IKVM.Tools.Runner.IkvmToolLauncher.LogEventAsync ( in IkvmToolDiagnosticEvent @ event, CancellationToken cancellationToken )

protected

Logs an event if a listener is provided.

Parameters

event

Returns

Definition at line 42 of file IkvmToolLauncher.cs.

        {
            return listener.ReceiveAsync(@event, cancellationToken);
        }

ParseAndLogEventAsync()

ValueTask IKVM.Tools.Runner.IkvmToolLauncher.ParseAndLogEventAsync ( string line, CancellationToken cancellationToken )

protected

Parses the line and logs it.

Parameters

line
cancellationToken

Returns

Definition at line 65 of file IkvmToolLauncher.cs.

        {
            return LogEventAsync(ParseEvent(line), cancellationToken);
        }

ParseEvent()

IkvmToolDiagnosticEvent IKVM.Tools.Runner.IkvmToolLauncher.ParseEvent ( string line )

protected

Parse a line of JSON tool output into a diagnostic event.

Parameters

line

Returns

Definition at line 75 of file IkvmToolLauncher.cs.

        {
            try
            {
                var buffer = Encoding.UTF8.GetBytes(line);
                var reader = new Utf8JsonReader(buffer);
                if (reader.Read() == false)
                    throw new JsonException();
 
                return IkvmToolDiagnosticEvent.ReadJson(ref reader);
            }
            catch (JsonException)
            {
                return new IkvmToolDiagnosticEvent(0, IkvmToolDiagnosticEventLevel.Fatal, "Unable to parse tool output: {0}", [line]);
            }
        }

---

The documentation for this class was generated from the following file:

• src/IKVM.Tools.Runner/IkvmToolLauncher.cs