RagTimeText.hxx Source File documentation

RagTimeText.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 * Parser to RagTime text document
36 *
37 */
38 #ifndef RAGTIME_TEXT
39 # define RAGTIME_TEXT
40
41 #include <list>
42 #include <string>
43 #include <vector>
44
45 #include "libmwaw_internal.hxx"
46
47 #include "MWAWEntry.hxx"
48 #include "MWAWSubDocument.hxx"
49
50 #include "MWAWDebug.hxx"
51 #include "MWAWInputStream.hxx"
52
53 #include "MWAWParser.hxx"
54
55 namespace RagTimeTextInternal
56 {
57 struct TextZone;
58 struct Token;
59
60 struct State;
61 }
62
63 class RagTimeParser;
64
70 class RagTimeText
71 {
72 friend class RagTimeParser;
73 public:
75 explicit RagTimeText(RagTimeParser &parser);
77 virtual ~RagTimeText();
78
80 int version() const;
81
83 int getFontId(int localId) const;
85 bool getCharStyle(int charId, MWAWFont &font) const;
86
87 protected:
89 bool readFontNames(MWAWEntry &entry);
91 bool readCharProperties(MWAWEntry &entry);
92
94 bool readTextZone(MWAWEntry &entry, int width, MWAWColor const &fontColor=MWAWColor::black());
96 bool readFonts(RagTimeTextInternal::TextZone &zone, MWAWColor const &color, long endPos);
98 bool readParagraphs(RagTimeTextInternal::TextZone &zone, int width, long endPos);
100 bool readTokens(RagTimeTextInternal::TextZone &zone, long endPos);
101
103 bool send(int id, MWAWListenerPtr listener);
105 void flushExtra();
106
107 //
108 // low level
109 //
110
112 bool send(RagTimeTextInternal::TextZone const &zone, MWAWListenerPtr listener);
113
114 private:
115 RagTimeText(RagTimeText const &orig) = delete;
116 RagTimeText &operator=(RagTimeText const &orig) = delete;
117
118 protected:
119 //
120 // data
121 //
123 MWAWParserStatePtr m_parserState;
124
126 std::shared_ptr<RagTimeTextInternal::State> m_state;
127
129 RagTimeParser *m_mainParser;
130 };
131 #endif
132 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTimeText::m_mainParser
RagTimeParser * m_mainParser
the main parser;
Definition: RagTimeText.hxx:129
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
RagTimeTextInternal
Internal: the structures of a RagTimeText.
Definition: RagTimeText.cxx:55
MWAWParser.hxx
RagTimeText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTimeText.hxx:123
MWAWEntry.hxx
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
MWAWSubDocument.hxx
RagTimeText
the main class to read the text part of ragTime file
Definition: RagTimeText.hxx:70
MWAWColor::black
static MWAWColor black()
return the back color
Definition: libmwaw_internal.hxx:245
RagTimeParser::RagTimeText
friend class RagTimeText
Definition: RagTimeParser.hxx:63
RagTimeParser::flushExtra
void flushExtra()
flush unsent zone (debugging function)
Definition: RagTimeParser.cxx:2650
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
RagTimeParser::getFontId
int getFontId(int localId) const
returns a mac font id corresponding to a local id
Definition: RagTimeParser.cxx:414
RagTimeParser::getCharStyle
bool getCharStyle(int charId, MWAWFont &font) const
returns font style corresponding to a char style id
Definition: RagTimeParser.cxx:419
RagTimeTextInternal::TextZone
Internal: a text&#39;s zone of a RagTimeText.
Definition: RagTimeText.cxx:162
RagTimeText::m_state
std::shared_ptr< RagTimeTextInternal::State > m_state
the state
Definition: RagTimeText.hxx:126
RagTimeParser
the main class to read a RagTime v2-3 file
Definition: RagTimeParser.hxx:60
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
RagTimeParser::send
bool send(int zId)
try to send a zone
Definition: RagTimeParser.cxx:2586
MWAWParser::version
int version() const
returns the works version
Definition: MWAWParser.hxx:108
MWAWParser::operator=
MWAWParser & operator=(const MWAWParser &)=delete
private operator=: forbidden
RagTimeParser::readTextZone
bool readTextZone(MWAWEntry &entry, int width, MWAWColor const &fontColor=MWAWColor::black())
try to read a text zone (knowing the zone width in point and the font color)
Definition: RagTimeParser.cxx:454
MWAWInputStream.hxx
MWAWDebug.hxx
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46