0032565: Foundation Classes, OSD_FileSystem - expose interface for registering global...
[occt.git] / src / OSD / OSD_FileSystemSelector.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_FileSystemSelector_HeaderFile
15 #define _OSD_FileSystemSelector_HeaderFile
16
17 #include <OSD_FileSystem.hxx>
18
19 #include <NCollection_List.hxx>
20
21 //! File system implementation which tried to open stream using registered list of file systems.
22 class OSD_FileSystemSelector : public OSD_FileSystem
23 {
24   DEFINE_STANDARD_RTTIEXT(OSD_FileSystemSelector, OSD_FileSystem)
25 public:
26
27   //! Constructor.
28   OSD_FileSystemSelector() {}
29
30   //! Registers file system within this selector.
31   //! @param theFileSystem  [in] file system to register
32   //! @param theIsPreferred [in] add to the beginning of the list when TRUE, or add to the end otherwise
33   Standard_EXPORT void AddProtocol (const Handle(OSD_FileSystem)& theFileSystem, bool theIsPreferred = false);
34
35   //! Unregisters file system within this selector.
36   Standard_EXPORT void RemoveProtocol (const Handle(OSD_FileSystem)& theFileSystem);
37
38 public:
39
40   //! Returns TRUE if URL defines a supported protocol.
41   Standard_EXPORT virtual bool IsSupportedPath (const TCollection_AsciiString& theUrl) const Standard_OVERRIDE;
42
43   //! Returns TRUE if current input stream is opened for reading operations.
44   Standard_EXPORT virtual Standard_Boolean IsOpenIStream (const opencascade::std::shared_ptr<std::istream>& theStream) const Standard_OVERRIDE;
45
46   //! Returns TRUE if current output stream is opened for writing operations.
47   Standard_EXPORT virtual Standard_Boolean IsOpenOStream (const opencascade::std::shared_ptr<std::ostream>& theStream) const Standard_OVERRIDE;
48
49   //! Opens input stream using one of registered protocols.
50   Standard_EXPORT virtual opencascade::std::shared_ptr<std::istream> OpenIStream
51                           (const TCollection_AsciiString& theUrl,
52                            const std::ios_base::openmode theMode,
53                            const int64_t theOffset = 0,
54                            const opencascade::std::shared_ptr<std::istream>& theOldStream = opencascade::std::shared_ptr<std::istream>()) Standard_OVERRIDE;
55
56   //! Opens output stream using one of registered protocols.
57   Standard_EXPORT virtual opencascade::std::shared_ptr<std::ostream> OpenOStream (const TCollection_AsciiString& theUrl,
58                                                                                   const std::ios_base::openmode theMode) Standard_OVERRIDE;
59
60   //! Opens stream buffer using one of registered protocols.
61   Standard_EXPORT virtual opencascade::std::shared_ptr<std::streambuf> OpenStreamBuffer
62                           (const TCollection_AsciiString& theUrl,
63                            const std::ios_base::openmode theMode,
64                            const int64_t theOffset = 0,
65                            int64_t* theOutBufSize = NULL) Standard_OVERRIDE;
66
67 protected:
68
69   NCollection_List<Handle(OSD_FileSystem)> myProtocols;
70
71 };
72
73 #endif // _OSD_FileSystemSelector_HeaderFile