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
|
/*
* 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 нояб. 2017 г.
*
* 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_IINSTREAM_H_
#define LSP_PLUG_IN_IO_IINSTREAM_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>
namespace lsp
{
namespace io
{
class IOutStream;
/** This is data stream available to be read from clipboard
*
*/
class IInStream
{
private:
IInStream & operator = (const IInStream &);
protected:
status_t nErrorCode;
protected:
inline status_t set_error(status_t error) { return nErrorCode = error; }
public:
explicit IInStream();
virtual ~IInStream();
public:
/** Get last I/O error code
*
* @return last I/O error code
*/
inline status_t last_error() const { return nErrorCode; };
/** The number of bytes available
*
* @return number of bytes available or negative error code
* @note some implementations can return STATUS_NOT_IMPLEMENTED error code
*/
virtual wssize_t avail();
/** The current read position
*
* @return current read position or negative error code
*/
virtual wssize_t position();
/** Read single byte from stream
*
* @return byte value or negative error code
*/
virtual ssize_t read_byte();
/** Read amount of data
*
* @param dst target buffer to read data
* @param count number of bytes to read
* @return number of bytes actually read or negative error code,
* for end of file, -STATUS_EOF should be returned
*/
virtual ssize_t read(void *dst, size_t count);
/** Read maximum possible amount of data
*
* @param dst target buffer to read data
* @param count number of bytes to read
* @return number of bytes actually read
*/
virtual ssize_t read_fully(void *dst, size_t count);
/**
* Read entire block of specified size
* @param dst target buffer to read block
* @param count number of bytes in block
* @return status of operation
*/
virtual status_t read_block(void *dst, size_t count);
/** Seek the stream to the specified position from the beginning
*
* @param position the specified position
* @return real position or negative value on error
* @note some implementations can return STATUS_NOT_IMPLEMENTED error code
*/
virtual wssize_t seek(wsize_t position);
/**
* Skip amount of data
* @param amount amount of bytes to skip
* @return actual number of bytes skipped or error
*/
virtual wssize_t skip(wsize_t amount);
/**
* Sink all data to the output stream
* @param os pointer to the output stream
* @return number of bytes written or negative error code
*/
virtual wssize_t sink(IOutStream *os, size_t buf_size = 0x1000);
/** Close the clip data stream
*
* @return status of operation
*/
virtual status_t close();
};
} /* namespace ws */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IO_IINSTREAM_H_ */
|
