Environment.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2022 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file Environment.cc
 *
 * Definition of Environment class.
 *
 * @author Atte Oksman 2003 (oksman-no.spam-cs.tut.fi)
 * @author Viljami Korhonen 2007 (viljami.korhonen-no.spam-tut.fi)
 * @author Pekka Jääskeläinen 2007-2020
 *
 * @note reviewed 19 May 2004 by ao, jn, ml, am
 * @note rating: red
 */
 
#include <vector>
#include <string>
 
#include "Environment.hh"
#include "tce_config.h"
#include "FileSystem.hh"
#include "StringTools.hh"
#include "VectorTools.hh"
#include "MapTools.hh"
#include "TCEString.hh"
#include "Application.hh"
 
using std::vector;
using std::string;
 
// initializing the static class member variables
const string Environment::SCHEMA_DIR_NAME_ = "data";
const string Environment::DATA_DIR_NAME_ = "data";
const string Environment::BITMAPS_DIR_NAME_ = "bitmaps";
const string Environment::MAN_DIR_NAME_ = "man";
const string Environment::CONF_DIR_NAME_ = "conf";
const string Environment::ICON_DIR_NAME_ = "icons";
const string Environment::ERROR_LOG_FILE_NAME_ = "error_log.log";
bool Environment::initialized_ = false;
bool Environment::developerMode_ = false;
vector<string> Environment::schemaPaths_;
vector<string> Environment::dataPaths_;
vector<string> Environment::bitmapsPaths_;
vector<string> Environment::manPaths_;
vector<string> Environment::iconPaths_;
vector<string> Environment::errorPaths_;
vector<string> Environment::pathsToUse_;
string Environment::newSchemaFileDir_ = "";
string Environment::newDataFileDir_ = "";
string Environment::newBitmapsFileDir_ = "";
string Environment::newIconFileDir_ = "";
string Environment::newManFileDir_ = "";
string Environment::newConfFile_ = "";
string Environment::newErrorLogFileDir_ = "";
string Environment::simTraceDir_ = "";
 
const string Environment::PDF_MANUAL_INSTALLED = "manual/OpenASIP_manual.pdf";
const string Environment::PDF_MANUAL_SRC = "manual/OpenASIP_manual.pdf";
 
const string Environment::MINIMAL_ADF_INSTALLED = "data/mach/minimal.adf";
const string Environment::MINIMAL_ADF_SRC = "data/mach/minimal.adf";
 
// macro definitions (maybe relocated later to config.h)
#define INSTALLATION_DIR "/share/openasip/"
#define DS TCEString(FileSystem::DIRECTORY_SEPARATOR)
 
 
/**
 * Initializes the program environment.
 *
 * Initializes all of the source directories the program needs.
 */
void
Environment::initialize() {
 
    if (initialized_) {
        return;
    }
 
    developerMode_ =
        Environment::environmentVariable("TCE_DEVEL_MODE") == "1";
 
    errorPaths_.push_back(
        FileSystem::homeDirectory() +
        FileSystem::DIRECTORY_SEPARATOR + string(".openasip"));
 
    if (developerMode_) {
        schemaPaths_.push_back(string(TCE_SRC_ROOT));
        iconPaths_.push_back(string(TCE_SRC_ROOT));
        dataPaths_.push_back(string(TCE_SRC_ROOT));
        bitmapsPaths_.push_back(string(TCE_SRC_ROOT));
        manPaths_.push_back(
            string(TCE_SRC_ROOT) +
            FileSystem::DIRECTORY_SEPARATOR + string("doc"));
    } else {
        string instDir =
            Application::installationDir() + string(INSTALLATION_DIR);
        schemaPaths_.push_back(instDir);
        iconPaths_.push_back(instDir);
        dataPaths_.push_back(instDir);
        bitmapsPaths_.push_back(instDir);
        manPaths_.push_back(instDir);
    }
 
    string traceEnv = environmentVariable("TTASIM_TRACE_DIR");
    if (traceEnv != "") {
        if (!FileSystem::fileExists(traceEnv)) {
            if (!FileSystem::createDirectory(traceEnv)) {
                traceEnv = "";
            }
        }
    }
    simTraceDir_ = traceEnv;
 
    initialized_ = true;
}
 
 
/**
 * Tries to locate the directory where the XML Schema file is stored.
 *
 * Returns the first absolute path of the directory where the file is found.
 * If directory for new data file is given, it is created and returned.
 * If the directory can not be created, an empty string is returned.
 *
 * @param prog The program whose Schema is searched.
 * @return The path of the Schema directory.
 */
string
Environment::schemaDirPath(const std::string& prog) {
    initialize();
    string path = SCHEMA_DIR_NAME_ + FileSystem::DIRECTORY_SEPARATOR + prog;
    pathsToUse_.assign(schemaPaths_.begin(), schemaPaths_.end());
    string schemaPath = pathTo(path);
    if (schemaPath == "" && newSchemaFileDir_ != "") {
        if (FileSystem::createDirectory(newSchemaFileDir_)) {
            return newSchemaFileDir_;
        }
    }
    return schemaPath;
}
 
 
/**
 * Tries to locate the directory where the application data is stored.
 *
 * Returns the first absolute path of the directory where the data is found.
 * If directory is not found and directory for new data file is given, it
 * is created. If creation fails, an empty string is returned.
 *
 * @param prog The program whose data directory is searched.
 * @return The path of data directory or an empty string.
 */
string
Environment::dataDirPath(const std::string& prog) {
    initialize();
    string path = DATA_DIR_NAME_ + FileSystem::DIRECTORY_SEPARATOR + prog;
    pathsToUse_.assign(dataPaths_.begin(), dataPaths_.end());
    string dataPath = pathTo(path);
    if (dataPath == "" && newDataFileDir_ != "") {
        if (FileSystem::createDirectory(newDataFileDir_)) {
            return newDataFileDir_;
        }
    }
    return dataPath;
}
 
 
/**
 * Tries to locate the directory where the application bitmaps are stored.
 *
 * Returns the first absolute path of the directory where the file is found.
 * If bitmaps directory is not found and a new directory is given, it is
 * created. If creation fails, an empty string is returned.
 *
 * @param prog The program whose bitmaps directory are searched.
 * @return The path of the bitmaps directory.
 */
string
Environment::bitmapsDirPath(const std::string& prog) {
    initialize();
    string path = DATA_DIR_NAME_ + FileSystem::DIRECTORY_SEPARATOR +
        BITMAPS_DIR_NAME_ + FileSystem::DIRECTORY_SEPARATOR + prog;
    pathsToUse_.assign(bitmapsPaths_.begin(), bitmapsPaths_.end());
    string bitmapsPath = pathTo(path);
    if (bitmapsPath == "" && newBitmapsFileDir_ != "") {
        if (FileSystem::createDirectory(newBitmapsFileDir_)) {
            return newBitmapsFileDir_;
        }
    }
    return bitmapsPath;
}
 
/**
 * Tries to locate the directory where common toolbar icon files are stored.
 *
 * Returns the first absolute path of the directory where the file is found.
 * If icons directory is not found and a new directory is given, it is
 * created. If creation fails, an empty string is returned.
 *
 * @return The path of the icons directory.
 */
string
Environment::iconDirPath() {
    initialize();
    string path = DATA_DIR_NAME_ + FileSystem::DIRECTORY_SEPARATOR +
        ICON_DIR_NAME_;
    pathsToUse_.assign(bitmapsPaths_.begin(), bitmapsPaths_.end());
    string iconPath = pathTo(path);
    if (iconPath == "" && newIconFileDir_ != "") {
        if (FileSystem::createDirectory(newIconFileDir_)) {
            return newIconFileDir_;
        }
    }
    return iconPath;
}
 
/**
 * Tries to locate the directory where the system's manual is stored.
 *
 * Returns the first absolute path of the directory where the file is found.
 * If no directory is found and a new directory for manual is given, it is
 * created. If creation fails, an empty string is returned.
 *
 * @param prog The program whose manual directory is searched.
 * @return The path of the manual directory.
 */
string
Environment::manDirPath(const std::string& prog) {
    initialize();
    string path = MAN_DIR_NAME_ + FileSystem::DIRECTORY_SEPARATOR + prog;
    pathsToUse_.assign(manPaths_.begin(), manPaths_.end());
    string manPath = pathTo(path);
    if (manPath == "" && newManFileDir_ != "") {
        if (FileSystem::createDirectory(newManFileDir_)) {
            return newManFileDir_;
        }
    }
    return manPath;
}
 
 
/**
 * Tries to locate the application's configuration file for
 * reading.
 *
 * First tries to find one in the user's homedir, if not found,
 * uses the installed one (with defaults). Note: when writing
 * (overriding) configuration files, one should call userConfDirPath()
 * instead!
 *
 * @param fileName The name of the configuration file.
 * @return The path of the configuration file.
 */
TCEString
Environment::confPath(const std::string& fileName) {
    initialize();
 
    TCEString userConf =
        FileSystem::homeDirectory() + DS + ".openasip" + DS + fileName;
    TCEString srcDirConf =
        TCEString(TCE_SRC_ROOT) + DS + CONF_DIR_NAME_ + DS + fileName;
 
    TCEString installedConf =
        Application::installationDir() + TCEString(INSTALLATION_DIR) +
        DS + CONF_DIR_NAME_ + DS + fileName;
    if (FileSystem::fileExists(userConf)) {
        return userConf;
    }
 
    if (Environment::developerMode() && FileSystem::fileExists(srcDirConf)) {
        return srcDirConf;
    } else if (FileSystem::fileExists(installedConf)) {
        return installedConf;
    }
 
    FileSystem::createFile(userConf);
    return userConf;
}
 
TCEString
Environment::userConfPath(const std::string& fileName) {
    TCEString userConf =
        FileSystem::homeDirectory() + DS + ".openasip" + DS + fileName;
    if (!FileSystem::fileExists(userConf)) {
        FileSystem::createFile(userConf);
    }
    return userConf;
}
 
/**
 * Tries to locate the error log file on system.
 *
 * Returns the first absolute path where the file is found. If the file is
 * not found and directory for the error log file is given, the directory
 * and the error log file is created. If creation fails, an empty string is
 * returned.
 *
 * @return The path of the error log file.
 */
string
Environment::errorLogFilePath() {
    initialize();
    pathsToUse_.assign(errorPaths_.begin(), errorPaths_.end());
    string errorPath = pathTo(ERROR_LOG_FILE_NAME_);
    if (errorPath == "" && newErrorLogFileDir_ != "") {
        if (FileSystem::createDirectory(newErrorLogFileDir_)) {
            string filePath = newErrorLogFileDir_ +
                FileSystem::DIRECTORY_SEPARATOR + ERROR_LOG_FILE_NAME_;
            if (FileSystem::createFile(filePath)) {
                return filePath;
            }
        }
    }
    return errorPath;
}
 
/**
 * Returns path where installable tce include headers reside.
 *
 * The list returned contains both post-installation paths and the paths to
 * the original header files found in the source tree.
 *
 * @return Paths where tce installable headers files reside.
 */
std::vector<std::string>
Environment::includeDirPaths() {
    vector<string> includes;
    const std::string ROOT = string(TCE_SRC_ROOT);
    const std::string BASE = ROOT + DS + "src" + DS + "base";
    const std::string APPLIBS = ROOT + DS + "src" + DS + "applibs";
    const std::string BLD = string(TCE_BLD_ROOT);
 
    if (Environment::developerMode()) {
        includes.push_back(ROOT);
        includes.push_back(ROOT + DS + "src" + DS + "tools");
        includes.push_back(BASE + DS + "osal");
        includes.push_back(BASE + DS + "memory");
        includes.push_back(BASE + DS + "bem");
        includes.push_back(BASE + DS + "Graph");
        includes.push_back(BASE + DS + "idf");
        includes.push_back(BASE + DS + "mach");
        includes.push_back(BASE + DS + "program");
        includes.push_back(BASE + DS + "tpef");
        includes.push_back(BASE + DS + "umach");
        includes.push_back(APPLIBS + DS + "Simulator");
        includes.push_back(APPLIBS + DS + "mach");
        includes.push_back(APPLIBS + DS + "FSA");
        includes.push_back(TCE_BLD_ROOT);
    } else {
        includes.push_back(Application::installationDir() + DS + "include");
    }
 
    return includes;
}
 
/**
 * Returns the include dir needed to build base opset in compiling the
 * distributed version of TCE
 *
 */
vector<string>
Environment::opsetIncludeDir() {
    string BASE = TCE_SRC_ROOT + DS + "src" + DS + "base";
    
    vector<string> includePaths;   
    includePaths.push_back(BASE + DS + "osal ");
    includePaths.push_back(BASE + DS + "tpef ");
    includePaths.push_back(BASE + DS + "memory ");
    includePaths.push_back(TCE_SRC_ROOT + DS + "src" + DS +  "tools");
    includePaths.push_back(TCE_SRC_ROOT);
 
    return includePaths;
}
 
/**
 * Returns the value of the given environment variable.
 *
 * An empty string is returned if the variable does not exist.
 *
 * @param variable The environment variable whose value is required.
 * @return The value of the environment variable.
 */
string
Environment::environmentVariable(const std::string& variable) {
 
    char* varValue = getenv(variable.c_str());
    if (varValue == NULL) {
        return "";
    }
 
    return varValue;
}
 
 
/**
 * Constructor.
 */
Environment::Environment() {
}
 
 
/**
 * Destructor.
 */
Environment::~Environment() {
}
 
 
/**
 * Tries to locate the given directory or file on system.
 *
 * Returns the first absolute path of the directory if the directory/file
 * is found. In case the directory/file is not found in any of the search
 * paths, returns an empty string.
 *
 * @fixme this is not thread safe due to the use of pathsToUse_ member
 *        variable for data passing!
 * @param name The name of the searched directory/file.
 * @return The path of the directory/file.
 */
string
Environment::pathTo(const std::string& name) {
 
    // test the stored paths and try to open the file
    for (unsigned int i = 0; i < pathsToUse_.size(); ++i) {
        string path =
            pathsToUse_[i] + FileSystem::DIRECTORY_SEPARATOR + name;
 
        if (FileSystem::fileExists(path)) {
            return path;
        }
    }
 
    return "";
}
 
/**
 * Sets the value for new schema file directory.
 *
 * @param path The path of new schema file directory.
 */
void
Environment::setNewSchemaFileDir(const std::string& path) {
    newSchemaFileDir_ = path;
}
 
/**
 * Sets the value for new data file directory
 *
 * @param path The path of new data file directory.
 */
void
Environment::setNewDataFileDir(const std::string& path) {
    newDataFileDir_ = path;
}
 
/**
 * Sets the value for new bitmaps file directory.
 *
 * @param path The path for new bitmaps directory.
 */
void
Environment::setNewBitmapsFileDir(const std::string& path) {
    newBitmapsFileDir_ = path;
}
 
/**
 * Sets the path for new manual file directory.
 *
 * @param path The path of new manual file directory.
 */
void
Environment::setNewManFileDir(const std::string& path) {
    newManFileDir_ = path;
}
 
/**
 * Sets the path for new error log file directory.
 *
 * @param path The path of new error log file directory.
 */
void
Environment::setNewErrorLogFileDir(const std::string& path) {
    newErrorLogFileDir_ = path;
}
 
/**
 * Returns the paths in which operation set files are searched.
 *
 * The paths are returned in the order of preference. The user
 * can override global operation definitions by redefining them in
 * a local search path.
 *
 * @return The paths in which operations are searched.
 */
vector<string>
Environment::osalPaths() {
 
    vector<string> paths;
 
    // ./data
    string data = FileSystem::currentWorkingDir() + DS + "data";
 
    // tce/opset/base -- these are needed during newlib build,
    // specifically STDOUT is needed to build puts() correctly.
    string src = string(TCE_BLD_ROOT) + DS + "opset" + DS + "base";
 
    // default path for predefined and "standard" operations
    string basePath =
        Application::installationDir() + string(INSTALLATION_DIR) + "opset" +
        DS + "base";
    // path for user-local custom operations
    string userPath =
        FileSystem::homeDirectory() + DS + ".openasip" + DS + "opset" +
        DS + "custom";
    // path for system-wide, shared custom operations
    string customPath =
        Application::installationDir() + string(INSTALLATION_DIR) + "opset" +
        DS + "custom";
    // search path taken from environment
    string envPath = Environment::environmentVariable("TCE_OSAL_PATH");
    envPath = FileSystem::absolutePathOf(envPath);
    // as a last resort fall-back, operations are always searched in
    // in current working directory
    string cwd = FileSystem::currentWorkingDir();
 
    if (envPath != "")
        VectorTools::insertUnique(paths, envPath);
    VectorTools::insertUnique(paths, cwd);
    VectorTools::insertUnique(paths, data);
    if (Environment::developerMode()) {
        VectorTools::insertUnique(paths, src);
    } else {
        VectorTools::insertUnique(paths, userPath);
        VectorTools::insertUnique(paths, customPath);
        VectorTools::insertUnique(paths, basePath);
    }
 
    return paths;
}
 
/**
 * Returns the paths in which code compressor plugins are searched.
 *
 * @param libraryPathsOnly When set to true, excludes CWD from search paths.
 * @return The paths in which code compressor plugins are searched.
 */
vector<string>
Environment::codeCompressorPaths(bool libraryPathsOnly) {
 
    vector<string> paths;
 
    if (Environment::developerMode()) {
        string path = string(TCE_SRC_ROOT) + DS + "compressors";
        paths.push_back(path);
    } else {
        string base = Application::installationDir() + string(INSTALLATION_DIR) +
            "codecompressors" + DS + "base";
        string custom = Application::installationDir() + string(INSTALLATION_DIR)+
            "codecompressors" + DS + "custom";
        string personal = FileSystem::homeDirectory() + DS + ".openasip" + DS +
            "codecompressors" + DS + "custom";
 
        paths.push_back(base);
        paths.push_back(personal);
        paths.push_back(custom);
    }
    string cwd = FileSystem::currentWorkingDir();
    if (!libraryPathsOnly) paths.push_back(cwd);
    return paths;
}
 
/**
 * Returns the paths in which scheduler plugins are searched.
 *
 * @return The paths in which scheduler plugins are searched.
 */
vector<string>
Environment::schedulerPluginPaths() {
 
    vector<string> paths;
 
    string base = Application::installationDir() + string(INSTALLATION_DIR) +
        "scheduler" + DS + "passes";
 
    string personal = FileSystem::homeDirectory() + DS + ".openasip" + DS +
        "scheduler" + DS + "passes";
 
    string srcBase = string(TCE_SRC_ROOT) + DS + "scheduler" + DS + "passes";
 
    string cwd = FileSystem::currentWorkingDir();
 
    if (Environment::developerMode()) {
        // first find from the src tree to make the system tests etc.
        // to test the plugins in source base, not the installed plugins
        paths.push_back(srcBase);
    } else {
        paths.push_back(base);
        paths.push_back(personal);
    }
    paths.push_back(cwd);
 
    return paths;
}
 
/**
 * Returns the paths in which IC/decoder plugins are searched.
 *
 * @param libraryPathsOnly Set to true excludes CWD from search paths.
 * @return The paths in which IC/decoder plugins are searched.
 */
vector<string>
Environment::icDecoderPluginPaths(bool libraryPathsOnly) {
 
    vector<string> paths;
 
    string base = Application::installationDir() + string(INSTALLATION_DIR) +
        "icdecoder_plugins" + DS + "base";
    string custom = Application::installationDir() + string(INSTALLATION_DIR)+
        "icdecoder_plugins" + DS + "custom";
    string personal = FileSystem::homeDirectory() + DS + ".openasip" + DS + 
        "icdecoder_plugins";
    string cwd = FileSystem::currentWorkingDir();
    string data = cwd + DS + "data";
    if (Environment::developerMode()) {
        // first find from the src tree to make the system tests etc.
        // to test the plugins in source base, not the installed plugins
        string path = string(TCE_SRC_ROOT) + DS + "icdecoder_plugins";
        paths.push_back(path);
    } else {
        paths.push_back(base);
        paths.push_back(personal);
        paths.push_back(custom);
    }
    if (!libraryPathsOnly) paths.push_back(cwd);
    if (!libraryPathsOnly) paths.push_back(data);
    return paths;
}
 
 
/**
 * Returns the paths in which hardware modules are searched.
 *
 * @return The paths in which hardware modules are searched.
 */
std::vector<std::string>
Environment::hwModulePaths() {
    vector<string> paths;
    paths.push_back(FileSystem::currentWorkingDir());
    return paths;
}
 
 
/**
 * Returns the paths in which hardware databases are searched.
 *
 * @param libraryPathsOnly When set to true, excludes CWD from search paths.
 * @return The paths in which hardware databases are searched.
 */
std::vector<std::string>
Environment::hdbPaths(bool libraryPathsOnly) {
 
    vector<string> paths;
    if (Environment::developerMode()) {
        string srcBase = string(TCE_SRC_ROOT) + DS + "hdb";
        paths.push_back(srcBase);
    } else {
        string instBase = Application::installationDir() +
            string(INSTALLATION_DIR) + "hdb";
        paths.push_back(instBase);
    }
    if (!libraryPathsOnly) {
        string cwd = FileSystem::currentWorkingDir();
        paths.push_back(cwd);
        paths.push_back(cwd + DS + "data");
    }
    return paths;
}
 
/**
 * Shortens the given HDB path by replacing source tree, install directory or
 * current working directory paths with human-readable aliases.
 */
TCEString
Environment::shortHDBPath(const TCEString& hdbPath) {
    string sourceRoot = string(TCE_SRC_ROOT) + DS;
    string installRoot = Application::installationDir() + DS;
    string cwd = FileSystem::currentWorkingDir() + DS;
 
    TCEString shortPath = hdbPath;
    if (hdbPath.startsWith(sourceRoot)) {
        int rootPathLength = sourceRoot.length();
        shortPath = "<source tree>" + DS + hdbPath.substr(rootPathLength);
    } else if (hdbPath.startsWith(installRoot)) {
        int installDirLength = installRoot.length();
        shortPath = "<install directory>" + DS +
                    hdbPath.substr(installDirLength);
    } else if (hdbPath.startsWith(cwd)) {
        int cwdLength = cwd.length();
        shortPath = "." + DS + hdbPath.substr(cwdLength);
    }
    return shortPath;
}
 
/**
 * Undoes the shortening done by shortHDBPath
 */
TCEString
Environment::longHDBPath(const TCEString& hdbPath) {
    string sourceRoot = string("<source tree>") + DS;
    string installRoot = string("<install directory>") + DS;
    string cwd = string(".") + DS;
 
    TCEString longPath = hdbPath;
    if (hdbPath.startsWith(sourceRoot)) {
        int rootPathLength = sourceRoot.length();
        longPath = string(TCE_SRC_ROOT) + DS + hdbPath.substr(rootPathLength);
    } else if (hdbPath.startsWith(installRoot)) {
        int installDirLength = installRoot.length();
        longPath = Application::installationDir() + DS +
                    hdbPath.substr(installDirLength);
    } else if (hdbPath.startsWith(cwd)) {
        int cwdLength = cwd.length();
        longPath = FileSystem::currentWorkingDir() + DS +
                    hdbPath.substr(cwdLength);
    }
    return longPath;
}
 
/**
 * Returns the paths in which VHDL files are searched for.
 *
 * @param hdbPath The path where the HDB file is, to be added to the
 * search paths.
 * @return The paths in which VHDL files are searched for.
 */
std::vector<std::string>
Environment::vhdlPaths(const std::string& hdbPath) {
 
    vector<string> paths;
 
    // Drop the name of hdb file from hdb path
    string hdbDir = FileSystem::directoryOfPath(hdbPath);
    paths.push_back(hdbDir);
    paths.push_back(hdbDir + DS + "vhdl");
 
    if (Environment::developerMode()) {
        string srcBase = string(TCE_SRC_ROOT) + DS + "hdb";
        paths.push_back(srcBase);
        paths.push_back(srcBase + DS + "vhdl");
    } else {
        string srcBase = Application::installationDir() +
            string(INSTALLATION_DIR) + "hdb";
        paths.push_back(srcBase);
        paths.push_back(srcBase + DS + "vhdl");
    }
    string cwd = FileSystem::currentWorkingDir();
    paths.push_back(cwd);
    paths.push_back(cwd + DS + "data");
    return paths;
}
 
 
/**
 * Returns the paths in which decompressor module definitions are searhed.
 *
 * @param libraryPathsOnly When set to true, excludes CWD from search paths.
 * @return The paths in which decompressor module definitions are searched.
 */
std::vector<std::string>
Environment::decompressorPaths(bool libraryPathsOnly) {
    vector<string> paths;
    if (!libraryPathsOnly) {
        paths.push_back(FileSystem::currentWorkingDir());
        paths.push_back(FileSystem::currentWorkingDir() + DS + "data");
    }
    return paths;
}
 
 
/**
 * Returns the paths in which explorer plugins are searched.
 *
 * @return The paths in which explorer plugins are searched.
 */
vector<string>
Environment::explorerPluginPaths() {
 
    vector<string> paths;
 
    if (Environment::developerMode()) {
        string srcBase = string(TCE_SRC_ROOT) + DS + "explorer";
        paths.push_back(srcBase);
    } else {
        string base = Application::installationDir() + string(INSTALLATION_DIR) +
            "explorer" + DS + "base";
        paths.push_back(base);
 
        string personal = FileSystem::homeDirectory() + DS + ".openasip" + DS +
            "explorer";
        paths.push_back(personal);
    }
 
    string cwd = FileSystem::currentWorkingDir();
    paths.push_back(cwd);
 
    string data = FileSystem::currentWorkingDir() + DS + "data";
    paths.push_back(data);
 
    return paths;
}
 
 
/**
 * Returns the paths in which estimator plugins are searched.
 *
 * @return The paths in which estimator plugins are searched.
 */
vector<string>
Environment::estimatorPluginPaths() {
 
    vector<string> paths;
    string base = Application::installationDir() + string(INSTALLATION_DIR) +
        "cost_estimator_plugins";
    string baseRF = Application::installationDir() + string(INSTALLATION_DIR) +
        "cost_estimator_plugins/rf";
    string baseFU = Application::installationDir() + string(INSTALLATION_DIR) +
        "cost_estimator_plugins/fu";
    string personal = FileSystem::homeDirectory() + DS + ".openasip" + DS +
        "cost_estimator_plugins";
    string custom = string(TCE_SRC_ROOT) + DS + "cost_estimator_plugins";
    string cwd = FileSystem::currentWorkingDir();
    string data = FileSystem::currentWorkingDir() + DS + "data";
 
    if (Environment::developerMode()) {
        paths.push_back(custom);
    } else {
        paths.push_back(base);
        paths.push_back(baseRF);
        paths.push_back(baseFU);
    }
    paths.push_back(personal);
    paths.push_back(cwd);
    paths.push_back(data);
    return paths;
}
 
 
/**
 * Returns full path to the TCE .pdf manual.
 *
 * @return Full path to the TCE manual pdf.
 */
string
Environment::pdfManual() {
 
    if (Environment::developerMode()) {
        std::string srcPath =
            string(TCE_SRC_ROOT) + FileSystem::DIRECTORY_SEPARATOR +
            PDF_MANUAL_SRC;
        assert(
            FileSystem::fileExists(srcPath) &&
            "Installation broken, minimal.adf not found");
        return srcPath;
    } else {
        std::string path = Application::installationDir() +
            string(INSTALLATION_DIR) + PDF_MANUAL_INSTALLED;
 
        if (!FileSystem::fileExists(path))
            debugLog("Installation broken, manual not found");
        return path;
    }
}
 
/**
 * Returns the full path to the minimal.adf.
 */
string
Environment::minimalADF() {
 
    if (Environment::developerMode()) {
        std::string srcPath =
            string(TCE_SRC_ROOT) + FileSystem::DIRECTORY_SEPARATOR +
            MINIMAL_ADF_SRC;
 
        assert(
            FileSystem::fileExists(srcPath) &&
            "Installation broken, minimal.adf not found");
        return srcPath;
    } else {
        std::string path = Application::installationDir() +
            string(INSTALLATION_DIR) + MINIMAL_ADF_INSTALLED;
 
        assert(
            FileSystem::fileExists(path) &&
            "Installation broken, minimal.adf not found");
        return path;
    }
}
 
 
/**
 * @return Full path to the tce compiler tcecc.
 */
string
Environment::tceCompiler() {
 
    if (Environment::developerMode()) {
        std::string srcPath =
            string(TCE_SRC_ROOT) + "/src/bintools/Compiler/oacc";
 
        std::string llvmTceSrcPath =
            string(TCE_SRC_ROOT) + "/src/bintools/Compiler/llvm-tce/llvm-tce";
 
        assert(FileSystem::fileExists(srcPath) &&
               FileSystem::fileExists(llvmTceSrcPath) &&
               "Build broken, compiler paths not found.");
        return srcPath;
    } else {
        std::string path = Application::installationDir() + "/bin/oacc";
        assert(
            FileSystem::fileExists(path) &&
            "Installation broken: oacc not found.");
        return path;
    }
}
 
 
/**
 * Returns full path to the default scheduler pass configuration file.
 *
 * @return Full path to the default_scheduler.conf
 */
string
Environment::defaultSchedulerConf() {
 
    if (Environment::developerMode()) {
        std::string srcPath =
            string(TCE_SRC_ROOT) + "/scheduler/passes/default_scheduler.conf";
        assert(
            FileSystem::fileExists(srcPath) &&
            "Build broken, default_scheduler.conf not found.");
        return srcPath;
    } else {
        std::string path = Application::installationDir() +
            string(INSTALLATION_DIR) + "/scheduler/passes/default_scheduler.conf";
        assert(
            FileSystem::fileExists(path) &&
            "Installation broken, default_scheduler.conf not found.");
        return path;
    }
}
 
 
/**
 * Returns full path to the old gcc scheduler pass configuration file.
 *
 * This is the scheduler conf that is used to schedule code from the
 * old gcc compiler.
 *
 * @return Full path to the old_gcc.conf
 */
string
Environment::oldGccSchedulerConf() {
 
    if (Environment::developerMode()) {
        // first find from the src tree
        std::string srcPath =
            string(TCE_SRC_ROOT) + "/scheduler/passes/old_gcc.conf";
        assert(
            FileSystem::fileExists(srcPath) &&
            "Build broken, old_gcc.conf not found.");
        return srcPath;
    } else {
        std::string path = Application::installationDir() +
            string(INSTALLATION_DIR) + "/scheduler/passes/old_gcc.conf";
        assert(
            FileSystem::fileExists(path) &&
            "Installation broken, old_gcc.conf not found.");
        return path;
    }
}
 
/**
 * Returns full path to the default IC/Decoder plugin file.
 *
 * @return Full path to the defaultICDecoderPlugin.so
 */
string
Environment::defaultICDecoderPlugin() {
 
    try {
        std::string file = "DefaultICDecoderPlugin.so";
        vector<std::string> paths = icDecoderPluginPaths();
        std::string path = FileSystem::findFileInSearchPaths(paths, file);
 
        return path;
    } catch(FileNotFound const& e) {
        abortWithError(
            "Installation broken, DefaultICDecoderPlugin.so not found.");
        return ""; // just to remove a warning
    }
}
 
/**
 * Returns default GUI text editor to be used, atm. for osed
 *
 * @return Full path of default text editor, first from VISUAL and, failing
 *         that, from a list of popular GUI editors
 */
string
Environment::defaultTextEditorPath() {
 
    std::string editor = environmentVariable("VISUAL");
 
    if (editor.empty()) {
        // If env variable is empty, check a list of known GUI editors
        vector<std::string> editors;
        editors.push_back("gedit");    // Gnome
        editors.push_back("leafpad");  // LXDE
        editors.push_back("mousepad"); // XFCE (old)
        editors.push_back("kate");     // KDE
 
        // returns empty string if none found
        return findExecutableFromPATH(editors);
    }
 
    // test if env variable contained full path to text editor executable
    if (FileSystem::fileIsExecutable(editor)) {
        return editor;
    }
 
    // EDITOR and VISUAL doesn't have to contain full path
    // so let's search PATH enviroment variable to get the full path
    std::string testEditor = "";
    vector<std::string> paths;
    parsePathEnvVariable(paths);
    for (unsigned int i = 0; i < paths.size(); ++i) {
        testEditor = paths.at(i) + DS + editor;
        if (FileSystem::fileIsExecutable(testEditor)) {
            return testEditor;
        }
    }
 
    // no editor were found
    return "";
}
 
/**
 * Returns Paths in PATH environment variable.
 *
 * @return Paths in PATH environment variable.
 */
inline void
Environment::parsePathEnvVariable(std::vector<std::string>& paths) {
 
    std::string pathsEnv = environmentVariable("PATH");
    StringTools::chopString(pathsEnv, ":", paths);
}
 
/**
 * Returns full path to the default LLVM backend plugin cache directory.
 */
string
Environment::llvmtceCachePath() {
 
    std::string path =
        FileSystem::homeDirectory() +
        FileSystem::DIRECTORY_SEPARATOR + string(".openasip") +
        FileSystem::DIRECTORY_SEPARATOR + string("tcecc") +
        FileSystem::DIRECTORY_SEPARATOR + string("cache");
 
    return path;
}
 
/**
 * Finds a first match of a given list of files from PATH env variable.
 *
 * Finds a first executable match of a given list of files from paths in the
 * PATH environment variable.
 *
 * @param execs A list of file names, that are to be searched from PATH.
 * @return Full path of the executable found or a zero length string, in case
 *         nothing was found.
 */
std::string 
Environment::findExecutableFromPATH(const std::vector<std::string>& execs) {
    vector<std::string> paths;
    parsePathEnvVariable(paths);
    for (unsigned int i = 0; i < paths.size(); ++i) {
        for (unsigned int j = 0; j < execs.size(); ++j) {
            std::string exec = paths.at(i) + DS + execs.at(j);
            if (FileSystem::fileIsExecutable(exec)) {
                return exec;
            }
        }
    }
    return "";
}
 
/**
 * Returns full paths to implementation tester vhdl testbench template 
 * directory
 *
 * @return Paths to testbench templates
 */
std::vector<std::string> Environment::implementationTesterTemplatePaths() {
    std::vector<std::string> paths;
    if (Environment::developerMode()) {
        string path = string(TCE_SRC_ROOT) + DS + "data" + DS + "hdb";
        paths.push_back(path);
    }
    string path = Application::installationDir() + string(INSTALLATION_DIR) +
        "data" + DS + "hdb";
    paths.push_back(path);
    return paths;
}
 
/**
 * Returns full path to ttasim trace dir if set using TTASIM_TRACE_DIR
 * environment variable
 *
 * Return full path to ttasim trace dir location if environment variable
 * TTASIM_TRACE_DIR is pointing to valid dir. Empty string otherwise.
 */
string
Environment::simTraceDirPath() {
    initialize();
    return simTraceDir_;
}
 
/**
 * Returns true in case TCE is running in developer mode.
 *
 * The developer mode can be enabled by setting environment variable
 * TCE_DEVEL_MODE to 1 and causes the following differences at TCE
 * runtime:
 *
 * - build directories are used as various search paths instead of
 *   installation prefix paths
 * - debug output printed to stderr
 */
bool
Environment::developerMode() {
    Environment::initialize();
    return developerMode_;
}