RagTimeStruct.hxx Source File documentation

RagTimeStruct.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 /*
35 * main structure of a RagTime document
36 *
37 */
38 #ifndef RAGTIME_STRUCT
39 # define RAGTIME_STRUCT
40
41 #include <string>
42
43 #include "libmwaw_internal.hxx"
44
45 #include "MWAWDebug.hxx"
46 #include "MWAWEntry.hxx"
47 #include "MWAWInputStream.hxx"
48
54 namespace RagTimeStruct
55 {
57 struct ResourceList {
59 enum Type { BuSl=0, BuGr, SpBo, SpCe, SpDE, SpTe, SpVa, gray, colr, res_, Undef};
61 ResourceList() : m_type(Undef), m_headerPos(0), m_headerSize(0), m_dataPos(0), m_dataNumber(0), m_dataSize(0), m_endPos(0), m_extra("")
62 {
63 }
65 bool read(MWAWInputStreamPtr input, MWAWEntry &entry);
67 static std::string getName(Type type)
68 {
69 static char const *(wh[])= { "BuSl", "BuGr", "SpBo", "SpCe", "SpDE", "SpTe", "SpVa", "gray", "colr", "res_", "#Undef"};
70 return wh[int(type)];
71 }
73 friend std::ostream &operator<<(std::ostream &o, ResourceList &zone);
75 Type m_type;
77 long m_headerPos;
79 int m_headerSize;
81 long m_dataPos;
83 int m_dataNumber;
85 int m_dataSize;
87 long m_endPos;
89 std::string m_extra;
90 };
91 }
92 #endif
93 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTimeStruct::ResourceList::colr
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::SpDE
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::SpCe
Definition: RagTimeStruct.hxx:59
MWAWEntry.hxx
libmwaw_internal.hxx
RagTimeStruct::ResourceList::SpBo
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::SpTe
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::m_endPos
long m_endPos
the end pos
Definition: RagTimeStruct.hxx:87
RagTimeStruct::ResourceList::getName
static std::string getName(Type type)
returns a string corresponding to a type
Definition: RagTimeStruct.hxx:67
RagTimeStruct::ResourceList::SpVa
Definition: RagTimeStruct.hxx:59
RagTimeStruct
some structure used to parse a RagTime document
Definition: RagTimeStruct.cxx:39
RagTimeStruct::ResourceList::BuSl
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::m_dataPos
long m_dataPos
the begin position of the first data
Definition: RagTimeStruct.hxx:81
RagTimeStruct::ResourceList::m_headerSize
int m_headerSize
the header size
Definition: RagTimeStruct.hxx:79
RagTimeStruct::ResourceList::m_dataSize
int m_dataSize
the data size
Definition: RagTimeStruct.hxx:85
RagTimeStruct::ResourceList::ResourceList
ResourceList()
constructor
Definition: RagTimeStruct.hxx:61
RagTimeStruct::ResourceList::operator<<
friend std::ostream & operator<<(std::ostream &o, ResourceList &zone)
operator<<
Definition: RagTimeStruct.cxx:161
RagTimeStruct::ResourceList::m_dataNumber
int m_dataNumber
the number of data
Definition: RagTimeStruct.hxx:83
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
RagTimeStruct::ResourceList::m_headerPos
long m_headerPos
the begin position of the header
Definition: RagTimeStruct.hxx:77
RagTimeStruct::ResourceList::m_type
Type m_type
the resource type
Definition: RagTimeStruct.hxx:75
MWAWInputStream.hxx
MWAWDebug.hxx
RagTimeStruct::ResourceList::read
bool read(MWAWInputStreamPtr input, MWAWEntry &entry)
try to read the header block
Definition: RagTimeStruct.cxx:42
RagTimeStruct::ResourceList::m_extra
std::string m_extra
extra data
Definition: RagTimeStruct.hxx:89
RagTimeStruct::ResourceList::gray
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::BuGr
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::res_
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList::Type
Type
the different resource type which can be stored as list
Definition: RagTimeStruct.hxx:59
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
RagTimeStruct::ResourceList::Undef
Definition: RagTimeStruct.hxx:59
RagTimeStruct::ResourceList
a structure used to store list in a resource fork
Definition: RagTimeStruct.hxx:57