blob: 18ce16df36bfabe0320379812d47c4575149e3c8 [file] [log] [blame]
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -07001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Prabir Pradhanc08b0db2022-09-10 00:57:15 +000017#pragma once
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070018
Siarhei Vishniakou4d9f9772020-09-02 22:28:29 -050019#include <android-base/result.h>
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070020#include <utils/Tokenizer.h>
Harry Cutts2b67ff12023-03-13 11:32:06 +000021
22#include <string>
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -070023#include <unordered_map>
Harry Cutts2b67ff12023-03-13 11:32:06 +000024#include <unordered_set>
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070025
26namespace android {
27
28/*
29 * Provides a mechanism for passing around string-based property key / value pairs
30 * and loading them from property files.
31 *
32 * The property files have the following simple structure:
33 *
34 * # Comment
35 * key = value
36 *
37 * Keys and values are any sequence of printable ASCII characters.
38 * The '=' separates the key from the value.
39 * The key and value may not contain whitespace.
40 *
41 * The '\' character is reserved for escape sequences and is not currently supported.
42 * The '"" character is reserved for quoting and is not currently supported.
43 * Files that contain the '\' or '"' character will fail to parse.
44 *
45 * The file must not contain duplicate keys.
46 *
47 * TODO Support escape sequences and quoted values when needed.
48 */
49class PropertyMap {
50public:
51 /* Creates an empty property map. */
52 PropertyMap();
53 ~PropertyMap();
54
55 /* Clears the property map. */
56 void clear();
57
58 /* Adds a property.
59 * Replaces the property with the same key if it is already present.
60 */
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -070061 void addProperty(const std::string& key, const std::string& value);
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070062
Harry Cutts2b67ff12023-03-13 11:32:06 +000063 /* Returns a set of all property keys starting with the given prefix. */
64 std::unordered_set<std::string> getKeysWithPrefix(const std::string& prefix) const;
65
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070066 /* Gets the value of a property and parses it.
67 * Returns true and sets outValue if the key was found and its value was parsed successfully.
68 * Otherwise returns false and does not modify outValue. (Also logs a warning.)
69 */
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -070070 bool tryGetProperty(const std::string& key, std::string& outValue) const;
71 bool tryGetProperty(const std::string& key, bool& outValue) const;
72 bool tryGetProperty(const std::string& key, int32_t& outValue) const;
73 bool tryGetProperty(const std::string& key, float& outValue) const;
Harry Cutts2b67ff12023-03-13 11:32:06 +000074 bool tryGetProperty(const std::string& key, double& outValue) const;
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070075
76 /* Adds all values from the specified property map. */
77 void addAll(const PropertyMap* map);
78
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070079 /* Loads a property map from a file. */
Siarhei Vishniakou4d9f9772020-09-02 22:28:29 -050080 static android::base::Result<std::unique_ptr<PropertyMap>> load(const char* filename);
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070081
82private:
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -070083 /* Returns true if the property map contains the specified key. */
84 bool hasProperty(const std::string& key) const;
85
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070086 class Parser {
87 PropertyMap* mMap;
88 Tokenizer* mTokenizer;
89
90 public:
91 Parser(PropertyMap* map, Tokenizer* tokenizer);
92 ~Parser();
93 status_t parse();
94
95 private:
96 status_t parseType();
97 status_t parseKey();
98 status_t parseKeyProperty();
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -070099 status_t parseModifier(const std::string& token, int32_t* outMetaState);
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -0700100 status_t parseCharacterLiteral(char16_t* outCharacter);
101 };
102
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -0700103 std::unordered_map<std::string, std::string> mProperties;
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -0700104};
105
106} // namespace android