add initial macOS support #40

src/application/Parser/Script/CategoryCollectionParseContext.ts

@@ -0,0 +1,22 @@
+import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+import { FunctionData } from 'js-yaml-loader!*';
+import { IScriptCompiler } from './Compiler/IScriptCompiler';
+import { ScriptCompiler } from './Compiler/ScriptCompiler';
+import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
+import { SyntaxFactory } from './Syntax/SyntaxFactory';
+import { ISyntaxFactory } from './Syntax/ISyntaxFactory';
+
+export class CategoryCollectionParseContext implements ICategoryCollectionParseContext {
+    public readonly compiler: IScriptCompiler;
+    public readonly syntax: ILanguageSyntax;
+
+    constructor(
+        functionsData: ReadonlyArray<FunctionData> | undefined,
+        scripting: IScriptingDefinition,
+        syntaxFactory: ISyntaxFactory = new SyntaxFactory()) {
+        if (!scripting) { throw new Error('undefined scripting'); }
+        this.syntax = syntaxFactory.create(scripting.language);
+        this.compiler = new ScriptCompiler(functionsData, this.syntax);
+    }
+}

src/application/Parser/Script/Compiler/ILCode.ts

@@ -0,0 +1,73 @@
+export interface IILCode {
+    compile(): string;
+    getUniqueParameterNames(): string[];
+    substituteParameter(parameterName: string, parameterValue: string): IILCode;
+}
+
+export function generateIlCode(rawText: string): IILCode {
+    const ilCode = generateIl(rawText);
+    return new ILCode(ilCode);
+}
+
+class ILCode implements IILCode {
+    private readonly ilCode: string;
+
+    constructor(ilCode: string) {
+        this.ilCode = ilCode;
+    }
+
+    public substituteParameter(parameterName: string, parameterValue: string): IILCode {
+        const newCode = substituteParameter(this.ilCode, parameterName, parameterValue);
+        return new ILCode(newCode);
+    }
+
+    public getUniqueParameterNames(): string[] {
+        return getUniqueParameterNames(this.ilCode);
+    }
+
+    public compile(): string {
+        ensureNoExpressionLeft(this.ilCode);
+        return this.ilCode;
+    }
+}
+
+// Trim each expression and put them inside "{{exp|}}" e.g. "{{ $hello }}" becomes "{{exp|$hello}}"
+function generateIl(rawText: string): string {
+    return rawText.replace(/\{\{([\s]*[^;\s\{]+[\s]*)\}\}/g, (_, match) => {
+        return `\{\{exp|${match.trim()}\}\}`;
+    });
+}
+
+// finds all "{{exp|..}} left"
+function ensureNoExpressionLeft(ilCode: string) {
+    const allSubstitutions = ilCode.matchAll(/\{\{exp\|(.*?)\}\}/g);
+    const allMatches = Array.from(allSubstitutions, (match) => match[1]);
+    const uniqueExpressions = getDistinctValues(allMatches);
+    if (uniqueExpressions.length > 0) {
+        throw new Error(`unknown expression: ${printList(uniqueExpressions)}`);
+    }
+}
+
+// Parses all distinct usages of {{exp|$parameterName}}
+function getUniqueParameterNames(ilCode: string) {
+    const allSubstitutions = ilCode.matchAll(/\{\{exp\|\$([^;\s\{]+[\s]*)\}\}/g);
+    const allParameters = Array.from(allSubstitutions, (match) => match[1]);
+    const uniqueParameterNames = getDistinctValues(allParameters);
+    return uniqueParameterNames;
+}
+
+// substitutes {{exp|$parameterName}} to value of the parameter
+function substituteParameter(ilCode: string, parameterName: string, parameterValue: string) {
+    const pattern = `{{exp|$${parameterName}}}`;
+    return ilCode.split(pattern).join(parameterValue); // as .replaceAll() is not yet supported by TS
+}
+
+function getDistinctValues(values: readonly string[]): string[] {
+    return values.filter((value, index, self) => {
+        return self.indexOf(value) === index;
+      });
+}
+
+function printList(list: readonly string[]): string {
+    return `"${list.join('","')}"`;
+}

src/application/Parser/Script/Compiler/IScriptCompiler.ts

@@ -0,0 +1,7 @@
+import { IScriptCode } from '@/domain/IScriptCode';
+import { ScriptData } from 'js-yaml-loader!@/*';
+
+export interface IScriptCompiler {
+    canCompile(script: ScriptData): boolean;
+    compile(script: ScriptData): IScriptCode;
+}

src/application/Parser/Script/Compiler/ScriptCompiler.ts

@@ -0,0 +1,171 @@
+import { generateIlCode, IILCode } from './ILCode';
+import { IScriptCode } from '@/domain/IScriptCode';
+import { ScriptCode } from '@/domain/ScriptCode';
+import { ScriptData, FunctionData, FunctionCallData, ScriptFunctionCallData, FunctionCallParametersData } from 'js-yaml-loader!@/*';
+import { IScriptCompiler } from './IScriptCompiler';
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+
+interface ICompiledCode {
+    readonly code: string;
+    readonly revertCode: string;
+}
+
+export class ScriptCompiler implements IScriptCompiler {
+    constructor(
+        private readonly functions: readonly FunctionData[] | undefined,
+        private syntax: ILanguageSyntax) {
+        ensureValidFunctions(functions);
+        if (!syntax) { throw new Error('undefined syntax'); }
+    }
+    public canCompile(script: ScriptData): boolean {
+        if (!script.call) {
+            return false;
+        }
+        return true;
+    }
+    public compile(script: ScriptData): IScriptCode {
+        this.ensureCompilable(script.call);
+        const compiledCodes = new Array<ICompiledCode>();
+        const calls = getCallSequence(script.call);
+        calls.forEach((currentCall, currentCallIndex) => {
+            ensureValidCall(currentCall, script.name);
+            const commonFunction = this.getFunctionByName(currentCall.function);
+            let functionCode = compileCode(commonFunction, currentCall.parameters);
+            if (currentCallIndex !== calls.length - 1) {
+                functionCode = appendLine(functionCode);
+            }
+            compiledCodes.push(functionCode);
+        });
+        const scriptCode = merge(compiledCodes);
+        return new ScriptCode(scriptCode.code, scriptCode.revertCode, script.name, this.syntax);
+    }
+
+    private getFunctionByName(name: string): FunctionData {
+        const func = this.functions.find((f) => f.name === name);
+        if (!func) {
+            throw new Error(`called function is not defined "${name}"`);
+        }
+        return func;
+    }
+    private ensureCompilable(call: ScriptFunctionCallData) {
+        if (!this.functions || this.functions.length === 0) {
+            throw new Error('cannot compile without shared functions');
+        }
+        if (typeof call !== 'object') {
+            throw new Error('called function(s) must be an object');
+        }
+    }
+}
+
+function getDuplicates(texts: readonly string[]): string[] {
+    return texts.filter((item, index) => texts.indexOf(item) !== index);
+}
+
+function printList(list: readonly string[]): string {
+    return `"${list.join('","')}"`;
+}
+
+function ensureNoDuplicatesInFunctionNames(functions: readonly FunctionData[]) {
+    const duplicateFunctionNames = getDuplicates(functions
+        .map((func) => func.name.toLowerCase()));
+    if (duplicateFunctionNames.length) {
+        throw new Error(`duplicate function name: ${printList(duplicateFunctionNames)}`);
+    }
+}
+function ensureNoUndefinedItem(functions: readonly FunctionData[]) {
+    if (functions.some((func) => !func)) {
+        throw new Error(`some functions are undefined`);
+    }
+}
+function ensureNoDuplicatesInParameterNames(functions: readonly FunctionData[]) {
+    const functionsWithParameters = functions
+        .filter((func) => func.parameters && func.parameters.length > 0);
+    for (const func of functionsWithParameters) {
+        const duplicateParameterNames = getDuplicates(func.parameters);
+        if (duplicateParameterNames.length) {
+            throw new Error(`"${func.name}": duplicate parameter name: ${printList(duplicateParameterNames)}`);
+        }
+    }
+}
+
+function ensureNoDuplicateCode(functions: readonly FunctionData[]) {
+    const duplicateCodes = getDuplicates(functions.map((func) => func.code));
+    if (duplicateCodes.length > 0) {
+        throw new Error(`duplicate "code" in functions: ${printList(duplicateCodes)}`);
+    }
+    const duplicateRevertCodes = getDuplicates(functions
+        .filter((func) => func.revertCode)
+        .map((func) => func.revertCode));
+    if (duplicateRevertCodes.length > 0) {
+        throw new Error(`duplicate "revertCode" in functions: ${printList(duplicateRevertCodes)}`);
+    }
+}
+
+function ensureValidFunctions(functions: readonly FunctionData[]) {
+    if (!functions || functions.length === 0) {
+        return;
+    }
+    ensureNoUndefinedItem(functions);
+    ensureNoDuplicatesInFunctionNames(functions);
+    ensureNoDuplicatesInParameterNames(functions);
+    ensureNoDuplicateCode(functions);
+}
+
+function appendLine(code: ICompiledCode): ICompiledCode {
+    const appendLineIfNotEmpty = (str: string) => str ? `${str}\n` : str;
+    return {
+        code: appendLineIfNotEmpty(code.code),
+        revertCode: appendLineIfNotEmpty(code.revertCode),
+    };
+}
+
+function merge(codes: readonly ICompiledCode[]): ICompiledCode {
+    return {
+        code: codes.map((code) => code.code).join(''),
+        revertCode: codes.map((code) => code.revertCode).join(''),
+    };
+}
+
+function compileCode(func: FunctionData, parameters: FunctionCallParametersData): ICompiledCode {
+    return {
+        code: compileExpressions(func.code, parameters),
+        revertCode: compileExpressions(func.revertCode, parameters),
+    };
+}
+
+function compileExpressions(code: string, parameters: FunctionCallParametersData): string {
+    let intermediateCode = generateIlCode(code);
+    intermediateCode = substituteParameters(intermediateCode, parameters);
+    return intermediateCode.compile();
+}
+
+function substituteParameters(intermediateCode: IILCode, parameters: FunctionCallParametersData): IILCode {
+    const parameterNames = intermediateCode.getUniqueParameterNames();
+    if (parameterNames.length && !parameters) {
+        throw new Error(`no parameters defined, expected: ${printList(parameterNames)}`);
+    }
+    for (const parameterName of parameterNames) {
+        const parameterValue = parameters[parameterName];
+        if (!parameterValue) {
+            throw Error(`parameter value is not provided for "${parameterName}" in function call`);
+        }
+        intermediateCode = intermediateCode.substituteParameter(parameterName, parameterValue);
+    }
+    return intermediateCode;
+}
+
+function ensureValidCall(call: FunctionCallData, scriptName: string) {
+    if (!call) {
+        throw new Error(`undefined function call in script "${scriptName}"`);
+    }
+    if (!call.function) {
+        throw new Error(`empty function name called in script "${scriptName}"`);
+    }
+}
+
+function getCallSequence(call: ScriptFunctionCallData): FunctionCallData[] {
+    if (call instanceof Array) {
+        return call as FunctionCallData[];
+    }
+    return [ call as FunctionCallData ];
+}

src/application/Parser/Script/ICategoryCollectionParseContext.ts

@@ -0,0 +1,7 @@
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+import { IScriptCompiler } from './Compiler/IScriptCompiler';
+
+export interface ICategoryCollectionParseContext {
+    readonly compiler: IScriptCompiler;
+    readonly syntax: ILanguageSyntax;
+}

src/application/Parser/Script/ScriptParser.ts

@@ -0,0 +1,54 @@
+import { Script } from '@/domain/Script';
+import { ScriptData } from 'js-yaml-loader!@/*';
+import { parseDocUrls } from '../DocumentationParser';
+import { RecommendationLevel } from '@/domain/RecommendationLevel';
+import { IScriptCode } from '@/domain/IScriptCode';
+import { ScriptCode } from '@/domain/ScriptCode';
+import { createEnumParser, IEnumParser } from '../../Common/Enum';
+import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
+
+export function parseScript(
+    data: ScriptData, context: ICategoryCollectionParseContext,
+    levelParser = createEnumParser(RecommendationLevel)): Script {
+    validateScript(data);
+    if (!context)    {    throw new Error('undefined context');  }
+    const script = new Script(
+        /* name */  data.name,
+        /* code */  parseCode(data, context),
+        /* docs */  parseDocUrls(data),
+        /* level */ parseLevel(data.recommend, levelParser));
+    return script;
+}
+
+function parseLevel(level: string, parser: IEnumParser<RecommendationLevel>): RecommendationLevel | undefined {
+    if (!level) {
+        return undefined;
+    }
+    return parser.parseEnum(level, 'level');
+}
+
+function parseCode(script: ScriptData, context: ICategoryCollectionParseContext): IScriptCode {
+    if (context.compiler.canCompile(script)) {
+        return context.compiler.compile(script);
+    }
+    return new ScriptCode(script.code, script.revertCode, script.name, context.syntax);
+}
+
+function ensureNotBothCallAndCode(script: ScriptData) {
+    if (script.code && script.call) {
+        throw new Error('cannot define both "call" and "code"');
+    }
+    if (script.revertCode && script.call) {
+        throw new Error('cannot define "revertCode" if "call" is defined');
+    }
+}
+
+function validateScript(script: ScriptData) {
+    if (!script) {
+        throw new Error('undefined script');
+    }
+    if (!script.code && !script.call) {
+        throw new Error('must define either "call" or "code"');
+    }
+    ensureNotBothCallAndCode(script);
+}

src/application/Parser/Script/Syntax/BatchFileSyntax.ts

@@ -0,0 +1,6 @@
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+
+export class BatchFileSyntax implements ILanguageSyntax {
+    public readonly commentDelimiters = [ 'REM', '::' ];
+    public readonly commonCodeParts = [ '(', ')', 'else' ];
+}

src/application/Parser/Script/Syntax/ISyntaxFactory.ts

@@ -0,0 +1,6 @@
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
+
+export interface ISyntaxFactory {
+    create(language: ScriptingLanguage): ILanguageSyntax;
+}

src/application/Parser/Script/Syntax/ShellScriptSyntax.ts

@@ -0,0 +1,6 @@
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+
+export class ShellScriptSyntax implements ILanguageSyntax {
+    public readonly commentDelimiters = [ '#' ];
+    public readonly commonCodeParts = [ '(', ')', 'else' ];
+}

src/application/Parser/Script/Syntax/SyntaxFactory.ts

@@ -0,0 +1,15 @@
+import { ILanguageSyntax } from '@/domain/ScriptCode';
+import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
+import { ISyntaxFactory } from './ISyntaxFactory';
+import { BatchFileSyntax } from './BatchFileSyntax';
+import { ShellScriptSyntax } from './ShellScriptSyntax';
+
+export class SyntaxFactory implements ISyntaxFactory {
+    public create(language: ScriptingLanguage): ILanguageSyntax {
+        switch (language) {
+            case ScriptingLanguage.batchfile:   return new BatchFileSyntax();
+            case ScriptingLanguage.shellscript: return new ShellScriptSyntax();
+            default:    throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
+        }
+    }
+}