ClarisWksText.hxx Source File documentation

ClarisWksText.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 Claris Works text document
36 *
37 */
38#ifndef CLARIS_WKS_TEXT
39# define CLARIS_WKS_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#include "ClarisWksStruct.hxx"
56
57namespace ClarisWksTextInternal
58{
59class SubDocument;
60
61struct Paragraph;
62struct Zone;
63struct State;
64}
65
66class ClarisWksDocument;
67class ClarisWksParser;
68class ClarisWksStyleManager;
69
75 class ClarisWksText
76{
77 friend class ClarisWksTextInternal::SubDocument;
78 friend class ClarisWksDocument;
79 friend class ClarisWksParser;
80 friend class ClarisWksStyleManager;
81
82public:
84 explicit ClarisWksText(ClarisWksDocument &document);
86 virtual ~ClarisWksText();
87
89 int version() const;
90
92 int numPages() const;
94 bool updatePageSpanList(MWAWPageSpan const &page, std::vector<MWAWPageSpan> &spanList);
95
97 std::shared_ptr<ClarisWksStruct::DSET> readDSETZone(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete);
98
99protected:
101 void setProperty(MWAWListener &listener, ClarisWksTextInternal::Paragraph const &ruler, int listId=-1);
102
104 bool sendZone(int number, MWAWListenerPtr const &listener=MWAWListenerPtr());
106 bool canSendTextAsGraphic(int number) const;
107
109 void flushExtra();
110
111 //
112 // low level
113 //
114
116 bool readParagraphs(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone);
117
119 bool readFonts(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone);
120
122 bool readTokens(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone);
123
125 bool readTextZoneSize(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone);
126
128 bool readTextSection(ClarisWksTextInternal::Zone &zone);
129
131 bool sendText(ClarisWksTextInternal::Zone const &zone, MWAWListenerPtr listener);
133 bool canSendTextAsGraphic(ClarisWksTextInternal::Zone const &zone) const;
134
136 int findListId(ClarisWksTextInternal::Zone const &zone, int actListId, long cPos, long &lastPos);
137
139 bool readParagraphs();
140
144 bool readParagraph(int id=-1);
145
146 // THE NAMED ENTRY
147
149 bool readSTYL_RULR(int N, int fSz);
150
151private:
152 ClarisWksText(ClarisWksText const &orig) = delete;
153 ClarisWksText &operator=(ClarisWksText const &orig) = delete;
154
155protected:
156 //
157 // data
158 //
159
161 ClarisWksDocument &m_document;
162
164 MWAWParserStatePtr m_parserState;
165
167 std::shared_ptr<ClarisWksTextInternal::State> m_state;
168
170 MWAWParser *m_mainParser;
171};
172#endif
173// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
ClarisWksStruct.hxx
MWAWDebug.hxx
MWAWEntry.hxx
MWAWInputStream.hxx
MWAWParser.hxx
MWAWSubDocument.hxx
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:74
ClarisWksParser
the main class to read a Claris Works file
Definition: ClarisWksParser.hxx:68
ClarisWksStyleManager
a structure to store the style list and the lookup zone
Definition: ClarisWksStyleManager.hxx:61
ClarisWksTextInternal::SubDocument
Internal: the subdocument of a ClarisWksDocument.
Definition: ClarisWksText.cxx:588
ClarisWksText
the main class to read the text part of Claris Works file
Definition: ClarisWksText.hxx:76
ClarisWksText::readTextSection
bool readTextSection(ClarisWksTextInternal::Zone &zone)
try to read the section
Definition: ClarisWksText.cxx:1289
ClarisWksText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksText.hxx:164
ClarisWksText::canSendTextAsGraphic
bool canSendTextAsGraphic(int number) const
check if we can send a textzone as graphic
Definition: ClarisWksText.cxx:2156
ClarisWksText::readFonts
bool readFonts(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone)
try to read a font sequence
Definition: ClarisWksText.cxx:1030
ClarisWksText::readSTYL_RULR
bool readSTYL_RULR(int N, int fSz)
read a STYL Paragraph sequence
Definition: ClarisWksText.cxx:1826
ClarisWksText::readDSETZone
std::shared_ptr< ClarisWksStruct::DSET > readDSETZone(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete)
reads the zone Text DSET
Definition: ClarisWksText.cxx:759
ClarisWksText::sendZone
bool sendZone(int number, MWAWListenerPtr const &listener=MWAWListenerPtr())
sends the zone data to the listener (if it exists )
Definition: ClarisWksText.cxx:2164
ClarisWksText::setProperty
void setProperty(MWAWListener &listener, ClarisWksTextInternal::Paragraph const &ruler, int listId=-1)
sends a paragraph property to the listener
Definition: ClarisWksText.cxx:2145
ClarisWksText::m_state
std::shared_ptr< ClarisWksTextInternal::State > m_state
the state
Definition: ClarisWksText.hxx:167
ClarisWksText::updatePageSpanList
bool updatePageSpanList(MWAWPageSpan const &page, std::vector< MWAWPageSpan > &spanList)
updates the page span list and returns true if this is possible
Definition: ClarisWksText.cxx:682
ClarisWksText::~ClarisWksText
virtual ~ClarisWksText()
destructor
Definition: ClarisWksText.cxx:650
ClarisWksText::m_document
ClarisWksDocument & m_document
the document
Definition: ClarisWksText.hxx:161
ClarisWksText::readTextZoneSize
bool readTextZoneSize(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone)
try to read the text zone size
Definition: ClarisWksText.cxx:1411
ClarisWksText::readTokens
bool readTokens(MWAWEntry const &entry, ClarisWksTextInternal::Zone &zone)
try to the token zone)
Definition: ClarisWksText.cxx:1164
ClarisWksText::ClarisWksText
ClarisWksText(ClarisWksText const &orig)=delete
ClarisWksText::ClarisWksText
ClarisWksText(ClarisWksDocument &document)
constructor
Definition: ClarisWksText.cxx:642
ClarisWksText::operator=
ClarisWksText & operator=(ClarisWksText const &orig)=delete
ClarisWksText::readParagraphs
bool readParagraphs()
read the rulers block which is present at the beginning of the text in the first version of Claris Wo...
Definition: ClarisWksText.cxx:1854
ClarisWksText::version
int version() const
returns the file version
Definition: ClarisWksText.cxx:654
ClarisWksText::findListId
int findListId(ClarisWksTextInternal::Zone const &zone, int actListId, long cPos, long &lastPos)
try to find a list id which corresponds to the list beginning in actPos
Definition: ClarisWksText.cxx:1783
ClarisWksText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: ClarisWksText.cxx:2173
ClarisWksText::readParagraph
bool readParagraph(int id=-1)
the definition of ruler : present at the beginning of the text in the first version of Claris Works :...
Definition: ClarisWksText.cxx:1893
ClarisWksText::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: ClarisWksText.hxx:170
ClarisWksText::numPages
int numPages() const
returns the number of pages
Definition: ClarisWksText.cxx:661
ClarisWksText::sendText
bool sendText(ClarisWksTextInternal::Zone const &zone, MWAWListenerPtr listener)
send the text zone to the listener
Definition: ClarisWksText.cxx:1469
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWListener
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:50
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:99
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:100
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
ClarisWksTextInternal
Internal: the structures of a ClarisWksText.
Definition: ClarisWksText.cxx:59
ClarisWksStruct::DSET
main structure which correspond to a document part
Definition: ClarisWksStruct.hxx:87
ClarisWksTextInternal::Paragraph
Internal: class to store the paragraph properties.
Definition: ClarisWksText.cxx:117
ClarisWksTextInternal::Zone
Definition: ClarisWksText.cxx:495