OCCT

// Created on: 1997-12-09
// Created by: Jean-Louis Frenkel
// Copyright (c) 1997-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _PCDM_ReadWriter_HeaderFile
#define _PCDM_ReadWriter_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <Standard_Transient.hxx>
#include <Standard_Integer.hxx>
#include <PCDM_Reference.hxx>
#include <NCollection_Sequence.hxx>
#include <TCollection_ExtendedString.hxx>
#include <Storage_OpenMode.hxx>
#include <Standard_IStream.hxx>

class TCollection_AsciiString;
class Storage_Data;
class CDM_Document;
class TCollection_ExtendedString;
class Message_Messenger;
class Storage_BaseDriver;

class PCDM_ReadWriter : public Standard_Transient
{

public:
  //! returns PCDM_ReadWriter_1.
  Standard_EXPORT virtual TCollection_AsciiString Version() const = 0;

  Standard_EXPORT virtual void WriteReferenceCounter(
    const occ::handle<Storage_Data>& aData,
    const occ::handle<CDM_Document>& aDocument) const = 0;

  Standard_EXPORT virtual void WriteReferences(
    const occ::handle<Storage_Data>&  aData,
    const occ::handle<CDM_Document>&  aDocument,
    const TCollection_ExtendedString& theReferencerFileName) const = 0;

  Standard_EXPORT virtual void WriteExtensions(
    const occ::handle<Storage_Data>& aData,
    const occ::handle<CDM_Document>& aDocument) const = 0;

  Standard_EXPORT virtual void WriteVersion(const occ::handle<Storage_Data>& aData,
                                            const occ::handle<CDM_Document>& aDocument) const = 0;

  Standard_EXPORT virtual int ReadReferenceCounter(
    const TCollection_ExtendedString&     theFileName,
    const occ::handle<Message_Messenger>& theMsgDriver) const = 0;

  Standard_EXPORT virtual void ReadReferences(
    const TCollection_ExtendedString&     aFileName,
    NCollection_Sequence<PCDM_Reference>& theReferences,
    const occ::handle<Message_Messenger>& theMsgDriver) const = 0;

  Standard_EXPORT virtual void ReadExtensions(
    const TCollection_ExtendedString&                 aFileName,
    NCollection_Sequence<TCollection_ExtendedString>& theExtensions,
    const occ::handle<Message_Messenger>&             theMsgDriver) const = 0;

  Standard_EXPORT virtual int ReadDocumentVersion(
    const TCollection_ExtendedString&     aFileName,
    const occ::handle<Message_Messenger>& theMsgDriver) const = 0;

  Standard_EXPORT static void Open(const occ::handle<Storage_BaseDriver>& aDriver,
                                   const TCollection_ExtendedString&      aFileName,
                                   const Storage_OpenMode                 anOpenMode);

  //! returns the convenient Reader for a File.
  Standard_EXPORT static occ::handle<PCDM_ReadWriter> Reader(
    const TCollection_ExtendedString& aFileName);

  Standard_EXPORT static occ::handle<PCDM_ReadWriter> Writer();

  Standard_EXPORT static void WriteFileFormat(const occ::handle<Storage_Data>& aData,
                                              const occ::handle<CDM_Document>& aDocument);

  //! Parses a persisted document reference in the form "identifier version file-name".
  //! @param[in] theReference persisted reference record to parse
  //! @param[out] theIdentifier parsed reference identifier
  //! @param[out] theDocumentVersion parsed document version
  //! @param[out] theFileName parsed file name, which may contain spaces
  //! @return true on success; false for an incomplete record or a non-numeric identifier/version.
  //!         Output arguments remain unchanged when false is returned.
  Standard_EXPORT static bool ParseReference(const TCollection_ExtendedString& theReference,
                                             int&                              theIdentifier,
                                             int&                              theDocumentVersion,
                                             TCollection_ExtendedString&       theFileName);

  //! tries to get a format in the file. returns an empty
  //! string if the file could not be read or does not have
  //! a FileFormat information.
  Standard_EXPORT static TCollection_ExtendedString FileFormat(
    const TCollection_ExtendedString& aFileName);

  //! tries to get a format from the stream. returns an empty
  //! string if the file could not be read or does not have
  //! a FileFormat information.
  Standard_EXPORT static TCollection_ExtendedString FileFormat(Standard_IStream& theIStream,
                                                               occ::handle<Storage_Data>& theData);

  DEFINE_STANDARD_RTTIEXT(PCDM_ReadWriter, Standard_Transient)
};

#endif // _PCDM_ReadWriter_HeaderFile