refactor: renames the CompilerFilters type (#4346)

The type which probably started as a real enum of possible post filtering options now also includes options used for compilers' invocations. The type was already split, but the naming was not reflecting this in the other part of the code. This changes tries to apply a simple renaming to the type only (corresponding variables are left as 'filters'). While doing so, some typing error were discovered around the GccDump feature. A fix for this will follow in a different PR. Signed-off-by: Marc Poulhiès <dkm@kataplop.net>
compiler-explorer · Nov 28, 2022 · 2fa2bbb · 2fa2bbb
1 parent 90e6e4e
commit 2fa2bbb
Show file tree

Hide file tree

Showing 35 changed files with 171 additions and 104 deletions.
diff --git a/lib/base-compiler.ts b/lib/base-compiler.ts
@@ -48,7 +48,7 @@ import {
     ExecutableExecutionOptions,
     UnprocessedExecResult,
 } from '../types/execution/execution.interfaces';
-import {CompilerFilters, ParseFilters} from '../types/features/filters.interfaces';
+import {CompilerOutputOptions, ParseFiltersAndOutputOptions} from '../types/features/filters.interfaces';
 import {Language} from '../types/languages.interfaces';
 import {Library, LibraryVersion, SelectedLibraryVersion} from '../types/libraries/libraries.interfaces';
 import {ResultLine} from '../types/resultline/resultline.interfaces';
@@ -392,7 +392,14 @@ export class BaseCompiler {
         return output;
     }
 
-    async objdump(outputFilename, result: any, maxSize: number, intelAsm, demangle, filters: ParseFilters) {
+    async objdump(
+        outputFilename,
+        result: any,
+        maxSize: number,
+        intelAsm,
+        demangle,
+        filters: ParseFiltersAndOutputOptions,
+    ) {
         outputFilename = this.getObjdumpOutputFilename(outputFilename);
 
         if (!(await utils.fileExists(outputFilename))) {
@@ -585,7 +592,11 @@ export class BaseCompiler {
         return addOpts;
     }
 
-    protected optionsForFilter(filters: ParseFilters, outputFilename: string, userOptions?: string[]): string[] {
+    protected optionsForFilter(
+        filters: ParseFiltersAndOutputOptions,
+        outputFilename: string,
+        userOptions?: string[],
+    ): string[] {
         let options = ['-g', '-o', this.filename(outputFilename)];
         if (this.compiler.intelAsm && filters.intel && !filters.binary) {
             options = options.concat(this.compiler.intelAsm.split(' '));
@@ -844,7 +855,7 @@ export class BaseCompiler {
 
     prepareArguments(
         userOptions: string[],
-        filters: ParseFilters,
+        filters: ParseFiltersAndOutputOptions,
         backendOptions: Record<string, any>,
         inputFilename: string,
         outputFilename: string,
@@ -1009,7 +1020,7 @@ export class BaseCompiler {
         }
     }
 
-    async generateIR(inputFilename: string, options: string[], filters: ParseFilters) {
+    async generateIR(inputFilename: string, options: string[], filters: ParseFiltersAndOutputOptions) {
         // These options make Clang produce an IR
         const newOptions = options.filter(option => option !== '-fcolor-diagnostics').concat(this.compiler.irArg);
 
@@ -1025,7 +1036,7 @@ export class BaseCompiler {
         return ir.asm;
     }
 
-    async processIrOutput(output, filters: ParseFilters) {
+    async processIrOutput(output, filters: ParseFiltersAndOutputOptions) {
         const irPath = this.getIrOutputFilename(output.inputFilename, filters);
         if (await fs.pathExists(irPath)) {
             const output = await fs.readFile(irPath, 'utf-8');
@@ -1041,7 +1052,7 @@ export class BaseCompiler {
     async generateLLVMOptPipeline(
         inputFilename: string,
         options: string[],
-        filters: ParseFilters,
+        filters: ParseFiltersAndOutputOptions,
         llvmOptPipelineOptions: LLVMOptPipelineBackendOptions,
     ): Promise<LLVMOptPipelineOutput | undefined> {
         // These options make Clang produce the pass dumps
@@ -1102,7 +1113,11 @@ export class BaseCompiler {
         }
     }
 
-    async processLLVMOptPipeline(output, filters: ParseFilters, llvmOptPipelineOptions: LLVMOptPipelineBackendOptions) {
+    async processLLVMOptPipeline(
+        output,
+        filters: ParseFiltersAndOutputOptions,
+        llvmOptPipelineOptions: LLVMOptPipelineBackendOptions,
+    ) {
         return this.llvmPassDumpParser.process(output.stderr, filters, llvmOptPipelineOptions);
     }
 
@@ -1198,7 +1213,7 @@ export class BaseCompiler {
         return [{text: 'Internal error; unable to open output path'}];
     }
 
-    getIrOutputFilename(inputFilename: string, filters: ParseFilters): string {
+    getIrOutputFilename(inputFilename: string, filters: ParseFiltersAndOutputOptions): string {
         return inputFilename.replace(path.extname(inputFilename), '.ll');
     }
 
@@ -1316,7 +1331,7 @@ export class BaseCompiler {
         else return null;
     }
 
-    async checkOutputFileAndDoPostProcess(asmResult, outputFilename, filters: ParseFilters) {
+    async checkOutputFileAndDoPostProcess(asmResult, outputFilename, filters: ParseFiltersAndOutputOptions) {
         try {
             const stat = await fs.stat(outputFilename);
             asmResult.asmSize = stat.size;
@@ -1386,7 +1401,7 @@ export class BaseCompiler {
         return Promise.all(filesToWrite);
     }
 
-    protected async writeAllFiles(dirPath, source, files, filters: ParseFilters) {
+    protected async writeAllFiles(dirPath, source, files, filters: ParseFiltersAndOutputOptions) {
         if (!source) throw new Error(`File ${this.compileFilename} has no content or file is missing`);
 
         const inputFilename = path.join(dirPath, this.compileFilename);
@@ -1401,7 +1416,7 @@ export class BaseCompiler {
         };
     }
 
-    protected async writeAllFilesCMake(dirPath, source, files, filters: ParseFilters) {
+    protected async writeAllFilesCMake(dirPath, source, files, filters: ParseFiltersAndOutputOptions) {
         if (!source) throw new Error('File CMakeLists.txt has no content or file is missing');
 
         const inputFilename = path.join(dirPath, 'CMakeLists.txt');
@@ -1424,7 +1439,7 @@ export class BaseCompiler {
 
         const outputFilename = this.getExecutableFilename(dirPath, this.outputFilebase, key);
 
-        const buildFilters: ParseFilters = Object.assign({}, key.filters);
+        const buildFilters: ParseFiltersAndOutputOptions = Object.assign({}, key.filters);
         buildFilters.binary = true;
         buildFilters.execute = true;
 
@@ -2307,7 +2322,7 @@ export class BaseCompiler {
         return this.asm.process(result.asm, filters);
     }
 
-    async postProcessAsm(result, filters?: ParseFilters) {
+    async postProcessAsm(result, filters?: ParseFiltersAndOutputOptions) {
         if (!result.okToCache || !this.demanglerClass || !result.asm) return result;
         const demangler = new this.demanglerClass(this.compiler.demangler, this);
 
@@ -2478,14 +2493,14 @@ but nothing was dumped. Possible causes are:
         return this.handlePostProcessResult(result, await this.exec('bash', ['-c', postCommand], {maxOutput: maxSize}));
     }
 
-    preProcess(source: string, filters: CompilerFilters): string {
+    preProcess(source: string, filters: CompilerOutputOptions): string {
         if (filters.binary && !this.stubRe.test(source)) {
             source += `\n${this.stubText}\n`;
         }
         return source;
     }
 
-    async postProcess(result, outputFilename: string, filters: ParseFilters) {
+    async postProcess(result, outputFilename: string, filters: ParseFiltersAndOutputOptions) {
         const postProcess = _.compact(this.compiler.postProcess);
         const maxSize = this.env.ceProps('max-asm-size', 64 * 1024 * 1024);
         const optPromise = result.hasOptOutput ? this.processOptOutput(result.optPath) : '';

diff --git a/lib/compilers/assembly.ts b/lib/compilers/assembly.ts
@@ -28,7 +28,7 @@ import path from 'path';
 import _ from 'underscore';
 
 import {BuildResult} from '../../types/compilation/compilation.interfaces';
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 import {AsmRaw} from '../parsers/asm-raw';
 import {fileExists} from '../utils';
@@ -138,7 +138,7 @@ export class AssemblyCompiler extends BaseCompiler {
 
         const outputFilename = this.getExecutableFilename(dirPath);
 
-        const buildFilters: ParseFilters = Object.assign({}, key.filters);
+        const buildFilters: ParseFiltersAndOutputOptions = Object.assign({}, key.filters);
         buildFilters.binary = true;
         buildFilters.execute = false;
 

diff --git a/lib/compilers/cc65.ts b/lib/compilers/cc65.ts
@@ -28,7 +28,7 @@ import fs from 'fs-extra';
 import _ from 'underscore';
 
 import {CompilationResult} from '../../types/compilation/compilation.interfaces';
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 import {CC65AsmParser} from '../parsers/asm-parser-cc65';
 import * as utils from '../utils';
@@ -98,7 +98,7 @@ export class Cc65Compiler extends BaseCompiler {
         maxSize: number,
         intelAsm,
         demangle,
-        filters: ParseFilters,
+        filters: ParseFiltersAndOutputOptions,
     ) {
         const res = await super.objdump(outputFilename, result, maxSize, intelAsm, demangle, filters);
 

diff --git a/lib/compilers/circt.ts b/lib/compilers/circt.ts
@@ -24,7 +24,7 @@
 
 import path from 'path';
 
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 
 import {BaseParser} from './argument-parsers';
@@ -63,7 +63,7 @@ export class CIRCTCompiler extends BaseCompiler {
         return BaseParser;
     }
 
-    override optionsForFilter(filters: ParseFilters, outputFilename, userOptions?): any[] {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename, userOptions?): any[] {
         return [];
     }
 }
diff --git a/lib/compilers/cppfront.ts b/lib/compilers/cppfront.ts
@@ -24,7 +24,7 @@
 
 import path from 'path';
 
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 import {AsmParserCpp} from '../parsers/asm-parser-cpp';
 
@@ -44,7 +44,7 @@ export class CppFrontCompiler extends BaseCompiler {
         return 'cppp';
     }
 
-    override optionsForFilter(filters: ParseFilters, outputFilename: any) {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename: any) {
         return [];
     }
 

diff --git a/lib/compilers/dotnet.ts b/lib/compilers/dotnet.ts
@@ -37,7 +37,7 @@ import {
 import {CompilationResult, ExecutionOptions} from '../../types/compilation/compilation.interfaces';
 import {BaseCompiler} from '../base-compiler';
 import {DotNetAsmParser} from '../parsers/asm-parser-dotnet';
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 
 class DotNetCompiler extends BaseCompiler {
     private targetFramework: string;
@@ -204,7 +204,7 @@ class DotNetCompiler extends BaseCompiler {
         return compilerResult;
     }
 
-    override optionsForFilter(filters: ParseFilters) {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions) {
         if (filters.binary) {
             this.compileToBinary = true;
         }

diff --git a/lib/compilers/erlang.ts b/lib/compilers/erlang.ts
@@ -24,7 +24,7 @@
 
 import path from 'path';
 
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 
 import {ErlangParser} from './argument-parsers';
@@ -34,7 +34,7 @@ export class ErlangCompiler extends BaseCompiler {
         return 'erlang';
     }
 
-    override optionsForFilter(filters: ParseFilters, outputFilename: string): string[] {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename: string): string[] {
         return [
             '-noshell',
             '-eval',

diff --git a/lib/compilers/hlsl.ts b/lib/compilers/hlsl.ts
@@ -24,7 +24,7 @@
 
 import path from 'path';
 
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 
 export class HLSLCompiler extends BaseCompiler {
@@ -39,7 +39,11 @@ export class HLSLCompiler extends BaseCompiler {
     }
 
     /* eslint-disable no-unused-vars */
-    override optionsForFilter(filters: ParseFilters, outputFilename: string, userOptions?: string[]): string[] {
+    override optionsForFilter(
+        filters: ParseFiltersAndOutputOptions,
+        outputFilename: string,
+        userOptions?: string[],
+    ): string[] {
         return [
             '-Zi', // Embed debug information to get DXIL line associations
             '-Qembed_debug', // Silences the warning associated with embedded debug information

diff --git a/lib/compilers/hook.ts b/lib/compilers/hook.ts
@@ -25,15 +25,15 @@
 import path from 'path';
 
 import {CompilationResult, ExecutionOptions} from '../../types/compilation/compilation.interfaces';
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 
 export class HookCompiler extends BaseCompiler {
     static get key(): string {
         return 'hook';
     }
 
-    override optionsForFilter(filters: ParseFilters): string[] {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions): string[] {
         return ['--dump'];
     }
 

diff --git a/lib/compilers/jakt.ts b/lib/compilers/jakt.ts
@@ -25,7 +25,7 @@
 import path from 'path';
 
 import {ExecutionOptions} from '../../types/compilation/compilation.interfaces';
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 
 export class JaktCompiler extends BaseCompiler {
@@ -43,13 +43,20 @@ export class JaktCompiler extends BaseCompiler {
         return 'cppp';
     }
 
-    override async objdump(outputFilename, result: any, maxSize: number, intelAsm, demangle, filters: ParseFilters) {
+    override async objdump(
+        outputFilename,
+        result: any,
+        maxSize: number,
+        intelAsm,
+        demangle,
+        filters: ParseFiltersAndOutputOptions,
+    ) {
         const objdumpResult = await super.objdump(outputFilename, result, maxSize, intelAsm, demangle, filters);
         objdumpResult.languageId = 'asm';
         return objdumpResult;
     }
 
-    override optionsForFilter(filters: ParseFilters, outputFilename: any) {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename: any) {
         return ['--binary-dir', path.dirname(outputFilename)];
     }
 

diff --git a/lib/compilers/llvm-mos.ts b/lib/compilers/llvm-mos.ts
@@ -28,7 +28,7 @@ import fs from 'fs-extra';
 import _ from 'underscore';
 
 import {CompilationResult} from '../../types/compilation/compilation.interfaces';
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import * as utils from '../utils';
 
 import {ClangCompiler} from './clang';
@@ -62,7 +62,7 @@ export class LLVMMOSCompiler extends ClangCompiler {
         maxSize: number,
         intelAsm,
         demangle,
-        filters: ParseFilters,
+        filters: ParseFiltersAndOutputOptions,
     ) {
         if (!outputFilename.endsWith('.elf') && (await utils.fileExists(outputFilename + '.elf'))) {
             outputFilename = outputFilename + '.elf';

diff --git a/lib/compilers/mlir.ts b/lib/compilers/mlir.ts
@@ -24,7 +24,7 @@
 
 import path from 'path';
 
-import {ParseFilters} from '../../types/features/filters.interfaces';
+import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces';
 import {BaseCompiler} from '../base-compiler';
 
 import {BaseParser} from './argument-parsers';
@@ -67,7 +67,7 @@ export class MLIRCompiler extends BaseCompiler {
         return BaseParser;
     }
 
-    override optionsForFilter(filters: ParseFilters, outputFilename, userOptions?): any[] {
+    override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename, userOptions?): any[] {
         return [];
     }
 }
diff --git a/lib/compilers/nvcc.js b/lib/compilers/nvcc.js
@@ -51,7 +51,7 @@ export class NvccCompiler extends BaseCompiler {
 
     /**
      *
-     * @param {import('../../types/features/filters.interfaces').ParseFilters} filters
+     * @param {import('../../types/features/filters.interfaces').ParseFiltersAndOutputOptions} filters
      * @param {string} outputFilename
      * @param {string[]?} userOptions
      * @returns {string[]}
@@ -107,7 +107,7 @@ export class NvccCompiler extends BaseCompiler {
      *
      * @param {*} result
      * @param {string} outputFilename
-     * @param {import('../../types/features/filters.interfaces').ParseFilters} filters
+     * @param {import('../../types/features/filters.interfaces').ParseFiltersAndOutputOptions} filters
      */
     async postProcess(result, outputFilename, filters) {
         const maxSize = this.env.ceProps('max-asm-size', 64 * 1024 * 1024);