Qore Programming Language - C/C++ Library  0.8.12.3
QoreFile.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreFile.h
4 
5  thread-safe File object
6 
7  Qore Programming Language
8 
9  Copyright (C) 2003 - 2016 David Nichols
10 
11  Permission is hereby granted, free of charge, to any person obtaining a
12  copy of this software and associated documentation files (the "Software"),
13  to deal in the Software without restriction, including without limitation
14  the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  and/or sell copies of the Software, and to permit persons to whom the
16  Software is furnished to do so, subject to the following conditions:
17 
18  The above copyright notice and this permission notice shall be included in
19  all copies or substantial portions of the Software.
20 
21  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  DEALINGS IN THE SOFTWARE.
28 
29  Note that the Qore library is released under a choice of three open-source
30  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
31  information.
32 */
33 
34 #ifndef _QORE_QOREFILE_H
35 
36 #define _QORE_QOREFILE_H
37 
38 #include <fcntl.h>
39 
40 #include <sys/file.h>
41 #include <unistd.h>
42 
43 #include <string>
44 
45 /*
46  getchar from stdio.h(included via string on some platforms)
47  is allowed to be defined as a macro and this can cause
48  problems here since the getchar mentioned in this file might
49  get replaced, so we undefine it if it is defined.
50  Undefining getchar is safe since getchar must be defined as
51  a function, so the function is used if the macro is not available.
52  */
53 #ifdef getchar
54 #undef getchar
55 #endif
56 
57 class QoreTermIOS;
58 class Queue;
59 
61 
66 class QoreFile {
67 protected:
69  struct qore_qf_private *priv;
70 
72  DLLLOCAL QoreFile(const QoreFile&);
73 
75  DLLLOCAL QoreFile& operator=(const QoreFile&);
76 
77 public:
79  DLLEXPORT QoreFile(const QoreEncoding *cs = QCS_DEFAULT);
80 
82  DLLEXPORT ~QoreFile();
83 
85 
94  DLLEXPORT int open(const char *fn, int flags = O_RDONLY, int mode = 0777, const QoreEncoding *cs = QCS_DEFAULT);
95 
97 
107  DLLEXPORT int open2(ExceptionSink *xsink, const char *fn, int flags = O_RDONLY, int mode = 0777, const QoreEncoding *cs = QCS_DEFAULT);
108 
110 
113  DLLEXPORT int close();
114 
116  DLLEXPORT void setEncoding(const QoreEncoding *cs);
117 
119  DLLEXPORT const QoreEncoding *getEncoding() const;
120 
122  DLLEXPORT int sync();
123 
125 
132  DLLEXPORT QoreStringNode* readLine(ExceptionSink* xsink);
133 
135 
144  DLLEXPORT QoreStringNode* readLine(bool incl_eol, ExceptionSink* xsink);
145 
147 
155  DLLEXPORT int readLine(QoreString &str);
156 
158 
167  DLLEXPORT int readLine(QoreString &str, bool incl_eol);
168 
170 
180  DLLEXPORT QoreStringNode* readUntil(const char* bytes, bool incl_bytes, ExceptionSink* xsink);
181 
183 
193  DLLEXPORT int readUntil(char byte, QoreString& str, bool incl_bytes = true);
194 
196 
205  DLLEXPORT int readUntil(const char* bytes, QoreString& str, bool incl_bytes = true);
206 
208 
213  DLLEXPORT int write(const QoreString *str, ExceptionSink *xsink);
214 
216 
221  DLLEXPORT int write(const BinaryNode *b, ExceptionSink *xsink);
222 
224 
230  DLLEXPORT int write(const void *data, qore_size_t len, ExceptionSink *xsink);
231 
233 
238  DLLEXPORT int writei1(char i, ExceptionSink *xsink);
239 
241 
247  DLLEXPORT int writei2(short i, ExceptionSink *xsink);
248 
250 
256  DLLEXPORT int writei4(int i, ExceptionSink *xsink);
257 
259 
265  DLLEXPORT int writei8(int64 i, ExceptionSink *xsink);
266 
268 
274  DLLEXPORT int writei2LSB(short i, ExceptionSink *xsink);
275 
277 
283  DLLEXPORT int writei4LSB(int i, ExceptionSink *xsink);
284 
286 
292  DLLEXPORT int writei8LSB(int64 i, ExceptionSink *xsink);
293 
295 
301  DLLEXPORT int readu1(unsigned char *val, ExceptionSink *xsink);
302 
304 
312  DLLEXPORT int readu2(unsigned short *val, ExceptionSink *xsink);
313 
315 
323  DLLEXPORT int readu4(unsigned int *val, ExceptionSink *xsink);
324 
326 
334  DLLEXPORT int readu2LSB(unsigned short *val, ExceptionSink *xsink);
335 
337 
345  DLLEXPORT int readu4LSB(unsigned int *val, ExceptionSink *xsink);
346 
348 
354  DLLEXPORT int readi1(char *val, ExceptionSink *xsink);
355 
357 
365  DLLEXPORT int readi2(short *val, ExceptionSink *xsink);
366 
368 
376  DLLEXPORT int readi4(int *val, ExceptionSink *xsink);
377 
379 
385  DLLEXPORT int readi8(int64 *val, ExceptionSink *xsink);
386 
388 
396  DLLEXPORT int readi2LSB(short *val, ExceptionSink *xsink);
397 
399 
407  DLLEXPORT int readi4LSB(int *val, ExceptionSink *xsink);
408 
410 
416  DLLEXPORT int readi8LSB(int64 *val, ExceptionSink *xsink);
417 
419 
427  DLLEXPORT QoreStringNode *read(qore_offset_t size, ExceptionSink *xsink);
428 
430 
437  DLLEXPORT int read(QoreString &str, qore_offset_t size, ExceptionSink *xsink);
438 
440 
446  DLLEXPORT BinaryNode *readBinary(qore_offset_t size, ExceptionSink *xsink);
447 
449 
455  DLLEXPORT int readBinary(BinaryNode &b, qore_offset_t size, ExceptionSink *xsink);
456 
458 
465  DLLEXPORT QoreStringNode *read(qore_offset_t size, int timeout_ms, ExceptionSink *xsink);
466 
468 
474  DLLEXPORT BinaryNode *readBinary(qore_offset_t size, int timeout_ms, ExceptionSink *xsink);
475 
477 
479  DLLEXPORT qore_size_t setPos(qore_size_t pos);
480 
482 
485  DLLEXPORT qore_size_t getPos();
486 
488 
490  DLLEXPORT qore_size_t getPos() const;
491 
493 
496  DLLEXPORT QoreStringNode *getchar();
497 
499 
504  DLLEXPORT QoreStringNode *getchar(ExceptionSink *xsink);
505 
507  DLLEXPORT std::string getFileNameStr() const;
508 
510  DLLEXPORT QoreStringNode* getFileName() const;
511 
512 #ifndef _Q_WINDOWS
513  DLLEXPORT int chown(uid_t owner, gid_t group, ExceptionSink *xsink);
515 
517  DLLEXPORT int lockBlocking(struct flock &fl, ExceptionSink *xsink);
518 
520  DLLEXPORT int lock(const struct flock &fl, ExceptionSink *xsink);
521 
523  DLLEXPORT int getLockInfo(struct flock &fl, ExceptionSink *xsink);
524 #endif
525 
527 
531  DLLEXPORT bool isDataAvailable(int timeout_ms, ExceptionSink *xsink) const;
532 
534 
537  DLLEXPORT QoreListNode *stat(ExceptionSink *xsink) const;
538 
540 
543  DLLEXPORT QoreHashNode *hstat(ExceptionSink *xsink) const;
544 
546 
549  DLLEXPORT QoreHashNode *statvfs(ExceptionSink *xsink) const;
550 
551 #if 0
552  DLLEXPORT int preallocate(fstore_t &fs, ExceptionSink *xsink);
554 #endif
555 
557  DLLEXPORT int getFD() const;
558 
560  DLLEXPORT bool isOpen() const;
561 
563  DLLEXPORT bool isTty() const;
564 
566  DLLLOCAL int setTerminalAttributes(int action, QoreTermIOS *ios, ExceptionSink *xsink) const;
567 
569  DLLLOCAL int getTerminalAttributes(QoreTermIOS *ios, ExceptionSink *xsink) const;
570 
571  // NOTE: QoreFile::makeSpecial() can only be called right after the constructor (private API)
572  DLLLOCAL void makeSpecial(int sfd);
573 
575  DLLLOCAL void setEventQueue(Queue *cbq, ExceptionSink *xsink);
576 
578  DLLLOCAL void cleanup(ExceptionSink *xsink);
579 };
580 
581 class QoreFileHelper : QorePrivateObjectAccessHelper {
582 public:
583  DLLEXPORT QoreFileHelper(QoreObject* obj, ExceptionSink* xsink);
584  DLLEXPORT ~QoreFileHelper();
585  DLLEXPORT QoreFile* operator*() const;
586  DLLEXPORT QoreFile* operator->() const;
587 };
588 
589 #endif // _QORE_QOREFILE_H
DLLEXPORT int writei2LSB(short i, ExceptionSink *xsink)
writes 2-byte (16bit) binary integer data in LSB (Least Significant Byte first, little endian) format...
DLLEXPORT int readi2LSB(short *val, ExceptionSink *xsink)
reads a 2-byte signed integer from the file in LSB (Least Significant Byte first, big endian) format ...
DLLEXPORT QoreStringNode * getFileName() const
returns the filename of the file being read (NULL if no file name is set); caller owns the reference ...
defines string encoding functions in Qore
Definition: QoreEncoding.h:85
DLLEXPORT int lock(const struct flock &fl, ExceptionSink *xsink)
perform a file lock operation, does not block
DLLEXPORT int writei8LSB(int64 i, ExceptionSink *xsink)
writes 8-byte (64bit) binary integer data in LSB (Least Significant Byte first, little endian) format...
DLLEXPORT int writei4LSB(int i, ExceptionSink *xsink)
writes 4-byte (32bit) binary integer data in LSB (Least Significant Byte first, little endian)format ...
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:49
DLLEXPORT qore_size_t setPos(qore_size_t pos)
sets the absolute file position to "pos"
DLLEXPORT QoreStringNode * readUntil(const char *bytes, bool incl_bytes, ExceptionSink *xsink)
reads string data from the file up to and optionally including the terminating EOL characters passed ...
DLLLOCAL QoreFile & operator=(const QoreFile &)
this function is not implemented; it is here as a private function in order to prohibit it from being...
DLLEXPORT int writei1(char i, ExceptionSink *xsink)
writes 1-byte binary integer data to the file and returns the number of bytes written (normally 1) ...
DLLEXPORT const QoreEncoding * QCS_DEFAULT
the default encoding for the Qore library
DLLEXPORT int readi4(int *val, ExceptionSink *xsink)
reads a 4-byte signed integer from the file in MSB (Most Significant Byte first, big endian) format a...
DLLEXPORT QoreListNode * stat(ExceptionSink *xsink) const
returns a QoreListNode with file status information
DLLEXPORT int writei2(short i, ExceptionSink *xsink)
writes 2-byte (16bit) binary integer data in MSB (Most Significant Byte first, big endian) format to ...
DLLEXPORT int readi8LSB(int64 *val, ExceptionSink *xsink)
reads an 8-byte signed integer from the file in LSB (Least Significant Byte first, big endian) format and returns the value read as an output parameter
DLLLOCAL QoreFile(const QoreFile &)
this function is not implemented; it is here as a private function in order to prohibit it from being...
DLLEXPORT int chown(uid_t owner, gid_t group, ExceptionSink *xsink)
changes ownership of the file (if possible)
DLLEXPORT int readu2(unsigned short *val, ExceptionSink *xsink)
reads a 2-byte unsigned integer from the file in MSB (Most Significant Byte first, big endian) format and returns the value read as an output parameter
size_t qore_size_t
used for sizes (same range as a pointer)
Definition: common.h:71
DLLEXPORT int readi4LSB(int *val, ExceptionSink *xsink)
reads a 4-byte signed integer from the file in LSB (Least Significant Byte first, big endian) format ...
DLLEXPORT bool isOpen() const
returns true if the file is open, false if not
DLLEXPORT int getFD() const
get file descriptor
Qore's string type supported by the QoreEncoding class.
Definition: QoreString.h:82
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
DLLEXPORT int readi1(char *val, ExceptionSink *xsink)
reads a 1-byte signed integer from the file and returns the value read as an output parameter ...
DLLEXPORT QoreHashNode * statvfs(ExceptionSink *xsink) const
returns a QoreHashNode with filesystem status information
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
DLLLOCAL int setTerminalAttributes(int action, QoreTermIOS *ios, ExceptionSink *xsink) const
sets terminal attributes
DLLEXPORT void setEncoding(const QoreEncoding *cs)
sets the encoding for the file
provides controlled access to file data through Qore data structures
Definition: QoreFile.h:66
DLLEXPORT QoreHashNode * hstat(ExceptionSink *xsink) const
returns a QoreHashNode with file status information
DLLEXPORT QoreStringNode * read(qore_offset_t size, ExceptionSink *xsink)
reads string data from the file and returns the string read (caller owns the reference count returned...
DLLEXPORT QoreStringNode * getchar()
reads a single byte from the file and returns it as a new string, caller owns the reference count ret...
the implementation of Qore's object data type, reference counted, dynamically-allocated only ...
Definition: QoreObject.h:64
DLLEXPORT const QoreEncoding * getEncoding() const
returns the encoding used for the file
DLLEXPORT qore_size_t getPos()
returns the absolute byte position in the file
DLLEXPORT int writei8(int64 i, ExceptionSink *xsink)
writes 8-byte (64bit) binary integer data in MSB (Most Significant Byte first, big endian) format to ...
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:43
DLLEXPORT int readu2LSB(unsigned short *val, ExceptionSink *xsink)
reads a 2-byte unsigned integer from the file in LSB (Least Significant Byte first, big endian) format and returns the value read as an output parameter
DLLEXPORT bool isDataAvailable(int timeout_ms, ExceptionSink *xsink) const
returns true if data is available for the file descriptor
long long int64
64bit integer type, cannot use int64_t here since it breaks the API on some 64-bit systems due to equ...
Definition: common.h:228
DLLEXPORT int readu1(unsigned char *val, ExceptionSink *xsink)
reads a 1-byte unsigned integer from the file and returns the value read as an output parameter ...
DLLEXPORT int write(const QoreString *str, ExceptionSink *xsink)
writes string data to the file, character encoding is converted if necessary, and returns the number ...
DLLLOCAL void setEventQueue(Queue *cbq, ExceptionSink *xsink)
sets the event queue (not part of the library's pubilc API), must be already referenced before call ...
intptr_t qore_offset_t
used for offsets that could be negative
Definition: common.h:74
DLLEXPORT QoreStringNode * readLine(ExceptionSink *xsink)
reads string data from the file up to and including the terminating EOL characters (can be "\n"...
DLLEXPORT ~QoreFile()
closes the file and frees all memory allocated to the object
DLLLOCAL int getTerminalAttributes(QoreTermIOS *ios, ExceptionSink *xsink) const
gets terminal attributes
DLLEXPORT int readi2(short *val, ExceptionSink *xsink)
reads a 2-byte signed integer from the file in MSB (Most Significant Byte first, big endian) format a...
DLLEXPORT bool isTty() const
returns true if the file is a tty
struct qore_qf_private * priv
private implementation
Definition: QoreFile.h:69
DLLEXPORT int open2(ExceptionSink *xsink, const char *fn, int flags=O_RDONLY, int mode=0777, const QoreEncoding *cs=QCS_DEFAULT)
opens the file and raises a Qore-language exception if an error occurs
DLLEXPORT int getLockInfo(struct flock &fl, ExceptionSink *xsink)
get lock info operation, does not block
DLLEXPORT int lockBlocking(struct flock &fl, ExceptionSink *xsink)
perform a file lock operation
DLLEXPORT int open(const char *fn, int flags=O_RDONLY, int mode=0777, const QoreEncoding *cs=QCS_DEFAULT)
opens the file and returns 0 for success, non-zero for error
DLLEXPORT int writei4(int i, ExceptionSink *xsink)
writes 4-byte (32bit) binary integer data in MSB (Most Significant Byte first, big endian) format to ...
DLLEXPORT int sync()
flushes the write buffer to disk
DLLEXPORT int close()
closes the file
DLLEXPORT int readu4(unsigned int *val, ExceptionSink *xsink)
reads a 4-byte unsigned integer from the file in MSB (Most Significant Byte first, big endian) format and returns the value read as an output parameter
DLLEXPORT int readu4LSB(unsigned int *val, ExceptionSink *xsink)
reads a 4-byte unsigned integer from the file in LSB (Least Significant Byte first, big endian) format and returns the value read as an output parameter
DLLEXPORT int readi8(int64 *val, ExceptionSink *xsink)
reads an 8-byte signed integer from the file in MSB (Most Significant Byte first, big endian) format ...
DLLEXPORT std::string getFileNameStr() const
returns the filename of the file being read as a std::string (the string is empty if no file name is ...
DLLLOCAL void cleanup(ExceptionSink *xsink)
internal API, must be called before deleting the object if an event queue is set
holds arbitrary binary data
Definition: BinaryNode.h:41
DLLEXPORT BinaryNode * readBinary(qore_offset_t size, ExceptionSink *xsink)
reads binary data from the file and returns the data read (caller owns the reference count returned) ...