1 /* 2 * Copyright (c) 2021-2022 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 16 #ifndef COMMON_UTILITIES_HPP 17 #define COMMON_UTILITIES_HPP 18 19 #include <array> 20 #include <chrono> 21 #include <string_view> 22 #include "nlohmann/json.hpp" 23 24 #ifdef __OHOS__ 25 #include "hilog/log.h" 26 #endif 27 28 #define FORCE_INLINE __attribute__((always_inline)) inline 29 30 namespace OHOS::uitest { 31 using CStr = const char *; 32 constexpr size_t INDEX_ZERO = 0; 33 constexpr size_t INDEX_ONE = 1; 34 constexpr size_t INDEX_TWO = 2; 35 constexpr size_t INDEX_THREE = 3; 36 constexpr size_t INDEX_FOUR = 4; 37 constexpr size_t INDEX_FIVE = 5; 38 constexpr size_t INDEX_SIX = 6; 39 constexpr size_t INDEX_SEVEN = 7; 40 constexpr size_t INDEX_EIGHT = 8; 41 constexpr size_t INDEX_NINE = 9; 42 constexpr int32_t ZERO = 0; 43 constexpr int32_t ONE = 1; 44 constexpr int32_t TWO = 2; 45 constexpr int32_t THREE = 3; 46 constexpr int32_t FOUR = 4; 47 constexpr int32_t FIVE = 5; 48 constexpr int32_t SIX = 6; 49 constexpr int32_t SEVEN = 7; 50 constexpr int32_t EIGHT = 8; 51 constexpr int32_t UNASSIGNED = -1; 52 constexpr int32_t VIRTUAL_DISPLAY_ID = 999; 53 54 /**Get current time millisecond.*/ GetCurrentMillisecond()55 inline uint64_t GetCurrentMillisecond() 56 { 57 using namespace std::chrono; 58 return time_point_cast<milliseconds>(steady_clock::now()).time_since_epoch().count(); 59 } 60 61 /**Get current time microseconds.*/ GetCurrentMicroseconds()62 inline uint64_t GetCurrentMicroseconds() 63 { 64 using namespace std::chrono; 65 return time_point_cast<microseconds>(steady_clock::now()).time_since_epoch().count(); 66 } 67 ReadArgFromJson(const nlohmann::json & json,const std::string arg,const T defValue)68 template <typename T> T ReadArgFromJson(const nlohmann::json &json, const std::string arg, const T defValue) 69 { 70 if (json.type() == nlohmann::detail::value_t::object && json.contains(arg)) { 71 nlohmann::json val = json[arg]; 72 return val.get<T>(); 73 } 74 return defValue; 75 } 76 77 // log tag length limit 78 constexpr uint8_t MAX_LOG_TAG_LEN = 64; 79 80 /**Generates log-tag by fileName and lineNumber, must be 'constexpr' to ensure the efficiency of Logger.*/ GenLogTag(std::string_view fp,std::string_view func)81 constexpr std::array<char, MAX_LOG_TAG_LEN> GenLogTag(std::string_view fp, std::string_view func) 82 { 83 constexpr uint8_t MAX_CONTENT_LEN = MAX_LOG_TAG_LEN - 1; 84 std::array<char, MAX_LOG_TAG_LEN> chars = {0}; 85 size_t pos = fp.find_last_of('/'); 86 if (pos == std::string_view::npos) { 87 pos = 0; 88 } 89 uint8_t writeCursor = 0; 90 chars[writeCursor++] = '['; 91 for (size_t offSet = pos + 1; offSet < fp.length() && writeCursor < MAX_CONTENT_LEN; offSet++) { 92 chars[writeCursor++] = fp[offSet]; 93 } 94 if (writeCursor < MAX_CONTENT_LEN) { 95 chars[writeCursor++] = ':'; 96 } 97 if (writeCursor < MAX_CONTENT_LEN) { 98 chars[writeCursor++] = '('; 99 } 100 for (size_t offSet = 0; offSet < func.length() && writeCursor < MAX_CONTENT_LEN; offSet++) { 101 chars[writeCursor++] = func[offSet]; 102 } 103 if (writeCursor < MAX_CONTENT_LEN) { 104 chars[writeCursor++] = ')'; 105 } 106 if (writeCursor < MAX_CONTENT_LEN) { 107 chars[writeCursor++] = ']'; 108 } 109 // record the actual tag-length in the end byte 110 chars[MAX_CONTENT_LEN] = writeCursor; 111 return chars; 112 } 113 114 // log level 115 enum LogRank : uint8_t { 116 DEBUG = 3, INFO = 4, WARN = 5, ERROR = 6 117 }; 118 119 #ifdef __OHOS__ 120 #ifndef LOG_TAG 121 #define LOG_TAG "UiTestKit" 122 #endif 123 #undef LOG_DOMAIN 124 #define LOG_DOMAIN 0xD003100 125 // print pretty log with pretty format, auto-generate tag by fileName and functionName at compile time 126 #define LOG(LEVEL, FMT, VARS...) do { \ 127 static constexpr auto tagChars= GenLogTag(__FILE__, __FUNCTION__); \ 128 static constexpr int8_t tagLen = tagChars[MAX_LOG_TAG_LEN - 1]; \ 129 if constexpr (tagLen > 0) { \ 130 auto tag = std::string_view(tagChars.data(), tagLen); \ 131 static constexpr LogType type = LogType::LOG_CORE; \ 132 HILOG_##LEVEL(type, "%{public}s " FMT, tag.data(), ##VARS); \ 133 } \ 134 }while (0) 135 #else 136 // nop logger 137 #define LOG(LEVEL, FMT, VARS...) do {}while (0) 138 #endif 139 140 // print debug log 141 #define LOG_D(FMT, VARS...) LOG(DEBUG, FMT, ##VARS) 142 // print info log 143 #define LOG_I(FMT, VARS...) LOG(INFO, FMT, ##VARS) 144 // print warning log 145 #define LOG_W(FMT, VARS...) LOG(WARN, FMT, ##VARS) 146 // print error log 147 #define LOG_E(FMT, VARS...) LOG(ERROR, FMT, ##VARS) 148 } 149 150 #define DCHECK(cond) \ 151 do { \ 152 if (!(cond)) { \ 153 LOG_E("DCHECK FAILED, %{public}s %{public}d: %{public}s", __FILE__, __LINE__, #cond); \ 154 _Exit(0); \ 155 } \ 156 } while (0) 157 158 #endif