File: IOutSequence.h

package info (click to toggle)
lsp-plugins 1.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 91,856 kB
  • sloc: cpp: 427,831; xml: 57,779; makefile: 9,961; php: 1,005; sh: 18
file content (174 lines) | stat: -rw-r--r-- 6,593 bytes parent folder | download
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
/*
 * 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: 14 июн. 2018 г.
 *
 * 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_IOUTSEQUENCE_H_
#define LSP_PLUG_IN_IO_IOUTSEQUENCE_H_

#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>

namespace lsp
{
    namespace io
    {
        class IOutSequence
        {
            protected:
                status_t        nErrorCode;

            protected:
                inline status_t set_error(status_t error) { return nErrorCode = error; }

            private:
                IOutSequence & operator = (const IOutSequence &);

            public:
                explicit IOutSequence();
                virtual ~IOutSequence();

            public:
                /**
                 * Return last error code
                 * @return last error code
                 */
                inline status_t last_error() const  { return nErrorCode; };

                /**
                 * Write single character to output stream
                 * @param c character to write
                 * @return status of operation
                 */
                virtual status_t    write(lsp_wchar_t c);

                /**
                 * Write single character to output stream and trailing end-of-line
                 * @param c character to write
                 * @return status of operation
                 */
                virtual status_t    writeln(lsp_wchar_t c);

                /**
                 * Write multiple characters to output stream
                 * @param c array of characters to write
                 * @param count number of characters to write
                 * @return status of operation
                 */
                virtual status_t    write(const lsp_wchar_t *c, size_t count);

                /**
                 * Write multiple characters to output stream and end-of-line
                 * @param c array of characters to write
                 * @param count number of characters to write
                 * @return status of operation
                 */
                virtual status_t    writeln(const lsp_wchar_t *c, size_t count);
    
                /**
                 * Write null-terminated ASCII string to output
                 * @param s ASCII string to write
                 * @param count number of characters to write
                 * @return status of operation
                 */
                virtual status_t    write_ascii(const char *s);

                /**
                 * Write ASCII character sequence to output
                 * @param s ASCII string to write
                 * @param count number of characters to write
                 * @return status of operation
                 */
                virtual status_t    write_ascii(const char *s, size_t count);

                /**
                 * Write zero-terminated ASCII string to output and end-of-line
                 * @param s ASCII string to write
                 * @param count number of characters to write
                 * @return status of operation
                 */
                virtual status_t    writeln_ascii(const char *s);

                /**
                 * Write string to output stream
                 * @param s string to write
                 * @return status of operation
                 */
                virtual status_t    write(const LSPString *s);

                /**
                 * Write string to output stream and end-of-line
                 * @param s string to write
                 * @return status of operation
                 */
                virtual status_t    writeln(const LSPString *s);

                /**
                 * Write substring to output stream
                 * @param s string to write
                 * @param first index of first character to write substring from
                 * @return status of operation
                 */
                virtual status_t    write(const LSPString *s, ssize_t first);

                /**
                 * Write substring to output stream and end-of-line
                 * @param s string to write
                 * @param first index of first character to write substring from
                 * @return status of operation
                 */
                virtual status_t    writeln(const LSPString *s, ssize_t first);

                /**
                 * Write substring to output stream
                 * @param s string to write
                 * @param first index of first character to write substring from
                 * @param last index of last character to write substring
                 * @return status of operation
                 */
                virtual status_t    write(const LSPString *s, ssize_t first, ssize_t last);

                /**
                 * Write substring to output stream and end-of-line
                 * @param s string to write
                 * @param first index of first character to write substring from
                 * @param last index of last character to write substring
                 * @return status of operation
                 */
                virtual status_t    writeln(const LSPString *s, ssize_t first, ssize_t last);

                /**
                 * Flush all underlying buffers
                 * @return status of operation
                 */
                virtual status_t    flush();

                /**
                 * Close character output stream
                 * @return status of operation
                 */
                virtual status_t    close();
        };
    }

} /* namespace lsp */

#endif /* LSP_PLUG_IN_IO_IOUTSEQUENCE_H_ */