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
15 #include "pw_tokenizer/enum.h"
16
17 #include "pw_compilation_testing/negative_compilation.h"
18 #include "pw_unit_test/framework.h"
19
20 namespace this_is_a_test {
21 namespace {
22
23 // DOCSTAG: [pw_tokenizer-examples-enum]
24 enum Thing : int { kAlpha, kBravo, kCharlie };
25
26 PW_TOKENIZE_ENUM(::this_is_a_test::Thing, kAlpha, kBravo, kCharlie);
27 // DOCSTAG: [pw_tokenizer-examples-enum]
28
29 // DOCSTAG: [pw_tokenizer-examples-enum-custom]
30 enum Thing2 { kDelta, kEcho, kFoxtrot };
31
32 PW_TOKENIZE_ENUM_CUSTOM(::this_is_a_test::Thing2,
33 (kDelta, "DELTA"),
34 (kEcho, "ECHO"),
35 (kFoxtrot, "FOXTROT"));
36 // DOCSTAG: [pw_tokenizer-examples-enum-custom]
37
38 enum OneThing { kGolf };
39
40 PW_TOKENIZE_ENUM(::this_is_a_test::OneThing, kGolf);
41
42 enum class ScopedThing { kKilo, kLima, kMike };
43
44 PW_TOKENIZE_ENUM(::this_is_a_test::ScopedThing, kKilo, kLima, kMike);
45
46 enum class ScopedThing2 { kKilo, kLima, kMike };
47
48 PW_TOKENIZE_ENUM_CUSTOM(::this_is_a_test::ScopedThing2,
49 (kKilo, "KILO"),
50 (kLima, "LIMA"),
51 (kMike, "MIKE"));
52
53 enum NonTokenizedThing { kNovember, kOscar, kPapa };
54
55 enum NamespaceThing { kHotel, kIndia, kJuliett };
56
TEST(TokenizeEnums,KnownValues_1)57 TEST(TokenizeEnums, KnownValues_1) {
58 constexpr const char* log_value = ::pw::tokenizer::EnumToString(kBravo);
59 EXPECT_STREQ("kBravo", log_value);
60 }
61
TEST(TokenizeEnums,KnownValues_2)62 TEST(TokenizeEnums, KnownValues_2) {
63 constexpr const char* log_value =
64 ::pw::tokenizer::EnumToString(::this_is_a_test::ScopedThing::kLima);
65 EXPECT_STREQ("kLima", log_value);
66 }
67
TEST(TokenizeEnums,KnownValues_3)68 TEST(TokenizeEnums, KnownValues_3) {
69 constexpr const char* log_value =
70 ::pw::tokenizer::EnumToString(::this_is_a_test::ScopedThing2::kLima);
71 EXPECT_STREQ("LIMA", log_value);
72 }
73
TokenizeUnknownValue()74 [[maybe_unused]] void TokenizeUnknownValue() {
75 #if PW_NC_TEST(TokenizeUnknownValue)
76 PW_NC_EXPECT("no matching function for call");
77
78 ::pw::tokenizer::EnumToString(kOscar);
79 #endif // PW_NC_TEST
80 }
81
82 enum ManyThing { kQuebec, kRomeo, kSierra };
83
MissAValue()84 [[maybe_unused]] void MissAValue() {
85 #if PW_NC_TEST(MissAValue)
86 PW_NC_EXPECT("is not allowed here");
87
88 PW_TOKENIZE_ENUM(::this_is_a_test::ManyThing, kQuebec, kRomeo);
89 #endif // PW_NC_TEST
90 }
91
TEST(TokenizeEnums,BadEnumValue)92 TEST(TokenizeEnums, BadEnumValue) {
93 EXPECT_STREQ("Unknown ::this_is_a_test::Thing value",
94 ::pw::tokenizer::EnumToString(static_cast<Thing>(-100)));
95 }
96
97 } // namespace
98 } // namespace this_is_a_test
99
100 namespace this_is_also_a_test {
101
102 PW_TOKENIZE_ENUM(::this_is_a_test::NamespaceThing, kHotel, kIndia, kJuliett);
103
TokenizeInDifferentNamespace()104 [[maybe_unused]] void TokenizeInDifferentNamespace() {
105 #if PW_NC_TEST(TokenizeInDifferentNamespace)
106 PW_NC_EXPECT("no matching function for call");
107
108 ::pw::tokenizer::EnumToString(::this_is_a_test::NamespaceThing::kHotel);
109 #endif // PW_NC_TEST
110 }
111
112 } // namespace this_is_also_a_test
113