/* -*- 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 MWAW_HEADER_H

#define MWAW_HEADER_H

/** \file MWAWHeader.hxx

 * Defines MWAWHeader (document's type, version, kind)

 */

#include <vector>

#include <librevenge-stream/librevenge-stream.h>

#include <libmwaw/libmwaw.hxx>

#include "MWAWInputStream.hxx"

/** \brief a function used by MWAWDocument to store the version of document

 *

 * This class is responsible for finding a list of potential formats

 * corresponding to a file, this list will latter be checked by

 * calling the corresponding parser's function checkHeader via

 * MWAWDocument.

 *

 * This class also allows to store the document type, king and version.

 */

class MWAWHeader

{

public:

  typedef enum MWAWDocument::Type Type;

  typedef enum MWAWDocument::Kind Kind;

  /** constructor given the input

      \param type the document type

      \param version the file version

      \param kind the document kind (default word processing document)

  */

  explicit MWAWHeader(MWAWDocument::Type type=MWAWDocument::MWAW_T_UNKNOWN, int version=0,

                      MWAWDocument::Kind kind = MWAWDocument::MWAW_K_TEXT);

  MWAWHeader(MWAWHeader const &)=default;

  MWAWHeader &operator=(MWAWHeader const &)=default;

  //! destructor

  virtual ~MWAWHeader();

  /** tests the input file and returns a header if the file looks like a MWAW document ( trying first to use the resource parsed if it exists )

  \note this check phase can only be partial ; ie. we only test the first bytes of the file and/or the existence of some oles. This explains that MWAWDocument implements a more complete test to recognize the difference Mac Files which share the same type of header...

  */

  static std::vector<MWAWHeader> constructHeader

  (MWAWInputStreamPtr input, std::shared_ptr<MWAWRSRCParser> rsrcParser);

  //! resets the data

  void reset(MWAWDocument::Type type, int vers, Kind kind = MWAWDocument::MWAW_K_TEXT)

  {

    m_docType = type;

    m_version = vers;

    m_docKind = kind;

  }

  //! returns the major version

  int getMajorVersion() const

  {

    return m_version;

  }

  //! sets the major version

  void setMajorVersion(int version)

  {

    m_version=version;

  }

  //! returns the document type

  Type getType() const

  {

    return m_docType;

  }

  //! sets the document type

  void setType(Type type)

  {

    m_docType = type;

  }

  //! returns the document kind

  Kind getKind() const

  {

    return m_docKind;

  }

  //! sets the document kind

  void setKind(Kind kind)

  {

    m_docKind = kind;

  }

private:

  /** the document version */

  int m_version;

  /** the document type */

  Type m_docType;

  /** the document kind */

  Kind m_docKind;

};

#endif /* MWAWHEADER_H */

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