MsWksDocument.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.
*/

#ifndef MS_WKS_DOCUMENT
#  define MS_WKS_DOCUMENT

#include <string>
#include <map>
#include <vector>

#include <librevenge/librevenge.h>

#include "libmwaw_internal.hxx"

#include "MWAWDebug.hxx"
#include "MWAWCell.hxx"

namespace MsWksDocumentInternal
{
struct State;

class SubDocument;
}

class MsWksParser;
class MsWksDBParser;
class MsWksDRParser;
class MsWksSSParser;
class MsWks4Zone;

class MsWksGraph;
class MsWks3Text;
class MsWks4Text;

class MsWksDocument
{
  friend class MsWksDocumentInternal::SubDocument;
  friend class MsWksParser;
  friend class MsWks4Zone;
  friend class MsWksDBParser;
  friend class MsWksDRParser;
  friend class MsWksSSParser;
public:
  enum ZoneType { Z_MAIN, Z_HEADER, Z_FOOTER, Z_NONE };
  struct Zone {
    Zone(ZoneType type=Z_NONE, int zoneId=-1) : m_type(type), m_zoneId(zoneId), m_textId(-1) {}
    ZoneType m_type;
    int m_zoneId;
    int m_textId;
  };

public:

  MsWksDocument(MWAWInputStreamPtr input, MWAWParser &parser);
  virtual ~MsWksDocument();

  int version() const;
  void setVersion(int vers);
  MWAWDocument::Kind getKind() const;
  void setKind(MWAWDocument::Kind kind);

  MWAWInputStreamPtr &getInput()
  {
    return m_input;
  }
  MWAWParser &getMainParser()
  {
    return *m_parser;
  }
  shared_ptr<MsWksGraph> getGraphParser()
  {
    return m_graphParser;
  }
  shared_ptr<MsWks3Text> getTextParser3();
  shared_ptr<MsWks4Text> getTextParser4();
  libmwaw::DebugFile &ascii()
  {
    return m_asciiFile;
  }

  //
  // read some v3 structure
  //

  bool checkHeader3(MWAWHeader *header, bool strict=false);
  long getLengthOfFileHeader3() const;
  bool readPrintInfo();
  bool readDocumentInfo(long sz=-1);
  bool readZone(Zone &zone);
  bool readGroupHeaderFooter(bool header, int check);

  //
  // read some ole structures
  //

  bool createOLEZones(MWAWInputStreamPtr input);
  std::vector<std::string> const &getUnparsedOLEZones() const;
  //
  // utilities functions
  //

  bool hasHeader() const;
  bool hasFooter() const;
  float getHeaderFooterHeight(bool header) const;
  void getPageSpanList(std::vector<MWAWPageSpan> &pagesList, int &numPages);
  static bool getColor(int id, MWAWColor &col, int vers);
  static std::vector<MWAWColor> const &getPalette(int vers);

  std::multimap<int, Zone> &getTypeZoneMap();
  Zone getZone(ZoneType type) const;
  int getNewZoneId() const;
  std::multimap<std::string, MWAWEntry> &getEntryMap();

  // general interface

  void sendZone(int zoneType);

  // interface with the text parser

  void newPage(int page, bool softBreak=false);
  void sendFootnoteContent(int noteId);
  void sendFootnote(int id);
  void sendText(int id);

  // interface with the graph parser

  void sendOLE(int id, MWAWPosition const &pos, MWAWGraphicStyle const &style);
  void sendRBIL(int id, MWAWVec2i const &sz);
  void sendTextbox(MWAWEntry const &entry, std::string const &frame);

protected:
  //
  // spreadsheet/database function
  //

  bool readCellInFormula(MWAWCellContent::FormulaInstruction &instr, bool is2D);
  bool readDBString(long endPos, std::string &res);
  bool readDBNumber(long endPos, double &res, bool &isNan, std::string &str);
  /* reads a formula */
  bool readFormula(long endPos, MWAWCellContent &content, std::string &extra);

protected:

  //
  // low level
  //
  void initAsciiFile(std::string const &name);

private:
  MsWksDocument(MsWksDocument const &orig);
  MsWksDocument &operator=(MsWksDocument const &orig);

  //
  // data
  //

protected:
  shared_ptr<MsWksDocumentInternal::State> m_state;
public:
  shared_ptr<MWAWParserState> m_parserState;

protected:
  MWAWParser *m_parser;
  MsWksDocument *m_parentDocument;
  MWAWInputStreamPtr m_input;
  libmwaw::DebugFile m_asciiFile;

  shared_ptr<MsWksGraph> m_graphParser;
  shared_ptr<MsWks3Text> m_textParser3;
  shared_ptr<MsWks4Text> m_textParser4;

  typedef void (MWAWParser::* NewPage)(int page, bool softBreak);

  NewPage m_newPage;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: