/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */

/* libstaroffice

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

*/

/*

 * StarZone zone of StarOffice document

 *

 */

#ifndef STAR_ZONE

#  define STAR_ZONE

#include <vector>

#include <stack>

#include "libstaroffice_internal.hxx"

#include "STOFFDebug.hxx"

#include "StarEncoding.hxx"

class StarEncryption;

/** \brief a zone in a StarOffice file

 *

 *

 *

 */

class StarZone

{

public:

  //! constructor

  StarZone(STOFFInputStreamPtr const &input, std::string const &ascName, std::string const &zoneName, char const *password);

  //! destructor

  virtual ~StarZone();

  //! read the zone header present in a SW file

  bool readSWHeader();

  //! check encryption

  bool checkEncryption(uint32_t date, uint32_t time, std::vector<uint8_t> const &passwd);

  //! open a zone header present in a SDR file

  bool openSDRHeader(std::string &magic);

  //! close a zone header

  bool closeSDRHeader(std::string const &debugName);

  //! open a zone header present in a SCH file

  bool openSCHHeader();

  //! close a zone header

  bool closeSCHHeader(std::string const &debugName);

  //! open a version compat header (version+size)

  bool openVersionCompatHeader();

  //! close a zone header

  bool closeVersionCompatHeader(std::string const &debugName);

  //! returns the StarOffice version: 3-5

  int getVersion() const

  {

    return m_version;

  }

  //! returns the StarOffice document version

  int getDocumentVersion() const

  {

    return m_documentVersion;

  }

  //! returns the StarOffice header version (if set)

  int getHeaderVersion() const

  {

    return m_headerVersionStack.empty() ? 0 : m_headerVersionStack.top();

  }

  //! checks if the document is compatible with vers

  int isCompatibleWith(int vers) const

  {

    return m_documentVersion>=vers;

  }

  //! checks if the document is compatible with vers1 and not vers2

  int isCompatibleWith(int vers1, int vers2) const

  {

    return m_documentVersion>=vers1 && m_documentVersion<vers2;

  }

  //! checks if the document is compatible with vers1 and not vers2 or vers3

  int isCompatibleWith(int vers1, int vers2, int vers3) const

  {

    return (m_documentVersion>=vers1 && m_documentVersion<vers2) ||

           m_documentVersion>=vers3;

  }

  //! checks if the document is compatible with vers1 and not vers2 or vers3 and not vers4

  int isCompatibleWith(int vers1, int vers2, int vers3, int vers4) const

  {

    return (m_documentVersion>=vers1 && m_documentVersion<vers2) ||

           (m_documentVersion>=vers3 && m_documentVersion<vers4);

  }

  //! returns the zone encoding

  StarEncoding::Encoding getEncoding() const

  {

    return m_encoding;

  }

  //! sets the zone encoding

  void setEncoding(StarEncoding::Encoding encod)

  {

    m_encoding=encod;

  }

  //! returns the zone GUI type

  int getGuiType() const

  {

    return m_guiType;

  }

  //! sets the zone GUI type

  void setGuiType(int type)

  {

    m_guiType=type;

  }

  //

  // basic

  //

  //! try to open a classic record: size (32 bytes) +  size-4 bytes

  bool openRecord();

  //! try to close a record

  bool closeRecord(std::string const &debugName)

  {

    return closeRecord(' ', debugName);

  }

  //! open a dummy record

  bool openDummyRecord();

  //! close a dummy record

  bool closeDummyRecord()

  {

    return closeRecord('@', "Entries(BadDummy)");

  }

  //

  // sc record

  //

  //! try to open a SC record: size (32 bytes) + size bytes

  bool openSCRecord();

  //! try to close a record

  bool closeSCRecord(std::string const &debugName)

  {

    return closeRecord('_', debugName);

  }

  //

  // sw record

  //

  //! try to open a SW record: type + size (24 bytes)

  bool openSWRecord(unsigned char &type);

  //! try to close a record

  bool closeSWRecord(unsigned char type, std::string const &debugName)

  {

    return closeRecord(type, debugName);

  }

  //

  // sfx record

  //

  //! try to open a Sfx record: type + size (24 bytes)

  bool openSfxRecord(unsigned char &type);

  //! try to close a record

  bool closeSfxRecord(unsigned char type, std::string const &debugName)

  {

    return closeRecord(type, debugName);

  }

  //! returns the record level

  int getRecordLevel() const

  {

    return int(m_positionStack.size());

  }

  //! returns the actual record last position

  long getRecordLastPosition() const

  {

    if (m_positionStack.empty()) {

      STOFF_DEBUG_MSG(("StarZone::getRecordLastPosition: can not find last position\n"));

      return 0;

    }

    return m_positionStack.top();

  }

  //! try to open a cflag zone

  unsigned char openFlagZone();

  //! close the cflag zone

  void closeFlagZone();

  //! returns the flag last position

  long getFlagLastPosition() const

  {

    return m_flagEndZone;

  }

  //! try to read an unicode string

  bool readString(std::vector<uint32_t> &string, int encoding=-1) const

  {

    std::vector<size_t> srcPositions;

    return readString(string, srcPositions, encoding);

  }

  //! try to read an unicode string

  bool readString(std::vector<uint32_t> &string, std::vector<size_t> &srcPositions, int encoding=-1, bool checkEncryption=false) const;

  //! try to read a pool of strings

  bool readStringsPool();

  //! return the number of pool name

  int getNumPoolNames() const

  {

    return int(m_poolList.size());

  }

  //! try to return a pool name

  bool getPoolName(int poolId, librevenge::RVNGString &res) const

  {

    res="";

    if (poolId>=0 && poolId<int(m_poolList.size())) {

      res=m_poolList[size_t(poolId)];

      return true;

    }

    if (poolId==0xFFF0) return true;

    STOFF_DEBUG_MSG(("StarZone::getPoolName: can not find pool name for %d\n", poolId));

    return false;

  }

  //! return the zone input

  STOFFInputStreamPtr input()

  {

    return m_input;

  }

  //! reset the current input

  void setInput(STOFFInputStreamPtr input);

  //! returns the ascii file

  libstoff::DebugFile &ascii()

  {

    return m_ascii;

  }

  //! return the zone name

  std::string const &name() const

  {

    return m_zoneName;

  }

protected:

  //

  // low level

  //

  //! try to read the record sizes

  bool readRecordSizes(long pos);

  //! try to close a record

  bool closeRecord(unsigned char type, std::string const &debugName);

  //

  // data

  //

  //! the input stream

  STOFFInputStreamPtr m_input;

  //! the ascii zone

  libstoff::DebugFile m_ascii;

  //! the zone version

  int m_version;

  //! the document version

  int m_documentVersion;

  //! the header version (for SDR zone)

  std::stack<int> m_headerVersionStack;

  //! the zone encoding

  StarEncoding::Encoding m_encoding;

  //! the zone GUI type

  int m_guiType;

  //! the encryption

  std::shared_ptr<StarEncryption> m_encryption;

  //! the file ascii name

  std::string m_asciiName;

  //! the zone name

  std::string m_zoneName;

  //! the type stack

  std::stack<unsigned char> m_typeStack;

  //! the position stack

  std::stack<long> m_positionStack;

  //! other position to end position zone

  std::map<long, long> m_beginToEndMap;

  //! end of a cflags zone

  long m_flagEndZone;

  //! the pool name list

  std::vector<librevenge::RVNGString> m_poolList;

};

#endif

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