1 /*
2  * Copyright (c) 2023-2024 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef SECURITY_COMPONENT_BASE_H
16 #define SECURITY_COMPONENT_BASE_H
17 
18 #include "nlohmann/json.hpp"
19 #include "sec_comp_info.h"
20 
21 namespace OHOS {
22 namespace Security {
23 namespace SecurityComponent {
24 constexpr int32_t UNKNOWN_TEXT = -2;
25 constexpr int32_t NO_TEXT = -1;
26 constexpr int32_t UNKNOWN_ICON = -2;
27 constexpr int32_t NO_ICON = -1;
28 
29 enum class SecCompBackground {
30     UNKNOWN_BG = -2,
31     NO_BG_TYPE = -1,
32     CAPSULE = 0,
33     CIRCLE = 1,
34     NORMAL = 2,
35     MAX_BG_TYPE
36 };
37 
38 class __attribute__((visibility("default"))) JsonTagConstants final {
39 public:
40     static const std::string JSON_RECT;
41     static const std::string JSON_SC_TYPE;
42     static const std::string JSON_NODE_ID;
43     static const std::string JSON_RECT_X;
44     static const std::string JSON_RECT_Y;
45     static const std::string JSON_RECT_WIDTH;
46     static const std::string JSON_RECT_HEIGHT;
47     static const std::string JSON_WINDOW_RECT;
48 
49     static const std::string JSON_SIZE_TAG;
50     static const std::string JSON_FONT_SIZE_TAG;
51     static const std::string JSON_ICON_SIZE_TAG;
52     static const std::string JSON_PADDING_SIZE_TAG;
53     static const std::string JSON_PADDING_LEFT_TAG;
54     static const std::string JSON_PADDING_TOP_TAG;
55     static const std::string JSON_PADDING_RIGHT_TAG;
56     static const std::string JSON_PADDING_BOTTOM_TAG;
57     static const std::string JSON_TEXT_ICON_PADDING_TAG;
58     static const std::string JSON_RECT_WIDTH_TAG;
59     static const std::string JSON_RECT_HEIGHT_TAG;
60     static const std::string JSON_COLORS_TAG;
61     static const std::string JSON_FONT_COLOR_TAG;
62     static const std::string JSON_ICON_COLOR_TAG;
63     static const std::string JSON_BG_COLOR_TAG;
64 
65     static const std::string JSON_BORDER_TAG;
66     static const std::string JSON_BORDER_WIDTH_TAG;
67     static const std::string JSON_PARENT_TAG;
68     static const std::string JSON_PARENT_EFFECT_TAG;
69     static const std::string JSON_IS_CLIPPED_TAG;
70     static const std::string JSON_TOP_CLIP_TAG;
71     static const std::string JSON_BOTTOM_CLIP_TAG;
72     static const std::string JSON_LEFT_CLIP_TAG;
73     static const std::string JSON_RIGHT_CLIP_TAG;
74     static const std::string JSON_PARENT_TAG_TAG;
75 
76     static const std::string JSON_STYLE_TAG;
77     static const std::string JSON_TEXT_TAG;
78     static const std::string JSON_ICON_TAG;
79     static const std::string JSON_BG_TAG;
80     static const std::string JSON_WINDOW_ID;
81 };
82 
83 class __attribute__((visibility("default"))) SecCompBase {
84 public:
85     SecCompBase() = default;
86     virtual ~SecCompBase() = default;
87     bool FromJson(const nlohmann::json& jsonSrc);
88     void ToJson(nlohmann::json& jsonRes) const;
89     std::string ToJsonStr(void) const;
90     virtual bool CompareComponentBasicInfo(SecCompBase *other, bool isRectCheck) const;
SetValid(bool valid)91     void SetValid(bool valid)
92     {
93         isValid_ = valid;
94     };
95 
GetValid()96     bool GetValid()
97     {
98         return isValid_;
99     };
100 
101     // size
102     DimensionT fontSize_ = DEFAULT_DIMENSION;
103     DimensionT iconSize_ = DEFAULT_DIMENSION;
104     PaddingSize padding_;
105     DimensionT textIconSpace_ = DEFAULT_DIMENSION;
106 
107     // color
108     SecCompColor fontColor_;
109     SecCompColor iconColor_;
110     SecCompColor bgColor_;
111 
112     // border
113     DimensionT borderWidth_ = DEFAULT_DIMENSION;
114 
115     // parent effect
116     bool parentEffect_ = false;
117     bool isClipped_ = false;
118     DimensionT topClip_;
119     DimensionT bottomClip_;
120     DimensionT leftClip_;
121     DimensionT rightClip_;
122     std::string parentTag_;
123 
124     SecCompType type_ = UNKNOWN_SC_TYPE;
125     SecCompRect rect_;
126     SecCompRect windowRect_;
127     bool isValid_ = false;
128 
129     int32_t text_ = UNKNOWN_TEXT;
130     int32_t icon_ = UNKNOWN_ICON;
131     SecCompBackground bg_ = SecCompBackground::UNKNOWN_BG;
132 
133     int32_t windowId_ = 0;
134     int32_t nodeId_ = 0;
135 protected:
136     virtual bool IsTextIconTypeValid() = 0;
137     virtual bool IsCorrespondenceType() = 0;
138 private:
139     bool ParseDimension(const nlohmann::json& json, const std::string& tag, DimensionT& res);
140     bool ParseColor(const nlohmann::json& json, const std::string& tag, SecCompColor& res);
141     bool ParseBool(const nlohmann::json& json, const std::string& tag, bool& res);
142     bool ParseString(const nlohmann::json& json, const std::string& tag, std::string& res);
143     bool ParsePadding(const nlohmann::json& json, const std::string& tag, PaddingSize& res);
144     bool ParseColors(const nlohmann::json& json, const std::string& tag);
145     bool ParseBorders(const nlohmann::json& json, const std::string& tag);
146     bool ParseSize(const nlohmann::json& json, const std::string& tag);
147     bool ParseParent(const nlohmann::json& json, const std::string& tag);
148     bool ParseRect(const nlohmann::json& json, const std::string& tag, SecCompRect& rect);
149     bool ParseStyle(const nlohmann::json& json, const std::string& tag);
150 };
151 }  // namespace SecurityComponent
152 }  // namespace Security
153 }  // namespace OHOS
154 #endif  // SECURITY_COMPONENT_BASE_H
155