1 /*
2  *  Copyright (c) 2024, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file provides a compile time counter and utilities based on it.
32  */
33 
34 #ifndef OT_UTILS_STATIC_COUNTER_HPP_
35 #define OT_UTILS_STATIC_COUNTER_HPP_
36 
37 namespace ot {
38 
39 template <int N> struct StaticInt : public StaticInt<N - 1>
40 {
41 public:
42     static constexpr int kValue = N;
43 };
44 
45 template <> struct StaticInt<0>
46 {
47 public:
48     static constexpr int kValue = 0;
49 };
50 
51 #define StaticCounterInit(N) static constexpr StaticInt<N> StaticCounter(StaticInt<N>)
52 
53 #define StaticCounterValue() decltype(StaticCounter(StaticInt<255>{}))::kValue
54 
55 #define StaticCounterIncr() \
56     static constexpr StaticInt<StaticCounterValue() + 1> StaticCounter(StaticInt<StaticCounterValue() + 1>)
57 
58 #define InitEnumValidatorCounter() StaticCounterInit(0)
59 
60 #define ValidateNextEnum(kEnumartor)                                                      \
61     static_assert(kEnumartor == StaticCounterValue(), #kEnumartor " value is incorrect"); \
62     StaticCounterIncr()
63 
64 #define SkipNextEnum() StaticCounterIncr()
65 
66 } // namespace ot
67 
68 #endif // OT_UTILS_STATIC_COUNTER_HPP_
69