forked from eclipse-iceoryx/iceoryx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
file_reader.hpp
78 lines (69 loc) · 2.61 KB
/
file_reader.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2021 - 2022 by Apex.AI Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_DUST_FILE_READER_FILE_READER_HPP
#define IOX_DUST_FILE_READER_FILE_READER_HPP
#include <fstream>
namespace iox
{
namespace cxx
{
/// @brief Wrapper class for file reading operations. Tries to open a file in the constructor. Error handling strategy
/// can be decided by means of the ErrorMode argument.
///
/// @code
/// cxx::FileReader reader("filename");
/// std::string str;
/// if(reader.isOpen()) {
/// reader.readLine(str);
/// }
///
/// // Terminates program execution, if file cannot be opened (or found):
/// cxx::FileReader reader("filename", "path/to/file", cxx::FileReader::ErrorMode::Terminate);
/// @endcode
class FileReader
{
public:
/// Error handling strategy. Ignore continues execution as if nothing happened. Inform continues, but prints an
/// error message. Terminate causes the process to exit.
enum class ErrorMode
{
Ignore,
Inform,
Terminate
};
/// Opens a file and creates a FileReader object. The file path argument is optional and is ignored if empty. The
/// error mode is evaluated when an error occurs.
explicit FileReader(const std::string& f_fileName,
const std::string& f_filePath = "",
ErrorMode f_errorMode = ErrorMode::Inform) noexcept;
FileReader(const FileReader&) = delete;
FileReader(FileReader&&) = delete;
FileReader& operator=(const FileReader&) = delete;
FileReader& operator=(FileReader&&) = delete;
~FileReader() noexcept = default;
/// Check if the associated file is open.
bool isOpen() const noexcept;
/// Read one line from the file and store the result in f_string.
bool readLine(std::string& f_string) noexcept;
private:
std::fstream m_fileStream;
std::string m_file;
ErrorMode m_errorMode;
};
} // namespace cxx
} // namespace iox
#endif // IOX_DUST_FILE_READER_FILE_READER_HPP