fileUtils.hpp

Go to the documentation of this file.

/************************************************************************

 Copyright (C) 2011 - 2014 Project Wolframe.
 All rights reserved.

 This file is part of Project Wolframe.

 Commercial Usage
    Licensees holding valid Project Wolframe Commercial licenses may
    use this file in accordance with the Project Wolframe
    Commercial License Agreement provided with the Software or,
    alternatively, in accordance with the terms contained
    in a written agreement between the licensee and Project Wolframe.

 GNU General Public License Usage
    Alternatively, you can redistribute this file and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Wolframe 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Wolframe.  If not, see <http://www.gnu.org/licenses/>.

 If you have questions regarding the use of this file, please contact
 Project Wolframe.

************************************************************************/

#ifndef _WOLFRAME_FILE_UTILS_HPP_INCLUDED
#define _WOLFRAME_FILE_UTILS_HPP_INCLUDED
#include "types/propertyTree.hpp"
#include <string>
#include <vector>

namespace _Wolframe {
namespace utils {

std::string resolvePath( const std::string& path );

std::string getFileExtension( const std::string& path);

std::string getFileStem( const std::string& path);

std::string getCanonicalPath( const std::string& path, const std::string& refPath);

std::string getParentPath( const std::string& path, unsigned int levels=1);

std::string joinPath( const std::string& path, const std::string& item);

bool fileExists( const std::string& path);

std::string readSourceFileContent( const std::string& filename);

std::string readBinaryFileContent( const std::string& filename);

types::PropertyTree readPropertyTreeFile( const std::string& filename);
types::PropertyTree readXmlPropertyTreeFile( const std::string& filename);
types::PropertyTree readInfoPropertyTreeFile( const std::string& filename);

void writeFile( const std::string& filename, const std::string& content);

struct FileType
{
        enum Encoding {Undefined,UCS1,UCS2BE,UCS2LE,UCS4BE,UCS4LE};
        enum Format {Unknown,XML,Info};

        Encoding encoding;
        Format format;

        FileType()
                :encoding(Undefined),format(Unknown){}
        FileType( const FileType& o)
                :encoding(o.encoding),format(o.format){}
        FileType( Encoding encoding_, Format format_)
                :encoding(encoding_),format(format_){}
};
FileType getFileType( const std::string& filename);

}} //namespace _Wolframe::utils

#endif // _MISC_UTILS_HPP_INCLUDED