AaronCameron.net
Because you all make me very, very tired.
Not a Member? - Login or Create an Account
Tuesday the 22nd of May 2012 @ 04:24pm
Front Page Journal Projects Your Profile About
[]

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

cVfsFile.h

Go to the documentation of this file.
00001 /************************************************************************
00002 Nova-2 Library (libN2L, or simply n2l) Game development C++ Library
00003 Copyright (C) 2002  Aaron Cameron
00004 
00005 This library is free software; you can redistribute it and/or
00006 modify it under the terms of the GNU Lesser General Public
00007 License as published by the Free Software Foundation; either
00008 version 2.1 of the License, or (at your option) any later version.
00009 
00010 This library is distributed in the hope that it will be useful,
00011 but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013 Lesser General Public License for more details.
00014 
00015 You should have received a copy of the GNU Lesser General Public
00016 License along with this library; if not, write to the Free Software
00017 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00018 
00019 A copy of the GNU Lesser General Public License has been provided with
00020 this library in the file 'COPYING'.
00021 
00022 Contact information for the author of this library has been provided
00023 with this library in the file 'AUTHOR'.
00024 ************************************************************************/
00025 #ifndef _n2l4_cVfsFile_H
00026 #define _n2l4_cVfsFile_H
00027 
00028 #include "n2l/n2l.h"
00029 
00030 #include "cVfsFileInterface.h"
00031 #include "cVfsStat.h"
00032 
00033 struct SDL_RWops;
00034 
00035 namespace n2l
00036 {
00037 
00041     class cVfsFile : public cVfsFileInterface
00042     {
00043     public:
00044         cVfsFile( const tFsNodeName & iName );
00045         virtual ~cVfsFile();
00046 
00047         virtual const tVfsNodeName & name() const;
00048 
00049         virtual const tUint permissions() const;
00050 
00051         virtual const tBool isSymLink() const;
00052         virtual const tFsNodeName readLink() const;
00053 
00054         virtual const tUint size() const;
00055 
00056         virtual const tVfsFileBuffer &buffer() const;
00057         virtual void buffer( const tVfsFileBuffer &iBuffer ) const;
00058         void getBuffer( tVfsFileBuffer & oBuffer ) const;
00059 
00060         virtual const tVfsFileBuffer & firstLine() const;
00061         virtual SDL_RWops * getRWops() const;
00062 
00063         virtual const tBool supportsFsName() const;
00064         virtual const tFsNodeName fsName() const;
00065 
00066         virtual void clearCache() const;
00067 
00068     private:
00069         static const tUint FirstLineMaxLength;
00070 
00071         tVfsNodeName mVfsNodeName;
00072         tFsNodeName mFsNodeName;
00073 
00074         cVfsStat mStat;
00075 
00076         mutable tBool mBufferCached;
00077         mutable tVfsFileBuffer mBuffer;
00078 
00079         mutable tBool mBufferFirstLineCached;
00080         mutable tVfsFileBuffer mBufferFirstLine;
00081 
00082         mutable tBool mSizeCached;
00083         mutable tVfsFileSize mFileSize;
00084 
00085         cVfsFile();
00086 
00087         void readBuffer() const;
00088         void writeBufferToDisk() const;
00089         void readFirstLine() const;
00090         void clear();
00091 
00092     }; // class
00093 
00094 } // namespace
00095 
00096 #endif
©2012 Aaron Cameron