xref: /dports/audio/supercollider/SuperCollider-3.11.0-Source/lang/LangSource/SC_LanguageConfig.cpp

/*
 *  Copyright 2003 Maurizio Umberto Puxeddu
 *  Copyright 2011 Jakob Leben
 *
 *  This file is part of SuperCollider.
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 *  USA
 *
 */

#include "SC_LanguageConfig.hpp"
#include "SC_Filesystem.hpp" // getDirectory

#include "SCBase.h" // postfl

#include <algorithm> // std::find

#include <boost/filesystem/operations.hpp> // exists (, canonical?)
#include <boost/filesystem/fstream.hpp> // ofstream
#include <yaml-cpp/yaml.h> // YAML

SC_LanguageConfig::Path SC_LanguageConfig::gConfigFile;
bool SC_LanguageConfig::gPostInlineWarnings = false;

SC_LanguageConfig* gLanguageConfig;

static const char* INCLUDE_PATHS = "includePaths";
static const char* EXCLUDE_PATHS = "excludePaths";
static const char* POST_INLINE_WARNINGS = "postInlineWarnings";
static const char* CLASS_LIB_DIR_NAME = "SCClassLibrary";
const char* SCLANG_YAML_CONFIG_FILENAME = "sclang_conf.yaml";

using DirName = SC_Filesystem::DirName;
namespace bfs = boost::filesystem;

SC_LanguageConfig::SC_LanguageConfig(bool optStandalone) {
    if (!optStandalone) {
        const Path& classLibraryDir = SC_Filesystem::instance().getDirectory(DirName::Resource) / CLASS_LIB_DIR_NAME;
        addPath(mDefaultClassLibraryDirectories, classLibraryDir);

        const Path& systemExtensionDir = SC_Filesystem::instance().getDirectory(DirName::SystemExtension);
        addPath(mDefaultClassLibraryDirectories, systemExtensionDir);

        const Path& userExtensionDir = SC_Filesystem::instance().getDirectory(DirName::UserExtension);
        addPath(mDefaultClassLibraryDirectories, userExtensionDir);
    }
}

void SC_LanguageConfig::postExcludedDirectories(void) const {
    for (auto it : mExcludedDirectories) {
        post("\texcluding dir: '%s'\n", it.c_str());
    }
}

bool SC_LanguageConfig::forEachIncludedDirectory(bool (*func)(const Path&)) const {
    for (const auto& it : mDefaultClassLibraryDirectories) {
        if (!pathIsExcluded(it)) {
            if (!func(it))
                return false;
        }
    }

    for (const auto& it : mIncludedDirectories) {
        if (!pathIsExcluded(it)) {
            if (!func(it))
                return false;
        }
    }

    return true;
}

bool SC_LanguageConfig::pathIsExcluded(const Path& path) const { return findPath(mExcludedDirectories, path); }

bool SC_LanguageConfig::addIncludedDirectory(const Path& path) { return addPath(mIncludedDirectories, path); }

bool SC_LanguageConfig::addExcludedDirectory(const Path& path) { return addPath(mExcludedDirectories, path); }

bool SC_LanguageConfig::removeIncludedDirectory(const Path& path) { return removePath(mIncludedDirectories, path); }

bool SC_LanguageConfig::removeExcludedDirectory(const Path& path) { return removePath(mExcludedDirectories, path); }

bool SC_LanguageConfig::readLibraryConfigYAML(const Path& fileName, bool standalone) {
    freeLibraryConfig();
    gLanguageConfig = new SC_LanguageConfig(standalone);

    std::string emptyString;

    using namespace YAML;
    try {
        bfs::ifstream fin(fileName);
        Node doc = Load(fin);
        if (doc) {
            const Node& includePaths = doc[INCLUDE_PATHS];
            if (includePaths && includePaths.IsSequence()) {
                for (auto const& pathNode : includePaths) {
                    const std::string& path = pathNode.as<std::string>(emptyString);
                    if (!path.empty()) {
                        const Path& native_path = SC_Codecvt::utf8_str_to_path(path);
                        gLanguageConfig->addIncludedDirectory(native_path);
                    }
                }
            }

            const Node& excludePaths = doc[EXCLUDE_PATHS];
            if (excludePaths && excludePaths.IsSequence()) {
                for (auto const& pathNode : excludePaths) {
                    const std::string& path = pathNode.as<std::string>(emptyString);
                    if (!path.empty()) {
                        const Path& native_path = SC_Codecvt::utf8_str_to_path(path);
                        gLanguageConfig->addExcludedDirectory(native_path);
                    }
                }
            }

            const Node& inlineWarnings = doc[POST_INLINE_WARNINGS];
            if (inlineWarnings) {
                try {
                    gPostInlineWarnings = inlineWarnings.as<bool>();
                } catch (...) {
                    postfl("WARNING: Cannot parse config file entry \"%s\"\n", POST_INLINE_WARNINGS);
                }
            }
        }
        return true;
    } catch (std::exception& e) {
        postfl("Exception while parsing YAML config file: %s\n", e.what());
        freeLibraryConfig();
        return false;
    }
}

bool SC_LanguageConfig::writeLibraryConfigYAML(const Path& fileName) {
    if (!bfs::exists(fileName.parent_path()))
        return false;

    using namespace YAML;
    Emitter out;
    out.SetIndent(4);
    out.SetMapFormat(Block);
    out.SetSeqFormat(Block);
    out.SetBoolFormat(TrueFalseBool);

    out << BeginMap;

    out << Key << INCLUDE_PATHS;
    out << Value << BeginSeq;
    for (const bfs::path& it : gLanguageConfig->mIncludedDirectories)
        out << SC_Codecvt::path_to_utf8_str(it);
    out << EndSeq;

    out << Key << EXCLUDE_PATHS;
    out << Value << BeginSeq;
    for (const bfs::path& it : gLanguageConfig->mExcludedDirectories)
        out << SC_Codecvt::path_to_utf8_str(it);
    out << EndSeq;

    out << Key << POST_INLINE_WARNINGS;
    out << Value << gPostInlineWarnings;

    out << EndMap;

    bfs::ofstream fout(fileName);
    fout << out.c_str();
    return fout.good();
}

bool SC_LanguageConfig::defaultLibraryConfig(bool standalone) {
    freeLibraryConfig();
    gLanguageConfig = new SC_LanguageConfig(standalone);

    return true;
}

bool SC_LanguageConfig::readLibraryConfig(bool standalone) {
    bool configured = false;

    if (bfs::exists(gConfigFile))
        configured = readLibraryConfigYAML(gConfigFile, standalone);

    if (!configured && !standalone) {
        const Path userYamlConfigFile =
            SC_Filesystem::instance().getDirectory(DirName::UserConfig) / SCLANG_YAML_CONFIG_FILENAME;

        if (bfs::exists(userYamlConfigFile))
            configured = readLibraryConfigYAML(userYamlConfigFile, standalone);

        if (!configured) {
            const Path globalYamlConfigFile = Path("/etc") / SCLANG_YAML_CONFIG_FILENAME;

            if (bfs::exists(globalYamlConfigFile))
                configured = readLibraryConfigYAML(globalYamlConfigFile, standalone);
        }
    }

    if (!configured)
        configured = SC_LanguageConfig::defaultLibraryConfig(standalone);

    return configured;
}

void SC_LanguageConfig::freeLibraryConfig() {
    if (gLanguageConfig) {
        delete gLanguageConfig;
        gLanguageConfig = nullptr;
    }
}

bool SC_LanguageConfig::findPath(const DirVector& vec, const Path& path) {
    return std::find(vec.begin(), vec.end(), path) != vec.end();
}

bool SC_LanguageConfig::addPath(DirVector& vec, const Path& path) {
    if (!findPath(vec, path)) {
        vec.push_back(path);
        return true;
    } else {
        return false;
    }
}

bool SC_LanguageConfig::removePath(DirVector& vec, const Path& path) {
    const DirVector::iterator& end = std::remove(vec.begin(), vec.end(), path);
    const bool removed = end != vec.end();
    vec.erase(end, vec.end());
    return removed;
}