UnixFile.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. 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.
 
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 COPYRIGHT OWNER OR CONTRIBUTORS 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 NOMLIB_UNIX_FILE_HEADERS
#define NOMLIB_UNIX_FILE_HEADERS
 
#include <iostream>
#include <string>
#include <sstream>
#include <cstring>
#include <vector>
#include <fstream>
 
#include "nomlib/config.hpp"
#include "nomlib/system/IFile.hpp"
 
namespace nom {

class UnixFile: public IFile
{
  public:
    UnixFile ( void );
    ~UnixFile ( void );

    const std::string extension ( const std::string& file );

    int32 size ( const std::string& file_path );

    bool is_dir( const std::string& file_path );
 
    bool is_file( const std::string& file_path );

    bool exists( const std::string& file_path );

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

    std::string currentPath( void );

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

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

    std::vector<std::string> read_dir( const std::string& dir_path );

    const std::string resource_path( const std::string& identifier = "\0" );

    const std::string user_documents_path( void );

    const std::string user_app_support_path( void );

    const std::string user_home_path( void );

    const std::string system_path( void );
 
    // TODO: Implement getter method for platform's system temporary files path;
    // (/tmp on POSIX and C:\Windows\Temp on Windows).
    // const std::string system_temp_path( void );
 
    // \brief Get the platform-defined system path.
    //
    // \returns Under Mac OS X: a directory path in the format of:
    // "/System/Library". Under POSIX-compliant Unix (not verified):
    // "/bin" (Linux/BSD). Under Windows: "<drive>:\Windows".
    // const std::string system_library_path( void );
 
    // \brief Get the platform-defined system fonts path.
    //
    // \returns Under Mac OS X: a directory path in the format of:
    // "/System/Library/Fonts". Under POSIX-compliant Unix (not verified):
    // "/usr/share/fonts" (Linux/BSD). Under Windows: "<drive>:\Windows\Fonts".
    // const std::string system_fonts_path( void );

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

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

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

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

    std::string env( const std::string& path );
 
    nom::size_type num_files(const std::string& path);
};
 
 
} // namespace nom
 
#endif // include guard