/* -*- 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.
*/
/*
* Document data used by the Claris Works parser
*
*/
#ifndef CLARIS_WKS_DOCUMENT
# define CLARIS_WKS_DOCUMENT
#include <vector>
#include "libmwaw_internal.hxx"
#include "MWAWParser.hxx"
#include "MWAWPosition.hxx"
#include "ClarisWksStruct.hxx"
class MWAWSection;
namespace ClarisWksDocumentInternal
{
class SubDocument;
struct State;
}
class ClarisWksParser;
class ClarisWksBMParser;
class ClarisWksPRParser;
class ClarisWksSSParser;
class ClarisWksDatabase;
class ClarisWksGraph;
class ClarisWksStyleManager;
class ClarisWksPresentation;
class ClarisWksSpreadsheet;
class ClarisWksTable;
class ClarisWksText;
//! main document information used to create a ClarisWorks file
class ClarisWksDocument
{
public:
friend class ClarisWksParser;
friend class ClarisWksBMParser;
friend class ClarisWksPRParser;
friend class ClarisWksSSParser;
friend class ClarisWksDocumentInternal::SubDocument;
//! constructor
explicit ClarisWksDocument(MWAWParser &parser);
//! virtual destructor
~ClarisWksDocument();
//! checks if the document header is correct (or not)
bool checkHeader(MWAWHeader *header, bool strict=false);
//! finds the different objects zones
bool createZones();
//! returns the document number of page
int numPages() const;
//! returns the number of expected pages ( accross pages x down page)
MWAWVec2i getDocumentPages();
/** returns the document meta data */
librevenge::RVNGPropertyList const &getDocumentMetaData() const;
//! returns the page height, ie. paper size less margin (in inches) less header/footer size
double getTextHeight() const;
//! returns the page left top point ( in inches)
MWAWVec2f getPageLeftTop() const;
/** updates the page span list */
void updatePageSpanList(std::vector<MWAWPageSpan> &spanList);
/** updates the page span list (and returns a master page)*/
void updatePageSpanList(std::vector<MWAWPageSpan> &spanList, MWAWPageSpan &master);
//! returns the main document section
MWAWSection getMainSection() const;
//! return the zone corresponding to an id ( low level)
std::shared_ptr<ClarisWksStruct::DSET> getZone(int zId) const;
//! try to update the child page of each zone
void updateChildPositions();
/** send a page break */
void newPage(int page, bool softBreak=false);
/** returns the list of the main zones */
std::vector<int> const &getMainZonesList() const;
//! indicates that a zone is parser
void forceParsed(int zoneId);
//! check if we can send a zone as a graphic
bool canSendZoneAsGraphic(int number) const;
//! try to send a zone
bool sendZone(int zoneId, MWAWListenerPtr listener=MWAWListenerPtr(), MWAWPosition pos=MWAWPosition());
//! try to send a database picture
bool sendDatabasePictZone(int pictId, MWAWListenerPtr listener=MWAWListenerPtr(), MWAWPosition pos=MWAWPosition());
/** ask the main parser to create a document to send a footnote */
void sendFootnote(int zoneId);
//! returns the main parser
MWAWParser &getMainParser()
{
return *m_parser;
}
//! returns the style manager
std::shared_ptr<ClarisWksStyleManager> getStyleManager()
{
return m_styleManager;
}
//! returns the database parser
std::shared_ptr<ClarisWksDatabase> getDatabaseParser()
{
return m_databaseParser;
}
//! returns the graph parser
std::shared_ptr<ClarisWksGraph> getGraphParser()
{
return m_graphParser;
}
//! returns the presentation parser
std::shared_ptr<ClarisWksPresentation> getPresentationParser()
{
return m_presentationParser;
}
//! returns the spreadsheet parser
std::shared_ptr<ClarisWksSpreadsheet> getSpreadsheetParser()
{
return m_spreadsheetParser;
}
//! returns the table parser
std::shared_ptr<ClarisWksTable> getTableParser()
{
return m_tableParser;
}
//! returns the text parser
std::shared_ptr<ClarisWksText> getTextParser()
{
return m_textParser;
}
//! read a zone
bool readZone();
//! reads the document header
bool readDocHeader();
//! reads the document info part ( end of the header)
bool readDocInfo();
//! read the print info zone
bool readPrintInfo();
// THE NAMED ENTRY
//! reads the end table ( appears in v3.0 : file version ? )
bool readEndTable(long &eof);
/* sequence of plist of printer : in v6 */
bool readCPRT(MWAWEntry const &entry);
/* read the list of mark */
bool readMARKList(MWAWEntry const &entry);
/* read a URL mark */
bool readURL(long endPos);
/* read a bookmark mark */
bool readBookmark(long endPos);
/* read a document mark */
bool readDocumentMark(long endPos);
/* read a end mark */
bool readEndMark(long endPos);
/* read the document summary */
bool readDSUM(MWAWEntry const &entry, bool inHeader);
/* SNAP (in v6) : size[4]/size[2] picture... */
bool readSNAP(MWAWEntry const &entry);
/* read the temporary file name ? */
bool readTNAM(MWAWEntry const &entry);
//
// low level
//
/** reads the zone DSET
\note set complete to true if we read all the zone */
std::shared_ptr<ClarisWksStruct::DSET> readDSET(bool &complete);
/** try to type the main zones */
void typeMainZones();
/** try to type the main zones recursif, returns the father id*/
int typeMainZonesRec(int zId, ClarisWksStruct::DSET::Position type, int maxHeight);
/** try to find the zone dags structure... */
bool exploreZonesGraph();
/** try to find the zone tree graph ( DSF) function*/
bool exploreZonesGraphRec(int zId, std::set<int> ¬DoneList);
/** remove uneeded edge (mainly header/footer edges in main graph) */
void cleanZonesGraph();
/** try to read a structured zone list of cells */
bool readStructCellZone(char const *zoneName, bool hasEntete, std::vector<MWAWVec2i> &res);
/* read a list of string zone */
bool readStringList(char const *zoneName, bool hasEntete, std::vector<std::string> &res);
/** try to read a structured zone list of picture definition: v5-v6 */
bool readDataLinkList();
//! try to read a unknown zone which appear to be filled at least in some v2 database file
bool readZoneA();
/** small fonction used to check unusual endian ordering of a list of int16_t, int32_t*/
void checkOrdering(std::vector<int16_t> &vec16, std::vector<int32_t> &vec32) const;
protected:
//! returns the final page span to use for the document
MWAWPageSpan getFinalPageSpan() const;
//! the state
std::shared_ptr<ClarisWksDocumentInternal::State> m_state;
public:
//! the parser state
std::shared_ptr<MWAWParserState> m_parserState;
protected:
//! the main parser
MWAWParser *m_parser;
//! the style manager
std::shared_ptr<ClarisWksStyleManager> m_styleManager;
//! the database parser
std::shared_ptr<ClarisWksDatabase> m_databaseParser;
//! the graph parser
std::shared_ptr<ClarisWksGraph> m_graphParser;
//! the spreadsheet parser
std::shared_ptr<ClarisWksPresentation> m_presentationParser;
//! the spreadsheet parser
std::shared_ptr<ClarisWksSpreadsheet> m_spreadsheetParser;
//! the table parser
std::shared_ptr<ClarisWksTable> m_tableParser;
//! the text parser
std::shared_ptr<ClarisWksText> m_textParser;
//
// the callback
//
/** callback used to send a page break */
typedef void (MWAWParser::* NewPage)(int page, bool softBreak);
//! callback used to send a footnote
typedef void (MWAWParser::* SendFootnote)(int zoneId);
/** the new page callback */
NewPage m_newPage;
/** the send footnote callback */
SendFootnote m_sendFootnote;
private:
ClarisWksDocument(ClarisWksDocument const &orig) = delete;
ClarisWksDocument operator=(ClarisWksDocument const &orig) = delete;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: