ClarisWksDatabase.hxx Source File documentation

ClarisWksDatabase.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 ( database part )
36 *
37 */
38#ifndef CLARIS_WKS_DATABASE
39# define CLARIS_WKS_DATABASE
40
41#include <list>
42#include <string>
43#include <vector>
44
45#include "MWAWEntry.hxx"
46#include "MWAWSubDocument.hxx"
47
48#include "MWAWDebug.hxx"
49#include "MWAWInputStream.hxx"
50
51#include "MWAWParser.hxx"
52
53#include "ClarisWksStruct.hxx"
54
55namespace ClarisWksDatabaseInternal
56{
57struct Database;
58struct Field;
59struct State;
60}
61
62class ClarisWksDocument;
63class ClarisWksParser;
64class ClarisWksStyleManager;
65
71 class ClarisWksDatabase
72{
73 friend class ClarisWksParser;
74
75public:
77 explicit ClarisWksDatabase(ClarisWksDocument &document);
79 virtual ~ClarisWksDatabase();
80
82 int version() const;
83
85 int numPages() const;
86
88 std::shared_ptr<ClarisWksStruct::DSET> readDatabaseZone
89 (ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete);
91 bool canSendDatabaseAsGraphic(int) const
92 {
93 return false;
94 }
96 bool sendDatabase(int number, MWAWListenerPtr listener);
97
98protected:
99 //
100 // Intermediate level
101 //
103 bool readFields(ClarisWksDatabaseInternal::Database &dBase);
104
106 bool readDefaults(ClarisWksDatabaseInternal::Database &dBase);
107
109 bool readLayout(ClarisWksDatabaseInternal::Database &dBase);
110
111 //
112 // low level
113 //
114
115private:
116 ClarisWksDatabase(ClarisWksDatabase const &) = delete;
117 ClarisWksDatabase &operator=(ClarisWksDatabase const &) = delete;
118
119protected:
120 //
121 // data
122 //
123
125 ClarisWksDocument &m_document;
126
128 MWAWParserStatePtr m_parserState;
129
131 std::shared_ptr<ClarisWksDatabaseInternal::State> m_state;
132
134 MWAWParser *m_mainParser;
135};
136#endif
137// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
ClarisWksStruct.hxx
MWAWDebug.hxx
MWAWEntry.hxx
MWAWInputStream.hxx
MWAWParser.hxx
MWAWSubDocument.hxx
ClarisWksDatabase
the main class to read the text part of Claris Works file
Definition: ClarisWksDatabase.hxx:72
ClarisWksDatabase::sendDatabase
bool sendDatabase(int number, MWAWListenerPtr listener)
sends the zone data to the listener (if it exists )
Definition: ClarisWksDatabase.cxx:825
ClarisWksDatabase::version
int version() const
returns the file version
Definition: ClarisWksDatabase.cxx:279
ClarisWksDatabase::readDatabaseZone
std::shared_ptr< ClarisWksStruct::DSET > readDatabaseZone(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete)
reads the zone Text DSET
Definition: ClarisWksDatabase.cxx:297
ClarisWksDatabase::~ClarisWksDatabase
virtual ~ClarisWksDatabase()
destructor
Definition: ClarisWksDatabase.cxx:276
ClarisWksDatabase::operator=
ClarisWksDatabase & operator=(ClarisWksDatabase const &)=delete
ClarisWksDatabase::readLayout
bool readLayout(ClarisWksDatabaseInternal::Database &dBase)
try to read the layout structures
Definition: ClarisWksDatabase.cxx:747
ClarisWksDatabase::ClarisWksDatabase
ClarisWksDatabase(ClarisWksDatabase const &)=delete
ClarisWksDatabase::readDefaults
bool readDefaults(ClarisWksDatabaseInternal::Database &dBase)
try to read the default structure
Definition: ClarisWksDatabase.cxx:656
ClarisWksDatabase::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: ClarisWksDatabase.hxx:134
ClarisWksDatabase::m_state
std::shared_ptr< ClarisWksDatabaseInternal::State > m_state
the state
Definition: ClarisWksDatabase.hxx:131
ClarisWksDatabase::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksDatabase.hxx:128
ClarisWksDatabase::ClarisWksDatabase
ClarisWksDatabase(ClarisWksDocument &document)
constructor
Definition: ClarisWksDatabase.cxx:268
ClarisWksDatabase::numPages
int numPages() const
returns the number of pages
Definition: ClarisWksDatabase.cxx:285
ClarisWksDatabase::readFields
bool readFields(ClarisWksDatabaseInternal::Database &dBase)
try to read the database structure
Definition: ClarisWksDatabase.cxx:474
ClarisWksDatabase::canSendDatabaseAsGraphic
bool canSendDatabaseAsGraphic(int) const
check if we can send a database as graphic
Definition: ClarisWksDatabase.hxx:91
ClarisWksDatabase::m_document
ClarisWksDocument & m_document
the document
Definition: ClarisWksDatabase.hxx:125
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
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:100
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
ClarisWksDatabaseInternal
Internal: the structures of a ClarisWksDatabase.
Definition: ClarisWksDatabase.cxx:58
ClarisWksDatabaseInternal::Database
Internal: the database of a ClarisWksDatabase.
Definition: ClarisWksDatabase.cxx:225
ClarisWksStruct::DSET
main structure which correspond to a document part
Definition: ClarisWksStruct.hxx:87