diff --git a/docs/classIdenticonpp-members.html b/docs/classIdenticonpp-members.html index 67f3d2e..87ec3dd 100644 --- a/docs/classIdenticonpp-members.html +++ b/docs/classIdenticonpp-members.html @@ -46,23 +46,10 @@ $(function() {

This is the complete list of members for Identiconpp, including all inherited members.

- - - - - - - - - - - - - - - + +
_background (defined in Identiconpp)Identiconppprotected
_columns (defined in Identiconpp)Identiconppprotected
_foreground (defined in Identiconpp)Identiconppprotected
_padding (defined in Identiconpp)Identiconppprotected
_rows (defined in Identiconpp)Identiconppprotected
_type (defined in Identiconpp)Identiconppprotected
algorithm enum nameIdenticonpp
check_color(const string &color)Identiconppprotected
check_entropy(const string &digest, algorithm type)Identiconppprotected
generate(const string &digest, const uint16_t width=100)Identiconpp
generate_ltr_asymmetric(const string &digest)Identiconppprotected
generate_ltr_symmetric(const string &digest)Identiconppprotected
generate_sigil(const string &digest)Identiconppprotected
get_bit(const uint16_t bit, const string &digest)Identiconppprotected
get_color(const uint16_t firstbit, const string &digest)Identiconppprotected
Identiconpp(const uint8_t columns, const uint8_t rows, algorithm type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" }, const array< const uint8_t, 2 > &padding={ 0, 0 })Identiconppexplicit
not_hex(const char c)Identiconppprotectedstatic
Identiconpp(const uint8_t columns, const uint8_t rows, algorithm type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" }, const array< const uint8_t, 2 > &padding={ 0, 0 })Identiconppexplicit
Testiconpp (defined in Identiconpp)Identiconppfriend
diff --git a/docs/classIdenticonpp.html b/docs/classIdenticonpp.html index acef5f8..a8b8872 100644 --- a/docs/classIdenticonpp.html +++ b/docs/classIdenticonpp.html @@ -42,9 +42,7 @@ $(function() {
Public Types | Public Member Functions | -Protected Member Functions | -Static Protected Member Functions | -Protected Attributes | +Friends | List of all members
Identiconpp Class Reference
@@ -74,56 +72,11 @@ Public Member Functions  Generates identicon from digest. More...
  - - - - - - - - - - - - - - - - - - - - - - -

-Protected Member Functions

Magick::Image generate_ltr_symmetric (const string &digest)
 Generate ltr_symmetric identicon. More...
 
Magick::Image generate_ltr_asymmetric (const string &digest)
 Generate ltr_asymmetric identicon. More...
 
Magick::Image generate_sigil (const string &digest)
 Generate sigil identicon. More...
 
void check_entropy (const string &digest, algorithm type)
 Check if the digest contains enough entropy. More...
 
bool get_bit (const uint16_t bit, const string &digest)
 Determines if the n-th bit of passed digest is 1 or 0. More...
 
Magick::Color get_color (const uint16_t firstbit, const string &digest)
 Chooses a foreground color. More...
 
void check_color (const string &color)
 Performs checks on a color definition in a string. More...
 
- - - - -

-Static Protected Member Functions

static bool not_hex (const char c)
 Checks if character is not hexadecimal. More...
 
- - - - - - - - - - - - - + + +

-Protected Attributes

-const uint8_t _rows
 
-const uint8_t _columns
 
-const algorithm _type
 
-const string _background
 
-const vector< string > _foreground
 
-const array< const uint8_t, 2 > _padding
 

+Friends

+class Testiconpp
 

Detailed Description

Base class for identiconpp.

@@ -159,7 +112,7 @@ const array< const uint8_t, 2 > sigil 

Generates the same results as sigil and pydenticon.

-
49  {
51  ltr_symmetric,
53  ltr_asymmetric,
59  sigil
60  };
+
50  {
52  ltr_symmetric,
54  ltr_asymmetric,
60  sigil
61  };

Constructor & Destructor Documentation

@@ -234,96 +187,10 @@ const array< const uint8_t, 2 >  -
29 : _rows(rows)
30 , _columns(columns)
31 , _type(type)
32 , _background(background)
33 , _foreground(foreground)
34 , _padding(padding)
35 {
36  check_color(_background);
37 
38  for (const string &color : _foreground)
39  {
40  check_color(color);
41  }
42 
43  if (_foreground.size() == 0)
44  {
45  throw std::invalid_argument
46  (
47  "You must specify at least 1 foreground color."
48  );
49  }
50 }
Identiconpp::check_color
void check_color(const string &color)
Performs checks on a color definition in a string.
Definition: checks.cpp:96
-
+
29 : _rows(rows)
30 , _columns(columns)
31 , _type(type)
32 , _background(background)
33 , _foreground(foreground)
34 , _padding(padding)
35 {
36  check_color(_background);
37 
38  for (const string &color : _foreground)
39  {
40  check_color(color);
41  }
42 
43  if (_foreground.size() == 0)
44  {
45  throw std::invalid_argument
46  (
47  "You must specify at least 1 foreground color."
48  );
49  }
50 }

Member Function Documentation

- -

◆ check_color()

- -
-
- - - - - -
- - - - - - - - -
void Identiconpp::check_color (const string & color)
- 		-protected
-
- -

Performs checks on a color definition in a string.

-
Parameters
- - -
colorThe color as string
-
-
-
97 {
98  if (color.length() != 8)
99  {
100  throw std::invalid_argument
101  (
102  "Colors must consist of exactly 8 digits(" + color + ")."
103  );
104  }
105  if (std::any_of(color.begin(), color.end(), not_hex))
106  {
107  throw std::invalid_argument
108  (
109  "Colors must consist of hexadecimal digits (" + color + ")."
110  );
111  }
112 }
Identiconpp::not_hex
static bool not_hex(const char c)
Checks if character is not hexadecimal.
Definition: checks.cpp:78
-
-
-
- -

◆ check_entropy()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
void Identiconpp::check_entropy (const string & digest,
algorithm type 
)
- 		-protected
-
- -

Check if the digest contains enough entropy.

-

Throws std::invalid_argument if not.

-
Parameters
- - - -
digestThe pre-computed digest
typeThe type of identicon
-
-
-
25 {
26  if (std::any_of(digest.begin(), digest.end(), not_hex))
27  {
28  throw std::invalid_argument
29  (
30  "Digests must consist of hexadecimal digits (" + digest + ")."
31  );
32  }
33 
34  uint16_t entropy_provided;
35  uint16_t entropy_required;
36  switch (type)
37  {
38  case algorithm::ltr_symmetric:
39  {
40  // Every char is 4 bit
41  entropy_provided = digest.length() * 4;
42  // We need bits for each field in half of the columns, +1 column if
43  // they are uneven. Then we need enough bits to pick a color.
44  entropy_required = (_columns / 2 + _columns % 2) * _rows
45  + std::floor(std::log2(_foreground.size())) + 1;
46  break;
47  }
48  case algorithm::ltr_asymmetric:
49  {
50  entropy_provided = digest.length() * 4;
51  entropy_required = _columns * _rows
52  + std::floor(std::log2(_foreground.size())) + 1;
53  break;
54  }
55  case algorithm::sigil:
56  {
57  if (_foreground.size() > 256)
58  {
59  throw std::invalid_argument(
60  "sigil algorithm does not support more than 256 colors.");
61  }
62  entropy_provided = digest.length() * 4;
63  entropy_required = (_columns / 2 + _columns % 2) * _rows + 8;
64  break;
65  }
66  }
67  ttdebug << "entropy_provided=" << std::to_string(entropy_provided)
68  << ", entropy_required=" << std::to_string(entropy_required) << '\n';
69 
70  if (entropy_provided < entropy_required)
71  {
72  throw std::invalid_argument(
73  "Passed digest \"" + digest + "\" is not capable of providing " +
74  std::to_string(entropy_required) + " bits of entropy.");
75  }
76 }
Identiconpp::algorithm::ltr_symmetric
Generates symmetric (vertically mirrored) identicons.
- -
Identiconpp::not_hex
static bool not_hex(const char c)
Checks if character is not hexadecimal.
Definition: checks.cpp:78
-
Identiconpp::algorithm::ltr_asymmetric
Generates asymmetric identicons.
-
-
-

◆ generate()

@@ -360,258 +227,12 @@ const array< const uint8_t, 2 > 
Returns
The image as Magick::Image
Examples:
example.cpp.
-
53 {
54  ttdebug << "Using digest: " << digest << '\n';
55  check_entropy(digest, _type);
56  const std::int16_t imgwidth = width - _padding[0] * 2;
57  const std::int16_t imgheight =
58  std::round(static_cast<float>(imgwidth) / _columns * _rows);
59  ttdebug << "width: " << std::to_string(imgwidth)
60  << "+" << std::to_string(_padding[0] * 2)
61  << ", height: " << std::to_string(imgheight)
62  << "+" << std::to_string(_padding[1] * 2)
63  << "\n";
64  if (imgwidth <= 0 || imgheight <= 0)
65  {
66  throw std::invalid_argument("Width or height is zero or less.");
67  }
68  Magick::Image img;
69 
70  switch (_type)
71  {
72  case algorithm::ltr_symmetric:
73  {
74  img = generate_ltr_symmetric(digest);
75  break;
76  }
77  case algorithm::ltr_asymmetric:
78  {
79  img = generate_ltr_asymmetric(digest);
80  break;
81  }
82  case algorithm::sigil:
83  {
84  img = generate_sigil(digest);
85  break;
86  }
87  }
88 
89  img.scale(Magick::Geometry(imgwidth, imgheight));
90  // The CompositeOperator prevents the background color to be affected by the
91  // frame color. See https://github.com/ImageMagick/ImageMagick/issues/647
92  img.compose(Magick::CompositeOperator::CopyCompositeOp);
93  img.matteColor(Magick::Color('#' + _background));
94  img.frame(Magick::Geometry(_padding[0], _padding[1]));
95  return img;
96 }
Identiconpp::check_entropy
void check_entropy(const string &digest, algorithm type)
Check if the digest contains enough entropy.
Definition: checks.cpp:24
-
Identiconpp::generate_ltr_symmetric
Magick::Image generate_ltr_symmetric(const string &digest)
Generate ltr_symmetric identicon.
Definition: ltr_symmetric.cpp:20
-
Identiconpp::generate_ltr_asymmetric
Magick::Image generate_ltr_asymmetric(const string &digest)
Generate ltr_asymmetric identicon.
Definition: ltr_asymmetric.cpp:20
-
Identiconpp::generate_sigil
Magick::Image generate_sigil(const string &digest)
Generate sigil identicon.
Definition: sigil.cpp:20
-
Identiconpp::algorithm::ltr_symmetric
Generates symmetric (vertically mirrored) identicons.
+
53 {
54  ttdebug << "Using digest: " << digest << '\n';
55  check_entropy(digest, _type);
56  const std::int16_t imgwidth = width - _padding[0] * 2;
57  const std::int16_t imgheight =
58  std::round(static_cast<float>(imgwidth) / _columns * _rows);
59  ttdebug << "width: " << std::to_string(imgwidth)
60  << "+" << std::to_string(_padding[0] * 2)
61  << ", height: " << std::to_string(imgheight)
62  << "+" << std::to_string(_padding[1] * 2)
63  << "\n";
64  if (imgwidth <= 0 || imgheight <= 0)
65  {
66  throw std::invalid_argument("Width or height is zero or less.");
67  }
68  Magick::Image img;
69 
70  switch (_type)
71  {
72  case algorithm::ltr_symmetric:
73  {
74  img = generate_ltr_symmetric(digest);
75  break;
76  }
77  case algorithm::ltr_asymmetric:
78  {
79  img = generate_ltr_asymmetric(digest);
80  break;
81  }
82  case algorithm::sigil:
83  {
84  img = generate_sigil(digest);
85  break;
86  }
87  }
88 
89  img.scale(Magick::Geometry(imgwidth, imgheight));
90  // The CompositeOperator prevents the background color to be affected by the
91  // frame color. See https://github.com/ImageMagick/ImageMagick/issues/647
92  img.compose(Magick::CompositeOperator::CopyCompositeOp);
93  img.matteColor(Magick::Color('#' + _background));
94  img.frame(Magick::Geometry(_padding[0], _padding[1]));
95  return img;
96 }
Identiconpp::algorithm::ltr_symmetric
Generates symmetric (vertically mirrored) identicons.
Identiconpp::algorithm::ltr_asymmetric
Generates asymmetric identicons.
- -

◆ generate_ltr_asymmetric()

- -
-
- - - - - -
- - - - - - - - -
Magick::Image Identiconpp::generate_ltr_asymmetric (const string & digest)
- 		-protected
-
- -

Generate ltr_asymmetric identicon.

-

Use bits 0 to _columns * _rows, use the following bits to determine foreground color. Squares are drawn from left to right, top to bottom.

-
Parameters
- - -
digestThe pre-computed digest
-
-
-
Returns
The image
-
21 {
22  Magick::Image img(Magick::Geometry(_columns, _rows),
23  Magick::Color('#' + _background));
24  Magick::Color dotcolor = get_color(_columns * _rows + 1, digest);
25 
26  for (uint8_t row = 0; row < _rows; ++row)
27  {
28  for (uint8_t column = 0; column < _columns; ++column)
29  {
30  if (get_bit(row * _columns + column, digest))
31  {
32  ttdebug << "col=" << std::to_string(column)
33  << ", row=" << std::to_string(row) << '\n';
34  img.pixelColor(column, row, dotcolor);
35  }
36  }
37  }
38 
39  return img;
40 }
Identiconpp::get_bit
bool get_bit(const uint16_t bit, const string &digest)
Determines if the n-th bit of passed digest is 1 or 0.
Definition: identiconpp.cpp:98
-
Identiconpp::get_color
Magick::Color get_color(const uint16_t firstbit, const string &digest)
Chooses a foreground color.
Definition: identiconpp.cpp:117
-
-
-
- -

◆ generate_ltr_symmetric()

- -
-
- - - - - -
- - - - - - - - -
Magick::Image Identiconpp::generate_ltr_symmetric (const string & digest)
- 		-protected
-
- -

Generate ltr_symmetric identicon.

-

Use bits 0 to (_columns / 2 + _columns % 2) * _rows, use the following bits to determine foreground color. Squares are drawn from left to right, top to bottom.

-
Parameters
- - -
digestThe pre-computed digest
-
-
-
Returns
The image
-
21 {
22  Magick::Image img(Magick::Geometry(_columns, _rows),
23  Magick::Color('#' + _background));
24  uint8_t used_columns = _columns / 2 + _columns % 2;
25  Magick::Color dotcolor = get_color(used_columns * _rows + 1, digest);
26 
27  for (uint8_t row = 0; row < _rows; ++row)
28  {
29  for (uint8_t column = 0; column < used_columns; ++column)
30  {
31  if (get_bit(row * used_columns + column, digest))
32  {
33  ttdebug << "col=" << std::to_string(column)
34  << ", row=" << std::to_string(row) << '\n';
35  img.pixelColor(column, row, dotcolor);
36  img.pixelColor(_columns - 1 - column, row, dotcolor);
37  }
38  }
39  }
40 
41  return img;
42 }
Identiconpp::get_bit
bool get_bit(const uint16_t bit, const string &digest)
Determines if the n-th bit of passed digest is 1 or 0.
Definition: identiconpp.cpp:98
-
Identiconpp::get_color
Magick::Color get_color(const uint16_t firstbit, const string &digest)
Chooses a foreground color.
Definition: identiconpp.cpp:117
-
-
-
- -

◆ generate_sigil()

- -
-
- - - - - -
- - - - - - - - -
Magick::Image Identiconpp::generate_sigil (const string & digest)
- 		-protected
-
- -

Generate sigil identicon.

-

Use bits 9 to (_columns / 2 + _columns % 2) * _rows, use the first 8 bits to determine foreground color. Squares are drawn from top to bottom, left to right.

-
Parameters
- - -
digestThe pre-computed digest
-
-
-
Returns
The image
-
21 {
22  Magick::Image img(Magick::Geometry(_columns, _rows),
23  Magick::Color('#' + _background));
24  Magick::Color dotcolor = get_color(0, digest);
25 
26  uint8_t used_columns = _columns / 2 + _columns % 2;
27  uint8_t cells = _rows * used_columns;
28  for (uint8_t cur_cell = 0; cur_cell < cells; ++cur_cell)
29  {
30  if (get_bit(8 + cur_cell, digest))
31  {
32  const uint8_t column = cur_cell / _columns;
33  const uint8_t row = cur_cell % _rows;
34  ttdebug << "col=" << std::to_string(column)
35  << ", row=" << std::to_string(row) << '\n';
36  img.pixelColor(column, row, dotcolor);
37  img.pixelColor(_columns - column - 1, row, dotcolor);
38  }
39  }
40 
41  return img;
42 }
Identiconpp::get_bit
bool get_bit(const uint16_t bit, const string &digest)
Determines if the n-th bit of passed digest is 1 or 0.
Definition: identiconpp.cpp:98
-
Identiconpp::get_color
Magick::Color get_color(const uint16_t firstbit, const string &digest)
Chooses a foreground color.
Definition: identiconpp.cpp:117
-
-
-
- -

◆ get_bit()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
bool Identiconpp::get_bit (const uint16_t bit,
const string & digest 
)
- 		-protected
-
- -

Determines if the n-th bit of passed digest is 1 or 0.

-
Parameters
- - - -
bitBit to get
digestThe digest
-
-
-
Returns
The bit.
-
99 {
100  std::stringstream ss;
101  ss << std::hex << digest[bit / 4];
102  // std::stringstream does not support writing into uint8_t
103  unsigned short nibble;
104  ss >> nibble;
105 
106  // Shift nibble to the right until the bit we want is on the right border.
107  // Then check if it is set.
108  if (nibble >> (3 - bit % 4) & 1)
109  {
110  ttdebug << "Bit " << std::to_string(bit + 1) << " is set.\n";
111  return true;
112  }
113 
114  return false;
115 }
-
-
- -

◆ get_color()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
Magick::Color Identiconpp::get_color (const uint16_t firstbit,
const string & digest 
)
- 		-protected
-
- -

Chooses a foreground color.

-

Extracts the right bits from the digest and returns a color.

-
Parameters
- - - -
firstbitThe first bit of the digest to choose a color
digestThe digest
-
-
-
Returns
A foreground color.
-
119 {
120  // Number of bits to use
121  const uint16_t colorbits = std::floor(std::log2(_foreground.size())) + 1;
122 
123  // Extract approximation
124  std::stringstream ss;
125  if (colorbits % 4 == 0)
126  {
127  ss << std::hex << digest.substr(firstbit / 4, colorbits / 4);
128  }
129  else
130  {
131  ss << std::hex << digest.substr(firstbit / 4, colorbits / 4 + 1);
132  }
133  // std::stringstream does not support writing into uint16_t
134  unsigned short bits;
135  ss >> bits;
136 
137  // Shift an one $colorbits times to the left, substract 1. This leaves us
138  // with $colorbits ones. Then AND bits and our ones to keep only as many
139  // bits as we need.
140  bits = bits & ((1 << colorbits) - 1);
141 
142  // We may get a number that is slightly too big if _foreground.size() is not
143  // a power of 2.
144  if (bits > (_foreground.size() - 1))
145  {
146  bits -= _foreground.size();
147  }
148 
149  // Lookup und set color
150  ttdebug << "Color: #" << _foreground[bits] << '\n';
151  return Magick::Color("#" + _foreground[bits]);
152 }
-
-
- -

◆ not_hex()

- -
-
- - - - - -
- - - - - - - - -
bool Identiconpp::not_hex (const char c)
- 		-staticprotected
-
- -

Checks if character is not hexadecimal.

-
Parameters
- - -
cCharacter to check
-
-
-
Returns
true if not hex.
-
79 {
80  if (c >= 0x61 && c <= 0x66)
81  { // a-f
82  return false;
83  }
84  if (c >= 0x41 && c <= 0x46)
85  { // A-F
86  return false;
87  }
88  if (c >= 0x30 && c <= 0x39)
89  { // 0-9
90  return false;
91  }
92 
93  return true;
94 }
-
-
The documentation for this class was generated from the following files: diff --git a/docs/functions_func.html b/docs/functions_func.html index 37df7e8..ce6edb9 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -40,36 +40,12 @@ $(function() {
 
diff --git a/docs/identiconpp_8hpp_source.html b/docs/identiconpp_8hpp_source.html index 9ba1c26..1fbed8e 100644 --- a/docs/identiconpp_8hpp_source.html +++ b/docs/identiconpp_8hpp_source.html @@ -47,19 +47,11 @@ $(function() {
identiconpp.hpp
-
1 /* This file is part of identiconpp.
2  * Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, version 3.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef IDENTICONPP_HPP
18 #define IDENTICONPP_HPP
19 
20 #include <cstdint>
21 #include <string>
22 #include <vector>
23 #include <array>
24 #include <Magick++/Image.h>
25 
26 using std::uint8_t;
27 using std::uint16_t;
28 using std::string;
29 using std::vector;
30 using std::array;
31 
42 class Identiconpp
43 {
44 public:
48  enum class algorithm
49  {
51  ltr_symmetric,
53  ltr_asymmetric,
59  sigil
60  };
61 
76  explicit Identiconpp(const uint8_t columns, const uint8_t rows,
77  algorithm type = algorithm::ltr_symmetric,
78  const string &background = "ffffffff",
79  const vector<string> &foreground = { "000000ff" },
80  const array<const uint8_t, 2> &padding = { 0, 0 });
81 
90  Magick::Image generate(const string &digest, const uint16_t width = 100);
91 
92 protected:
93  const uint8_t _rows;
94  const uint8_t _columns;
95  const algorithm _type;
96  const string _background;
97  const vector<string> _foreground;
98  const array<const uint8_t, 2> _padding;
99 
111  Magick::Image generate_ltr_symmetric(const string &digest);
112 
124  Magick::Image generate_ltr_asymmetric(const string &digest);
125 
137  Magick::Image generate_sigil(const string &digest);
138 
147  void check_entropy(const string &digest, algorithm type);
148 
157  bool get_bit(const uint16_t bit, const string &digest);
158 
169  Magick::Color get_color(const uint16_t firstbit, const string &digest);
170 
178  static bool not_hex(const char c);
179 
185  void check_color(const string &color);
186 };
187 
188 #endif // IDENTICONPP_HPP
Identiconpp::check_entropy
void check_entropy(const string &digest, algorithm type)
Check if the digest contains enough entropy.
Definition: checks.cpp:24
-
Identiconpp::generate_ltr_symmetric
Magick::Image generate_ltr_symmetric(const string &digest)
Generate ltr_symmetric identicon.
Definition: ltr_symmetric.cpp:20
-
Identiconpp::check_color
void check_color(const string &color)
Performs checks on a color definition in a string.
Definition: checks.cpp:96
-
Identiconpp::generate_ltr_asymmetric
Magick::Image generate_ltr_asymmetric(const string &digest)
Generate ltr_asymmetric identicon.
Definition: ltr_asymmetric.cpp:20
-
Identiconpp::algorithm
algorithm
List of identicon algorithms.
Definition: identiconpp.hpp:48
-
Identiconpp::get_bit
bool get_bit(const uint16_t bit, const string &digest)
Determines if the n-th bit of passed digest is 1 or 0.
Definition: identiconpp.cpp:98
+
1 /* This file is part of identiconpp.
2  * Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, version 3.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef IDENTICONPP_HPP
18 #define IDENTICONPP_HPP
19 
20 #include <cstdint>
21 #include <string>
22 #include <vector>
23 #include <array>
24 #include <Magick++/Image.h>
25 
26 using std::uint8_t;
27 using std::uint16_t;
28 using std::string;
29 using std::vector;
30 using std::array;
31 
42 class Identiconpp
43 {
44 public:
45  friend class Testiconpp;
49  enum class algorithm
50  {
52  ltr_symmetric,
54  ltr_asymmetric,
60  sigil
61  };
62 
77  explicit Identiconpp(const uint8_t columns, const uint8_t rows,
78  algorithm type = algorithm::ltr_symmetric,
79  const string &background = "ffffffff",
80  const vector<string> &foreground = { "000000ff" },
81  const array<const uint8_t, 2> &padding = { 0, 0 });
82 
91  Magick::Image generate(const string &digest, const uint16_t width = 100);
92 
93 private:
94  const uint8_t _rows;
95  const uint8_t _columns;
96  const algorithm _type;
97  const string _background;
98  const vector<string> _foreground;
99  const array<const uint8_t, 2> _padding;
100 
112  Magick::Image generate_ltr_symmetric(const string &digest);
113 
125  Magick::Image generate_ltr_asymmetric(const string &digest);
126 
138  Magick::Image generate_sigil(const string &digest);
139 
148  void check_entropy(const string &digest, algorithm type);
149 
158  bool get_bit(const uint16_t bit, const string &digest);
159 
170  Magick::Color get_color(const uint16_t firstbit, const string &digest);
171 
179  static bool not_hex(const char c);
180 
186  void check_color(const string &color);
187 };
188 
189 #endif // IDENTICONPP_HPP
Identiconpp::algorithm
algorithm
List of identicon algorithms.
Definition: identiconpp.hpp:49
Identiconpp::generate
Magick::Image generate(const string &digest, const uint16_t width=100)
Generates identicon from digest.
Definition: identiconpp.cpp:52
Identiconpp
Base class for identiconpp.
Definition: identiconpp.hpp:42
-
Identiconpp::generate_sigil
Magick::Image generate_sigil(const string &digest)
Generate sigil identicon.
Definition: sigil.cpp:20
Identiconpp::algorithm::ltr_symmetric
Generates symmetric (vertically mirrored) identicons.
-
Identiconpp::not_hex
static bool not_hex(const char c)
Checks if character is not hexadecimal.
Definition: checks.cpp:78
-
Identiconpp::get_color
Magick::Color get_color(const uint16_t firstbit, const string &digest)
Chooses a foreground color.
Definition: identiconpp.cpp:117
Identiconpp::Identiconpp
Identiconpp(const uint8_t columns, const uint8_t rows, algorithm type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" }, const array< const uint8_t, 2 > &padding={ 0, 0 })
Initialises an instance of Identiconpp.
Definition: identiconpp.cpp:24
Identiconpp::algorithm::ltr_asymmetric
Generates asymmetric identicons.