Qore Programming Language 1.19.5
Loading...
Searching...
No Matches
FileOutputStream.h
1/* -*- mode: c++; indent-tabs-mode: nil -*- */
2/*
3 FileOutputStream.h
4
5 Qore Programming Language
6
7 Copyright (C) 2016 - 2023 Qore Technologies, s.r.o.
8
9 Permission is hereby granted, free of charge, to any person obtaining a
10 copy of this software and associated documentation files (the "Software"),
11 to deal in the Software without restriction, including without limitation
12 the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 and/or sell copies of the Software, and to permit persons to whom the
14 Software is furnished to do so, subject to the following conditions:
15
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 DEALINGS IN THE SOFTWARE.
26
27 Note that the Qore library is released under a choice of three open-source
28 licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29 information.
30*/
31
32#ifndef _QORE_FILEOUTPUTSTREAM_H
33#define _QORE_FILEOUTPUTSTREAM_H
34
35#include <stdint.h>
36#include "qore/OutputStream.h"
37
42
43public:
44 DLLLOCAL FileOutputStream(const QoreStringNode *fileName, bool append, int mode, const QoreEncoding* encoding, ExceptionSink *xsink) {
45 f.open2(xsink, fileName->getBuffer(), O_WRONLY | (append ? O_APPEND : O_TRUNC) | O_CREAT, mode, encoding);
46 }
47
48 DLLLOCAL FileOutputStream(int fd) {
49 f.makeSpecial(fd);
50 }
51
52 DLLLOCAL const char *getName() override {
53 return "FileOutputStream";
54 }
55
56 DLLLOCAL bool isClosed() override {
57 return !f.isOpen();
58 }
59
60 DLLLOCAL void close(ExceptionSink* xsink) override {
61 assert(!isClosed());
62 int rc = f.close();
63 if (rc) {
64 xsink->raiseException("FILE-CLOSE-ERROR", "Error %d closing file", rc);
65 }
66 }
67
68 DLLLOCAL void write(const void *ptr, int64 count, ExceptionSink *xsink) override {
69 assert(!isClosed());
70 assert(count >= 0);
71 if (f.write(ptr, count, xsink) != count) {
72 xsink->raiseException("FILE-WRITE-ERROR", "Error writing to file");
73 }
74 }
75
76 DLLLOCAL const QoreEncoding* getEncoding() const { return f.getEncoding(); }
77
78private:
79 QoreFile f;
80};
81
82#endif // _QORE_FILEOUTPUTSTREAM_H
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:50
DLLEXPORT AbstractQoreNode * raiseException(const char *err, const char *fmt,...)
appends a Qore-language exception to the list
Private data for the Qore::FileOutputStream class.
Definition: FileOutputStream.h:41
DLLLOCAL void write(const void *ptr, int64 count, ExceptionSink *xsink) override
Writes bytes to the output stream.
Definition: FileOutputStream.h:68
DLLLOCAL void close(ExceptionSink *xsink) override
Flushes any buffered (unwritten) bytes, closes the output stream and releases resources.
Definition: FileOutputStream.h:60
DLLLOCAL const char * getName() override
Returns the name of the class.
Definition: FileOutputStream.h:52
DLLLOCAL bool isClosed() override
Returns true is the stream has been closed.
Definition: FileOutputStream.h:56
Interface for private data of output streams.
Definition: OutputStream.h:44
defines string encoding functions in Qore
Definition: QoreEncoding.h:83
provides controlled access to file data through Qore data structures
Definition: QoreFile.h:66
DLLEXPORT int close()
closes the file
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 const QoreEncoding * getEncoding() const
returns the encoding used for the file
DLLEXPORT bool isOpen() const
returns true if the file is open, false if not
DLLEXPORT int write(const QoreString *str, ExceptionSink *xsink)
writes string data to the file, character encoding is converted if necessary, and returns the number ...
DLLEXPORT const char * getBuffer() const
returns the string's buffer; this data should not be changed
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
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:260