FileUtils.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/*  Copyright 2014 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    MeteoIO 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 Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef FILEUTILS_H
#define FILEUTILS_H
 
#include <string>
#include <map>
#include <vector>
#include <list>
 
#include <meteoio/dataClasses/Date.h>
#include <meteoio/FStream.h>
 
namespace mio {
namespace FileUtils {
 
        void copy_file(const std::string& src, const std::string& dest);
        
        void readDirectory(const std::string& path, std::list<std::string>& dirlist, const std::string& pattern="", const bool& isRecursive=false);
 
        std::list<std::string> readDirectory(const std::string& path, const std::string& pattern="", const bool& isRecursive=false);
 
        bool directoryExists(const std::string &path);
        bool isWindowsPath(const std::string &path);
        void createDirectories(const std::string &path);
 
        bool validFileAndPath(const std::string& filename);
 
        bool fileExists(const std::string& filename);
 
        std::string cleanPath(std::string in_path, const bool& resolve=false, const bool& silent=false);
 
 
        bool isSubDirOf(const std::string& in_path, const std::string& root_path);
 
        bool isAllowedPath(const std::string& path, const bool& is_write);
 
        FILE* fopen_safe(const char* filename, const char* mode);
 
        std::string getExtension(const std::string& filename);
 
        std::string removeExtension(const std::string& filename);
 
        std::string getCWD();
 
        std::string getDateTime();
 
        std::string getPath(const std::string& filename, const bool& resolve=false);
 
        bool isAbsolutePath(const std::string& in_path);
 
        std::string getFilename(const std::string& path);
 
        char getEoln(std::istream& fin);
 
        void skipLines(std::istream& fin, const size_t& nbLines, const char& eoln='\n');
 
        std::map<std::string,std::string> readKeyValueHeader(std::istream& fin,
                                const size_t& linecount=1,
                                const std::string& delimiter="=", const bool& keep_case=false);
 
        class FileIndexer {
                public:
                        FileIndexer() : vecIndex() {}
 
                        void setIndex(const Date& i_date, const std::streampos& i_pos, const size_t& linenr=static_cast<size_t>(-1));
                        void setIndex(const std::string& i_date, const std::streampos& i_pos, const size_t& linenr=static_cast<size_t>(-1));
                        void setIndex(const double& i_date, const std::streampos& i_pos, const size_t& linenr=static_cast<size_t>(-1));
 
                        std::streampos getIndex(const Date& i_date) const;
                        std::streampos getIndex(const std::string& i_date) const;
                        std::streampos getIndex(const double& i_date) const;
 
                        std::streampos getIndex(const Date& i_date, size_t& o_linenr) const;
                        std::streampos getIndex(const std::string& i_date, size_t& o_linenr) const;
                        std::streampos getIndex(const double& i_date, size_t& o_linenr) const;
 
                        const std::string toString() const;
 
                private:
                        struct file_index {
                                file_index(const Date& i_date, const std::streampos& i_pos, const size_t& i_linenr=static_cast<size_t>(-1)) : date(i_date), linenr(i_linenr), pos(i_pos) {}
                                bool operator<(const file_index& a) const {
                                        return date < a.date;
                                }
                                bool operator>(const file_index& a) const {
                                        return date > a.date;
                                }
                                Date date;
                                size_t linenr;
                                std::streampos pos;
                        };
                        size_t binarySearch(const Date& soughtdate) const;
 
                        std::vector< struct file_index > vecIndex;
        };
 
} //end namespace FileUtils
} //end namespace mio
 
#endif