BeagleWksParser.hxx Source File documentation

BeagleWksParser.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 BEAGLE_WKS_PARSER
35# define BEAGLE_WKS_PARSER
36
37#include <string>
38#include <vector>
39
40#include <librevenge/librevenge.h>
41
42#include "MWAWDebug.hxx"
43#include "MWAWGraphicStyle.hxx"
44#include "MWAWInputStream.hxx"
45
46#include "MWAWParser.hxx"
47
48#include "BeagleWksStructManager.hxx"
49
50namespace BeagleWksParserInternal
51{
52struct State;
53}
54
55class BeagleWksText;
56
59 class BeagleWksParser final : public MWAWTextParser
60{
61 friend class BeagleWksText;
62public:
64 BeagleWksParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
66 ~BeagleWksParser() final;
67
69 bool checkHeader(MWAWHeader *header, bool strict=false) final;
70
71 // the main parse function
72 void parse(librevenge::RVNGTextInterface *documentInterface) final;
73
74protected:
76 void init();
77
79 void createDocument(librevenge::RVNGTextInterface *documentInterface);
80
82 MWAWVec2f getPageLeftTop() const;
84 void newPage(int number);
85
86 // interface with the text parser
87
89 bool sendFrame(int pId);
90
91protected:
93 bool createZones();
94
96 bool readRSRCZones();
97
99 bool sendPageFrames();
100
102 bool sendFrame(BeagleWksStructManager::Frame const &frame);
103
105 bool sendPicture(int pId, MWAWPosition const &pos,
106 MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
107 //
108 // low level
109 //
110
111 // data fork
112
114 bool readPrintInfo();
116 bool readLastZone();
117
119 MWAWInputStreamPtr rsrcInput();
120
122 libmwaw::DebugFile &rsrcAscii();
123
124 //
125 // data
126 //
127
129 std::shared_ptr<BeagleWksParserInternal::State> m_state;
130
132 std::shared_ptr<BeagleWksStructManager> m_structureManager;
134 std::shared_ptr<BeagleWksText> m_textParser;
135};
136#endif
137// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
BeagleWksStructManager.hxx
MWAWDebug.hxx
MWAWGraphicStyle.hxx
MWAWInputStream.hxx
MWAWParser.hxx
BeagleWksParser
the main class to read a BeagleWorks file
Definition: BeagleWksParser.hxx:60
BeagleWksParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: BeagleWksParser.cxx:169
BeagleWksParser::readPrintInfo
bool readPrintInfo()
read the print info zone
Definition: BeagleWksParser.cxx:404
BeagleWksParser::createZones
bool createZones()
finds the different objects zones
Definition: BeagleWksParser.cxx:254
BeagleWksParser::m_structureManager
std::shared_ptr< BeagleWksStructManager > m_structureManager
the structure manager
Definition: BeagleWksParser.hxx:132
BeagleWksParser::~BeagleWksParser
~BeagleWksParser() final
destructor
Definition: BeagleWksParser.cxx:98
BeagleWksParser::getPageLeftTop
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: BeagleWksParser.cxx:129
BeagleWksParser::newPage
void newPage(int number)
adds a new page
Definition: BeagleWksParser.cxx:153
BeagleWksParser::sendPicture
bool sendPicture(int pId, MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
try to send a picture
Definition: BeagleWksParser.cxx:568
BeagleWksParser::init
void init()
inits all internal variables
Definition: BeagleWksParser.cxx:102
BeagleWksParser::m_textParser
std::shared_ptr< BeagleWksText > m_textParser
the text parser
Definition: BeagleWksParser.hxx:134
BeagleWksParser::readRSRCZones
bool readRSRCZones()
read the resource fork zone
Definition: BeagleWksParser.cxx:336
BeagleWksParser::sendFrame
bool sendFrame(int pId)
try to insert the pId picture (as char)
Definition: BeagleWksParser.cxx:138
BeagleWksParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: BeagleWksParser.cxx:116
BeagleWksParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: BeagleWksParser.cxx:202
BeagleWksParser::readLastZone
bool readLastZone()
read the last zone
Definition: BeagleWksParser.cxx:460
BeagleWksParser::BeagleWksParser
BeagleWksParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: BeagleWksParser.cxx:89
BeagleWksParser::m_state
std::shared_ptr< BeagleWksParserInternal::State > m_state
the state
Definition: BeagleWksParser.hxx:129
BeagleWksParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: BeagleWksParser.cxx:121
BeagleWksParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: BeagleWksParser.cxx:603
BeagleWksParser::sendPageFrames
bool sendPageFrames()
try to send the page graphic
Definition: BeagleWksParser.cxx:374
BeagleWksStructManager
the main class to read the structure shared between different BeagleWorks files
Definition: BeagleWksStructManager.hxx:57
BeagleWksText
the main class to read the text part of BeagleWorks Text file
Definition: BeagleWksText.hxx:62
MWAWGraphicStyle
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:48
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
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
BeagleWksParserInternal
Internal: the structures of a BeagleWksParser.
Definition: BeagleWksParser.cxx:59
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