Open3D (C++ API)  0.12.0
FileSystem.h
Go to the documentation of this file.
1 // ----------------------------------------------------------------------------
2 // - Open3D: www.open3d.org -
3 // ----------------------------------------------------------------------------
4 // The MIT License (MIT)
5 //
6 // Copyright (c) 2018 www.open3d.org
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // ----------------------------------------------------------------------------
26 
27 #pragma once
28 
29 #include <functional>
30 #include <string>
31 #include <vector>
32 
33 namespace open3d {
34 namespace utility {
35 namespace filesystem {
36 
37 std::string GetFileExtensionInLowerCase(const std::string &filename);
38 
39 std::string GetFileNameWithoutExtension(const std::string &filename);
40 
41 std::string GetFileNameWithoutDirectory(const std::string &filename);
42 
43 std::string GetFileParentDirectory(const std::string &filename);
44 
45 std::string GetRegularizedDirectoryName(const std::string &directory);
46 
47 std::string GetWorkingDirectory();
48 
49 std::vector<std::string> GetPathComponents(const std::string &path);
50 
51 bool ChangeWorkingDirectory(const std::string &directory);
52 
53 bool DirectoryExists(const std::string &directory);
54 
55 bool MakeDirectory(const std::string &directory);
56 
57 bool MakeDirectoryHierarchy(const std::string &directory);
58 
59 bool DeleteDirectory(const std::string &directory);
60 
61 bool FileExists(const std::string &filename);
62 
63 bool RemoveFile(const std::string &filename);
64 
65 bool ListDirectory(const std::string &directory,
66  std::vector<std::string> &subdirs,
67  std::vector<std::string> &filenames);
68 
69 bool ListFilesInDirectory(const std::string &directory,
70  std::vector<std::string> &filenames);
71 
72 bool ListFilesInDirectoryWithExtension(const std::string &directory,
73  const std::string &extname,
74  std::vector<std::string> &filenames);
75 
76 std::vector<std::string> FindFilesRecursively(
77  const std::string &directory,
78  std::function<bool(const std::string &)> is_match);
79 
80 // wrapper for fopen that enables unicode paths on Windows
81 FILE *FOpen(const std::string &filename, const std::string &mode);
82 std::string GetIOErrorString(const int errnoVal);
83 bool FReadToBuffer(const std::string &path,
84  std::vector<char> &bytes,
85  std::string *errorStr);
86 
97 class CFile {
98 public:
100  ~CFile();
101 
103  bool Open(const std::string &filename, const std::string &mode);
104 
106  std::string GetError();
107 
109  void Close();
110 
112  int64_t CurPos();
113 
115  int64_t GetFileSize();
116 
118  int64_t GetNumLines();
119 
124  const char *ReadLine();
125 
130  template <class T>
131  size_t ReadData(T *data, size_t num_elems) {
132  return ReadData(data, sizeof(T), num_elems);
133  }
134 
139  size_t ReadData(void *data, size_t elem_size, size_t num_elems);
140 
142  FILE *GetFILE() { return file_; }
143 
144 private:
145  FILE *file_ = nullptr;
146  int error_code_ = 0;
147  std::vector<char> line_buffer_;
148 };
149 
150 } // namespace filesystem
151 } // namespace utility
152 } // namespace open3d
bool DeleteDirectory(const std::string &directory)
Definition: FileSystem.cpp:213
std::vector< std::string > FindFilesRecursively(const std::string &directory, std::function< bool(const std::string &)> is_match)
Definition: FileSystem.cpp:291
const char const char value recording_handle imu_sample recording_handle uint8_t size_t data_size k4a_record_configuration_t config target_format k4a_capture_t capture_handle k4a_imu_sample_t imu_sample playback_handle k4a_logging_message_cb_t void min_level device_handle k4a_imu_sample_t timeout_in_ms capture_handle capture_handle capture_handle image_handle temperature_c k4a_image_t image_handle uint8_t image_handle image_handle image_handle image_handle image_handle timestamp_usec white_balance image_handle k4a_device_configuration_t config device_handle char size_t serial_number_size bool int32_t int32_t int32_t int32_t k4a_color_control_mode_t default_mode mode
Definition: K4aPlugin.cpp:680
std::string GetIOErrorString(const int errnoVal)
Definition: FileSystem.cpp:332
std::string GetFileExtensionInLowerCase(const std::string &filename)
Definition: FileSystem.cpp:56
std::string GetFileNameWithoutDirectory(const std::string &filename)
Definition: FileSystem.cpp:76
bool FReadToBuffer(const std::string &path, std::vector< char > &bytes, std::string *errorStr)
Definition: FileSystem.cpp:383
bool Open(const std::string &filename, const std::string &mode)
Open a file.
Definition: FileSystem.cpp:433
~CFile()
The destructor closes the file automatically.
Definition: FileSystem.cpp:431
const char * ReadLine()
Definition: FileSystem.cpp:514
size_t ReadData(T *data, size_t num_elems)
Definition: FileSystem.h:131
bool ListFilesInDirectoryWithExtension(const std::string &directory, const std::string &extname, std::vector< std::string > &filenames)
Definition: FileSystem.cpp:272
bool DirectoryExists(const std::string &directory)
Definition: FileSystem.cpp:184
bool ChangeWorkingDirectory(const std::string &directory)
Definition: FileSystem.cpp:180
bool ListFilesInDirectory(const std::string &directory, std::vector< std::string > &filenames)
Definition: FileSystem.cpp:266
void Close()
Close the file.
Definition: FileSystem.cpp:444
Definition: FileSystem.h:97
void * bytes
Definition: TriangleMeshBuffers.cpp:176
std::string GetError()
Returns the last encountered error for this file.
Definition: FileSystem.cpp:442
FILE * GetFILE()
Returns the underlying C FILE pointer.
Definition: FileSystem.h:142
std::string GetFileParentDirectory(const std::string &filename)
Definition: FileSystem.cpp:85
int64_t CurPos()
Returns current position in the file (ftell).
Definition: FileSystem.cpp:454
std::string GetWorkingDirectory()
Definition: FileSystem.cpp:102
bool MakeDirectoryHierarchy(const std::string &directory)
Definition: FileSystem.cpp:198
Definition: PinholeCameraIntrinsic.cpp:35
bool RemoveFile(const std::string &filename)
Definition: FileSystem.cpp:233
std::string GetFileNameWithoutExtension(const std::string &filename)
Definition: FileSystem.cpp:70
std::vector< std::string > GetPathComponents(const std::string &path)
Definition: FileSystem.cpp:108
int64_t GetNumLines()
Returns the number of lines in the file.
Definition: FileSystem.cpp:487
std::string GetRegularizedDirectoryName(const std::string &directory)
Definition: FileSystem.cpp:94
bool FileExists(const std::string &filename)
Definition: FileSystem.cpp:221
int64_t GetFileSize()
Returns the file size in bytes.
Definition: FileSystem.cpp:466
bool ListDirectory(const std::string &directory, std::vector< std::string > &subdirs, std::vector< std::string > &filenames)
Definition: FileSystem.cpp:237
FILE * FOpen(const std::string &filename, const std::string &mode)
Definition: FileSystem.cpp:314
bool MakeDirectory(const std::string &directory)
Definition: FileSystem.cpp:190
const char const char value recording_handle imu_sample recording_handle uint8_t data
Definition: K4aPlugin.cpp:274