xref: /aosp_15_r20/tools/netsim/src/util/ini_file.h (revision cf78ab8cffb8fc9207af348f23af247fb04370a6)
1*cf78ab8cSAndroid Build Coastguard Worker /*
2*cf78ab8cSAndroid Build Coastguard Worker  * Copyright 2022 The Android Open Source Project
3*cf78ab8cSAndroid Build Coastguard Worker  *
4*cf78ab8cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*cf78ab8cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*cf78ab8cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*cf78ab8cSAndroid Build Coastguard Worker  *
8*cf78ab8cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*cf78ab8cSAndroid Build Coastguard Worker  *
10*cf78ab8cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*cf78ab8cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*cf78ab8cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*cf78ab8cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*cf78ab8cSAndroid Build Coastguard Worker  * limitations under the License.
15*cf78ab8cSAndroid Build Coastguard Worker  */
16*cf78ab8cSAndroid Build Coastguard Worker 
17*cf78ab8cSAndroid Build Coastguard Worker #pragma once
18*cf78ab8cSAndroid Build Coastguard Worker 
19*cf78ab8cSAndroid Build Coastguard Worker #include <optional>
20*cf78ab8cSAndroid Build Coastguard Worker #include <string>
21*cf78ab8cSAndroid Build Coastguard Worker #include <string_view>
22*cf78ab8cSAndroid Build Coastguard Worker #include <unordered_map>
23*cf78ab8cSAndroid Build Coastguard Worker 
24*cf78ab8cSAndroid Build Coastguard Worker namespace netsim {
25*cf78ab8cSAndroid Build Coastguard Worker 
26*cf78ab8cSAndroid Build Coastguard Worker // A simple class to process init file. Modified from
27*cf78ab8cSAndroid Build Coastguard Worker // external/qemu/android/android-emu-base/android/base/files/IniFile.h
28*cf78ab8cSAndroid Build Coastguard Worker class IniFile {
29*cf78ab8cSAndroid Build Coastguard Worker  public:
30*cf78ab8cSAndroid Build Coastguard Worker   // Note that the constructor _does not_ read data from the backing file.
31*cf78ab8cSAndroid Build Coastguard Worker   // Call |Read| to read the data.
filepath(std::move (filepath))32*cf78ab8cSAndroid Build Coastguard Worker   explicit IniFile(std::string filepath = "") : filepath(std::move(filepath)) {}
33*cf78ab8cSAndroid Build Coastguard Worker 
34*cf78ab8cSAndroid Build Coastguard Worker   // Reads data into IniFile from the backing file, overwriting any
35*cf78ab8cSAndroid Build Coastguard Worker   // existing data.
36*cf78ab8cSAndroid Build Coastguard Worker   bool Read();
37*cf78ab8cSAndroid Build Coastguard Worker 
38*cf78ab8cSAndroid Build Coastguard Worker   // Writes the current IniFile to the backing file.
39*cf78ab8cSAndroid Build Coastguard Worker   bool Write();
40*cf78ab8cSAndroid Build Coastguard Worker 
41*cf78ab8cSAndroid Build Coastguard Worker   // Checks if a certain key exists in the file.
42*cf78ab8cSAndroid Build Coastguard Worker   bool HasKey(const std::string &key) const;
43*cf78ab8cSAndroid Build Coastguard Worker 
44*cf78ab8cSAndroid Build Coastguard Worker   // Gets value.
45*cf78ab8cSAndroid Build Coastguard Worker   std::optional<std::string> Get(const std::string &key) const;
46*cf78ab8cSAndroid Build Coastguard Worker 
47*cf78ab8cSAndroid Build Coastguard Worker   // Sets value.
48*cf78ab8cSAndroid Build Coastguard Worker   void Set(const std::string &key, std::string_view value);
49*cf78ab8cSAndroid Build Coastguard Worker 
50*cf78ab8cSAndroid Build Coastguard Worker  private:
51*cf78ab8cSAndroid Build Coastguard Worker   std::unordered_map<std::string, std::string> data;
52*cf78ab8cSAndroid Build Coastguard Worker   std::string filepath;
53*cf78ab8cSAndroid Build Coastguard Worker };
54*cf78ab8cSAndroid Build Coastguard Worker 
55*cf78ab8cSAndroid Build Coastguard Worker }  // namespace netsim
56