QoreFile.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreFile.h
 
    thread-safe File object
 
    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_QOREFILE_H
 
#define _QORE_QOREFILE_H
 
#include <qore/AbstractPollableIoObjectBase.h>
 
#include <fcntl.h>
#include <string>
#include <sys/file.h>
#include <unistd.h>
 
/*
  getchar from stdio.h(included via string on some platforms)
  is allowed to be defined as a macro and this can cause
  problems here since the getchar mentioned in this file might
  get replaced, so we undefine it if it is defined.
  Undefining getchar is safe since getchar must be defined as
  a function, so the function is used if the macro is not available.
 */
#ifdef getchar
#undef getchar
#endif
 
class QoreTermIOS;
class Queue;
 
 
class QoreFile {
public:
    DLLEXPORT QoreFile(const QoreEncoding *cs = QCS_DEFAULT);
 
    DLLEXPORT ~QoreFile();
 
 
    DLLEXPORT int getPollableDescriptor() const;
 
 
    DLLEXPORT int open(const char *fn, int flags = O_RDONLY, int mode = 0777, const QoreEncoding *cs = QCS_DEFAULT);
 
 
    DLLEXPORT int open2(ExceptionSink *xsink, const char *fn, int flags = O_RDONLY, int mode = 0777, const QoreEncoding *cs = QCS_DEFAULT);
 
 
    DLLEXPORT int close();
 
    DLLEXPORT void setEncoding(const QoreEncoding *cs);
 
    DLLEXPORT const QoreEncoding *getEncoding() const;
 
    DLLEXPORT int sync();
 
 
    DLLEXPORT QoreStringNode* readLine(ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* readLine(bool incl_eol, ExceptionSink* xsink);
 
 
    DLLEXPORT int readLine(QoreString &str);
 
 
    DLLEXPORT int readLine(QoreString &str, bool incl_eol);
 
 
    DLLEXPORT QoreStringNode* readUntil(const char* bytes, bool incl_bytes, ExceptionSink* xsink);
 
 
    DLLEXPORT int readUntil(char byte, QoreString& str, bool incl_bytes = true);
 
 
    DLLEXPORT int readUntil(const char* bytes, QoreString& str, bool incl_bytes = true);
 
 
    DLLEXPORT int write(const QoreString *str, ExceptionSink *xsink);
 
 
    DLLEXPORT int write(const BinaryNode *b, ExceptionSink *xsink);
 
 
    DLLEXPORT int write(const void *data, size_t len, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei1(char i, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei2(short i, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei4(int i, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei8(int64 i, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei2LSB(short i, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei4LSB(int i, ExceptionSink *xsink);
 
 
    DLLEXPORT int writei8LSB(int64 i, ExceptionSink *xsink);
 
 
    DLLEXPORT int readu1(unsigned char *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readu2(unsigned short *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readu4(unsigned int *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readu2LSB(unsigned short *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readu4LSB(unsigned int *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi1(char *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi2(short *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi4(int *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi8(int64 *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi2LSB(short *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi4LSB(int *val, ExceptionSink *xsink);
 
 
    DLLEXPORT int readi8LSB(int64 *val, ExceptionSink *xsink);
 
 
    DLLEXPORT QoreStringNode *read(qore_offset_t size, ExceptionSink *xsink);
 
 
    DLLEXPORT QoreStringNode* read(qore_offset_t size, int timeout_ms, ExceptionSink *xsink);
 
 
    DLLEXPORT int read(QoreString &str, qore_offset_t size, ExceptionSink *xsink);
 
 
    DLLEXPORT BinaryNode *readBinary(qore_offset_t size, ExceptionSink *xsink);
 
 
    DLLEXPORT int readBinary(BinaryNode &b, qore_offset_t size, ExceptionSink *xsink);
 
 
    DLLEXPORT BinaryNode *readBinary(qore_offset_t size, int timeout_ms, ExceptionSink *xsink);
 
 
    DLLEXPORT size_t read(void *ptr, size_t limit, int timeout_ms, ExceptionSink *xsink);
 
 
    DLLEXPORT size_t setPos(size_t pos);
 
 
    DLLEXPORT size_t getPos();
 
 
    DLLEXPORT size_t getPos() const;
 
 
    DLLEXPORT QoreStringNode *getchar();
 
 
    DLLEXPORT QoreStringNode *getchar(ExceptionSink *xsink);
 
    DLLEXPORT std::string getFileNameStr() const;
 
    DLLEXPORT QoreStringNode* getFileName() const;
 
#ifndef _Q_WINDOWS
    DLLEXPORT int chown(uid_t owner, gid_t group, ExceptionSink *xsink);
 
    DLLEXPORT int lockBlocking(struct flock &fl, ExceptionSink *xsink);
 
    DLLEXPORT int lock(const struct flock &fl, ExceptionSink *xsink);
 
    DLLEXPORT int getLockInfo(struct flock &fl, ExceptionSink *xsink);
#endif
 
 
    DLLEXPORT bool isDataAvailable(int timeout_ms, ExceptionSink *xsink) const;
 
 
    DLLEXPORT QoreListNode *stat(ExceptionSink *xsink) const;
 
 
    DLLEXPORT QoreHashNode *hstat(ExceptionSink *xsink) const;
 
 
    DLLEXPORT QoreHashNode *statvfs(ExceptionSink *xsink) const;
 
 
    DLLEXPORT int redirect(QoreFile& file, ExceptionSink* xsink);
 
 
    DLLEXPORT int getFD() const;
 
    DLLEXPORT bool isOpen() const;
 
    DLLEXPORT bool isTty() const;
 
 
    DLLEXPORT int detachFd();
 
    DLLLOCAL int setTerminalAttributes(int action, QoreTermIOS *ios, ExceptionSink *xsink) const;
 
    DLLLOCAL int getTerminalAttributes(QoreTermIOS *ios, ExceptionSink *xsink) const;
 
    // NOTE: QoreFile::makeSpecial() can only be called right after the constructor (private API)
    DLLLOCAL void makeSpecial(int sfd);
 
    DLLLOCAL void setEventQueue(ExceptionSink* xsink, Queue* q, QoreValue arg, bool with_data);
 
    DLLLOCAL void cleanup(ExceptionSink *xsink);
 
protected:
    hashdecl qore_qf_private *priv;
 
    DLLLOCAL QoreFile(const QoreFile&);
 
    DLLLOCAL QoreFile& operator=(const QoreFile&);
};
 
DLLEXPORT extern qore_classid_t CID_FILE;
DLLEXPORT extern QoreClass* QC_FILE;
DLLEXPORT extern QoreClass* QC_READONLYFILE;
 
class File : public AbstractPollableIoObjectBase, public QoreFile {
protected:
    DLLLOCAL virtual ~File();
 
public:
    DLLLOCAL File(const QoreEncoding* cs);
    DLLLOCAL virtual void deref(ExceptionSink* xsink);
    DLLLOCAL virtual void deref();
 
 
    DLLLOCAL int getPollableDescriptor() const {
        return QoreFile::getPollableDescriptor();
    }
};
 
class QoreFileHelper : QorePrivateObjectAccessHelper {
public:
    DLLEXPORT QoreFileHelper(QoreObject* obj, ExceptionSink* xsink);
    DLLEXPORT ~QoreFileHelper();
    DLLEXPORT QoreFile* operator*() const;
    DLLEXPORT QoreFile* operator->() const;
};
 
#endif  // _QORE_QOREFILE_H