Blame view

src/compiletimedigits.h 4.1 KB
51becbde   Peter M. Groen   Committed the ent...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
  /* Copyright (C) 2019
   *
   * This file is part of the osdev components suite
   *
   * This program is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License as published by the
   * Free Software Foundation; either version 2, or (at your option) any
   * later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
   */
  #ifndef OSDEV_COMPONENTS_MQTT_COMPILETIMEDIGITS_H
  #define OSDEV_COMPONENTS_MQTT_COMPILETIMEDIGITS_H
  
  // std
  #include <string>
  
  #include "compiletimestring.h"
  
  namespace osdev {
  namespace components {
  namespace mqtt {
  
  /**
   * @brief Calculate the number of digits needed to represent a given value in a given base.
   * @tparam B The base to use.
   * @param value The value to represent.
   * @return The number of digits.
   */
  template <unsigned B>
  constexpr std::size_t numberOfDigits(unsigned value) noexcept
  {
      static_assert(B > 0, "base must be larger than zero");
      return (value / B) == 0 ? 1 : (1 + numberOfDigits<B>(value / B));
  }
  
  /**
   * @return stringified digit that represents the given single digit value.
   * @note Values can range from 0 to 37 inclusive which maps on 0-9A-Z.
   */
  template <unsigned value>
  constexpr char digit() noexcept
  {
      static_assert(value <= 37, "Value must lie between 0 and 37 both inclusive");
      return (value < 10 ? '0' + static_cast<char>(value) : 'A' + static_cast<char>(value) - 10);
  }
  
  /**
   * @brief Recursive template definition that is used to determine the value of a given number N in a given base B.
   * @tparam N The number to obtain the representation for.
   * @tparam B The base to use.
   * @tparam Len The length of the representation including the 0 terminator.
   *         If not provided the length is calculated on first instantiation of this template.
   * @tparam remains Empty parameter pack on first instantiation. Will be filled further by every following instantiation.
   */
  template <unsigned N, unsigned B, std::size_t Len = numberOfDigits<B>(N) + 1, unsigned... remains>
  struct Digits
  {
  
      static constexpr auto create() noexcept -> std::array<char, Len>
      {
          static_assert(B > 0, "base must be larger than zero");
          return Digits<N / B, B, Len, digit<N % B>(), remains...>::create();
      }
  };
  
  /**
   * @brief Termination template that will return the actual hex digit array that represents the given value.
   * @tparam B The base to use.
   * @tparam Len The length of the hexadecimal representation including 0 terminator.
   * @tparam remains Parameter pack that contains the hexadecimal character representations.
   */
  template <unsigned B, std::size_t Len, unsigned... remains>
  struct Digits<0, B, Len, remains...>
  {
  
      static constexpr auto create() noexcept -> std::array<char, Len>
      {
          static_assert(sizeof...(remains) + 1 == Len, "Parameter 'Len' must be equal to the length of the parameter pack 'remains' including the termination zero");
          return std::array<char, Len>{ { remains..., 0 } };
      }
  };
  
  /**
   * @brief Digits builder can be used in combination with the compiletime_string.
   * @tparam N The number to obtain the compile time string representation for.
   * @tparam B The base to use (up to 37).
   * This template struct defines a produce() method and the return type of that method.
   */
  template <unsigned N, unsigned B>
  struct ProduceDigits
  {
      /**
       * @brief Return type definition of the produce method.
       */
      using return_t = std::array<char, numberOfDigits<B>(N) + 1>;
  
      /**
       * @brief Produce the actual representation.
       */
      static constexpr return_t produce() noexcept
      {
          return Digits<N, B>::create();
      }
  };
  
  }       // End namespace mqtt
  }       // End namespace components
  }       // End namespace osdev
  
  #endif  // OSDEV_COMPONENTS_MQTT_COMPILETIMEDIGITS_H