config.h

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
/**
 * \dir
 * \brief Global project configurations
 *
 * \file
 * \brief Version information and units file path
 */
 
#include <cstdlib>
#include <filesystem>
#include <fstream>
#include <sstream>
#include <string>
#include <vector>
 
#include "utils/common_utils.hpp"
 
namespace nmodl {
namespace fs = std::filesystem;
 
/**
 * \brief Project version information
 */
struct Version {
    /// git revision id
    static const std::string GIT_REVISION;
 
    /// project tagged version in the cmake
    static const std::string NMODL_VERSION;
 
    /// return version string (version + git id) as a string
    static std::string to_string() {
        return NMODL_VERSION + " " + GIT_REVISION;
    }
};
 
/**
 * \brief Information of units database i.e. `nrnunits.lib`
 */
struct NrnUnitsLib {
    /// paths where nrnunits.lib can be found
    static std::vector<std::string> NRNUNITSLIB_PATH;
 
    static const std::string_view embedded_nrnunits;
 
    /**
     * Return content of units database file
     */
    static std::string get_content(const std::string& path) {
        if (!path.size()) {
            return std::string(embedded_nrnunits);
        }
        auto f = std::ifstream(path);
        auto size = std::filesystem::file_size(path);
        auto content = std::string(size, '\0');
        f.read(content.data(), size);
        return content;
    }
 
    /**
     * Return path of units database file
     */
    static std::string get_path() {
        // first look for NMODLHOME env variable
        if (const char* nmodl_home = std::getenv("NMODLHOME")) {
            auto path = std::string(nmodl_home) + "/share/nmodl/nrnunits.lib";
            NRNUNITSLIB_PATH.emplace(NRNUNITSLIB_PATH.begin(), path);
        }
 
        // check paths in order and return if found
        for (const auto& path: NRNUNITSLIB_PATH) {
            std::ifstream f(path.c_str());
            if (f.good()) {
                return path;
            }
        }
        return "";
    }
};
 
struct CMakeInfo {
    static const std::string SHARED_LIBRARY_SUFFIX;
};
 
}  // namespace nmodl