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