StudentWritingCParser.hxx Source File documentation

StudentWritingCParser.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 convert some Student Writing Center 1.0 text document
36 *
37 */
38#ifndef STUDENT_WRITING_C__PARSER
39# define STUDENT_WRITING_C__PARSER
40
41#include <vector>
42
43#include "MWAWDebug.hxx"
44#include "MWAWEntry.hxx"
45#include "MWAWInputStream.hxx"
46
47#include "MWAWParser.hxx"
48
49namespace StudentWritingCParserInternal
50{
51struct State;
52struct Zone;
53
54class SubDocument;
55}
56
62 class StudentWritingCParser final : public MWAWTextParser
63{
64 friend class StudentWritingCParserInternal::SubDocument;
65
66public:
68 StudentWritingCParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
70 ~StudentWritingCParser() final;
71
73 bool checkHeader(MWAWHeader *header, bool strict=false) final;
74
75 // the main parse function
76 void parse(librevenge::RVNGTextInterface *documentInterface) final;
77
78protected:
80 void createDocument(librevenge::RVNGTextInterface *documentInterface);
81
83 bool createZones();
84
86 bool readTextZone(StudentWritingCParserInternal::Zone const &zone);
88 bool readFrame(StudentWritingCParserInternal::Zone &zone);
90 bool readParagraph(StudentWritingCParserInternal::Zone &zone);
92 bool readPicture(StudentWritingCParserInternal::Zone &zone);
94 bool readFontsList(MWAWEntry const &entry);
96 bool readPrintInfo();
97
99 bool sendZone(int id);
101 bool sendText(StudentWritingCParserInternal::Zone const &zone, StudentWritingCParserInternal::Zone const &parent, bool isMain=false);
103 bool sendPicture(MWAWPosition const &pos, int id);
104
106 MWAWInputStreamPtr decode();
107protected:
108 //
109 // data
110 //
111
113 std::shared_ptr<StudentWritingCParserInternal::State> m_state;
114};
115#endif
116// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWEntry.hxx
MWAWInputStream.hxx
MWAWParser.hxx
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
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition MWAWPosition.hxx:48
MWAWTextParser::MWAWTextParser
MWAWTextParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor (protected)
Definition MWAWParser.hxx:307
StudentWritingCParserInternal::SubDocument
Internal: the subdocument of a StudentWritingCParser.
Definition StudentWritingCParser.cxx:263
StudentWritingCParser::readPicture
bool readPicture(StudentWritingCParserInternal::Zone &zone)
try to read a picture zone with type=6
Definition StudentWritingCParser.cxx:1506
StudentWritingCParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition StudentWritingCParser.cxx:366
StudentWritingCParser::sendText
bool sendText(StudentWritingCParserInternal::Zone const &zone, StudentWritingCParserInternal::Zone const &parent, bool isMain=false)
try to send the text(s) corresponding to a zone of type 5
Definition StudentWritingCParser.cxx:1927
StudentWritingCParser::decode
MWAWInputStreamPtr decode()
low level: try to uncompress the different compressed zone
Definition StudentWritingCParser.cxx:2394
StudentWritingCParser::readFrame
bool readFrame(StudentWritingCParserInternal::Zone &zone)
try to read a frame zone with type=3
Definition StudentWritingCParser.cxx:1110
StudentWritingCParser::readPrintInfo
bool readPrintInfo()
try to read the printer information
Definition StudentWritingCParser.cxx:1664
StudentWritingCParser::readTextZone
bool readTextZone(StudentWritingCParserInternal::Zone const &zone)
try to read a text zone with type=1
Definition StudentWritingCParser.cxx:867
StudentWritingCParser::readFontsList
bool readFontsList(MWAWEntry const &entry)
try to read the font list: the first entry of a zone with type=7
Definition StudentWritingCParser.cxx:1592
StudentWritingCParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition StudentWritingCParser.cxx:332
StudentWritingCParser::readParagraph
bool readParagraph(StudentWritingCParserInternal::Zone &zone)
try to read the paragraph zone with type=4
Definition StudentWritingCParser.cxx:1375
StudentWritingCParser::StudentWritingCParser
StudentWritingCParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition StudentWritingCParser.cxx:313
StudentWritingCParser::createZones
bool createZones()
finds the different objects zones
Definition StudentWritingCParser.cxx:442
StudentWritingCParser::sendZone
bool sendZone(int id)
try to send a zone knowing its id
Definition StudentWritingCParser.cxx:1768
StudentWritingCParser::~StudentWritingCParser
~StudentWritingCParser() final
destructor
Definition StudentWritingCParser.cxx:325
StudentWritingCParser::m_state
std::shared_ptr< StudentWritingCParserInternal::State > m_state
the state
Definition StudentWritingCParser.hxx:113
StudentWritingCParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition StudentWritingCParser.cxx:1728
StudentWritingCParser::sendPicture
bool sendPicture(MWAWPosition const &pos, int id)
try to send a picture: type 6
Definition StudentWritingCParser.cxx:1894
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
StudentWritingCParserInternal
Internal: the structures of a StudentWritingCParser.
Definition StudentWritingCParser.cxx:63
librevenge
Definition MWAWDocument.hxx:57
StudentWritingCParserInternal::State
Internal: the state of a StudentWritingCParser.
Definition StudentWritingCParser.cxx:199
StudentWritingCParserInternal::Zone
a list of entry of StudentWritingCParser defining a zone
Definition StudentWritingCParser.cxx:137