Panda3D
|
00001 // Filename: virtualFileMount.h 00002 // Created by: drose (03Aug02) 00003 // 00004 //////////////////////////////////////////////////////////////////// 00005 // 00006 // PANDA 3D SOFTWARE 00007 // Copyright (c) Carnegie Mellon University. All rights reserved. 00008 // 00009 // All use of this software is subject to the terms of the revised BSD 00010 // license. You should have received a copy of this license along 00011 // with this source code in a file named "LICENSE." 00012 // 00013 //////////////////////////////////////////////////////////////////// 00014 00015 #ifndef VIRTUALFILEMOUNT_H 00016 #define VIRTUALFILEMOUNT_H 00017 00018 #include "pandabase.h" 00019 00020 #include "virtualFile.h" 00021 #include "filename.h" 00022 #include "pointerTo.h" 00023 #include "typedReferenceCount.h" 00024 00025 class VirtualFileSystem; 00026 00027 //////////////////////////////////////////////////////////////////// 00028 // Class : VirtualFileMount 00029 // Description : The abstract base class for a mount definition used 00030 // within a VirtualFileSystem. Normally users don't 00031 // need to monkey with this class directly. 00032 //////////////////////////////////////////////////////////////////// 00033 class EXPCL_PANDAEXPRESS VirtualFileMount : public TypedReferenceCount { 00034 PUBLISHED: 00035 INLINE VirtualFileMount(); 00036 virtual ~VirtualFileMount(); 00037 00038 INLINE VirtualFileSystem *get_file_system() const; 00039 INLINE const Filename &get_mount_point() const; 00040 INLINE int get_mount_flags() const; 00041 00042 public: 00043 virtual PT(VirtualFile) make_virtual_file(const Filename &local_filename, 00044 const Filename &original_filename, 00045 bool implicit_pz_file, 00046 int open_flags); 00047 00048 virtual bool has_file(const Filename &file) const=0; 00049 virtual bool create_file(const Filename &file); 00050 virtual bool make_directory(const Filename &file); 00051 virtual bool delete_file(const Filename &file); 00052 virtual bool rename_file(const Filename &orig_filename, const Filename &new_filename); 00053 virtual bool copy_file(const Filename &orig_filename, const Filename &new_filename); 00054 virtual bool is_directory(const Filename &file) const=0; 00055 virtual bool is_regular_file(const Filename &file) const=0; 00056 virtual bool is_writable(const Filename &file) const; 00057 00058 virtual bool read_file(const Filename &file, bool do_uncompress, 00059 pvector<unsigned char> &result) const; 00060 virtual bool write_file(const Filename &file, bool do_compress, 00061 const unsigned char *data, size_t data_size); 00062 00063 virtual istream *open_read_file(const Filename &file) const=0; 00064 istream *open_read_file(const Filename &file, bool do_uncompress) const; 00065 virtual void close_read_file(istream *stream) const; 00066 00067 virtual ostream *open_write_file(const Filename &file, bool truncate); 00068 ostream *open_write_file(const Filename &file, bool do_compress, bool truncate); 00069 virtual ostream *open_append_file(const Filename &file); 00070 virtual void close_write_file(ostream *stream); 00071 00072 virtual iostream *open_read_write_file(const Filename &file, bool truncate); 00073 virtual iostream *open_read_append_file(const Filename &file); 00074 virtual void close_read_write_file(iostream *stream); 00075 00076 virtual off_t get_file_size(const Filename &file, istream *stream) const=0; 00077 virtual off_t get_file_size(const Filename &file) const=0; 00078 virtual time_t get_timestamp(const Filename &file) const=0; 00079 virtual bool get_system_info(const Filename &file, SubfileInfo &info); 00080 00081 virtual bool scan_directory(vector_string &contents, 00082 const Filename &dir) const=0; 00083 00084 virtual bool atomic_compare_and_exchange_contents(const Filename &file, string &orig_contents, const string &old_contents, const string &new_contents); 00085 virtual bool atomic_read_contents(const Filename &file, string &contents) const; 00086 00087 PUBLISHED: 00088 virtual void output(ostream &out) const; 00089 virtual void write(ostream &out) const; 00090 00091 protected: 00092 VirtualFileSystem *_file_system; 00093 Filename _mount_point; 00094 int _mount_flags; 00095 00096 00097 public: 00098 virtual TypeHandle get_type() const { 00099 return get_class_type(); 00100 } 00101 virtual TypeHandle force_init_type() {init_type(); return get_class_type();} 00102 static TypeHandle get_class_type() { 00103 return _type_handle; 00104 } 00105 static void init_type() { 00106 TypedReferenceCount::init_type(); 00107 register_type(_type_handle, "VirtualFileMount", 00108 TypedReferenceCount::get_class_type()); 00109 } 00110 00111 private: 00112 static TypeHandle _type_handle; 00113 00114 friend class VirtualFileSystem; 00115 }; 00116 00117 INLINE ostream &operator << (ostream &out, const VirtualFileMount &mount); 00118 00119 #include "virtualFileMount.I" 00120 00121 #endif