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 bool status_only); 00047 00048 virtual bool has_file(const Filename &file) const=0; 00049 virtual bool is_directory(const Filename &file) const=0; 00050 virtual bool is_regular_file(const Filename &file) const=0; 00051 00052 virtual bool read_file(const Filename &file, bool do_uncompress, 00053 pvector<unsigned char> &result) const; 00054 00055 virtual istream *open_read_file(const Filename &file) const=0; 00056 istream *open_read_file(const Filename &file, bool do_uncompress) const; 00057 void close_read_file(istream *stream) const; 00058 virtual off_t get_file_size(const Filename &file, istream *stream) const=0; 00059 virtual off_t get_file_size(const Filename &file) const=0; 00060 virtual time_t get_timestamp(const Filename &file) const=0; 00061 00062 virtual bool scan_directory(vector_string &contents, 00063 const Filename &dir) const=0; 00064 00065 PUBLISHED: 00066 virtual void output(ostream &out) const; 00067 virtual void write(ostream &out) const; 00068 00069 protected: 00070 VirtualFileSystem *_file_system; 00071 Filename _mount_point; 00072 int _mount_flags; 00073 00074 00075 public: 00076 virtual TypeHandle get_type() const { 00077 return get_class_type(); 00078 } 00079 virtual TypeHandle force_init_type() {init_type(); return get_class_type();} 00080 static TypeHandle get_class_type() { 00081 return _type_handle; 00082 } 00083 static void init_type() { 00084 TypedReferenceCount::init_type(); 00085 register_type(_type_handle, "VirtualFileMount", 00086 TypedReferenceCount::get_class_type()); 00087 } 00088 00089 private: 00090 static TypeHandle _type_handle; 00091 00092 friend class VirtualFileSystem; 00093 }; 00094 00095 INLINE ostream &operator << (ostream &out, const VirtualFileMount &mount); 00096 00097 #include "virtualFileMount.I" 00098 00099 #endif