xref: /aosp_15_r20/external/google-breakpad/src/client/mac/crash_generation/ConfigFile.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 // Utility class that can persist a SimpleStringDictionary to disk.
30 
31 #import <Foundation/Foundation.h>
32 
33 #include "common/simple_string_dictionary.h"
34 
35 namespace google_breakpad {
36 
37 BOOL EnsureDirectoryPathExists(NSString* dirPath);
38 
39 //=============================================================================
40 class ConfigFile {
41  public:
ConfigFile()42   ConfigFile() {
43     config_file_ = -1;
44     config_file_path_[0] = 0;
45     has_created_file_ = false;
46   }
47 
~ConfigFile()48   ~ConfigFile() {
49   }
50 
51   void WriteFile(const char* directory,
52                  const SimpleStringDictionary* configurationParameters,
53                  const char* dump_dir,
54                  const char* minidump_id);
55 
GetFilePath()56   const char* GetFilePath() { return config_file_path_; }
57 
Unlink()58   void Unlink() {
59     if (config_file_ != -1)
60       unlink(config_file_path_);
61 
62     config_file_ = -1;
63   }
64 
65  private:
66   BOOL WriteData(const void* data, size_t length);
67 
68   BOOL AppendConfigData(const char* key,
69                         const void* data,
70                         size_t length);
71 
72   BOOL AppendConfigString(const char* key,
73                           const char* value);
74 
75   BOOL AppendCrashTimeParameters(const char* processStartTimeString);
76 
77   int   config_file_;                    // descriptor for config file
78   char  config_file_path_[PATH_MAX];     // Path to configuration file
79   bool  has_created_file_;
80 };
81 
82 } // namespace google_breakpad
83