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
|
/*
** ClanLib SDK
** Copyright (c) 1997-2005 The ClanLib Team
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
** claim that you wrote the original software. If you use this software
** in a product, an acknowledgment in the product documentation would be
** appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
** misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Note: Some of the libraries ClanLib may link to may have additional
** requirements or restrictions.
**
** File Author(s):
**
** Magnus Norddahl
** (if your name is missing here, please add it)
*/
//! clanCore="I/O Data"
//! header=core.h
#ifndef header_outputsource
#define header_outputsource
#ifdef CL_API_DLL
#ifdef CL_CORE_EXPORT
#define CL_API_CORE __declspec(dllexport)
#else
#define CL_API_CORE __declspec(dllimport)
#endif
#else
#define CL_API_CORE
#endif
#if _MSC_VER > 1000
#pragma once
#endif
#include "datatypes.h"
#include <string>
//: Interface to write data to different types of output sources.
//- !group=Core/IO Data!
//- !header=core.h!
//- <p>CL_OutputSource is used to write data to different types of input sources.
//- In most cases, this is regular files and ClanLib zlib compressed datafiles.</p>
//-
//- <p>To access some system specific output source types, such as datafiles and
//- regular ones, use the static create functions in the CL_OutputSourceProvider
//- class.</p>
//- <p>CL_OutputSourceProvider - Interface to open output sources with.</p>
class CL_API_CORE CL_OutputSource
{
//! Construction:
public:
//: Output Source constructor.
CL_OutputSource() { set_system_mode(); }
//: Output Source destructor.
virtual ~CL_OutputSource() { return; }
//! Attributes:
public:
//: Returns current position in output source.
//return: Current position in source.
virtual int tell() const = 0;
//: Returns the size of the output source.
//return: Size of the output source.
virtual int size() const = 0;
//! Operations:
public:
//: Changes output data endianess to the local systems mode.
virtual void set_system_mode();
//: Changes output data endianess to big endian mode.
virtual void set_big_endian_mode();
//: Changes output data endianess to little endian mode. This is the default setting.
virtual void set_little_endian_mode();
//: Writes a signed 64 bit integer to output source.
virtual void write_int64(cl_int64 data);
//: Writes an unsigned 64 bit integer to output source.
virtual void write_uint64(cl_uint64 data);
//: Writes a signed 32 bit integer to output source.
virtual void write_int32(cl_int32 data);
//: Writes an unsigned 32 bit integer to output source.
virtual void write_uint32(cl_uint32 data);
//: Writes a signed 16 bit integer to output source.
virtual void write_int16(cl_int16 data);
//: Writes an unsigned 16 bit integer to output source.
virtual void write_uint16(cl_uint16 data);
//: Writes a signed 8 bit integer to output source.
virtual void write_int8(cl_int8 data);
//: Writes an unsigned 8 bit integer to output source.
virtual void write_uint8(cl_uint8 data);
//: Writes a signed 16 bit integer (short) to output source.
virtual void write_short16(short data);
//: Writes an unsigned 16 bit integer (short) to output source.
virtual void write_ushort16(unsigned short data);
//: Writes a signed 8 bit integer (char) to output source.
virtual void write_char8(char data);
//: Writes an unsigned 8 bit integer (char) to output source.
virtual void write_uchar8(unsigned char data);
//: Writes an ieee format floating point to output source.
virtual void write_float32(float data);
//: Writes an ieee format double to output source.
void write_float64(double data);
//: Writes a bool to output source.
virtual void write_bool8(bool data);
//: Writes a string to the output source.
//- <p>The binary format written to the output source is first an uint32 telling the length of the
//- string, and then the string itself.</p>
virtual void write_string(const std::string &str);
//: Writes larger amounts of data (no endian and 64 bit conversion).
//param data: Points to the array from which to write.
//param size: Number of bytes to write.
//return: Num bytes actually written.
virtual int write(const void *data, int size) = 0;
//: Opens the output source. By default, it is open.
virtual void open() = 0;
//: Closes the output source.
virtual void close() = 0;
//: Make a copy of the current outputsource, standing at the same position.
//return: The copy of the output source.
virtual CL_OutputSource *clone() = 0;
//! Implementation:
protected:
bool little_endian_mode;
};
#endif
|
