FileIOHelpers.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//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.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//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 MERCURYDPM DEVELOPERS TEAM 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.
 
#ifndef MERCURYDPM_FILEIO_HELPERS_H
#define MERCURYDPM_FILEIO_HELPERS_H
 
#include "Logger.h"
#include "Math/ExtendedMath.h"
 
#include <fstream>
#include <string>
#include <vector>
 
namespace helpers
{
    bool writeToFile(std::string filename, std::string filecontent);
 
    void writeCommandLineToFile(const std::string filename, const int argc, char * const argv[]);
 
    bool addToFile(std::string filename, std::string filecontent);
 
    bool fileExists(std::string strFilename);
 
    bool openFile(std::fstream& file, std::string filename, std::fstream::openmode mode);
 
    std::vector<double> readArrayFromFile(std::string filename, int& n, int& m);
 
    void more(std::string filename, unsigned nLines = constants::unsignedMax);
 
    bool createDirectory(std::string);
 
    std::string getPath();
 
    template<typename T>
    bool readOptionalVariable(std::istream& is, const std::string& name, T& variable)
    {
        const auto pos = is.tellg();
        std::string dummy;
        is >> dummy;
        if (dummy == name)
        {
            is >> variable;
            return true;
        } else {
            is.seekg(pos);
            return false;
        }
    }
 
    template<typename T>
    T readFromFile(const std::string fileName, const std::string varName, const T defaultValue)
    {
        //open filestream
        std::ifstream is(fileName.c_str(), std::ios::in);
        if (is.fail())
        {
            logger(INFO, "readFromFile: file % could not be opened, variable % set to default value %",
                fileName, varName, defaultValue);
            return defaultValue;
        }
        
        //read in variables, until the right one is fount
        std::string s;
        while (!is.eof())
        {
            is >> s;
            if (s == varName)
            {
                T value;
                is >> value;
                logger(INFO, "readFromFile: variable % set to % ", varName, value);
                return value;
            }
        }
        
        //if the right variable is never found
        logger(WARN, "readFromFile: variable % not set in file %, using default value % ", varName, fileName, defaultValue);
        return defaultValue;
    }
}
 
#endif // MERCURYDPM_FILEIO_HELPERS_H