Panda3D
|
00001 // Filename: virtualFile.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 VIRTUALFILE_H 00016 #define VIRTUALFILE_H 00017 00018 #include "pandabase.h" 00019 00020 #include "filename.h" 00021 #include "subfileInfo.h" 00022 #include "pointerTo.h" 00023 #include "typedReferenceCount.h" 00024 #include "ordered_vector.h" 00025 #include "pvector.h" 00026 00027 class VirtualFileMount; 00028 class VirtualFileList; 00029 class VirtualFileSystem; 00030 00031 00032 //////////////////////////////////////////////////////////////////// 00033 // Class : VirtualFile 00034 // Description : The abstract base class for a file or directory 00035 // within the VirtualFileSystem. 00036 //////////////////////////////////////////////////////////////////// 00037 class EXPCL_PANDAEXPRESS VirtualFile : public TypedReferenceCount { 00038 public: 00039 INLINE VirtualFile(); 00040 00041 PUBLISHED: 00042 virtual VirtualFileSystem *get_file_system() const=0; 00043 virtual Filename get_filename() const=0; 00044 INLINE const Filename &get_original_filename() const; 00045 00046 virtual bool has_file() const; 00047 virtual bool is_directory() const; 00048 virtual bool is_regular_file() const; 00049 virtual bool is_writable() const; 00050 00051 BLOCKING virtual bool delete_file(); 00052 BLOCKING virtual bool rename_file(VirtualFile *new_file); 00053 BLOCKING virtual bool copy_file(VirtualFile *new_file); 00054 00055 BLOCKING PT(VirtualFileList) scan_directory() const; 00056 00057 void output(ostream &out) const; 00058 BLOCKING void ls(ostream &out = cout) const; 00059 BLOCKING void ls_all(ostream &out = cout) const; 00060 00061 BLOCKING INLINE string read_file(bool auto_unwrap) const; 00062 BLOCKING virtual istream *open_read_file(bool auto_unwrap) const; 00063 BLOCKING virtual void close_read_file(istream *stream) const; 00064 virtual bool was_read_successful() const; 00065 00066 BLOCKING INLINE bool write_file(const string &data, bool auto_wrap); 00067 BLOCKING virtual ostream *open_write_file(bool auto_wrap, bool truncate); 00068 BLOCKING virtual ostream *open_append_file(); 00069 BLOCKING virtual void close_write_file(ostream *stream); 00070 00071 BLOCKING virtual iostream *open_read_write_file(bool truncate); 00072 BLOCKING virtual iostream *open_read_append_file(); 00073 BLOCKING virtual void close_read_write_file(iostream *stream); 00074 00075 BLOCKING virtual off_t get_file_size(istream *stream) const; 00076 BLOCKING virtual off_t get_file_size() const; 00077 BLOCKING virtual time_t get_timestamp() const; 00078 00079 virtual bool get_system_info(SubfileInfo &info); 00080 00081 public: 00082 virtual bool atomic_compare_and_exchange_contents(string &orig_contents, const string &old_contents, const string &new_contents); 00083 virtual bool atomic_read_contents(string &contents) const; 00084 00085 INLINE void set_original_filename(const Filename &filename); 00086 bool read_file(string &result, bool auto_unwrap) const; 00087 virtual bool read_file(pvector<unsigned char> &result, bool auto_unwrap) const; 00088 virtual bool write_file(const unsigned char *data, size_t data_size, bool auto_wrap); 00089 00090 static bool simple_read_file(istream *stream, pvector<unsigned char> &result); 00091 static bool simple_read_file(istream *stream, pvector<unsigned char> &result, size_t max_bytes); 00092 00093 protected: 00094 virtual bool scan_local_directory(VirtualFileList *file_list, 00095 const ov_set<string> &mount_points) const; 00096 00097 private: 00098 void r_ls_all(ostream &out, const Filename &root) const; 00099 00100 Filename _original_filename; 00101 00102 00103 public: 00104 virtual TypeHandle get_type() const { 00105 return get_class_type(); 00106 } 00107 virtual TypeHandle force_init_type() {init_type(); return get_class_type();} 00108 static TypeHandle get_class_type() { 00109 return _type_handle; 00110 } 00111 static void init_type() { 00112 TypedReferenceCount::init_type(); 00113 register_type(_type_handle, "VirtualFile", 00114 TypedReferenceCount::get_class_type()); 00115 } 00116 00117 private: 00118 static TypeHandle _type_handle; 00119 00120 friend class VirtualFileComposite; 00121 }; 00122 00123 INLINE ostream &operator << (ostream &out, const VirtualFile &file); 00124 00125 00126 #include "virtualFile.I" 00127 00128 #endif