MsWks4Text.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_WKS4_TEXT
#  define MS_WKS4_TEXT

#include <vector>

#include "MWAWEntry.hxx"
#include "MWAWDebug.hxx"
#include "MWAWInputStream.hxx"

namespace MsWks4TextInternal
{
struct Font;
struct Paragraph;
struct State;
}

class MsWksDocument;
class MsWks4Zone;

class MsWks4Text
{
  friend class MsWks4Zone;
protected:
  struct DataFOD;
  typedef bool (MsWks4Text::* FDPParser)(MWAWInputStreamPtr &input, long endPos,
                                         int &id, std::string &mess);
public:
  MsWks4Text(MsWksDocument &document);

  ~MsWks4Text();

  void setDefault(MWAWFont &font);

  int numPages() const;

  void flushExtra(MWAWInputStreamPtr /*input*/) {}

protected:
  bool readStructures(MWAWInputStreamPtr input, bool mainOle);

  bool readText(MWAWInputStreamPtr input, MWAWEntry const &entry, bool mainOle);

  bool readFootNote(MWAWInputStreamPtr input, int id);

  //----------------------------------------
  // PLC parsing, setting
  //----------------------------------------
  typedef bool (MsWks4Text::* DataParser)
  (MWAWInputStreamPtr input, long endPos,  long bot, long eot, int id, std::string &mess);

  bool readPLC(MWAWInputStreamPtr input, MWAWEntry const &entry,
               std::vector<long> &textPtrs, std::vector<long> &listValues,
               DataParser parser = &MsWks4Text::defDataParser);
  bool readSimplePLC(MWAWInputStreamPtr &input, MWAWEntry const &entry,
                     std::vector<long> &textPtrs,
                     std::vector<long> &listValues)
  {
    return readPLC(input, entry, textPtrs, listValues);
  }

  bool defDataParser(MWAWInputStreamPtr input, long endPos,
                     long bot, long eot, int id, std::string &mess);

  bool readFontNames(MWAWInputStreamPtr input, MWAWEntry const &entry);

  bool readFont(MWAWInputStreamPtr &input, long endPos,
                int &id, std::string &mess);

  void setProperty(MsWks4TextInternal::Paragraph const &tabs);
  bool readParagraph(MWAWInputStreamPtr &input, long endPos,
                     int &id, std::string &mess);

  bool ftntDataParser(MWAWInputStreamPtr input, long endPos,
                      long bot, long eot, int id, std::string &mess);

  bool eobjDataParser(MWAWInputStreamPtr input, long endPos,
                      long bot, long eot, int id, std::string &mess);

  bool toknDataParser(MWAWInputStreamPtr input, long endPos,
                      long bot, long eot, int id, std::string &mess);

  bool pgdDataParser(MWAWInputStreamPtr input, long endPos,
                     long , long, int id, std::string &mess);

  void flushNote(int noteId);

protected:
  std::vector<DataFOD> mergeSortedLists
  (std::vector<DataFOD> const &lst1, std::vector<DataFOD> const &lst2) const;

  bool readFDP(MWAWInputStreamPtr &input, MWAWEntry const &entry,
               std::vector<DataFOD> &fods, FDPParser parser);

  bool findFDPStructures(MWAWInputStreamPtr &input, int which);
  bool findFDPStructuresByHand(MWAWInputStreamPtr &input, int which);

protected:
  struct DataFOD {
    enum Type { ATTR_TEXT, ATTR_PARAG, ATTR_PLC, ATTR_UNKN };

    DataFOD() : m_type(ATTR_UNKN), m_pos(-1), m_defPos(0), m_id(-1) {}

    Type m_type;
    long m_pos;
    long m_defPos;
    int m_id;
  };

private:
  MsWks4Text(MsWks4Text const &orig);
  MsWks4Text &operator=(MsWks4Text const &orig);
protected:
  MWAWParser *m_mainParser;
  MWAWParserStatePtr m_parserState;

  MsWksDocument &m_document;

  MWAWEntry m_textPositions;

  mutable shared_ptr<MsWks4TextInternal::State> m_state;

  std::vector<DataFOD> m_FODsList;

  std::vector<MWAWEntry const *> m_FDPCs;
  std::vector<MWAWEntry const *> m_FDPPs;
};

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