xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/core/utils/io/FileHandler.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_IO_FILE_HANDLER_H
25 #define ARM_COMPUTE_IO_FILE_HANDLER_H
26 
27 #include <fstream>
28 #include <string>
29 
30 namespace arm_compute
31 {
32 namespace io
33 {
34 /** File Handling interface */
35 class FileHandler
36 {
37 public:
38     /** Default Constructor */
39     FileHandler();
40     /** Default Destructor */
41     ~FileHandler();
42     /** Allow instances of this class to be moved */
43     FileHandler(FileHandler &&) = default;
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     FileHandler(const FileHandler &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     FileHandler &operator=(const FileHandler &) = delete;
48     /** Allow instances of this class to be moved */
49     FileHandler &operator=(FileHandler &&) = default;
50     /** Opens file
51      *
52      * @param[in] filename File name
53      * @param[in] mode     File open mode
54      */
55     void open(const std::string &filename, std::ios_base::openmode mode);
56     /** Closes file */
57     void close();
58     /** Returns the file stream
59      *
60      * @return File stream
61      */
62     std::fstream &stream();
63     /** Returns filename of the handled file
64      *
65      * @return File filename
66      */
67     std::string filename() const;
68 
69 private:
70     std::fstream            _filestream;
71     std::string             _filename;
72     std::ios_base::openmode _mode;
73 };
74 } // namespace io
75 } // namespace arm_compute
76 #endif /* ARM_COMPUTE_IO_FILE_HANDLER_H */
77