Environment.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2019 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.hh
 *
 * Declaration 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 2011
 * @note reviewed 19 May 2004 by ao, jn, ml, am
 * @note rating: red
 */
 
#ifndef TTA_ENVIRONMENT_HH
#define TTA_ENVIRONMENT_HH
 
#include <string>
#include <vector>
#include "TCEString.hh"
 
/**
 * A class to get the environmental variable values as well as to find files
 * or directories from the project's directory structure.
 */
class Environment {
 
public:
    static void initialize();
 
    static std::string schemaDirPath(const std::string& prog);
    static std::string dataDirPath(const std::string& prog);
    static std::string bitmapsDirPath(const std::string& prog);
    static std::string manDirPath(const std::string& prog);
    static TCEString confPath(const std::string& fileName);
    static TCEString userConfPath(const std::string& fileName);
 
    static std::string errorLogFilePath();
    static std::string iconDirPath();
    static std::vector<std::string> includeDirPaths();
    static std::vector<std::string> opsetIncludeDir();
 
    static void setNewSchemaFileDir(const std::string& path);
    static void setNewDataFileDir(const std::string& path);
    static void setNewBitmapsFileDir(const std::string& path);
    static void setNewManFileDir(const std::string& path);
    static void setNewErrorLogFileDir(const std::string& path);
 
    static std::string environmentVariable(const std::string& variable);
    static std::vector<std::string> osalPaths();
    static std::vector<std::string> codeCompressorPaths(
            bool libraryPathsOnly = false);
    static std::vector<std::string> schedulerPluginPaths();
    static std::vector<std::string> icDecoderPluginPaths(
            bool libraryPathsOnly = false);
    static std::vector<std::string> hwModulePaths();
    static std::vector<std::string> hdbPaths(
            bool libraryPathsOnly = false);
    static TCEString shortHDBPath(const TCEString& hdbPath);
    static TCEString longHDBPath(const TCEString& hdbPath);
    static std::vector<std::string> vhdlPaths(const std::string& hdbPath);
    static std::vector<std::string> decompressorPaths(
            bool libraryPathsOnly = false);
    static std::vector<std::string> explorerPluginPaths();
    static std::vector<std::string> estimatorPluginPaths();
 
    static std::string pdfManual();
    static std::string minimalADF();
    static std::string tceCompiler();
    static std::string defaultSchedulerConf();
    static std::string oldGccSchedulerConf();
    static std::string defaultICDecoderPlugin();
    static std::string defaultTextEditorPath();
 
    static std::string llvmtceCachePath();
 
    static std::vector<std::string> implementationTesterTemplatePaths();
    static std::string simTraceDirPath();
 
    static bool developerMode();
 
private:
    Environment();
    ~Environment();
 
    static std::string pathTo(const std::string& name);
    static inline void parsePathEnvVariable(std::vector<std::string>& paths);
    static std::string findExecutableFromPATH(
        const std::vector<std::string>& file);
 
    /// Name of the XML Schema directory.
    static const std::string SCHEMA_DIR_NAME_;
    /// Name of the data directory.
    static const std::string DATA_DIR_NAME_;
    /// Name of the bitmaps directory.
    static const std::string BITMAPS_DIR_NAME_;
    /// Name of the manual directory.
    static const std::string MAN_DIR_NAME_;
    /// Name of the configuration directory.
    static const std::string CONF_DIR_NAME_;
    /// Name of the toolbar icon directory.
    static const std::string ICON_DIR_NAME_;
    /// Name of the system error log file.
    static const std::string ERROR_LOG_FILE_NAME_;
    /// Flag indicating whether class has been initialized.
    static bool initialized_;
    /// Flag indicating whether TCE is executing in developer mode.
    static bool developerMode_;
 
    /// Schema directory search paths.
    static std::vector<std::string> schemaPaths_;
    /// Data directory search paths.
    static std::vector<std::string> dataPaths_;
    /// Bitmaps directory search paths.
    static std::vector<std::string> bitmapsPaths_;
    /// Man directory search paths.
    static std::vector<std::string> manPaths_;
    /// Toolbar icon search paths.
    static std::vector<std::string> iconPaths_;
    /// Error file search paths.
    static std::vector<std::string> errorPaths_;
    /// Paths used in a particular search.
    static std::vector<std::string> pathsToUse_;
 
    /// Directory for new schema file.
    static std::string newSchemaFileDir_;
    /// Directory for new data file.
    static std::string newDataFileDir_;
    /// Directory for new bitmaps file.
    static std::string newBitmapsFileDir_;
    /// Directory for new icon file.
    static std::string newIconFileDir_;
    /// Directory for new manual file.
    static std::string newManFileDir_;
    /// Directory for new configure file.
    static std::string newConfFile_;
    /// Directory for new error log file.
    static std::string newErrorLogFileDir_;
    /// Directory to store ttasim traces
    static std::string simTraceDir_;
 
    /// Relative path to the installed TCE .pdf manual.
    static const std::string PDF_MANUAL_INSTALLED;
    /// Relative path to the TCE .pdf manual in source tree.
    static const std::string PDF_MANUAL_SRC;
    /// Relative path to the installed minimal.adf.
    static const std::string MINIMAL_ADF_INSTALLED;
    /// Relative path to the minimal.adf in source tree.
    static const std::string MINIMAL_ADF_SRC;
 
};
 
#endif