====== Core API ======

API Reference for the WvdS VSCode Core Extension.

===== Overview =====

The Core Extension provides central services that can be used by all other extensions.

<code pascal>
uses
  WvdS.Core.Services,
  WvdS.Core.Toolchain,
  WvdS.Core.Logging;
</code>

===== Logging Service =====

==== LogInfo ====

<code pascal>
procedure LogInfo(const AMessage: string);
procedure LogInfo(const AFormat: string; const AArgs: array of const);
</code>

Writes an info message to the Output Channel.

==== LogWarn ====

<code pascal>
procedure LogWarn(const AMessage: string);
procedure LogWarn(const AFormat: string; const AArgs: array of const);
</code>

Writes a warning to the Output Channel.

==== LogError ====

<code pascal>
procedure LogError(const AMessage: string);
procedure LogError(const AFormat: string; const AArgs: array of const);
</code>

Writes an error to the Output Channel.

==== LogDebug ====

<code pascal>
{$IFDEF DEBUG}
procedure LogDebug(const AMessage: string);
procedure LogDebug(const AFormat: string; const AArgs: array of const);
{$ENDIF}
</code>

Writes a debug message. Only available when compiling with ''-dDEBUG''.

===== Toolchain Service =====

==== GetToolPath ====

<code pascal>
function GetToolPath(ATool: TWvdSToolType): string;
</code>

Returns the configured path for a tool.

^ TWvdSToolType ^ Description ^
| ttFPC | Free Pascal Compiler |
| ttPas2js | pas2js Transpiler |
| ttLazbuild | Lazarus Build Tool |
| ttInnoSetup | Inno Setup Compiler |
| ttMake | GNU Make |

**Example:**

<code pascal>
var
  FpcPath: string;
begin
  FpcPath := GetToolPath(ttFPC);
  if FpcPath = '' then
    raise EWvdSToolNotFound.Create(rsToolNotFound);
end;
</code>

==== GetToolVersion ====

<code pascal>
function GetToolVersion(ATool: TWvdSToolType): string;
</code>

Returns the version of an installed tool.

==== IsToolAvailable ====

<code pascal>
function IsToolAvailable(ATool: TWvdSToolType): Boolean;
</code>

Checks if a tool is available.

==== AutoDetectTools ====

<code pascal>
procedure AutoDetectTools;
</code>

Performs automatic detection of all tools.

===== Configuration =====

==== GetConfiguration ====

<code pascal>
function GetConfiguration(const ASection: string): TJSObject;
</code>

Reads VS Code configuration.

**Example:**

<code pascal>
var
  Config: TJSObject;
  LogLevel: string;
begin
  Config := GetConfiguration('wvds.core');
  LogLevel := String(Config['logLevel']);
end;
</code>

==== UpdateConfiguration ====

<code pascal>
procedure UpdateConfiguration(
  const ASection: string;
  const AKey: string;
  AValue: JSValue;
  ATarget: TConfigurationTarget
);
</code>

Writes VS Code configuration.

^ TConfigurationTarget ^ Description ^
| ctGlobal | User settings |
| ctWorkspace | Workspace settings |
| ctWorkspaceFolder | Folder settings |

===== Event Bus =====

==== PublishEvent ====

<code pascal>
procedure PublishEvent(const AEventName: string; AData: TJSObject);
</code>

Publishes an event for other extensions.

**Example:**

<code pascal>
var
  Data: TJSObject;
begin
  Data := TJSObject.New;
  Data['projectPath'] := ProjectPath;
  Data['success'] := True;
  PublishEvent('wvds.build.completed', Data);
end;
</code>

==== SubscribeEvent ====

<code pascal>
procedure SubscribeEvent(
  const AEventName: string;
  AHandler: TWvdSEventHandler
);
</code>

Subscribes to events.

**Example:**

<code pascal>
procedure HandleBuildCompleted(AData: TJSObject);
begin
  if Boolean(AData['success']) then
    LogInfo('Build succeeded!')
  else
    LogError('Build failed!');
end;

// On activation:
SubscribeEvent('wvds.build.completed', @HandleBuildCompleted);
</code>

===== UI Services =====

==== ShowInfoMessage ====

<code pascal>
procedure ShowInfoMessage(const AMessage: string);
function ShowInfoMessage(
  const AMessage: string;
  const AItems: array of string
): TJSPromise;  // Resolves to selected item
</code>

==== ShowWarningMessage ====

<code pascal>
procedure ShowWarningMessage(const AMessage: string);
</code>

==== ShowErrorMessage ====

<code pascal>
procedure ShowErrorMessage(const AMessage: string);
</code>

==== ShowQuickPick ====

<code pascal>
function ShowQuickPick(
  const AItems: array of string;
  const APlaceholder: string
): TJSPromise;
</code>

===== Workspace Services =====

==== GetWorkspaceRoot ====

<code pascal>
function GetWorkspaceRoot: string;
</code>

Returns the path to the workspace folder.

==== GetOpenDocument ====

<code pascal>
function GetOpenDocument: string;
</code>

Returns the path to the currently open document.

===== See Also =====

  * [[.:meta-api|Meta API]]
  * [[.:vscode-wrapper|VSCode Wrapper]]
  * [[.:extension-entwicklung|Extension Development]]