0032565: Foundation Classes, OSD_FileSystem - expose interface for registering global...
[occt.git] / src / OSD / OSD_FileSystem.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 _OSD_FileSystem_HeaderFile
15 #define _OSD_FileSystem_HeaderFile
16
17 #include <OSD_StreamBuffer.hxx>
18 #include <TCollection_AsciiString.hxx>
19
20 //! Base interface for a file stream provider.
21 //! It is intended to be implemented for specific file protocol.
22 class OSD_FileSystem : public Standard_Transient
23 {
24   DEFINE_STANDARD_RTTIEXT(OSD_FileSystem, Standard_Transient)
25 public:
26
27   //! Returns a global file system, which a selector between registered file systems (OSD_FileSystemSelector).
28   Standard_EXPORT static const Handle(OSD_FileSystem)& DefaultFileSystem();
29
30   //! Registers file system within the global file system selector returned by OSD_FileSystem::DefaultFileSystem().
31   //! Note that registering protocols is not thread-safe operation and expected to be done once at application startup.
32   //! @param[in] theFileSystem  file system to register
33   //! @param[in] theIsPreferred add to the beginning of the list when TRUE, or add to the end otherwise
34   Standard_EXPORT static void AddDefaultProtocol (const Handle(OSD_FileSystem)& theFileSystem, bool theIsPreferred = false);
35
36   //! Unregisters file system within the global file system selector returned by OSD_FileSystem::DefaultFileSystem().
37   Standard_EXPORT static void RemoveDefaultProtocol (const Handle(OSD_FileSystem)& theFileSystem);
38
39 public:
40
41   //! Returns TRUE if URL defines a supported protocol.
42   virtual Standard_Boolean IsSupportedPath (const TCollection_AsciiString& theUrl) const = 0;
43
44   //! Returns TRUE if current input stream is opened for reading operations.
45   virtual Standard_Boolean IsOpenIStream (const opencascade::std::shared_ptr<std::istream>& theStream) const = 0;
46
47   //! Returns TRUE if current output stream is opened for writing operations.
48   virtual Standard_Boolean IsOpenOStream(const opencascade::std::shared_ptr<std::ostream>& theStream) const = 0;
49
50   //! Opens stream for specified file URL for reading operations (std::istream).
51   //! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer().
52   //! @param theUrl       [in] path to open
53   //! @param theMode      [in] flags describing the requested input mode for the stream (std::ios_base::in will be implicitly added)
54   //! @param theOffset    [in] expected stream position from the beginning of the file (beginning of the stream by default);
55   //!                          -1 would keep seek position undefined (in case of re-using theOldStream)
56   //! @param theOldStream [in] a pointer to existing stream pointing to theUrl to be reused (without re-opening)
57   //! @return pointer to newly created opened stream, to theOldStream if it can be reused or NULL in case of failure.
58   Standard_EXPORT virtual opencascade::std::shared_ptr<std::istream> OpenIStream
59                           (const TCollection_AsciiString& theUrl,
60                            const std::ios_base::openmode theMode,
61                            const int64_t theOffset = 0,
62                            const opencascade::std::shared_ptr<std::istream>& theOldStream = opencascade::std::shared_ptr<std::istream>());
63
64   //! Opens stream for specified file URL for writing operations (std::ostream).
65   //! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer().
66   //! @param theUrl       [in] path to open
67   //! @param theMode      [in] flags describing the requested output mode for the stream (std::ios_base::out will be implicitly added)
68   //! @return pointer to newly created opened stream or NULL in case of failure.
69   Standard_EXPORT virtual opencascade::std::shared_ptr<std::ostream> OpenOStream (const TCollection_AsciiString& theUrl,
70                                                                                   const std::ios_base::openmode theMode);
71
72   //! Opens stream buffer for specified file URL.
73   //! @param theUrl        [in]  path to open
74   //! @param theMode       [in]  flags describing the requested input mode for the stream
75   //! @param theOffset     [in]  expected stream position from the beginning of the buffer (beginning of the stream buffer by default)
76   //! @param theOutBufSize [out] total buffer size (only if buffer is opened for read)
77   //! @return pointer to newly created opened stream buffer or NULL in case of failure.
78   virtual opencascade::std::shared_ptr<std::streambuf> OpenStreamBuffer (const TCollection_AsciiString& theUrl,
79                                                                          const std::ios_base::openmode theMode,
80                                                                          const int64_t theOffset = 0,
81                                                                          int64_t* theOutBufSize = NULL) = 0;
82
83   //! Constructor.
84   Standard_EXPORT OSD_FileSystem();
85
86   //! Destructor.
87   Standard_EXPORT virtual ~OSD_FileSystem();
88 };
89 #endif // _OSD_FileSystem_HeaderFile