lib/compilers/argument-parsers.js

// Copyright (c) 2017, Jared Wyles
// 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 _ = require('underscore'),
    logger = require('../logger').logger,
    utils = require('../utils');

class BaseParser {
    static getOptions(compiler, helpArg) {
        return compiler.exec(compiler.compiler.exe, [helpArg]).then(result => {
            const options = {};
            if (result.code === 0) {
                const optionFinder = /^\s*(--?[-a-zA-Z0-9]+)\s*(.*)/;
                let previousOption = false;

                utils.eachLine(result.stdout + result.stderr, line => {
                    const match = line.match(optionFinder);
                    if (!match) {
                        if (previousOption && (line.trim().length !== 0)) {
                            options[previousOption].description += "\n" + line.trim();
                        } else {
                            previousOption = false;
                        }
                        return;
                    }

                    previousOption = match[1];
                    options[previousOption] = {
                        description: match[2],
                        timesused: 0
                    };
                });
            }
            compiler.possibleArguments = options;
            return options;
        });
    }

    static parse(compiler) {
        return compiler;
    }
}

class GCCParser extends BaseParser {
    static parse(compiler) {
        return Promise.all([
            GCCParser.getOptions(compiler, "--target-help"),
            GCCParser.getOptions(compiler, "--help=common"),
            GCCParser.getOptions(compiler, "--help=optimizers")
        ]).then(results => {
            const options = _.extend.apply(_.extend, results);
            const keys =  _.keys(options);
            logger.debug("gcc-like compiler options: ", keys.join(" "));
            if (options['-masm']) {
                compiler.compiler.intelAsm = "-masm=intel";
                compiler.compiler.supportsIntel = true;
            }
            if (options['-fdiagnostics-color']) {
                if (compiler.compiler.options) compiler.compiler.options += " ";
                compiler.compiler.options += "-fdiagnostics-color=always";
            }
            // This check is not infallible, but takes care of Rust and Swift being picked up :)
            if (_.find(keys, key => key.startsWith('-fdump-'))) {
                compiler.compiler.supportsGccDump = true;
            }
            return compiler;
        });
    }
}

class ClangParser extends BaseParser {
    static parse(compiler) {
        return ClangParser.getOptions(compiler, "--help").then(options => {
            logger.debug("clang-like compiler options: ", _.keys(options).join(" "));
            if (options['-fsave-optimization-record']) {
                compiler.compiler.optArg = "-fsave-optimization-record";
                compiler.compiler.supportsOptOutput = true;
            }
            if (options['-fcolor-diagnostics']) {
                if (compiler.compiler.options) compiler.compiler.options += " ";
                compiler.compiler.options += "-fcolor-diagnostics";
            }
            return compiler;
        });
    }
}

module.exports = {
    Base: BaseParser,
    Clang: ClangParser,
    GCC: GCCParser
};