QoreDir.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreDir.h
 
    thread-safe Directory object with a private implementation
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 
    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/
 
#ifndef _QORE_QOREDIR_H
 
#define _QORE_QOREDIR_H
 
#include <dirent.h>
#include <string>
#include <vector>
 
#ifndef HAVE_DIRENT_D_TYPE
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#endif
 
 
class QoreDir {
public:
 
    DLLEXPORT QoreDir(ExceptionSink* xsink, const QoreEncoding* cs = QCS_DEFAULT, const char* dir = nullptr);
 
 
    DLLEXPORT QoreDir(ExceptionSink* xsink, const QoreDir& old);
 
    DLLEXPORT ~QoreDir();
 
 
    DLLEXPORT static bool file_exists(const QoreString& filePath);
 
 
    DLLEXPORT static bool folder_exists(const QoreString& folderPath, ExceptionSink& xsink, const QoreEncoding* cs = QCS_DEFAULT);
 
 
    DLLEXPORT static std::string get_file_content(const QoreString& fullPath);
 
 
    DLLEXPORT static QoreListNode* get_files(const QoreString& path, ExceptionSink& xsink, QoreString* regex = nullptr, const QoreEncoding* cs = QCS_DEFAULT);
 
 
    DLLEXPORT int chdir(const char* dir, ExceptionSink* xsink);
 
 
    DLLEXPORT int chdir(const char* dir);
 
 
    DLLEXPORT int mkdir(ExceptionSink* xsink, const char* subdir, int mode = 0777) const;
 
 
    DLLEXPORT int rmdir(const char* subdir, ExceptionSink* xsink) const;
 
 
    DLLEXPORT int chmod(int mode, ExceptionSink* xsink) const;
 
#ifdef HAVE_PWD_H
 
    DLLEXPORT int chown(uid_t uid, gid_t gid, ExceptionSink* xsink) const;
#endif
 
 
    DLLEXPORT int create(int mode, ExceptionSink* xsink) const;
 
 
    DLLEXPORT int create(int mode) const;
 
 
    DLLEXPORT int checkPath() const;
 
 
    DLLEXPORT QoreStringNode* dirname() const;
 
 
    DLLEXPORT std::string getPath(const char* sub) const;
 
 
    DLLEXPORT const QoreEncoding* getEncoding() const;
 
 
    DLLEXPORT QoreFile openFile(ExceptionSink* xsink, const char* fn, int flags = O_RDONLY, int mode = 0777, const QoreEncoding* cs = QCS_DEFAULT);
 
 
    DLLEXPORT QoreListNode* list(ExceptionSink* xsink, int stat_filter, const QoreString* regex = nullptr, int regex_options = 0, bool full = false) const;
 
 
    DLLEXPORT QoreListNode* stat(ExceptionSink* xsink) const;
 
 
    DLLEXPORT QoreHashNode* hstat(ExceptionSink* xsink) const;
 
 
    DLLEXPORT QoreHashNode* statvfs(ExceptionSink* xsink) const;
 
private:
    class qore_qd_private *priv;
 
    DLLLOCAL QoreDir(const QoreDir&);
 
    DLLLOCAL QoreDir& operator=(const QoreDir&);
};
 
#endif  // _QORE_QOREDIR_H