gfile.h

Go to the documentation of this file.

//
// Copyright (C) 2001-2013 Graeme Walker <graeme_walker@users.sourceforge.net>
// 
// This program is free software: you can redistribute it 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.
// 
// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
// ===
        
#ifndef G_FILE_H
#define G_FILE_H

#include "gdef.h"
#include "gpath.h"
#include "gexception.h"
#include "gdatetime.h"
#include <cstdio> // std::remove()

namespace G
{
        class File ;
        class DirectoryIteratorImp ;
}

class G::File 
{
public:
        G_EXCEPTION( StatError , "cannot stat() file" ) ;
        G_EXCEPTION( CannotRemove , "cannot delete file" ) ;
        G_EXCEPTION( CannotRename , "cannot rename file" ) ;
        G_EXCEPTION( CannotCopy , "cannot copy file" ) ;
        G_EXCEPTION( CannotMkdir , "cannot mkdir" ) ;
        G_EXCEPTION( CannotChmod , "cannot chmod file" ) ;
        G_EXCEPTION( CannotLink , "cannot create symlink" ) ;
        G_EXCEPTION( CannotCreate , "cannot create empty file" ) ;
        G_EXCEPTION( SizeOverflow , "file size overflow" ) ;
        G_EXCEPTION( TimeError , "cannot get file modification time" ) ;
        typedef DateTime::EpochTime time_type ;
        class NoThrow 
                {} ;

        static bool remove( const Path & path , const NoThrow & ) ;

        static void remove( const Path & path ) ;

        static bool rename( const Path & from , const Path & to , const NoThrow & ) ;

        static void rename( const Path & from , const Path & to ) ;

        static bool copy( const Path & from , const Path & to , const NoThrow & ) ;

        static void copy( const Path & from , const Path & to ) ;

        static void copy( std::istream & from , std::ostream & to , 
                std::streamsize limit = 0U , std::string::size_type block = 0U ) ;

        static bool mkdirs( const Path & dir , const NoThrow & , int = 100 ) ;

        static void mkdirs( const Path & dir , int = 100 ) ;

        static bool mkdir( const Path & dir , const NoThrow & ) ;

        static void mkdir( const Path & dir ) ;

        static std::string sizeString( const Path & file ) ;

        static bool exists( const Path & file ) ;

        static bool exists( const Path & file , const NoThrow & ) ;

        static time_type time( const Path & file ) ;

        static time_type time( const Path & file , const NoThrow & ) ;

        static void chmodx( const Path & file ) ;

        static bool chmodx( const Path & file , const NoThrow & ) ;

        static void link( const Path & target , const Path & new_link ) ;

        static bool link( const Path & target , const Path & new_link , const NoThrow & ) ;

        static bool executable( const Path & ) ;

        static void create( const Path & ) ;

private:
        friend class G::DirectoryIteratorImp ;
        static std::string copy( const Path & , const Path & , int ) ;
        static std::string sizeString( g_uint32_t hi , g_uint32_t lo ) ; // win32
        static bool exists( const Path & , bool , bool ) ;
        static bool exists( const char * , bool & ) ; // o/s-specific
        static bool chmodx( const Path & file , bool ) ;
} ;

#endif