2008-03-08 08:52:38 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: datstrm.h
|
2008-03-10 11:24:38 -04:00
|
|
|
// Purpose: interface of wxDataOutputStream
|
2008-03-08 08:52:38 -05:00
|
|
|
// Author: wxWidgets team
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Licence: wxWindows license
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
/**
|
|
|
|
@class wxDataOutputStream
|
|
|
|
@wxheader{datstrm.h}
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
This class provides functions that write binary data types in a
|
|
|
|
portable way. Data can be written in either big-endian or little-endian
|
|
|
|
format, little-endian being the default on all architectures.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
|
|
|
If you want to write data to text files (or streams) use
|
2008-03-08 08:52:38 -05:00
|
|
|
wxTextOutputStream instead.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
|
|
|
The operator is overloaded and you can use this class like a standard
|
|
|
|
C++ iostream. See wxDataInputStream for its
|
2008-03-08 08:52:38 -05:00
|
|
|
usage and caveats.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
|
|
|
See also wxDataInputStream.
|
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@library{wxbase}
|
|
|
|
@category{streams}
|
|
|
|
*/
|
2008-03-08 09:43:31 -05:00
|
|
|
class wxDataOutputStream
|
2008-03-08 08:52:38 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
)
|
|
|
|
Constructs a datastream object from an output stream. Only write methods will
|
|
|
|
be available. The second form is only available in Unicode build of wxWidgets.
|
2008-03-20 09:45:17 -04:00
|
|
|
|
2008-03-08 09:43:31 -05:00
|
|
|
@param stream
|
2008-03-09 08:33:59 -04:00
|
|
|
The output stream.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param conv
|
2008-03-09 08:33:59 -04:00
|
|
|
Charset conversion object object used to encoding Unicode
|
|
|
|
strings before writing them to the stream
|
|
|
|
in Unicode mode (see WriteString()
|
|
|
|
documentation for detailed description). Note that you must not destroy
|
|
|
|
conv before you destroy this wxDataOutputStream instance! It is
|
|
|
|
recommended to use default value (UTF-8).
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
wxDataOutputStream(wxOutputStream& stream);
|
2008-03-08 09:43:31 -05:00
|
|
|
wxDataOutputStream(wxOutputStream& stream);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
/**
|
|
|
|
Destroys the wxDataOutputStream object.
|
|
|
|
*/
|
|
|
|
~wxDataOutputStream();
|
|
|
|
|
|
|
|
/**
|
2008-03-09 08:33:59 -04:00
|
|
|
If @a be_order is @true, all data will be written in big-endian
|
2008-03-08 08:52:38 -05:00
|
|
|
order, e.g. for reading on a Sparc or from Java-Streams (which
|
|
|
|
always use big-endian order), otherwise data will be written in
|
|
|
|
little-endian order.
|
|
|
|
*/
|
|
|
|
void BigEndianOrdered(bool be_order);
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Writes an array of 16 bit unsigned integer to the stream. The amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
16 bit unsigned integer to write is specified with the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
void Write16(wxUint16 i16);
|
2008-03-09 08:33:59 -04:00
|
|
|
void Write16(const wxUint16* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Writes an array of 32 bit unsigned integer to the stream. The amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
32 bit unsigned integer to write is specified with the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
void Write32(wxUint32 i32);
|
2008-03-09 08:33:59 -04:00
|
|
|
void Write32(const wxUint32* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Writes an array of 64 bit unsigned integer to the stream. The amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
64 bit unsigned integer to write is specified with the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
void Write64(wxUint64 i64);
|
2008-03-09 08:33:59 -04:00
|
|
|
void Write64(const wxUint64* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Writes an array of bytes to the stream. The amount of bytes to write is
|
2008-03-09 08:33:59 -04:00
|
|
|
specified with the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
void Write8(wxUint8 i8);
|
2008-03-09 08:33:59 -04:00
|
|
|
void Write8(const wxUint8* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Writes an array of double to the stream. The amount of double to write is
|
2008-03-09 08:33:59 -04:00
|
|
|
specified with the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
void WriteDouble(double f);
|
2008-03-09 08:33:59 -04:00
|
|
|
void WriteDouble(const double* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
/**
|
2008-03-09 08:33:59 -04:00
|
|
|
Writes @a string to the stream. Actually, this method writes the size of
|
|
|
|
the string before writing @a string itself.
|
2008-03-08 08:52:38 -05:00
|
|
|
In ANSI build of wxWidgets, the string is written to the stream in exactly
|
|
|
|
same way it is represented in memory. In Unicode build, however, the string
|
|
|
|
is first converted to multibyte representation with @e conv object passed
|
2008-03-08 09:43:31 -05:00
|
|
|
to stream's constructor (consequently, ANSI application can read data
|
2008-03-08 08:52:38 -05:00
|
|
|
written by Unicode application, as long as they agree on encoding) and this
|
|
|
|
representation is written to the stream. UTF-8 is used by default.
|
|
|
|
*/
|
|
|
|
void WriteString(const wxString& string);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2008-03-10 11:24:38 -04:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
/**
|
|
|
|
@class wxDataInputStream
|
|
|
|
@wxheader{datstrm.h}
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
This class provides functions that read binary data types in a
|
|
|
|
portable way. Data can be read in either big-endian or little-endian
|
|
|
|
format, little-endian being the default on all architectures.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
|
|
|
If you want to read data from text files (or streams) use
|
2008-03-08 08:52:38 -05:00
|
|
|
wxTextInputStream instead.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
The operator is overloaded and you can use this class like a standard C++
|
|
|
|
iostream.
|
|
|
|
Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
|
|
|
|
and on a typical 32-bit computer, none of these match to the "long" type
|
|
|
|
(wxInt32
|
|
|
|
is defined as signed int on 32-bit architectures) so that you cannot use long.
|
|
|
|
To avoid
|
|
|
|
problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
For example:
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@code
|
|
|
|
wxFileInputStream input( "mytext.dat" );
|
|
|
|
wxDataInputStream store( input );
|
|
|
|
wxUint8 i1;
|
|
|
|
float f2;
|
|
|
|
wxString line;
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
store i1; // read a 8 bit integer.
|
|
|
|
store i1 f2; // read a 8 bit integer followed by float.
|
|
|
|
store line; // read a text line
|
|
|
|
@endcode
|
2008-03-08 09:43:31 -05:00
|
|
|
|
|
|
|
See also wxDataOutputStream.
|
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@library{wxbase}
|
|
|
|
@category{streams}
|
|
|
|
*/
|
2008-03-08 09:43:31 -05:00
|
|
|
class wxDataInputStream
|
2008-03-08 08:52:38 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
)
|
|
|
|
Constructs a datastream object from an input stream. Only read methods will
|
|
|
|
be available. The second form is only available in Unicode build of wxWidgets.
|
2008-03-20 09:45:17 -04:00
|
|
|
|
2008-03-08 09:43:31 -05:00
|
|
|
@param stream
|
2008-03-09 08:33:59 -04:00
|
|
|
The input stream.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param conv
|
2008-03-09 08:33:59 -04:00
|
|
|
Charset conversion object object used to decode strings in Unicode
|
|
|
|
mode (see ReadString()
|
|
|
|
documentation for detailed description). Note that you must not destroy
|
|
|
|
conv before you destroy this wxDataInputStream instance!
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
wxDataInputStream(wxInputStream& stream);
|
2008-03-08 09:43:31 -05:00
|
|
|
wxDataInputStream(wxInputStream& stream);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
/**
|
|
|
|
Destroys the wxDataInputStream object.
|
|
|
|
*/
|
|
|
|
~wxDataInputStream();
|
|
|
|
|
|
|
|
/**
|
2008-03-09 08:33:59 -04:00
|
|
|
If @a be_order is @true, all data will be read in big-endian
|
2008-03-08 09:43:31 -05:00
|
|
|
order, such as written by programs on a big endian architecture
|
|
|
|
(e.g. Sparc) or written by Java-Streams (which always use
|
2008-03-08 08:52:38 -05:00
|
|
|
big-endian order).
|
|
|
|
*/
|
|
|
|
void BigEndianOrdered(bool be_order);
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Reads 16 bit unsigned integers from the stream in a specified buffer. the
|
2008-03-09 08:33:59 -04:00
|
|
|
amount of 16 bit unsigned integer to read is specified by the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
wxUint16 Read16();
|
2008-03-09 08:33:59 -04:00
|
|
|
void Read16(wxUint16* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Reads 32 bit unsigned integers from the stream in a specified buffer. the
|
|
|
|
amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
32 bit unsigned integer to read is specified by the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
wxUint32 Read32();
|
2008-03-09 08:33:59 -04:00
|
|
|
void Read32(wxUint32* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Reads 64 bit unsigned integers from the stream in a specified buffer. the
|
|
|
|
amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
64 bit unsigned integer to read is specified by the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
wxUint64 Read64();
|
2008-03-09 08:33:59 -04:00
|
|
|
void Read64(wxUint64* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Reads bytes from the stream in a specified buffer. The amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
bytes to read is specified by the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
wxUint8 Read8();
|
2008-03-09 08:33:59 -04:00
|
|
|
void Read8(wxUint8* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
//@{
|
|
|
|
/**
|
|
|
|
Reads double data (IEEE encoded) from the stream in a specified buffer. the
|
|
|
|
amount of
|
2008-03-09 08:33:59 -04:00
|
|
|
double to read is specified by the @a size variable.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
double ReadDouble();
|
2008-03-09 08:33:59 -04:00
|
|
|
void ReadDouble(double* buffer, size_t size);
|
2008-03-08 08:52:38 -05:00
|
|
|
//@}
|
|
|
|
|
|
|
|
/**
|
2008-03-08 09:43:31 -05:00
|
|
|
Reads a string from a stream. Actually, this function first reads a long
|
|
|
|
integer specifying the length of the string (without the last null character)
|
2008-03-08 08:52:38 -05:00
|
|
|
and then reads the string.
|
|
|
|
In Unicode build of wxWidgets, the fuction first reads multibyte (char*)
|
|
|
|
string from the stream and then converts it to Unicode using the @e conv
|
|
|
|
object passed to constructor and returns the result as wxString. You are
|
|
|
|
responsible for using the same convertor as when writing the stream.
|
|
|
|
See also wxDataOutputStream::WriteString.
|
|
|
|
*/
|
|
|
|
wxString ReadString();
|
|
|
|
};
|
2008-03-10 11:24:38 -04:00
|
|
|
|