0031918: Application Framework - New binary format for fast reading part of OCAF...
[occt.git] / src / BinTools / BinTools_IStream.hxx
1 // Copyright (c) 2021 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _BinTools_IStream_HeaderFile
15 #define _BinTools_IStream_HeaderFile
16
17 #include <BinTools.hxx>
18 #include <BinTools_ObjectType.hxx>
19 #include <TopAbs_ShapeEnum.hxx>
20 #include <TopAbs_Orientation.hxx>
21 #include <gp_Pnt.hxx>
22
23 //! Substitution of IStream for shape reader for fast management of position in the file (get and go)
24 //! and operation on all reading types.
25 class BinTools_IStream
26 {
27 public:
28
29   //! Creates IStream using the current stream IStream.
30   Standard_EXPORT BinTools_IStream (Standard_IStream& theStream);
31
32   //! Reads and returns the type.
33   Standard_EXPORT BinTools_ObjectType ReadType();
34   //! Returns the last read type.
35   Standard_EXPORT const BinTools_ObjectType& LastType() { return myLastType; }
36   //! Returns the shape type by the last retrieved type.
37   Standard_EXPORT TopAbs_ShapeEnum ShapeType();
38   //! Returns the shape orientation by the last retrieved type.
39   Standard_EXPORT TopAbs_Orientation ShapeOrientation();
40
41   //! Returns the current position in the stream.
42   Standard_EXPORT uint64_t Position() { return myPosition; }
43   //! Moves the current stream position to the given one.
44   Standard_EXPORT void GoTo (const uint64_t& thePosition);
45
46   //! Returns true if the last restored type is one of a reference
47   Standard_EXPORT Standard_Boolean IsReference();
48   //! Reads a reference IStream using the last restored type.
49   Standard_EXPORT uint64_t ReadReference();
50   //! Returns the original IStream.
51   Standard_EXPORT Standard_IStream& Stream() { return *myStream; }
52   //! Makes up to date the myPosition because myStream was used outside and position is changed.
53   Standard_EXPORT void UpdatePosition() { myPosition = uint64_t (myStream->tellg()); }
54
55   //! Returns false if stream reading is failed.
56   Standard_EXPORT operator bool() const;
57   //! Reads real value from the stream.
58   Standard_EXPORT Standard_Real ReadReal() { Standard_Real aValue; *this >> aValue; return aValue; }
59   Standard_EXPORT BinTools_IStream& operator >> (Standard_Real& theValue);
60   //! Reads integer value from the stream.
61   Standard_EXPORT Standard_Integer ReadInteger() { Standard_Integer aValue; *this >> aValue; return aValue; }
62   Standard_EXPORT BinTools_IStream& operator >> (Standard_Integer& theValue);
63   //! Reads point coordinates value from the stream.
64   Standard_EXPORT gp_Pnt ReadPnt() { gp_Pnt aValue; *this >> aValue; return aValue; }
65   Standard_EXPORT BinTools_IStream& operator >> (gp_Pnt& theValue);
66   //! Reads byte value from the stream.
67   Standard_EXPORT Standard_Byte ReadByte() { Standard_Byte aValue; *this >> aValue; return aValue; }
68   Standard_EXPORT BinTools_IStream& operator >> (Standard_Byte& theValue);
69   //! Reads boolean value from the stream (stored as one byte).
70   Standard_EXPORT Standard_Boolean ReadBool() { return ReadByte() != 0; }
71   Standard_EXPORT BinTools_IStream& operator >> (Standard_Boolean& theValue) { theValue = ReadByte() != 0; return *this; }
72   //! Reads short real value from the stream.
73   Standard_EXPORT Standard_ShortReal ReadShortReal() { Standard_ShortReal aValue; *this >> aValue; return aValue; }
74   Standard_EXPORT BinTools_IStream& operator >> (Standard_ShortReal& theValue);
75   //! Reads transformation value from the stream.
76   Standard_EXPORT BinTools_IStream& operator >> (gp_Trsf& theValue);
77   //! Reads 3 boolean values from one byte
78   Standard_EXPORT void ReadBools (Standard_Boolean& theBool1, Standard_Boolean& theBool2, Standard_Boolean& theBool3);
79   //! Reads 7 boolean values from one byte
80   Standard_EXPORT void ReadBools (Standard_Boolean& theBool1, Standard_Boolean& theBool2, Standard_Boolean& theBool3,
81     Standard_Boolean& theBool4, Standard_Boolean& theBool5, Standard_Boolean& theBool6, Standard_Boolean& theBool7);
82
83
84 private:
85   Standard_IStream* myStream; ///< pointer to the stream
86   uint64_t myPosition; ///< equivalent to tellg returned value for fast access
87   BinTools_ObjectType myLastType; ///< last type that was read
88 };
89
90 #endif // _BinTools_IStream_HeaderFile