compiler-explorer/lib/tooling/compiler-dropin-tool.ts

// Copyright (c) 2019, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import path from 'node:path';

import {splitArguments} from '../../shared/common-utils.js';
import {CompilationInfo} from '../../types/compilation/compilation.interfaces.js';
import {ToolInfo, ToolResult} from '../../types/tool.interfaces.js';
import {OptionsHandlerLibrary} from '../options-handler.js';
import {getToolchainPath} from '../toolchain-utils.js';
import {ToolEnv} from './base-tool.interface.js';
import {BaseTool} from './base-tool.js';

export class CompilerDropinTool extends BaseTool {
    static get key() {
        return 'compiler-dropin-tool';
    }

    constructor(toolInfo: ToolInfo, env: ToolEnv) {
        super(toolInfo, env);

        this.addOptionsToToolArgs = false;
    }

    getToolchainPath(compilationInfo: CompilationInfo): string | undefined {
        return getToolchainPath(compilationInfo.compiler.exe, compilationInfo.compiler.options);
    }

    getOrderedArguments(
        compilationInfo: CompilationInfo,
        includeflags: string[],
        libOptions: string[],
        args?: string[],
        sourcefile?: string,
    ): string[] | false {
        // order should be:
        //  1) options from the compiler config (compilationInfo.compiler.options)
        //  2) includes from the libraries (includeflags)
        //  3) options from the tool config (this.tool.options)
        //  4) options manually specified in the compiler tab (options)
        //  5) flags from the clang-tidy tab
        let compileFlags: string[] = [];
        const argsToFilterOut = new Set([sourcefile, '-stdlib=libc++']);

        const toolchainPath = this.getToolchainPath(compilationInfo);

        let compilerOptions = compilationInfo.compiler.options ? splitArguments(compilationInfo.compiler.options) : [];

        if (toolchainPath) {
            // note: needs toolchain argument twice as the first time its sometimes ignored
            compileFlags = compileFlags.concat(['--gcc-toolchain=' + toolchainPath]);
            compileFlags = compileFlags.concat(['--gcc-toolchain=' + toolchainPath]);

            compilerOptions = compilerOptions.filter(option => {
                return !(option.indexOf('--gcc-toolchain=') === 0 || option.indexOf('--gxx-name=') === 0);
            });
        } else {
            return false;
        }

        compilerOptions = compilerOptions.filter(option => !argsToFilterOut.has(option));

        compileFlags = compileFlags.concat(compilerOptions);
        compileFlags = compileFlags.concat(includeflags);

        const manualCompileFlags = compilationInfo.options.filter((option: string) => !argsToFilterOut.has(option));
        compileFlags = compileFlags.concat(manualCompileFlags);
        const toolOptions = this.tool.options || [];
        compileFlags = compileFlags.concat(toolOptions);
        compileFlags = compileFlags.concat(libOptions);
        compileFlags = compileFlags.concat(args || []);

        const pathFilteredFlags: (string | false)[] = compileFlags.map(option => {
            if (option && option.length > 1) {
                if (option[0] === '/') {
                    return false;
                }
            }

            return option;
        });

        return pathFilteredFlags.filter(Boolean) as string[];
    }

    override async runTool(
        compilationInfo: CompilationInfo,
        inputFilepath?: string,
        args?: string[],
        stdin?: string,
        supportedLibraries?: Record<string, OptionsHandlerLibrary>,
    ): Promise<ToolResult> {
        const sourcefile = inputFilepath;
        const pathDir = inputFilepath ? path.dirname(inputFilepath) : undefined;

        const includeflags = this.getIncludeArguments(compilationInfo.libraries, supportedLibraries || {}, pathDir);
        const libOptions = this.getLibraryOptions(compilationInfo.libraries, supportedLibraries || {});

        const compileFlags = this.getOrderedArguments(compilationInfo, includeflags, libOptions, args, sourcefile);
        if (!compileFlags) {
            return new Promise(resolve => {
                resolve(this.createErrorResponse('Unable to run tool with selected compiler'));
            });
        }

        return super.runTool(compilationInfo, sourcefile, compileFlags);
    }
}