MacDocParser.hxx Source File documentation

MacDocParser.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 MAC_DOC_PARSER
35 # define MAC_DOC_PARSER
36
37 #include <string>
38 #include <vector>
39
40 #include <librevenge/librevenge.h>
41
42 #include "MWAWDebug.hxx"
43 #include "MWAWInputStream.hxx"
44
45 #include "MWAWParser.hxx"
46
47 namespace MacDocParserInternal
48 {
49 struct State;
50 }
51
54 class MacDocParser final : public MWAWTextParser
55 {
56 public:
58 MacDocParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
60 ~MacDocParser() final;
61
63 bool checkHeader(MWAWHeader *header, bool strict=false) final;
64
65 // the main parse function
66 void parse(librevenge::RVNGTextInterface *documentInterface) final;
67
68 protected:
70 void init();
71
73 void createDocument(librevenge::RVNGTextInterface *documentInterface);
74
76 void newPage(int number);
77
78 protected:
80 bool createZones();
81
83 bool sendContents();
84
85 // Intermediate level
86
88 bool sendPicture(MWAWEntry const &entry);
90 bool readFont(MWAWEntry const &entry);
92 bool readIndex(MWAWEntry const &entry);
94 int updateIndex(int actIndex, int actLevel);
96 bool readBookmark(MWAWEntry const &entry);
98 bool readFile(MWAWEntry const &entry);
100 bool readWP(MWAWEntry const &entry);
101
103 bool sendIndex();
104
106 MWAWInputStreamPtr rsrcInput();
107
109 libmwaw::DebugFile &rsrcAscii();
110
111 //
112 // data
113 //
115 std::shared_ptr<MacDocParserInternal::State> m_state;
116 };
117 #endif
118 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:567
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWParagraph::m_justify
MWAWVariable< Justification > m_justify
the justification
Definition: MWAWParagraph.hxx:167
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
MWAWInputStream::get
static std::shared_ptr< MWAWInputStream > get(librevenge::RVNGBinaryData const &data, bool inverted)
returns a new input stream corresponding to a librevenge::RVNGBinaryData
Definition: MWAWInputStream.cxx:102
MWAWPageSpan::setPageSpan
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
MWAWTabStop::m_leaderCharacter
uint16_t m_leaderCharacter
the leader char
Definition: MWAWParagraph.hxx:78
MacDocParser::readIndex
bool readIndex(MWAWEntry const &entry)
try to read an index entry
Definition: MacDocParser.cxx:409
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
MWAWPosition::setRelativePosition
void setRelativePosition(AnchorTo anchor, XPos X=XLeft, YPos Y=YTop)
sets the relative position
Definition: MWAWPosition.hxx:237
MWAWParagraph::m_tabs
MWAWVariable< std::vector< MWAWTabStop > > m_tabs
the tabulations
Definition: MWAWParagraph.hxx:162
MWAWEntry::isParsed
bool isParsed() const
a flag to know if the entry was parsed or not
Definition: MWAWEntry.hxx:121
MacDocParserInternal::State
Internal: the state of a MacDocParser.
Definition: MacDocParser.cxx:100
MacDocParser::init
void init()
inits all internal variables
Definition: MacDocParser.cxx:135
MWAWFont::boldBit
@ boldBit
Definition: MWAWFont.hxx:190
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
MacDocParserInternal::Index
Internal: the index data of a MacDocParser.
Definition: MacDocParser.cxx:63
MWAWFont::setColor
void setColor(MWAWColor color)
sets the font color
Definition: MWAWFont.hxx:341
MWAWEntry::id
int id() const
returns the id
Definition: MWAWEntry.hxx:164
MacDocParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: MacDocParser.cxx:116
MWAWFontConverter.hxx
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
MWAWEmbeddedObject
small class use to define a embedded object
Definition: libmwaw_internal.hxx:467
MacDocParser::MacDocParser
MacDocParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: MacDocParser.cxx:124
MWAWParser::version
int version() const
returns the works version
Definition: MWAWParser.hxx:108
MWAWPrinter.hxx
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:84
MacDocParserInternal::State::State
State()
constructor
Definition: MacDocParser.cxx:102
MacDocParser::updateIndex
int updateIndex(int actIndex, int actLevel)
try to set the index level and return the next index value (or -1)
Definition: MacDocParser.cxx:489
MacDocParser::readFont
bool readFont(MWAWEntry const &entry)
try to read a font index entry
Definition: MacDocParser.cxx:355
MWAWFont::Line::Simple
@ Simple
Definition: MWAWFont.hxx:49
MWAWPictData::get
static MWAWPictData * get(MWAWInputStreamPtr const &input, int size)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:108
MWAWEntry::setParsed
void setParsed(bool ok=true) const
sets the flag m_parsed to true or false
Definition: MWAWEntry.hxx:126
MWAWParser::getTextListener
MWAWTextListenerPtr & getTextListener()
returns the text listener
Definition: MWAWParser.hxx:145
libmwaw::DebugFile::addNote
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
MacDocParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: MacDocParser.cxx:174
MacDocParser.hxx
MWAWFont::setDeltaLetterSpacing
void setDeltaLetterSpacing(float d, librevenge::RVNGUnit unit=librevenge::RVNG_POINT)
sets the letter spacing ( delta value in point )
Definition: MWAWFont.hxx:292
MWAWParagraph::m_margins
MWAWVariable< double > m_margins[3]
the margins
Definition: MWAWParagraph.hxx:148
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
MWAWFont::embossBit
@ embossBit
Definition: MWAWFont.hxx:190
MacDocParser::sendContents
bool sendContents()
try to send the contents
Definition: MacDocParser.cxx:330
MWAWTabStop
class to store a tab use by MWAWParagraph
Definition: MWAWParagraph.hxx:46
MacDocParserInternal
Internal: the structures of a MacDocParser.
Definition: MacDocParser.cxx:59
MWAWSubDocument.hxx
MWAWPageSpan::setFormLength
void setFormLength(const double formLength)
set the total page length
Definition: MWAWPageSpan.hxx:178
MWAWParser::getPageWidth
double getPageWidth() const
returns the page width (form width without margin )
Definition: MWAWParser.hxx:185
libmwaw::DebugFile::reset
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:93
MWAWFont::m_extra
std::string m_extra
extra data
Definition: MWAWFont.hxx:573
MWAWParagraph::JustificationCenter
@ JustificationCenter
Definition: MWAWParagraph.hxx:90
MWAWFont::shadowBit
@ shadowBit
Definition: MWAWFont.hxx:191
MWAWParser::setTextListener
void setTextListener(MWAWTextListenerPtr &listener)
sets the text listener
Definition: MWAWParser.cxx:158
MWAWParagraph.hxx
libmwaw::DebugFile::skipZone
void skipZone(long beginPos, long endPos)
skips the file zone defined by beginPos-endPos
Definition: MWAWDebug.hxx:113
MWAWRSRCParser.hxx
MWAWParser::getRSRCParser
MWAWRSRCParserPtr & getRSRCParser()
returns the rsrc parser
Definition: MWAWParser.hxx:190
MWAWParser::getPageSpan
const MWAWPageSpan & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
libmwaw::Debug::dumpFile
bool dumpFile(librevenge::RVNGBinaryData &data, char const *fileName)
a debug function to store in a datafile in the current directory WARNING: this function erase the fil...
Definition: MWAWDebug.cxx:193
libmwaw_internal.hxx
MWAWDocument::MWAW_T_MACDOC
@ MWAW_T_MACDOC
MacDoc (v1.3)
Definition: MWAWDocument.hxx:122
MWAWPageSpan::setFormWidth
void setFormWidth(const double formWidth)
set the total page width
Definition: MWAWPageSpan.hxx:183
MWAWPosition.hxx
MacDocParser::m_state
std::shared_ptr< MacDocParserInternal::State > m_state
the state
Definition: MacDocParser.hxx:115
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:47
MWAWEntry::setBegin
void setBegin(long off)
sets the begin offset
Definition: MWAWEntry.hxx:67
MacDocParserInternal::Index::m_box
MWAWBox2i m_box
the bdbox
Definition: MacDocParser.cxx:93
MacDocParserInternal::Index::m_level
int m_level
the entry level
Definition: MacDocParser.cxx:87
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWEntry::length
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:93
MWAWPictData.hxx
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
MacDocParser::createZones
bool createZones()
finds the different objects zones
Definition: MacDocParser.cxx:229
MWAWPict::MWAW_R_BAD
@ MWAW_R_BAD
Definition: MWAWPict.hxx:73
MWAWTabStop::m_alignment
Alignment m_alignment
the alignment ( left, center, ...)
Definition: MWAWParagraph.hxx:76
libmwaw::ParseException
Definition: libmwaw_internal.hxx:143
MWAWDebug.hxx
MWAWFont::getDebugString
std::string getDebugString(std::shared_ptr< MWAWFontConverter > &converter) const
returns a string which can be used for debugging
Definition: MWAWFont.cxx:181
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
MWAWTabStop::m_position
double m_position
the tab position
Definition: MWAWParagraph.hxx:74
MWAWFont::setId
void setId(int newId)
sets the font id
Definition: MWAWFont.hxx:264
MacDocParserInternal::Index::m_page
int m_page
the page
Definition: MacDocParser.cxx:91
MacDocParser::readBookmark
bool readBookmark(MWAWEntry const &entry)
try to read a bookmark entry
Definition: MacDocParser.cxx:637
MacDocParserInternal::Index::m_extra
std::string m_extra
extra data
Definition: MacDocParser.cxx:95
MacDocParserInternal::Index::operator<<
friend std::ostream & operator<<(std::ostream &o, Index const &index)
operator<<
Definition: MacDocParser.cxx:75
MWAWPosition::Char
@ Char
Definition: MWAWPosition.hxx:51
MacDocParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: MacDocParser.cxx:199
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWHeader.hxx
MWAWPictData::check
static ReadResult check(MWAWInputStreamPtr const &input, int size, MWAWBox2f &box)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:100
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
MWAWFont::setSize
void setSize(float sz, bool isRelative=false)
sets the font size
Definition: MWAWFont.hxx:275
MacDocParser::readWP
bool readWP(MWAWEntry const &entry)
try to read a MDwp entry (window pos?)
Definition: MacDocParser.cxx:660
MWAWBox2i
MWAWBox2< int > MWAWBox2i
MWAWBox2 of int.
Definition: libmwaw_internal.hxx:1191
MWAWFont::italicBit
@ italicBit
Definition: MWAWFont.hxx:190
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
MacDocParserInternal::Index::Index
Index()
constructor
Definition: MacDocParser.cxx:65
MWAWTextListener.hxx
MacDocParser::sendIndex
bool sendIndex()
try to send the index
Definition: MacDocParser.cxx:506
MacDocParser
the main class to read a MacDoc file
Definition: MacDocParser.hxx:54
MacDocParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: MacDocParser.cxx:116
libmwaw::DebugFile::addPos
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
MacDocParser::newPage
void newPage(int number)
adds a new page
Definition: MacDocParser.cxx:158
MacDocParserInternal::State::m_idFontMap
std::map< int, MWAWFont > m_idFontMap
a map id to index font
Definition: MacDocParser.cxx:115
MWAWBox2::size
MWAWVec2< T > size() const
the box size
Definition: libmwaw_internal.hxx:1067
MacDocParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: MacDocParser.cxx:686
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
MacDocParser::~MacDocParser
~MacDocParser() final
destructor
Definition: MacDocParser.cxx:131
MacDocParserInternal::State::m_idPictureMap
std::map< int, MWAWEntry > m_idPictureMap
the picture page map
Definition: MacDocParser.cxx:111
MWAWInputStream.hxx
MWAWHeader::reset
void reset(MWAWDocument::Type type, int vers, Kind kind=MWAWDocument::MWAW_K_TEXT)
resets the data
Definition: MWAWHeader.hxx:84
MWAWFont.hxx
MacDocParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: MacDocParser.cxx:145
MacDocParserInternal::Index::m_numChild
int m_numChild
the number of child
Definition: MacDocParser.cxx:89
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
MWAWTabStop::RIGHT
@ RIGHT
Definition: MWAWParagraph.hxx:48
MWAWBox2< int >
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
MacDocParser::readFile
bool readFile(MWAWEntry const &entry)
try to read a file entry
Definition: MacDocParser.cxx:612
MacDocParserInternal::Index::m_entry
MWAWEntry m_entry
the text entry
Definition: MacDocParser.cxx:85
MacDocParserInternal::State::m_indexList
std::vector< Index > m_indexList
the index list
Definition: MacDocParser.cxx:113
MacDocParser::sendPicture
bool sendPicture(MWAWEntry const &entry)
try to send a picture
Definition: MacDocParser.cxx:574
MacDocParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: MacDocParser.cxx:150
MWAWVec2i
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:838
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
MWAWParser.hxx
MWAWFont::setUnderlineStyle
void setUnderlineStyle(Line::Style style=Line::None, bool doReset=true)
sets the underline style ( by default, we also reset the style)
Definition: MWAWFont.hxx:466
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:98
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163
MWAWFont::setFlags
void setFlags(uint32_t fl)
sets the font attributes bold, ...
Definition: MWAWFont.hxx:325