ActaParser.hxx Source File documentation

ActaParser.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 ACTA_PARSER
35# define ACTA_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
47namespace ActaParserInternal
48{
49class SubDocument;
50struct State;
51}
52
53class ActaText;
54
57 class ActaParser final : public MWAWTextParser
58{
59 friend class ActaParserInternal::SubDocument;
60 friend class ActaText;
61public:
63 ActaParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
65 ~ActaParser() final;
66
68 bool checkHeader(MWAWHeader *header, bool strict=false) final;
69
70 // the main parse function
71 void parse(librevenge::RVNGTextInterface *documentInterface) final;
72
73protected:
75 void init();
76
78 void createDocument(librevenge::RVNGTextInterface *documentInterface);
79
81 MWAWVec2f getPageLeftTop() const;
83 void newPage(int number);
84
85 // interface with the text parser
86
88 std::shared_ptr<MWAWList> getMainList();
89
90protected:
92 bool createZones();
93
95 bool readRSRCZones();
96
98 bool readEndDataV3();
99
101 void sendHeaderFooter();
102
104 bool readPrintInfo(MWAWEntry const &entry);
105
107 bool readWindowPos(MWAWEntry const &entry);
108
110 bool readLabel(MWAWEntry const &entry);
111
113 bool readHFProperties(MWAWEntry const &entry);
114
116 bool readOption(MWAWEntry const &entry);
117
118 //
119 // low level
120 //
121
123 MWAWInputStreamPtr rsrcInput();
124
126 libmwaw::DebugFile &rsrcAscii();
127
128 //
129 // data
130 //
131
133 std::shared_ptr<ActaParserInternal::State> m_state;
134
136 std::shared_ptr<ActaText> m_textParser;
137};
138#endif
139// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWParser.hxx
ActaParserInternal::SubDocument
Internal: the subdocument of a ActaParser.
Definition: ActaParser.cxx:226
ActaParser
the main class to read a Acta file
Definition: ActaParser.hxx:58
ActaParser::~ActaParser
~ActaParser() final
destructor
Definition: ActaParser.cxx:276
ActaParser::newPage
void newPage(int number)
adds a new page
Definition: ActaParser.cxx:397
ActaParser::getPageLeftTop
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: ActaParser.cxx:306
ActaParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: ActaParser.cxx:293
ActaParser::init
void init()
inits all internal variables
Definition: ActaParser.cxx:280
ActaParser::readWindowPos
bool readWindowPos(MWAWEntry const &entry)
read the window position ( WSIZ resource block )
Definition: ActaParser.cxx:784
ActaParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: ActaParser.cxx:916
ActaParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: ActaParser.cxx:298
ActaParser::m_state
std::shared_ptr< ActaParserInternal::State > m_state
the state
Definition: ActaParser.hxx:133
ActaParser::readRSRCZones
bool readRSRCZones()
read the resource fork zone
Definition: ActaParser.cxx:540
ActaParser::sendHeaderFooter
void sendHeaderFooter()
sends the header/footer data
Definition: ActaParser.cxx:474
ActaParser::m_textParser
std::shared_ptr< ActaText > m_textParser
the text parser
Definition: ActaParser.hxx:136
ActaParser::readLabel
bool readLabel(MWAWEntry const &entry)
read the label type
Definition: ActaParser.cxx:813
ActaParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: ActaParser.cxx:413
ActaParser::createZones
bool createZones()
finds the different objects zones
Definition: ActaParser.cxx:525
ActaParser::readHFProperties
bool readHFProperties(MWAWEntry const &entry)
read the Header/Footer property (QHDR block)
Definition: ActaParser.cxx:836
ActaParser::getMainList
std::shared_ptr< MWAWList > getMainList()
returns a list to be used in the text
Definition: ActaParser.cxx:316
ActaParser::readPrintInfo
bool readPrintInfo(MWAWEntry const &entry)
read a PrintInfo block ( PSET resource block )
Definition: ActaParser.cxx:730
ActaParser::readEndDataV3
bool readEndDataV3()
read the end file data zones
Definition: ActaParser.cxx:607
ActaParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: ActaParser.cxx:442
ActaParser::readOption
bool readOption(MWAWEntry const &entry)
read the QOPT resource block (small print change )
Definition: ActaParser.cxx:886
ActaText
the main class to read the text part of Acta Text file
Definition: ActaText.hxx:58
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
MWAWList
a small structure used to store the informations about a list
Definition: MWAWList.hxx:123
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:299
MWAWVec2< float >
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
ActaParserInternal
Internal: the structures of a ActaParser.
Definition: ActaParser.cxx:58
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:51
librevenge
Definition: MWAWDocument.hxx:57