MWAWStream.hxx Source File documentation

MWAWStream.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33
34 #ifndef MWAW_STREAM_H
35 # define MWAW_STREAM_H
36
37 #include "libmwaw_internal.hxx"
38 #include "MWAWDebug.hxx"
39
41 struct MWAWStream {
43 MWAWStream(MWAWInputStreamPtr input, libmwaw::DebugFile &ascii);
45 explicit MWAWStream(MWAWInputStreamPtr input);
47 ~MWAWStream();
49 bool checkPosition(long pos) const
50 {
51 return pos<=m_eof;
52 }
54 MWAWInputStreamPtr m_input;
56 libmwaw::DebugFile &m_ascii;
58 long m_bof;
60 long m_eof;
61 protected:
63 libmwaw::DebugFile m_asciiFile;
64 };
65 #endif
66 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWStream::checkPosition
bool checkPosition(long pos) const
return true if the position is in the file
Definition: MWAWStream.hxx:49
MWAWStream::m_input
MWAWInputStreamPtr m_input
the stream
Definition: MWAWStream.hxx:54
MWAWStream::m_ascii
libmwaw::DebugFile & m_ascii
the ascii file
Definition: MWAWStream.hxx:56
MWAWStream.hxx
MWAWStream::~MWAWStream
~MWAWStream()
destructor
Definition: MWAWStream.cxx:54
libmwaw_internal.hxx
MWAWStream::m_asciiFile
libmwaw::DebugFile m_asciiFile
the local file(if not, is given)
Definition: MWAWStream.hxx:63
MWAWDebug.hxx
MWAWStream
small structure use to store a stream and it debug file
Definition: MWAWStream.hxx:41
MWAWStream::m_bof
long m_bof
the first position
Definition: MWAWStream.hxx:58
MWAWStream::MWAWStream
MWAWStream(MWAWInputStreamPtr input, libmwaw::DebugFile &ascii)
constructor with an ascii file
Definition: MWAWStream.cxx:36
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
MWAWStream::m_eof
long m_eof
the last position
Definition: MWAWStream.hxx:60