// Created on: 1993-02-04 // Created by: Christian CAILLET // Copyright (c) 1993-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 _Interface_FileReaderTool_HeaderFile #define _Interface_FileReaderTool_HeaderFile #include "Standard.hxx" #include "Standard_DefineAlloc.hxx" #include "Standard_Handle.hxx" #include "Standard_Integer.hxx" #include "Standard_Transient.hxx" #include "NCollection_Array1.hxx" #include "NCollection_HArray1.hxx" class Interface_Protocol; class Interface_FileReaderData; class Interface_InterfaceModel; class Message_Messenger; class Interface_Check; class Standard_Transient; class Interface_GeneralLib; class Interface_ReaderLib; //! Defines services which are required to load an InterfaceModel //! from a File. Typically, it may firstly transform a system //! file into a FileReaderData object, then work on it, not longer //! considering file contents, to load an Interface Model. //! It may also work on a FileReaderData already loaded. //! //! FileReaderTool provides, on one hand, some general services //! which are common to all read operations but can be redefined, //! plus general actions to be performed specifically for each //! Norm, as deferred methods to define. //! //! In particular, FileReaderTool defines the Interface's Unknown //! and Error entities class Interface_FileReaderTool { public: DEFINE_STANDARD_ALLOC //! Sets Data to a FileReaderData. Works with a Protocol Standard_EXPORT void SetData(const occ::handle& reader, const occ::handle& protocol); //! Returns the Protocol given at creation time Standard_EXPORT occ::handle Protocol() const; //! Returns the FileReaderData which is used to work Standard_EXPORT occ::handle Data() const; //! Stores a Model. Used when the Model has been loaded Standard_EXPORT void SetModel(const occ::handle& amodel); //! Returns the stored Model Standard_EXPORT occ::handle Model() const; //! Sets Messenger used for outputting messages Standard_EXPORT void SetMessenger(const occ::handle& messenger); //! Returns Messenger used for outputting messages. //! The returned object is guaranteed to be non-null; //! default is Message::Messenger(). Standard_EXPORT occ::handle Messenger() const; //! Sets trace level used for outputting messages //! - 0: no trace at all //! - 1: errors //! - 2: errors and warnings //! - 3: all messages //! Default is 1 : Errors traced Standard_EXPORT void SetTraceLevel(const int tracelev); //! Returns trace level used for outputting messages. Standard_EXPORT int TraceLevel() const; //! Allows controlling whether exception raisings are handled //! If err is False, they are not (hence, dbx can take control) //! If err is True, they are, and they are traced //! (by putting on messenger Entity's Number and file record num) //! Default given at Model's creation time is True Standard_EXPORT void SetErrorHandle(const bool err); //! Returns ErrorHandle flag Standard_EXPORT bool ErrorHandle() const; //! Fills records with empty entities; once done, each entity can //! ask the FileReaderTool for any entity referenced through an //! identifier. Calls Recognize which is specific to each specific //! type of FileReaderTool Standard_EXPORT void SetEntities(); //! Recognizes a record, given its number. Specific to each //! Interface; called by SetEntities. It can call the basic method //! RecognizeByLib. //! Returns False if recognition has failed, True else. //! has not to be filled if simply Recognition has failed : //! it must record true error messages : RecognizeByLib can //! generate error messages if NewRead is called //! //! Note that it works thru a Recognizer (method Evaluate) which //! has to be memorized before starting Standard_EXPORT virtual bool Recognize(const int num, occ::handle& ach, occ::handle& ent) = 0; //! Recognizes a record with the help of Libraries. Can be used //! to implement the method Recognize. //! is used to find Protocol and CaseNumber to apply //! performs the creation (by service NewVoid, or NewRead //! if NewVoid gave no result) //! is a check, which is transmitted to NewRead if it is //! called, gives a result but which is false //! is the result //! Returns False if recognition has failed, True else Standard_EXPORT bool RecognizeByLib(const int num, Interface_GeneralLib& glib, Interface_ReaderLib& rlib, occ::handle& ach, occ::handle& ent) const; //! Provides an unknown entity, specific to the Interface //! called by SetEntities when Recognize has failed (Unknown alone) //! or by LoadModel when an Entity has caused a Fail on reading //! (to keep at least its literal description) //! Uses Protocol to do it Standard_EXPORT occ::handle UnknownEntity() const; //! Creates an empty Model of the norm. Uses Protocol to do it Standard_EXPORT occ::handle NewModel() const; //! Reads and fills Entities from the FileReaderData set by //! SetData to an InterfaceModel. //! It enchains required operations, the specific ones correspond //! to deferred methods (below) to be defined for each Norm. //! It manages also error recovery and trace. //! Remark : it calls SetModel. //! It Can raise any error which can occur during a load //! operation, unless Error Handling is set. //! This method can also be redefined if judged necessary. Standard_EXPORT void LoadModel(const occ::handle& amodel); //! Reads, Fills and Returns one Entity read from a Record of the //! FileReaderData. This Method manages also case of Fail or //! Warning, by producing a ReportEntyty plus , for a Fail, a //! literal Content (as an UnknownEntity). Performs also Trace Standard_EXPORT occ::handle LoadedEntity(const int num); //! Fills model's header; each Interface defines for its Model its //! own file header; this method fills it from FileReaderTool.+ //! It is called by AnalyseFile from InterfaceModel Standard_EXPORT virtual void BeginRead(const occ::handle& amodel) = 0; //! Fills an Entity, given record no; specific to each Interface, //! called by AnalyseFile from InterfaceModel (which manages its //! calling arguments) //! To work, each Interface can define a method in its proper //! Transient class, like this (given as an example) : //! AnalyseRecord (me : mutable; FR : in out FileReaderTool; //! num : Integer; acheck : in out Check) //! returns Boolean; //! and call it from AnalyseRecord //! //! Returned Value : True if the entity could be loaded, False //! else (in case of syntactic fail) Standard_EXPORT virtual bool AnalyseRecord(const int num, const occ::handle& anent, occ::handle& acheck) = 0; Standard_EXPORT virtual ~Interface_FileReaderTool(); //! Ends file reading after reading all the entities //! default is doing nothing; redefinable as necessary Standard_EXPORT virtual void EndRead(const occ::handle& amodel); //! Clear fields Standard_EXPORT void Clear(); protected: //! Constructor; sets default fields Standard_EXPORT Interface_FileReaderTool(); private: occ::handle theproto; occ::handle thereader; occ::handle themodel; occ::handle themessenger; int thetrace; bool theerrhand; int thenbrep0; int thenbreps; occ::handle>> thereports; }; #endif // _Interface_FileReaderTool_HeaderFile