pgfilearchive.h

Go to the documentation of this file.

/*
    ParaGUI - crossplatform widgetset
    Copyright (C) 2000,2001,2002  Alexander Pipelka
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
    Alexander Pipelka
    pipelka@teleweb.at
 
    Last Update:      $Author: mbickel $
    Update Date:      $Date: 2008-02-01 22:15:09 $
    Source File:      $Source: /home/cvspsrv/cvsroot/games/asc/source/libs/paragui/include/pgfilearchive.h,v $
    CVS/RCS Revision: $Revision: 1.3 $
    Status:           $State: Exp $
*/

#ifndef PG_FILEARCHIVE_H
#define PG_FILEARCHIVE_H

#include "paragui.h"
#include "pgfile.h"
#include "pgsurfacecache.h"
#include "pgdatacontainer.h"

#include <vector>
#include <string>

typedef std::vector< std::string > PG_FileList;

class DECLSPEC PG_FileArchive {
private:   
   void init( const char* argv0 );
   
public:

        enum Mode {
            READ, 
            WRITE, 
            APPEND 
        };

        PG_FileArchive();
   PG_FileArchive( const char* argv0);
   
        ~PG_FileArchive();

        static void Deinit();

        static bool AddArchive(const std::string& arch, bool append = true);

        static bool RemoveArchive(const std::string& arch);

        static bool RemoveAllArchives();


        static char **GetSearchPath();


        static void FreeList(void* list);


        static char **EnumerateFiles(const std::string& dir);

        static bool Exists(const std::string& filename);

        static bool IsDirectory(const std::string& filename);

        static const char* GetDirSeparator();

        static const char* GetRealDir(const std::string&filename);

        static const char* GetLastError();

        static bool MakeDir(const std::string& dir);


        static bool SetWriteDir(const std::string& dir);


        static std::string *PathToPlatform(const std::string& path);


        static const char* GetBaseDir();


        static const char* GetUserDir();


        static const char* GetWriteDir();


        static bool SetSaneConfig(const std::string& organization,
                                  const std::string& appName,
                                  const std::string& archiveExt = PG_NULLSTR,
                                  bool includeCdRoms = false,
                                  bool archivesFirst = true);

        static PG_File* OpenFile(const std::string& filename, Mode mode = READ);

        static SDL_RWops* OpenFileRWops(const std::string& filename, Mode mode = READ);


        static PG_DataContainer* ReadFile(const std::string& filename);

        static SDL_Surface* LoadSurface(const std::string& filename, bool convert = false);

        static SDL_Surface* LoadSurface(const std::string& filename, bool usekey, Uint32 colorkey, bool convert = false);

        static bool UnloadSurface(SDL_Surface* surface, bool bDeleteIfNotExists = true);

        static void EnableSymlinks(bool followSymlinks);


        static PG_FileList* GetSearchPathList();



        static PG_FileList* GetFileList(const std::string& dir, const std::string& wildcard="*");

private:

        static Uint32 my_instance_count;

        static PG_SurfaceCache my_cache;
};

#endif

---