ClarisWksDatabase.hxx
Go to the documentation of this file.
/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
/* libmwaw
* Version: MPL 2.0 / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 2.0 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
* Copyright (C) 2006, 2007 Andrew Ziem
* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the LGPLv2+ are applicable
* instead of those above.
*/
/*
* Parser to Claris Works text document ( database part )
*
*/
#ifndef CLARIS_WKS_DATABASE
# define CLARIS_WKS_DATABASE
#include <list>
#include <string>
#include <vector>
#include "MWAWEntry.hxx"
#include "MWAWSubDocument.hxx"
#include "MWAWDebug.hxx"
#include "MWAWInputStream.hxx"
#include "MWAWParser.hxx"
#include "ClarisWksStruct.hxx"
namespace ClarisWksDatabaseInternal
{
struct Database;
struct Field;
struct State;
}
class ClarisWksDocument;
class ClarisWksParser;
class ClarisWksStyleManager;
class ClarisWksDatabase
{
friend class ClarisWksParser;
public:
explicit ClarisWksDatabase(ClarisWksDocument &document);
virtual ~ClarisWksDatabase();
int version() const;
int numPages() const;
std::shared_ptr<ClarisWksStruct::DSET> readDatabaseZone
(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete);
bool canSendDatabaseAsGraphic(int) const
{
return false;
}
bool sendDatabase(int number, MWAWListenerPtr listener);
protected:
//
// Intermediate level
//
bool readFields(ClarisWksDatabaseInternal::Database &dBase);
bool readDefaults(ClarisWksDatabaseInternal::Database &dBase);
bool readLayout(ClarisWksDatabaseInternal::Database &dBase);
//
// low level
//
private:
ClarisWksDatabase(ClarisWksDatabase const &) = delete;
ClarisWksDatabase &operator=(ClarisWksDatabase const &) = delete;
protected:
//
// data
//
ClarisWksDocument &m_document;
MWAWParserStatePtr m_parserState;
std::shared_ptr<ClarisWksDatabaseInternal::State> m_state;
MWAWParser *m_mainParser;
};
#endif
// 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::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::ClarisWksParser
friend class ClarisWksParser
Definition ClarisWksDatabase.hxx:73
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
ClarisWksDatabaseInternal::Field
Definition ClarisWksDatabase.cxx:59
ClarisWksDatabaseInternal::State
Internal: the state of a ClarisWksDatabase.
Definition ClarisWksDatabase.cxx:253
ClarisWksStruct::DSET
main structure which correspond to a document part
Definition ClarisWksStruct.hxx:87