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