1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-runtime-lib
* Created on: 18 мар. 2019 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_IO_DIR_H_
#define LSP_PLUG_IN_IO_DIR_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/io/File.h>
#ifndef PATH_MAX
#define PATH_MAX 1024
#endif
#ifndef PLATFORM_WINDOWS
#include <dirent.h>
#endif /* PLATFORM_WINDOWS */
namespace lsp
{
namespace io
{
#ifdef PLATFORM_WINDOWS
struct dirhandle_t;
#else
typedef DIR dirhandle_t;
#endif /* PLATFORM_WINDOWS */
class Dir
{
private:
Dir & operator = (const Dir &);
Dir(const Dir &);
protected:
status_t nErrorCode;
Path sPath;
dirhandle_t *hDir;
protected:
inline status_t set_error(status_t error) { return nErrorCode = error; }
public:
explicit Dir();
virtual ~Dir();
public:
/**
* Open directory
* @param path path to directory in UTF-8 encoding
* @return status of operation
*/
status_t open(const char *path);
/**
* Open directory
* @param path path to directory
* @return status of operation
*/
status_t open(const LSPString *path);
/**
* Open directory
* @param path path to directory
* @return status of operation
*/
status_t open(const Path *path);
/**
* Seek directory to it's beginning
* @return status of operation
*/
status_t rewind();
/**
* Read the record from directory
* @param path pointer to string to store new record
* @param full retrieve full path instead of relative
* @return status of operation
*/
status_t read(LSPString *path, bool full = false);
/**
* Read the record from directory
* @param path pointer to string to store new record
* @param full retrieve full path instead of relative
* @return status of operation
*/
status_t read(Path *path, bool full = false);
/**
* Read and stat the record from directory
* @param path pointer to string to store new record
* @param full retrieve full path instead of relative
* @return status of operation
*/
status_t reads(LSPString *path, fattr_t *attr, bool full = false);
/**
* Read and stat the record from directory
* @param path pointer to string to store new record
* @param full retrieve full path instead of relative
* @return status of operation
*/
status_t reads(Path *path, fattr_t *attr, bool full = false);
/**
* Close current directory
* @return status of operation
*/
status_t close();
/**
* Return last error code
* @return last error code
*/
inline status_t last_error() const { return nErrorCode; };
/**
* Return true if last read operations reached end of file
* @return true if last read operations reached end of file
*/
inline bool eof() const { return nErrorCode == STATUS_EOF; };
/**
* Get path associated with directory
* @param dst pointer to path to store value
* @return status of operation
*/
inline status_t get_path(Path *dst) const { return (dst != NULL) ? dst->set(&sPath) : STATUS_BAD_ARGUMENTS; }
/**
* Get path associated with directory
* @param dst pointer to path to store value
* @return status of operation
*/
inline status_t get_path(LSPString *dst) const { return (dst != NULL) ? dst->set(sPath.as_string()) : STATUS_BAD_ARGUMENTS; }
/**
* Get path associated with directory
* @return pointer to UTF-8 string or NULL
*/
inline const char *get_path() const { return sPath.as_string()->get_utf8(); }
/**
* Obtain file information, do not follow symlinks
* @param path UTF-8 encoded path to file
* @param attr structure to return file attributes
* @return status of operation
*/
status_t stat(const char *path, fattr_t *attr);
/**
* Obtain file information, do not follow symlinks
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
status_t stat(const LSPString *path, fattr_t *attr);
/**
* Obtain file information, do not follow symlinks
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
status_t stat(const Path *path, fattr_t *attr);
/**
* Obtain file information, follow symlinks
* @param path UTF-8 encoded path to file
* @param attr structure to return file attributes
* @return status of operation
*/
status_t sym_stat(const char *path, fattr_t *attr);
/**
* Obtain file information, follow symlinks
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
status_t sym_stat(const LSPString *path, fattr_t *attr);
/**
* Obtain file information, follow symlinks
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
status_t sym_stat(const Path *path, fattr_t *attr);
/**
* Create directory
* @param path path to the directory
* @return status of operation
*/
static status_t create(const char *path);
/**
* Create directory
* @param path path to the directory
* @return status of operation
*/
static status_t create(const LSPString *path);
/**
* Create directory
* @param path path to the directory
* @return status of operation
*/
static status_t create(const Path *path);
/**
* Delete directory
* @param path path to directory
* @return status of operation
*/
static status_t remove(const char *path);
/**
* Delete directory
* @param path path to directory
* @return status of operation
*/
static status_t remove(const LSPString *path);
/**
* Delete directory
* @param path path to directory
* @return status of operation
*/
static status_t remove(const Path *path);
/**
* Delete directory
* @param path path to directory
* @return status of operation
*/
static status_t get_current(LSPString *path);
/**
* Delete directory
* @param path path to directory
* @return status of operation
*/
static status_t get_current(Path *path);
};
} /* namespace io */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IO_DIR_H_ */
|