constants.ts

/*
 * SPDX-FileCopyrightText:  Copyright 2023 Roland Csaszar
 * SPDX-License-Identifier: MIT
 *
 * Project:  vscode-scheme-repl
 * File:     constants.ts
 * Date:     14.May.2023
 *
 * ==============================================================================
 * Constants used in the extensions.
 */

import * as vscode from "vscode";

/**
 * The version of VS Code to use for testing.
 */
export const vscodeVersion = "1.65.0";

/**
 * The name of the language this extension supports.
 */
export const languageName = "scheme";

/**
 * The name of the VS Code output channel - that's the `OUTPUT` tab of the
 * panel.
 */
export const outputChannelName = "Chez Scheme REPL";

/**
 * The name of the terminal the REPL runs in.
 */
export const replTerminalName = "Chez Scheme REPL";

/**
 * The name of the diagnostics collection.
 */
export const diagnosticsCollName = "Chez Scheme REPL";

/**
 * The command to start the Chez Scheme REPL.
 */
export const replCommand = "scheme";

/**
 * Argument to pass to the Chez REPL to suppress greetings and prompts.
 */
export const replQuietArg = "-q";

/**
 * Argument to pass to the Chez REPL to print the version and exit.
 */
export const replVersionArg = "--version";

/**
 * The default interactive REPl prompt and the prompt of the "eval" REPL.
 */
export const replPrompt = "λ>";

/**
 * Return the Chez Scheme function to set the REPL prompt to `prompt`.
 * @param prompt The string to use as prompt.
 * @returns The Chez Scheme function to set the REPL prompt to `prompt`.
 */
export function setREPLPrompt(prompt: string): string {
    return `(waiter-prompt-string "${prompt}")`;
}

/**
 * Return the command to send to a running Chez REPL to load the file
 * `fileName` and evaluate `sexp`.
 * Escapes backslashes in the file path (Windows paths) to be able to load files
 * on windows.
 * The lambda to `load` helps in getting a bit of context about an error, if an
 * error occurs when loading `fileName`.
 * Set the REPL prompt to `replPrompt`.
 * @param fileName The Scheme file to load.
 * @param sexp The sexp to evaluate in the REPL.
 * @returns The command to send to a running Chez REPL to load the file
 * `fileName` and evaluate `sexp`.
 */
export function replLoadFileAndSexp(fileName: string, sexp: string): string {
    const sanitized = fileName.replace(/\\/gu, "\\\\");
    return `(load "${sanitized}" (lambda (x) (pretty-print (if (annotation? x) (annotation-stripped x) x)) (newline) (eval x)))\n${setREPLPrompt(
        replPrompt
    )}\n ${sexp}`;
}

/**
 * Return a Chez Scheme function to get a list of local identifiers starting
 * with `prefix`.
 * @param prefix The substring to search for in the list of identifiers.
 * @returns a Chez Scheme function to get a list of local identifiers starting
 * with `prefix`.
 */
export function evalIdentifiers(prefix: string): string {
    return `(filter
      (lambda (x)
        (cond
          [(symbol? x) (equal? "${prefix}" (substring (symbol->string x) 0 ${prefix.length}))]
          [else #f]))
      (apropos-list "${prefix}" (interaction-environment)))`;
}

/**
 * The time in milliseconds to wait for a new REPL before sending strings to it.
 */
export const replSleepTime = 1000;

/**
 *******************************************************************************
 * Command names
 */

/**
 * Start a REPL in a pane beside the current editor.
 */
export const startREPLCommand = "startREPL";

/**
 * Send the current selection to the REPL.
 */
export const sendSelectionToREPL = "sendSelectionToREPL";

/**
 * Eval the current selection.
 */

export const evalSelection = "evalSelection";

/**
 * Expand all macros in the current selection.
 */
export const expandSelection = "expandSelection";

/**
 * Return the command to macro-expand `sexp` in the REPL.
 * @param sexp The sexp to macro-expand.
 * @returns The command to macro-expand `sexp` in the REPL.
 */
export function expandSexp(sexp: string): string {
    return `(expand '${sexp})`;
}

/**
 * Send the current source file to the REPL.
 */
export const sendFileToREPL = "sendFileToREPL";

/**
 * Send the sexp left of the cursor to the REPL.
 */
export const sendLastToREPL = "sendLastSexp";

/**
 * Eval the sexp left of the cursor.
 */
export const evalLast = "evalLastSexp";

/**
 * Remove all evaluation values from the current view.
 */
export const removeEvalVals = "removeEvalVals";

/**
 * Expand all macros in the sexp left of the cursor.
 */
export const expandLast = "expandLastSexp";

/**
 * Check the current file by loading it in the REPL.
 */
export const checkFile = "checkFile";

/**
 ******************************************************************************
 *  Color constants.
 */

/**
 * The 'root' part of the color identifier.
 */
export const colorBaseName = "chezScheme";

/**
 * The actual color identifier of the background or border color of an
 * evaluation.
 */
export const colorEvalBackgroundName = "evalBackgroundColor";

/**
 * The actual color identifier of the background or border color of an
 * evaluation.
 */
export const colorEvalErrorBackgroundName = "evalErrorBackgroundColor";

/**
 ******************************************************************************
 *  Configuration constants.
 */

/**
 * The name of the configuration section of the extension.
 */
export const cfgSection = "chezScheme";

/**
 * The path of the Chez Scheme REPL Executable.
 */
export const cfgREPLPath = "schemePath";

/**
 * The default value for the Chez Scheme REPL path.
 */
export const cfgREPLDefaultPath = replCommand;

/**
 * The configuration key for the REPL start delay.
 */
export const cfgREPLDelay = "replDelay";

/**
 * The default value of `cfgREPLDelay`.
 */
export const cfgREPLDefaultDelay = replSleepTime;

/**
 * Return the configuration value for `replDelay`.
 * @param config The configuration object to use.
 * @returns The configuration value for `replDelay`.
 */
export function getCfgREPLDelay(config: vscode.WorkspaceConfiguration): number {
    return config.get<number>(cfgREPLDelay) || cfgREPLDefaultDelay;
}

/**
 * The string to use as the Chez REPL prompt.
 */
export const cfgREPLPrompt = "waiterPrompt";

/**
 * The default value of `cfgREPLPrompt`.
 */
export const cfgREPLDefaultPrompt = replPrompt;

/**
 * Return the configuration value for `schemePath`.
 * Removes double or single quotes from the start and end of the string.
 * @param config The configuration object to use.
 * @returns The configuration value for `schemePath`.
 */
export function getCfgREPLPath(config: vscode.WorkspaceConfiguration): string {
    const cfgPath = config.get<string>(cfgREPLPath) || cfgREPLDefaultPath;
    if (cfgPath.startsWith('"') && cfgPath.endsWith('"')) {
        return cfgPath.substring(1, cfgPath.length - 1);
    } else if (cfgPath.startsWith("'") && cfgPath.endsWith("'")) {
        return cfgPath.substring(1, cfgPath.length - 1);
    }
    return cfgPath;
}

/**
 * Return the Chez Scheme function to set the REPL prompt to the configured
 * value of for `waiterPrompt`.
 * @param config The configuration object to use.
 * @returns The Chez Scheme function to set the REPL prompt to the configured
 * value of for `waiterPrompt`.
 */
export function getCfgREPLPromptFunction(
    config: vscode.WorkspaceConfiguration
): string {
    const promptString =
        config.get<string>(cfgREPLPrompt) || cfgREPLDefaultPrompt;
    return setREPLPrompt(promptString);
}