xref: /aosp_15_r20/external/google-breakpad/src/common/tests/file_utils.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2011 Google LLC
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //     * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //     * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //     * Neither the name of Google LLC nor the names of its
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 // file_utils.h: Define utility functions for file manipulation, which
30 // are used for testing.
31 
32 #ifndef COMMON_TESTS_FILE_UTILS_H_
33 #define COMMON_TESTS_FILE_UTILS_H_
34 
35 #include <string>
36 
37 namespace google_breakpad {
38 
39 // Copies a file from |from_path| to |to_path|. Returns true on success.
40 bool CopyFile(const std::string& from_path, const std::string& to_path);
41 bool CopyFile(const char* from_path, const char* to_path);
42 
43 // Reads the content of a file at |path| into |buffer|. |buffer_size| specifies
44 // the size of |buffer| in bytes and returns the number of bytes read from the
45 // file on success. Returns true on success.
46 bool ReadFile(const char* path, void* buffer, ssize_t* buffer_size);
47 
48 // Writes |buffer_size| bytes of the content in |buffer| to a file at |path|.
49 // Returns true on success.
50 bool WriteFile(const char* path, const void* buffer, size_t buffer_size);
51 
52 }  // namespace google_breakpad
53 
54 #endif  // COMMON_TESTS_FILE_UTILS_H_
55