mirror of
https://github.com/bkaradzic/bx.git
synced 2026-02-18 04:53:06 +01:00
129 lines
2.7 KiB
C++
129 lines
2.7 KiB
C++
/*
|
|
* Copyright 2010-2018 Branimir Karadzic. All rights reserved.
|
|
* License: https://github.com/bkaradzic/bx#license-bsd-2-clause
|
|
*/
|
|
|
|
#ifndef BX_FILEPATH_H_HEADER_GUARD
|
|
#define BX_FILEPATH_H_HEADER_GUARD
|
|
|
|
#include "error.h"
|
|
#include "string.h"
|
|
|
|
BX_ERROR_RESULT(BX_ERROR_ACCESS, BX_MAKEFOURCC('b', 'x', 0, 0) );
|
|
BX_ERROR_RESULT(BX_ERROR_NOT_DIRECTORY, BX_MAKEFOURCC('b', 'x', 0, 1) );
|
|
|
|
namespace bx
|
|
{
|
|
const int32_t kMaxFilePath = 1024;
|
|
|
|
/// Special predefined OS directories.
|
|
///
|
|
struct Dir
|
|
{
|
|
/// Special OS directories:
|
|
enum Enum
|
|
{
|
|
Current, //!< Current directory.
|
|
Temp, //!< Temporary directory.
|
|
Home, //!< User's home directory.
|
|
|
|
Count
|
|
};
|
|
};
|
|
|
|
/// FilePath parser and helper.
|
|
///
|
|
/// /abv/gd/555/333/pod.mac
|
|
/// ppppppppppppppppbbbeeee
|
|
/// ^ ^ ^
|
|
/// +-path base-+ +-ext
|
|
/// ^^^^^^^
|
|
/// +-filename
|
|
///
|
|
class FilePath
|
|
{
|
|
public:
|
|
/// Default constructor, creates empty file path.
|
|
///
|
|
FilePath();
|
|
|
|
/// Construct file path from special OS directory.
|
|
///
|
|
FilePath(Dir::Enum _dir);
|
|
|
|
/// Construct file path from C string.
|
|
///
|
|
FilePath(const char* _str);
|
|
|
|
/// Construct file path from string.
|
|
///
|
|
FilePath(const StringView& _str);
|
|
|
|
/// Assign file path from string.
|
|
///
|
|
FilePath& operator=(const StringView& _rhs);
|
|
|
|
/// Clear file path.
|
|
///
|
|
void clear();
|
|
|
|
/// Set file path from special OS directory.
|
|
///
|
|
void set(Dir::Enum _dir);
|
|
|
|
/// Set file path.
|
|
///
|
|
void set(const StringView& _str);
|
|
|
|
/// Join directory to file path.
|
|
///
|
|
void join(const StringView& _str);
|
|
|
|
/// Returns C string to file path.
|
|
///
|
|
const char* get() const;
|
|
|
|
/// If path is `/abv/gd/555/333/pod.mac` returns `/abv/gd/555/333/`.
|
|
///
|
|
StringView getPath() const;
|
|
|
|
/// If path is `/abv/gd/555/333/pod.mac` returns `pod.mac`.
|
|
///
|
|
StringView getFileName() const;
|
|
|
|
/// If path is `/abv/gd/555/333/pod.mac` returns `pod`.
|
|
///
|
|
StringView getBaseName() const;
|
|
|
|
/// If path is `/abv/gd/555/333/pod.mac` returns `.mac`.
|
|
///
|
|
StringView getExt() const;
|
|
|
|
/// Returns true if file path is absolute.
|
|
///
|
|
bool isAbsolute() const;
|
|
|
|
/// Returns true if file path is empty.
|
|
///
|
|
bool isEmpty() const;
|
|
|
|
private:
|
|
char m_filePath[kMaxFilePath];
|
|
};
|
|
|
|
/// Creates a directory named `_filePath`.
|
|
bool make(const FilePath& _filePath, Error* _err = NULL);
|
|
|
|
/// Creates a directory named `_filePath` along with all necessary parents.
|
|
bool makeAll(const FilePath& _filePath, Error* _err = NULL);
|
|
|
|
/// Removes file or directory.
|
|
bool remove(const FilePath& _filePath, Error* _err = NULL);
|
|
|
|
/// Removes file or directory recursivelly.
|
|
bool removeAll(const FilePath& _filePath, Error* _err = NULL);
|
|
|
|
} // namespace bx
|
|
|
|
#endif // BX_FILEPATH_H_HEADER_GUARD
|