298 lines
9.9 KiB
C
298 lines
9.9 KiB
C
|
/**
|
||
|
|
* PANDA 3D SOFTWARE
|
||
|
|
* Copyright (c) Carnegie Mellon University. All rights reserved.
|
||
|
|
*
|
||
|
|
* All use of this software is subject to the terms of the revised BSD
|
||
|
|
* license. You should have received a copy of this license along
|
||
|
|
* with this source code in a file named "LICENSE."
|
||
|
|
*
|
||
|
|
* @file filename.h
|
||
|
|
* @author drose
|
||
|
|
* @date 1999-01-18
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef FILENAME_H
|
||
|
|
#define FILENAME_H
|
||
|
|
|
||
|
|
#include "dtoolbase.h"
|
||
|
|
#include "pandaFileStream.h"
|
||
|
|
#include "typeHandle.h"
|
||
|
|
#include "register_type.h"
|
||
|
|
#include "vector_string.h"
|
||
|
|
#include "textEncoder.h"
|
||
|
|
|
||
|
|
#include <assert.h>
|
||
|
|
|
||
|
|
class DSearchPath;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The name of a file, such as a texture file or an Egg file. Stores the full
|
||
|
|
* pathname, and includes functions for extracting out the directory prefix
|
||
|
|
* part and the file extension and stuff.
|
||
|
|
*
|
||
|
|
* A Filename is also aware of the mapping between the Unix-like filename
|
||
|
|
* convention we use internally, and the local OS's specific filename
|
||
|
|
* convention, and it knows how to perform basic OS-specific I/O, like testing
|
||
|
|
* for file existence and searching a searchpath, as well as the best way to
|
||
|
|
* open an fstream for reading or writing.
|
||
|
|
*/
|
||
|
|
class EXPCL_DTOOL_DTOOLUTIL Filename {
|
||
|
|
PUBLISHED:
|
||
|
|
enum Type {
|
||
|
|
// These type values must fit within the bits allocated for F_type, below.
|
||
|
|
T_general = 0x00,
|
||
|
|
T_dso = 0x01,
|
||
|
|
T_executable = 0x02,
|
||
|
|
// Perhaps other types will be added later.
|
||
|
|
};
|
||
|
|
|
||
|
|
public:
|
||
|
|
enum Flags {
|
||
|
|
F_type = 0x0f,
|
||
|
|
F_binary = 0x10,
|
||
|
|
F_text = 0x20,
|
||
|
|
F_pattern = 0x40,
|
||
|
|
};
|
||
|
|
|
||
|
|
INLINE Filename(const char *filename);
|
||
|
|
INLINE Filename(const std::string &filename);
|
||
|
|
INLINE Filename(const std::wstring &filename);
|
||
|
|
INLINE Filename(const Filename ©);
|
||
|
|
INLINE Filename(std::string &&filename) noexcept;
|
||
|
|
INLINE Filename(Filename &&from) noexcept;
|
||
|
|
|
||
|
|
PUBLISHED:
|
||
|
|
INLINE Filename();
|
||
|
|
Filename(const Filename &dirname, const Filename &basename);
|
||
|
|
|
||
|
|
#ifdef HAVE_PYTHON
|
||
|
|
EXTENSION(Filename(PyObject *path));
|
||
|
|
|
||
|
|
EXTENSION(PyObject *__reduce__(PyObject *self) const);
|
||
|
|
#endif
|
||
|
|
|
||
|
|
// Static constructors to explicitly create a filename that refers to a text
|
||
|
|
// or binary file. This is in lieu of calling set_text() or set_binary() or
|
||
|
|
// set_type().
|
||
|
|
INLINE static Filename text_filename(const Filename &filename);
|
||
|
|
INLINE static Filename text_filename(const std::string &filename);
|
||
|
|
INLINE static Filename binary_filename(const Filename &filename);
|
||
|
|
INLINE static Filename binary_filename(const std::string &filename);
|
||
|
|
INLINE static Filename dso_filename(const std::string &filename);
|
||
|
|
INLINE static Filename executable_filename(const std::string &filename);
|
||
|
|
|
||
|
|
INLINE static Filename pattern_filename(const std::string &filename);
|
||
|
|
|
||
|
|
static Filename from_os_specific(const std::string &os_specific,
|
||
|
|
Type type = T_general);
|
||
|
|
static Filename from_os_specific_w(const std::wstring &os_specific,
|
||
|
|
Type type = T_general);
|
||
|
|
static Filename expand_from(const std::string &user_string,
|
||
|
|
Type type = T_general);
|
||
|
|
static Filename temporary(const std::string &dirname, const std::string &prefix,
|
||
|
|
const std::string &suffix = std::string(),
|
||
|
|
Type type = T_general);
|
||
|
|
|
||
|
|
static const Filename &get_home_directory();
|
||
|
|
static const Filename &get_temp_directory();
|
||
|
|
static const Filename &get_user_appdata_directory();
|
||
|
|
static const Filename &get_common_appdata_directory();
|
||
|
|
|
||
|
|
// Assignment is via the = operator.
|
||
|
|
INLINE Filename &operator = (const std::string &filename);
|
||
|
|
INLINE Filename &operator = (const std::wstring &filename);
|
||
|
|
INLINE Filename &operator = (const char *filename);
|
||
|
|
INLINE Filename &operator = (const Filename ©);
|
||
|
|
INLINE Filename &operator = (std::string &&filename) noexcept;
|
||
|
|
INLINE Filename &operator = (Filename &&from) noexcept;
|
||
|
|
|
||
|
|
// And retrieval is by any of the classic string operations.
|
||
|
|
INLINE operator const std::string & () const;
|
||
|
|
INLINE const char *c_str() const;
|
||
|
|
INLINE bool empty() const;
|
||
|
|
INLINE size_t length() const;
|
||
|
|
INLINE char operator [] (size_t n) const;
|
||
|
|
|
||
|
|
EXTENSION(PyObject *__repr__() const);
|
||
|
|
EXTENSION(PyObject *__fspath__() const);
|
||
|
|
|
||
|
|
INLINE std::string substr(size_t begin) const;
|
||
|
|
INLINE std::string substr(size_t begin, size_t end) const;
|
||
|
|
INLINE void operator += (const std::string &other);
|
||
|
|
INLINE Filename operator + (const std::string &other) const;
|
||
|
|
|
||
|
|
INLINE Filename operator / (const Filename &other) const;
|
||
|
|
|
||
|
|
// Or, you can use any of these.
|
||
|
|
INLINE std::string get_fullpath() const;
|
||
|
|
INLINE std::wstring get_fullpath_w() const;
|
||
|
|
INLINE std::string get_dirname() const;
|
||
|
|
INLINE std::string get_basename() const;
|
||
|
|
INLINE std::string get_fullpath_wo_extension() const;
|
||
|
|
INLINE std::string get_basename_wo_extension() const;
|
||
|
|
INLINE std::string get_extension() const;
|
||
|
|
|
||
|
|
// You can also use any of these to reassign pieces of the filename.
|
||
|
|
void set_fullpath(const std::string &s);
|
||
|
|
void set_dirname(const std::string &s);
|
||
|
|
void set_basename(const std::string &s);
|
||
|
|
void set_fullpath_wo_extension(const std::string &s);
|
||
|
|
void set_basename_wo_extension(const std::string &s);
|
||
|
|
void set_extension(const std::string &s);
|
||
|
|
|
||
|
|
// Setting these flags appropriately is helpful when opening or searching
|
||
|
|
// for a file; it helps the Filename resolve OS-specific conventions (for
|
||
|
|
// instance, that dynamic library names should perhaps be changed from .so
|
||
|
|
// to .dll).
|
||
|
|
INLINE void set_binary();
|
||
|
|
INLINE void set_text();
|
||
|
|
INLINE bool is_binary() const;
|
||
|
|
INLINE bool is_text() const;
|
||
|
|
INLINE bool is_binary_or_text() const;
|
||
|
|
|
||
|
|
INLINE void set_type(Type type);
|
||
|
|
INLINE Type get_type() const;
|
||
|
|
|
||
|
|
INLINE void set_pattern(bool pattern);
|
||
|
|
INLINE bool get_pattern() const;
|
||
|
|
|
||
|
|
INLINE bool has_hash() const;
|
||
|
|
Filename get_filename_index(int index) const;
|
||
|
|
|
||
|
|
INLINE std::string get_hash_to_end() const;
|
||
|
|
void set_hash_to_end(const std::string &s);
|
||
|
|
|
||
|
|
void extract_components(vector_string &components) const;
|
||
|
|
void standardize();
|
||
|
|
|
||
|
|
// The following functions deal with the outside world.
|
||
|
|
|
||
|
|
INLINE bool is_local() const;
|
||
|
|
INLINE bool is_fully_qualified() const;
|
||
|
|
void make_absolute();
|
||
|
|
void make_absolute(const Filename &start_directory);
|
||
|
|
|
||
|
|
bool make_canonical();
|
||
|
|
bool make_true_case();
|
||
|
|
|
||
|
|
std::string to_os_specific() const;
|
||
|
|
std::wstring to_os_specific_w() const;
|
||
|
|
std::string to_os_generic() const;
|
||
|
|
std::string to_os_short_name() const;
|
||
|
|
std::string to_os_long_name() const;
|
||
|
|
|
||
|
|
bool exists() const;
|
||
|
|
bool is_regular_file() const;
|
||
|
|
bool is_writable() const;
|
||
|
|
bool is_directory() const;
|
||
|
|
bool is_executable() const;
|
||
|
|
int compare_timestamps(const Filename &other,
|
||
|
|
bool this_missing_is_old = true,
|
||
|
|
bool other_missing_is_old = true) const;
|
||
|
|
time_t get_timestamp() const;
|
||
|
|
time_t get_access_timestamp() const;
|
||
|
|
std::streamsize get_file_size() const;
|
||
|
|
|
||
|
|
bool resolve_filename(const DSearchPath &searchpath,
|
||
|
|
const std::string &default_extension = std::string());
|
||
|
|
bool make_relative_to(Filename directory, bool allow_backups = true);
|
||
|
|
int find_on_searchpath(const DSearchPath &searchpath);
|
||
|
|
|
||
|
|
bool scan_directory(vector_string &contents) const;
|
||
|
|
#ifdef HAVE_PYTHON
|
||
|
|
EXTENSION(PyObject *scan_directory() const);
|
||
|
|
#endif
|
||
|
|
|
||
|
|
bool open_read(std::ifstream &stream) const;
|
||
|
|
bool open_write(std::ofstream &stream, bool truncate = true) const;
|
||
|
|
bool open_append(std::ofstream &stream) const;
|
||
|
|
bool open_read_write(std::fstream &stream, bool truncate = false) const;
|
||
|
|
bool open_read_append(std::fstream &stream) const;
|
||
|
|
|
||
|
|
#ifdef USE_PANDAFILESTREAM
|
||
|
|
bool open_read(pifstream &stream) const;
|
||
|
|
bool open_write(pofstream &stream, bool truncate = true) const;
|
||
|
|
bool open_append(pofstream &stream) const;
|
||
|
|
bool open_read_write(pfstream &stream, bool truncate = false) const;
|
||
|
|
bool open_read_append(pfstream &stream) const;
|
||
|
|
#endif // USE_PANDAFILESTREAM
|
||
|
|
|
||
|
|
bool chdir() const;
|
||
|
|
bool touch() const;
|
||
|
|
bool unlink() const;
|
||
|
|
BLOCKING bool rename_to(const Filename &other) const;
|
||
|
|
BLOCKING bool copy_to(const Filename &other) const;
|
||
|
|
|
||
|
|
bool make_dir() const;
|
||
|
|
bool mkdir() const;
|
||
|
|
bool rmdir() const;
|
||
|
|
|
||
|
|
// Comparison operators are handy.
|
||
|
|
INLINE bool operator == (const std::string &other) const;
|
||
|
|
INLINE bool operator != (const std::string &other) const;
|
||
|
|
INLINE bool operator < (const std::string &other) const;
|
||
|
|
INLINE int compare_to(const Filename &other) const;
|
||
|
|
INLINE bool __nonzero__() const;
|
||
|
|
int get_hash() const;
|
||
|
|
|
||
|
|
INLINE void output(std::ostream &out) const;
|
||
|
|
|
||
|
|
INLINE static void set_filesystem_encoding(TextEncoder::Encoding encoding);
|
||
|
|
INLINE static TextEncoder::Encoding get_filesystem_encoding();
|
||
|
|
|
||
|
|
public:
|
||
|
|
bool atomic_compare_and_exchange_contents(std::string &orig_contents, const std::string &old_contents, const std::string &new_contents) const;
|
||
|
|
bool atomic_read_contents(std::string &contents) const;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
void locate_basename();
|
||
|
|
void locate_extension();
|
||
|
|
void locate_hash();
|
||
|
|
size_t get_common_prefix(const std::string &other) const;
|
||
|
|
static int count_slashes(const std::string &str);
|
||
|
|
bool r_make_canonical(const Filename &cwd);
|
||
|
|
|
||
|
|
std::string _filename;
|
||
|
|
// We'll make these size_t instead of string::size_type to help out
|
||
|
|
// cppParser.
|
||
|
|
size_t _dirname_end;
|
||
|
|
size_t _basename_start;
|
||
|
|
size_t _basename_end;
|
||
|
|
size_t _extension_start;
|
||
|
|
size_t _hash_start;
|
||
|
|
size_t _hash_end;
|
||
|
|
|
||
|
|
int _flags;
|
||
|
|
|
||
|
|
static TextEncoder::Encoding _filesystem_encoding;
|
||
|
|
static TVOLATILE AtomicAdjust::Pointer _home_directory;
|
||
|
|
static TVOLATILE AtomicAdjust::Pointer _temp_directory;
|
||
|
|
static TVOLATILE AtomicAdjust::Pointer _user_appdata_directory;
|
||
|
|
static TVOLATILE AtomicAdjust::Pointer _common_appdata_directory;
|
||
|
|
|
||
|
|
#ifdef ANDROID
|
||
|
|
public:
|
||
|
|
static std::string _internal_data_dir;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
public:
|
||
|
|
static TypeHandle get_class_type() {
|
||
|
|
return _type_handle;
|
||
|
|
}
|
||
|
|
static void init_type() {
|
||
|
|
register_type(_type_handle, "Filename");
|
||
|
|
}
|
||
|
|
|
||
|
|
private:
|
||
|
|
static TypeHandle _type_handle;
|
||
|
|
};
|
||
|
|
|
||
|
|
INLINE std::ostream &operator << (std::ostream &out, const Filename &n) {
|
||
|
|
n.output(out);
|
||
|
|
return out;
|
||
|
|
}
|
||
|
|
|
||
|
|
#include "filename.I"
|
||
|
|
|
||
|
|
#endif
|