00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027 #ifndef CEYLAN_FILE_H_
00028 #define CEYLAN_FILE_H_
00029
00030
00031 #include "CeylanFileSystemCommon.h"
00032 #include "CeylanSystem.h"
00033 #include "CeylanTypes.h"
00034 #include "CeylanInputOutputStream.h"
00035
00036 #include <string>
00037
00038
00039
00040
00041 namespace Ceylan
00042 {
00043
00044
00045 namespace System
00046 {
00047
00048
00049
00050
00051
00052
00053
00054 class FileSystemManager ;
00055
00056
00057
00064 typedef Ceylan::Uint16 OpeningFlag ;
00065
00066
00067
00082 typedef Ceylan::Uint16 PermissionFlag ;
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099 class CEYLAN_DLL FileReadLockingFailed: public FileException
00100 {
00101 public:
00102
00103 explicit FileReadLockingFailed( const std::string & reason ) ;
00104 } ;
00105
00106
00107
00108 class CEYLAN_DLL FileReadUnlockingFailed: public FileException
00109 {
00110 public:
00111
00112 explicit FileReadUnlockingFailed( const std::string & reason ) ;
00113 } ;
00114
00115
00116
00117 class CEYLAN_DLL FileWriteLockingFailed: public FileException
00118 {
00119 public:
00120
00121 explicit FileWriteLockingFailed( const std::string & reason ) ;
00122 } ;
00123
00124
00125
00126 class CEYLAN_DLL FileWriteUnlockingFailed: public FileException
00127 {
00128 public:
00129
00130 explicit FileWriteUnlockingFailed(
00131 const std::string & reason ) ;
00132 } ;
00133
00134
00135
00142 class CEYLAN_DLL FileDelegatingException: public FileException
00143 {
00144
00145 public:
00146
00147 explicit FileDelegatingException( const std::string & reason ) ;
00148
00149 } ;
00150
00151
00152
00153
00197 class CEYLAN_DLL File: public InputOutputStream
00198 {
00199
00200
00201 public:
00202
00203
00204
00205
00206 static const OpeningFlag Read ;
00207
00208
00209
00210 static const OpeningFlag Write ;
00211
00212
00213
00221 static const OpeningFlag CreateFile ;
00222
00223
00224
00225 static const OpeningFlag TruncateFile ;
00226
00227
00228
00229 static const OpeningFlag AppendFile ;
00230
00231
00232
00233
00234 static const OpeningFlag Binary ;
00235
00236
00237
00238 static const OpeningFlag DoNotOpen ;
00239
00240
00241
00242
00243
00244
00245
00246
00247
00248 static const OpeningFlag CreateToWriteBinary ;
00249
00250
00251
00252
00253
00254
00255
00256
00257 static const OpeningFlag OpenToReadBinary ;
00258
00259
00260
00271 static const OpeningFlag NonBlocking ;
00272
00273
00274
00287 static const OpeningFlag Synchronous ;
00288
00289
00290
00291
00292
00293
00294
00295
00296
00297
00299 static const PermissionFlag OwnerRead ;
00300
00301
00302
00304 static const PermissionFlag OwnerWrite ;
00305
00306
00307
00309 static const PermissionFlag OwnerExec ;
00310
00311
00312
00318 static const PermissionFlag OwnerReadWrite ;
00319
00320
00321
00327 static const PermissionFlag OwnerReadWriteExec ;
00328
00329
00330
00331
00332
00333
00334
00335
00336
00337
00338
00339
00340
00348 static const PermissionFlag GroupRead ;
00349
00350
00351
00359 static const PermissionFlag GroupWrite ;
00360
00361
00369 static const PermissionFlag GroupExec ;
00370
00371
00372
00381 static const PermissionFlag GroupReadWrite ;
00382
00383
00384
00393 static const PermissionFlag GroupReadWriteExec ;
00394
00395
00396
00397
00398
00399
00400
00401
00402
00403
00404
00405
00406
00415 static const PermissionFlag OthersRead ;
00416
00417
00418
00427 static const PermissionFlag OthersWrite ;
00428
00429
00430
00439 static const PermissionFlag OthersExec ;
00440
00441
00442
00451 static const PermissionFlag OthersReadWrite ;
00452
00453
00454
00463 static const PermissionFlag OthersReadWriteExec ;
00464
00465
00466
00467
00468
00469
00470
00471
00472
00473
00474
00475
00476
00477
00478
00479
00480
00481
00497 static bool ExistsAsFileOrSymbolicLink(
00498 const std::string & filename ) ;
00499
00500
00501
00519 static bool Exists( const std::string & filename ) ;
00520
00521
00522
00534 static void Remove( const std::string & filename ) ;
00535
00536
00537
00553 static void Move( const std::string & sourceFilename,
00554 const std::string & targetFilename ) ;
00555
00556
00557
00570 static void Copy( const std::string & sourceFilename,
00571 const std::string & targetFilename ) ;
00572
00573
00574
00585 static Size GetSize( const std::string & filename ) ;
00586
00587
00588
00601 static time_t GetLastChangeTime(
00602 const std::string & filename ) ;
00603
00604
00605
00616 static std::string TransformIntoValidFilename(
00617 const std::string & rawFilename ) ;
00618
00619
00620
00641 static void Touch( const std::string & filename ) ;
00642
00643
00644
00663 static bool Diff( const std::string & firstFilename,
00664 const std::string & secondFilename ) ;
00665
00666
00667
00668
00669
00670
00671
00672
00713 static File & Create( const std::string & filename,
00714 OpeningFlag createFlag = CreateToWriteBinary,
00715 PermissionFlag permissionFlag = OwnerReadWrite ) ;
00716
00717
00718
00751 static File & Open( const std::string & filename,
00752 OpeningFlag openFlag = OpenToReadBinary ) ;
00753
00754
00755
00770 virtual ~File() throw() ;
00771
00772
00773
00774
00775
00776
00777
00779 const std::string & getName() const ;
00780
00781
00782
00787 virtual bool isOpen() const = 0 ;
00788
00789
00790
00799 virtual bool close() = 0 ;
00800
00801
00802
00811 virtual void saveAs( const std::string & newName ) = 0 ;
00812
00813
00814
00815
00816
00817
00818
00819
00820
00831 virtual void lockForReading() const ;
00832
00833
00834
00845 virtual void unlockForReading() const ;
00846
00847
00848
00859 virtual void lockForWriting() const ;
00860
00861
00862
00873 virtual void unlockForWriting() const ;
00874
00875
00876
00877
00889 virtual bool isLocked() const ;
00890
00891
00892
00893
00906 virtual Size size() const ;
00907
00908
00909
00917 virtual time_t getLastChangeTime() const = 0 ;
00918
00919
00920
00946 virtual Size read( Ceylan::Byte * buffer, Size maxLength ) = 0 ;
00947
00948
00949
00972 virtual void readExactLength( Ceylan::Byte * buffer,
00973 Size exactLength ) ;
00974
00975
00976
00983 virtual bool hasAvailableData() const ;
00984
00985
00986
01000 virtual Size write( const std::string & message ) = 0 ;
01001
01002
01003
01020 virtual Size write( const Ceylan::Byte * buffer,
01021 Size maxLength ) = 0 ;
01022
01023
01024
01033 virtual Position tell() = 0 ;
01034
01035
01036
01046 virtual void seek( Position targetPosition ) = 0 ;
01047
01048
01049
01058 virtual void open( OpeningFlag openFlag = CreateToWriteBinary,
01059 PermissionFlag permissionFlag = OwnerReadWrite ) ;
01060
01061
01062
01074 virtual void remove() ;
01075
01076
01077
01078
01079
01080
01081
01082
01090 virtual StreamID getStreamID() const = 0 ;
01091
01092
01093
01099 virtual StreamID getInputStreamID() const ;
01100
01101
01102
01108 virtual StreamID getOutputStreamID() const ;
01109
01110
01111
01124 virtual const std::string toString(
01125 Ceylan::VerbosityLevels level = Ceylan::high ) const ;
01126
01127
01128
01130 static const Size UsualBufferSize ;
01131
01132
01134 static const Size BigBufferSize ;
01135
01136
01137
01138
01139 protected:
01140
01141
01142
01169 explicit File( const std::string & name,
01170 OpeningFlag openFlag = CreateToWriteBinary,
01171 PermissionFlag permissionFlag = OwnerReadWrite ) ;
01172
01173
01174
01182 virtual FileSystemManager & getCorrespondingFileSystemManager()
01183 const = 0 ;
01184
01185
01186
01193 virtual void reopen() = 0 ;
01194
01195
01197 virtual std::string interpretState() const = 0 ;
01198
01199
01200
01202 std::string _name ;
01203
01204
01205
01207 OpeningFlag _openFlag ;
01208
01209
01210
01212 PermissionFlag _permissions ;
01213
01214
01221 bool _lockedForReading: 1, _lockedForWriting: 1 ;
01222
01223
01224
01234 static FileSystemManager & GetCorrespondingFileSystemManager() ;
01235
01236
01237
01238
01239 private:
01240
01241
01242
01251 File( const File & source ) ;
01252
01253
01254
01263 File & operator = ( const File & source ) ;
01264
01265
01266
01267 } ;
01268
01269
01270 }
01271
01272 }
01273
01274
01275
01276 #endif // CEYLAN_FILE_H_
01277