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 static const std::string JSON_DISPLAY_ID; 82 static const std::string JSON_CROSS_AXIS_STATE; 83 }; 84 85 class __attribute__((visibility("default"))) SecCompBase { 86 public: 87 SecCompBase() = default; 88 virtual ~SecCompBase() = default; 89 bool FromJson(const nlohmann::json& jsonSrc); 90 void ToJson(nlohmann::json& jsonRes) const; 91 std::string ToJsonStr(void) const; 92 virtual bool CompareComponentBasicInfo(SecCompBase *other, bool isRectCheck) const; SetValid(bool valid)93 void SetValid(bool valid) 94 { 95 isValid_ = valid; 96 }; 97 GetValid()98 bool GetValid() 99 { 100 return isValid_; 101 }; 102 103 // size 104 DimensionT fontSize_ = DEFAULT_DIMENSION; 105 DimensionT iconSize_ = DEFAULT_DIMENSION; 106 PaddingSize padding_; 107 DimensionT textIconSpace_ = DEFAULT_DIMENSION; 108 109 // color 110 SecCompColor fontColor_; 111 SecCompColor iconColor_; 112 SecCompColor bgColor_; 113 114 // border 115 DimensionT borderWidth_ = DEFAULT_DIMENSION; 116 117 // parent effect 118 bool parentEffect_ = false; 119 bool isClipped_ = false; 120 DimensionT topClip_; 121 DimensionT bottomClip_; 122 DimensionT leftClip_; 123 DimensionT rightClip_; 124 std::string parentTag_; 125 126 SecCompType type_ = UNKNOWN_SC_TYPE; 127 SecCompRect rect_; 128 SecCompRect windowRect_; 129 bool isValid_ = false; 130 131 int32_t text_ = UNKNOWN_TEXT; 132 int32_t icon_ = UNKNOWN_ICON; 133 SecCompBackground bg_ = SecCompBackground::UNKNOWN_BG; 134 135 int32_t windowId_ = 0; 136 uint64_t displayId_ = 0; 137 int32_t nodeId_ = 0; 138 CrossAxisState crossAxisState_ = CrossAxisState::STATE_INVALID; 139 protected: 140 virtual bool IsTextIconTypeValid() = 0; 141 virtual bool IsCorrespondenceType() = 0; 142 private: 143 bool ParseDimension(const nlohmann::json& json, const std::string& tag, DimensionT& res); 144 bool ParseColor(const nlohmann::json& json, const std::string& tag, SecCompColor& res); 145 bool ParseBool(const nlohmann::json& json, const std::string& tag, bool& res); 146 bool ParseString(const nlohmann::json& json, const std::string& tag, std::string& res); 147 bool ParsePadding(const nlohmann::json& json, const std::string& tag, PaddingSize& res); 148 bool ParseColors(const nlohmann::json& json, const std::string& tag); 149 bool ParseBorders(const nlohmann::json& json, const std::string& tag); 150 bool ParseSize(const nlohmann::json& json, const std::string& tag); 151 bool ParseParent(const nlohmann::json& json, const std::string& tag); 152 bool ParseRect(const nlohmann::json& json, const std::string& tag, SecCompRect& rect); 153 bool ParseStyle(const nlohmann::json& json, const std::string& tag); 154 bool ParseType(const nlohmann::json& json, const std::string& tag); 155 bool ParseValue(const nlohmann::json& json, const std::string& tag, int32_t& value); 156 bool ParseDisplayId(const nlohmann::json& json, const std::string& tag); 157 bool ParseCrossAxisState(const nlohmann::json& json, const std::string& tag); 158 }; 159 } // namespace SecurityComponent 160 } // namespace Security 161 } // namespace OHOS 162 #endif // SECURITY_COMPONENT_BASE_H 163