Repository: mattgodbolt/compiler-explorer
Pull request #1753 (2019-12-26 10:08:12)

Add support for Nim language
- Add language
- Add Nim compiler
- support js, c, c++ outputs (objc not tested)
- prevent --run option
- Basic test for nim

Todos:
- monaco profile for Nim
- hints are treated as errors, fix it

Solves https://github.com/mattgodbolt/compiler-explorer/issues/206

<!-- THIS COMMENT IS INVISIBLE IN THE FINAL PR, BUT FEEL FREE TO REMOVE IT
Thanks for taking the time to improve CE. We really appreciate it.
  Before opening the PR, please make sure that the tests & linter pass their checks,
  by running `make check`.
  In the best case scenario, you are also adding tests to back up your changes,
  but don't sweat it if you don't. We can discuss them at a later date.
Feel free to append your name to the CONTRIBUTORS.md file
Thanks again, we really appreciate this!
-->



Patch:
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
index f1a125f05..49ac00777 100644
--- a/CONTRIBUTORS.md
+++ b/CONTRIBUTORS.md
@@ -81,3 +81,4 @@ From oldest to newest contributor, we would like to thank:
 - [Sebastian Rath](https://github.com/seb-mtl)
 - [Haze Booth](https://github.com/haze)
 - [Cassie Jones](https://github.com/porglezomp)
+- [Bastien Penavayre](https://github.com/DaemonSnake)
diff --git a/etc/config/nim.defaults.properties b/etc/config/nim.defaults.properties
new file mode 100644
index 000000000..a6ba56d43
--- /dev/null
+++ b/etc/config/nim.defaults.properties
@@ -0,0 +1,6 @@
+compilers=/usr/bin/nim
+supportsBinary=true
+demangler=c++filt
+objdumper=objdump
+compilerType=nim
+binaryHideFuncRe=^(__.*|_(init|start|fini)|(de)?register_tm_clones|call_gmon_start|frame_dummy|.plt.*|.*@plt|_dl_relocate_static_pie)$
diff --git a/examples/nim/default.nim b/examples/nim/default.nim
new file mode 100644
index 000000000..7f5145c5d
--- /dev/null
+++ b/examples/nim/default.nim
@@ -0,0 +1,3 @@
+# Type your code here, or load an example.
+proc square(num: int): int =
+  num * num
diff --git a/lib/compilers/argument-parsers.js b/lib/compilers/argument-parsers.js
index 383aa2aa7..fe4e242c9 100644
--- a/lib/compilers/argument-parsers.js
+++ b/lib/compilers/argument-parsers.js
@@ -281,6 +281,13 @@ class RustParser extends BaseParser {
     }
 }
 
+class NimParser extends BaseParser {
+
+    static parse(compiler) {
+        return NimParser.getOptions(compiler, "-help").then(() => compiler);
+    }
+}
+
 module.exports = {
     Base: BaseParser,
     Clang: ClangParser,
@@ -289,5 +296,6 @@ module.exports = {
     VC: VCParser,
     Pascal: PascalParser,
     ISPC: ISPCParser,
-    Rust: RustParser
+    Rust: RustParser,
+    Nim: NimParser,
 };
diff --git a/lib/compilers/nim.js b/lib/compilers/nim.js
new file mode 100644
index 000000000..75e6e63c4
--- /dev/null
+++ b/lib/compilers/nim.js
@@ -0,0 +1,125 @@
+// Copyright (c) 2019, Bastien Penavayre
+// 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.
+
+const BaseCompiler = require('../base-compiler'),
+    _ = require('underscore'),
+    path = require('path'),
+    argumentParsers = require("./argument-parsers"),
+    fs = require('fs-extra');
+
+const NimCommands = [
+    "compile", "compileToC", "c",
+    "compileToCpp", "cpp", "cc",
+    "compileToOC", "objc",
+    "js",
+    "check"
+];
+
+class NimCompiler extends BaseCompiler {
+    constructor(info, env) {
+        super(info, env);
+        this.compiler.supportsIntel = true;
+    }
+
+    cacheDir(outputFilename) {
+        return outputFilename + '.cache';
+    }
+
+    optionsForFilter(filters, outputFilename) {
+        return [
+            "-o:" + outputFilename, //output file, only for js mode
+            "--nolinking", //disable linking, only compile to nimcache
+            "--nimcache:" + this.cacheDir(outputFilename) //output folder for the nimcache
+        ];
+    }
+
+    filterUserOptions(userOptions) {
+        //If none of the allowed commands is present in userOptions add 'compile' command
+        if (_.intersection(userOptions, NimCommands).length === 0) {
+            userOptions.unshift("compile");
+        }
+
+        return userOptions.filter(option => !['--run', '-r'].includes(option));
+    }
+
+    expectedExtensionFromCommand(command) {
+        const isC = ["compile", "compileToC", "c"],
+            isCpp = ["compileToCpp", "cpp", "cc"],
+            isObjC = ["compileToOC", "objc"];
+
+        if (isC.includes(command))
+            return '.c.o';
+        else if (isCpp.includes(command))
+            return '.cpp.o';
+        else if (isObjC.includes(command))
+            return '.m.o';
+        else
+            return null;
+    }
+
+    getCacheFile(options, inputFilename, cacheDir) {
+        const commandsInOptions = _.intersection(options, NimCommands);
+        if (!commandsInOptions.length)
+            return null;
+        const command = commandsInOptions[0];
+        const extension = this.expectedExtensionFromCommand(command);
+        if (!extension)
+            return null;
+        const moduleName = path.basename(inputFilename);
+        const resultName = moduleName + extension;
+        return path.join(cacheDir, resultName);
+    }
+
+    postProcess(result, outputFilename, filters) {
+        let options = result.compilationOptions;
+        let setup = Promise.resolve("");
+        const cacheDir = this.cacheDir(outputFilename);
+        const cleanup = () => fs.remove(cacheDir);
+
+        if (_.intersection(options, ["js", "check"]).length)
+            filters.binary = false;
+        else {
+            filters.binary = true;
+            const objFile = this.getCacheFile(options, result.inputFilename, cacheDir);
+            setup = fs.move(objFile, outputFilename);
+        }
+
+        const postProcess = () => super.postProcess(result, outputFilename, filters);
+        return setup.then(postProcess).finally(cleanup);
+    }
+
+    getSharedLibraryPathsAsArguments(/*libraries*/) {
+        return [];
+    }
+
+    getArgumentParser() {
+        return argumentParsers.Nim;
+    }
+
+    isCfgCompiler(/*compilerVersion*/) {
+        return true;
+    }
+}
+
+module.exports = NimCompiler;
diff --git a/lib/languages.js b/lib/languages.js
index 164b5055a..e75be3538 100644
--- a/lib/languages.js
+++ b/lib/languages.js
@@ -175,6 +175,12 @@ const languages = {
         monaco: 'ada',
         extensions: ['.adb', '.ads'],
         alias: []
+    },
+    nim: {
+        name: 'Nim',
+        monaco: 'nim',
+        extensions: ['.nim'],
+        alias: []
     }
 };
 
diff --git a/static/modes/nim-mode.js b/static/modes/nim-mode.js
new file mode 100644
index 000000000..a936e7100
--- /dev/null
+++ b/static/modes/nim-mode.js
@@ -0,0 +1,27 @@
+// Copyright (c) 2019, Matt Godbolt
+// 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.
+"use strict";
+var monaco = require('monaco-editor');
+
+monaco.languages.register({id: 'nim'});
diff --git a/static/panes/editor.js b/static/panes/editor.js
index c913275fc..f102eecd1 100644
--- a/static/panes/editor.js
+++ b/static/panes/editor.js
@@ -47,6 +47,7 @@ require('../modes/fortran-mode');
 require('../modes/zig-mode');
 require('../modes/nc-mode');
 require('../modes/ada-mode');
+require('../modes/nim-mode');
 require('selectize');
 
 var loadSave = new loadSaveLib.LoadSave();


Test patch:
diff --git a/test/nim-tests.js b/test/nim-tests.js
new file mode 100644
index 000000000..036a982bb
--- /dev/null
+++ b/test/nim-tests.js
@@ -0,0 +1,77 @@
+// Copyright (c) 2019, Bastien Penavayre
+// 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.
+
+const chai = require('chai');
+const chaiAsPromised = require("chai-as-promised");
+const NimCompiler = require('../lib/compilers/nim');
+const CompilationEnvironment = require('../lib/compilation-env');
+const properties = require('../lib/properties');
+
+chai.use(chaiAsPromised);
+chai.should();
+
+const languages = {
+    nim: {id: 'nim'}
+};
+
+const compilerProps = new properties.CompilerProps(languages, properties.fakeProps({}));
+
+describe('Nim', () => {
+    const ce = new CompilationEnvironment(compilerProps);
+    const info = {
+        exe: null,
+        remote: true,
+        lang: languages.nim.id
+    };
+
+    it('Nim should not allow --run/-r parameter', () => {
+        const compiler = new NimCompiler(info, ce);
+        compiler.filterUserOptions(["c", "--run", "--something"]).should.deep.equal(["c", "--something"]);
+        compiler.filterUserOptions(["cpp", "-r", "--something"]).should.deep.equal(["cpp", "--something"]);
+    });
+
+    it('Nim compile to Cpp if not asked otherwise', () => {
+        const compiler = new NimCompiler(info, ce);
+        compiler.filterUserOptions([]).should.deep.equal(["compile"]);
+        compiler.filterUserOptions(["badoption"]).should.deep.equal(["compile", "badoption"]);
+        compiler.filterUserOptions(["js"]).should.deep.equal(["js"]);
+    });
+
+    it("test getCacheFile from possible user-options", () => {
+        const compiler = new NimCompiler(info, ce),
+            input = "test.min",
+            folder = "/tmp/",
+            expected = {
+                "cpp": folder + input + ".cpp.o",
+                "c": folder + input + ".c.o",
+                "objc": folder + input + ".m.o",
+            };
+
+        for (const lang of ["cpp", "c", "objc"]) {
+            compiler.getCacheFile([lang], input, folder).should.equal(expected[lang]);
+        }
+        chai.assert.equal(compiler.getCacheFile([], input, folder), null);
+        chai.assert.equal(compiler.getCacheFile(["js"], input, folder), null);
+    });
+});