1 // Copyright 2024 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://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, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #include "pw_log/tokenized_args.h"
15
16 #include <cinttypes>
17 #include <cstring>
18
19 #include "pw_log_tokenized/log_tokenized.h"
20 #include "pw_tokenizer/enum.h"
21 #include "pw_tokenizer/hash.h"
22 #include "pw_tokenizer/tokenize.h"
23 #include "pw_unit_test/framework.h"
24
25 namespace this_is_a_test {
26 namespace {
27
28 enum Thing { kAlpha, kBravo, kCharlie };
29
30 // Tokenize the enum! Adding a new entry above but not here is a compiler error.
31 PW_TOKENIZE_ENUM(::this_is_a_test::Thing, kAlpha, kBravo, kCharlie);
32
33 enum Thing2 { kDelta, kEcho, kFoxtrot };
34
35 // Tokenize the enum with custom strings! Adding a new entry above but not here
36 // is a compiler error.
37 PW_TOKENIZE_ENUM_CUSTOM(::this_is_a_test::Thing2,
38 (kDelta, "DELTA"),
39 (kEcho, "ECHO"),
40 (kFoxtrot, "FOXTROT"));
41
42 // pw_log backends that use pw_tokenizer and want to support nested tokenization
43 // define this file under their public_overrides/ directory to activate the
44 // PW_LOG_TOKEN aliases. If this file does not exist in the log backend,
45 // arguments behave as basic strings (const char*).
46 #if __has_include("pw_log_backend/log_backend_uses_pw_tokenizer.h")
47
TEST(TokenizedArgs,EmptyString_TokenizingBackend)48 TEST(TokenizedArgs, EmptyString_TokenizingBackend) {
49 constexpr PW_LOG_TOKEN_TYPE token = PW_LOG_TOKEN("");
50 EXPECT_EQ(0u, token);
51 }
52
TEST(TokenizedArgs,ExprMatchesStringExpr_TokenizingBackend)53 TEST(TokenizedArgs, ExprMatchesStringExpr_TokenizingBackend) {
54 EXPECT_EQ(::pw::tokenizer::Hash("[:-)"), PW_LOG_TOKEN_EXPR("[:-)"));
55 }
56
TEST(TokenizedArgs,LogTokenFmt_TokenizingBackend)57 TEST(TokenizedArgs, LogTokenFmt_TokenizingBackend) {
58 constexpr const char* nested_token = PW_LOG_TOKEN_FMT();
59 EXPECT_STREQ("$#%08" PRIx32, nested_token);
60 }
61
TEST(TokenizedArgs,LogTokenEnumFmt_TokenizingBackend)62 TEST(TokenizedArgs, LogTokenEnumFmt_TokenizingBackend) {
63 constexpr char nested_token[] = PW_LOG_ENUM_FMT(::this_is_a_test::Thing);
64 EXPECT_STREQ("${::this_is_a_test::Thing}#%08" PRIx32, nested_token);
65 }
66
TEST(TokenizedArgs,LogTokenOrString_TokenizingBackend)67 TEST(TokenizedArgs, LogTokenOrString_TokenizingBackend) {
68 EXPECT_EQ(static_cast<uint32_t>(kAlpha), PW_LOG_ENUM(kAlpha));
69 }
70
TEST(TokenizedArgs,LogTokenEnumFmt2_TokenizingBackend)71 TEST(TokenizedArgs, LogTokenEnumFmt2_TokenizingBackend) {
72 constexpr char nested_token[] = PW_LOG_ENUM_FMT(::this_is_a_test::Thing2);
73 EXPECT_STREQ("${::this_is_a_test::Thing2}#%08" PRIx32, nested_token);
74 }
75
TEST(TokenizedArgs,LogTokenOrString2_TokenizingBackend)76 TEST(TokenizedArgs, LogTokenOrString2_TokenizingBackend) {
77 EXPECT_EQ(static_cast<uint32_t>(kDelta), PW_LOG_ENUM(kDelta));
78 }
79
TEST(TokenizedArgs,NestedTokenFmt1_TokenizingBackend)80 TEST(TokenizedArgs, NestedTokenFmt1_TokenizingBackend) {
81 constexpr char nested_token[] = PW_LOG_NESTED_TOKEN_FMT();
82 EXPECT_STREQ("${$#%" PRIx32 "}#%08" PRIx32, nested_token);
83 }
84
TEST(TokenizedArgs,NestedTokenFmt2_TokenizingBackend)85 TEST(TokenizedArgs, NestedTokenFmt2_TokenizingBackend) {
86 constexpr char nested_token[] = PW_LOG_NESTED_TOKEN_FMT("enum_domain");
87 EXPECT_STREQ("${${enum_domain}#%" PRIx32 "}#%08" PRIx32, nested_token);
88 }
89
90 #else
91
TEST(TokenizedArgs,EmptyString_NonTokenizingBackend)92 TEST(TokenizedArgs, EmptyString_NonTokenizingBackend) {
93 constexpr PW_LOG_TOKEN_TYPE token = PW_LOG_TOKEN("");
94 EXPECT_STREQ("", token);
95 }
96
TEST(TokenizedArgs,ExprMatchesStringExpr_NonTokenizingBackend)97 TEST(TokenizedArgs, ExprMatchesStringExpr_NonTokenizingBackend) {
98 constexpr PW_LOG_TOKEN_TYPE token1 = PW_LOG_TOKEN("[:-)");
99 constexpr PW_LOG_TOKEN_TYPE token2 = PW_LOG_TOKEN_EXPR("[:-)");
100 EXPECT_STREQ(token1, token2);
101 }
102
TEST(TokenizedArgs,LogTokenFmt_NonTokenizingBackend)103 TEST(TokenizedArgs, LogTokenFmt_NonTokenizingBackend) {
104 constexpr PW_LOG_TOKEN_TYPE token = PW_LOG_TOKEN_FMT();
105 EXPECT_STREQ("%s", token);
106 }
107
TEST(TokenizedArgs,LogTokenEnumFmt_NonTokenizingBackend)108 TEST(TokenizedArgs, LogTokenEnumFmt_NonTokenizingBackend) {
109 constexpr PW_LOG_TOKEN_TYPE nested_token =
110 PW_LOG_ENUM_FMT(::this_is_a_test::Thing);
111 EXPECT_STREQ("%s", nested_token);
112 }
113
TEST(TokenizedArgs,LogTokenOrString_NonTokenizingBackend)114 TEST(TokenizedArgs, LogTokenOrString_NonTokenizingBackend) {
115 constexpr PW_LOG_TOKEN_TYPE nested_token = PW_LOG_ENUM(kAlpha);
116 EXPECT_STREQ("kAlpha", nested_token);
117 }
118
TEST(TokenizedArgs,LogTokenEnumFmt2_NonTokenizingBackend)119 TEST(TokenizedArgs, LogTokenEnumFmt2_NonTokenizingBackend) {
120 constexpr PW_LOG_TOKEN_TYPE nested_token =
121 PW_LOG_ENUM_FMT(::this_is_a_test::Thing2);
122 EXPECT_STREQ("%s", nested_token);
123 }
124
TEST(TokenizedArgs,LogTokenOrString2_NonTokenizingBackend)125 TEST(TokenizedArgs, LogTokenOrString2_NonTokenizingBackend) {
126 constexpr PW_LOG_TOKEN_TYPE nested_token = PW_LOG_ENUM(kDelta);
127 EXPECT_STREQ("DELTA", nested_token);
128 }
129
TEST(TokenizedArgs,NestedTokenFmt1_NonTokenizingBackend)130 TEST(TokenizedArgs, NestedTokenFmt1_NonTokenizingBackend) {
131 constexpr char nested_token[] = PW_LOG_NESTED_TOKEN_FMT();
132 EXPECT_STREQ("%s::%s", nested_token);
133 }
134
TEST(TokenizedArgs,NestedTokenFmt2_NonTokenizingBackend)135 TEST(TokenizedArgs, NestedTokenFmt2_NonTokenizingBackend) {
136 constexpr char nested_token[] =
137 PW_LOG_NESTED_TOKEN_FMT(::this_is_a_test::Thing);
138 EXPECT_STREQ("%s::%s", nested_token);
139 }
140
141 #endif //__has_include("log_backend/log_backend_uses_pw_tokenizer.h")
142
143 } // namespace
144 } // namespace this_is_a_test
145