diff --git a/docs/annotated.html b/docs/annotated.html index 037daa6..af908e2 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -19,7 +19,7 @@
identiconpp -  0.0.0 +  0.1.0
diff --git a/docs/classIdenticonpp-members.html b/docs/classIdenticonpp-members.html index 885b08a..b19b7f5 100644 --- a/docs/classIdenticonpp-members.html +++ b/docs/classIdenticonpp-members.html @@ -19,7 +19,7 @@
identiconpp -  0.0.0 +  0.1.0
@@ -46,7 +46,9 @@ $(function() {

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

- + + +
Identiconpp(const uint8_t rows, const uint8_t columns, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })Identiconppexplicit
generate(const string &digest, const uint16_t width=100)Identiconpp
identicon_type enum nameIdenticonpp
Identiconpp(const uint8_t rows, const uint8_t columns, identicon_type type, const string background="ffffffff", const vector< string > &foreground={ "000000ff" })Identiconppexplicit
diff --git a/docs/classIdenticonpp.html b/docs/classIdenticonpp.html index 11456f7..e5a5c02 100644 --- a/docs/classIdenticonpp.html +++ b/docs/classIdenticonpp.html @@ -19,7 +19,7 @@
identiconpp -  0.0.0 +  0.1.0
@@ -40,6 +40,7 @@ $(function() {
+Public Types | Public Member Functions | List of all members
@@ -52,18 +53,56 @@ $(function() {

#include <identiconpp.hpp>

+ + + + +

+Public Types

enum  identicon_type { simple, +libravatar, +sigil + }
 List of identicon types. More...
 
- - - + + + + + +

Public Member Functions

 Identiconpp (const uint8_t rows, const uint8_t columns, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })
 Initialises an instance of Identiconpp. More...
 
 Identiconpp (const uint8_t rows, const uint8_t columns, identicon_type type, const string background="ffffffff", const vector< string > &foreground={ "000000ff" })
 Initialises an instance of Identiconpp. More...
 
Magick::Image generate (const string &digest, const uint16_t width=100)
 Generates identicon from digest. More...
 

Detailed Description

Base class for identiconpp.

-

Use this class for all your identicons.

-

Constructor & Destructor Documentation

- -

◆ Identiconpp()

+

Use this class for all your identicons. Exceptions will be thrown on error.

+

Member Enumeration Documentation

+ +

◆ identicon_type

+ +
+
+ + + + + +
+ + + + +
enum Identiconpp::identicon_type
+ 		+strong
+
+ +

List of identicon types.

+

libravatar and sigil are synonymous.

+
44  {
45  simple,
46  libravatar,
47  sigil
48  };
+
+
+

Constructor & Destructor Documentation

+ +

◆ Identiconpp()

@@ -86,7 +125,13 @@ Public Member Functions - const string &  + identicon_type  + type, + + + + + const string  background = "ffffffff", @@ -109,17 +154,57 @@ Public Member Functions

Initialises an instance of Identiconpp.

-

The instance can be used for creating identicons with differing image formats and sizes. Will throw std::invalid_argument if an argument is invalid.

+

The instance can be used for creating identicons with differing image formats and sizes. The colors must consist of exactly 8 digits.

Parameters
+
rowsNumber of rows
columnsNumber of columns
typeThe type of identicon
backgroundBackground color, hexadecimal, rrggbbaa
foregroundvector of foreground colors
-
25 : _rows(rows)
26 , _columns(columns)
27 , _background(background)
28 , _foreground(foreground)
29 {
30  // TODO: Check rows and columns
31  if (_background.size() != 8)
32  {
33  throw std::invalid_argument("Background color has the wrong format: " +
34  _background);
35  }
36  for (const string &color : _foreground)
37  {
38  if (color.size() != 8)
39  {
40  throw std::invalid_argument("Foreground color has the wrong format: " +
41  color);
42  }
43  }
44 }
+
29 : _rows(rows)
30 , _columns(columns)
31 , _type(type)
32 , _background(background)
33 , _foreground(foreground)
34 {
35  if (background.length() != 8)
36  {
37  throw std::invalid_argument
38  (
39  "The background color must consist of exactly 8 digits."
40  );
41  }
42 
43  for (const string &color : foreground)
44  if (color.length() != 8)
45  {
46  throw std::invalid_argument
47  (
48  "The foreground colors must consist of exactly 8 digits."
49  );
50  }
51 }
+
+
+

Member Function Documentation

+ +

◆ generate()

+ +
+
+ + + + + + + + + + + + + + + + + + +
Magick::Image Identiconpp::generate (const string & digest,
const uint16_t width = 100 
)
+
+ +

Generates identicon from digest.

+
Parameters
+ + + +
digestThe pre-computed digest
widthThe width of the image
+
+
+
Returns
The image
+
54 {
55  check_entropy(digest, _type);
56  const uint16_t height = width / _columns * _rows;
57  ttdebug << "width: " << std::to_string(width)
58  << ", height: " << std::to_string(height) << "\n";
59 
60  switch (_type)
61  {
62  case identicon_type::simple:
63  {
64  return generate_simple(digest, width, height);
65  }
66  case identicon_type::libravatar:
67  case identicon_type::sigil:
68  {
69  return generate_libravatar(digest, width, height);
70  }
71  }
72 }
The documentation for this class was generated from the following files:
    diff --git a/docs/classes.html b/docs/classes.html index b24c4ae..de00132 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -19,7 +19,7 @@
    identiconpp -  0.0.0 +  0.1.0
    diff --git a/docs/debug_8hpp_source.html b/docs/debug_8hpp_source.html index 5e14049..c9a3a36 100644 --- a/docs/debug_8hpp_source.html +++ b/docs/debug_8hpp_source.html @@ -19,7 +19,7 @@
    identiconpp -  0.0.0 +  0.1.0
    diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index e38442d..1055231 100644 --- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -19,7 +19,7 @@
    identiconpp -  0.0.0 +  0.1.0
    diff --git a/docs/files.html b/docs/files.html index 769af19..b44e756 100644 --- a/docs/files.html +++ b/docs/files.html @@ -19,7 +19,7 @@
    identiconpp -  0.0.0 +  0.1.0
    diff --git a/docs/functions.html b/docs/functions.html index 690e7bc..ee33a0d 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -19,7 +19,7 @@
    identiconpp -  0.0.0 +  0.1.0
    @@ -40,8 +40,14 @@ $(function() {
Here is a list of all documented class members with links to the class documentation for each member:
diff --git a/docs/functions_enum.html b/docs/functions_enum.html new file mode 100644 index 0000000..eab1d28 --- /dev/null +++ b/docs/functions_enum.html @@ -0,0 +1,55 @@ + + + + + + + +identiconpp: Class Members - Enumerations + + + + + + +
+
+ + + + + + +
+
identiconpp +  0.1.0 +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/functions_func.html b/docs/functions_func.html index 8780e02..99de5ea 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -19,7 +19,7 @@
identiconpp -  0.0.0 +  0.1.0
@@ -40,8 +40,11 @@ $(function() {
 
diff --git a/docs/functions_vars.html b/docs/functions_vars.html new file mode 100644 index 0000000..da2538d --- /dev/null +++ b/docs/functions_vars.html @@ -0,0 +1,55 @@ + + + + + + + +identiconpp: Class Members - Variables + + + + + + +
+
+ + + + + + +
+
identiconpp +  0.0.0 +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/identiconpp_8hpp_source.html b/docs/identiconpp_8hpp_source.html index 97ecb9b..c365c3f 100644 --- a/docs/identiconpp_8hpp_source.html +++ b/docs/identiconpp_8hpp_source.html @@ -19,7 +19,7 @@
identiconpp -  0.0.0 +  0.1.0
@@ -47,8 +47,10 @@ $(function() {
identiconpp.hpp
-
1 /* This file is part of identiconpp.
2  * Copyright © 2018 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 #include <cstdint>
18 #include <string>
19 #include <vector>
20 
21 using std::uint8_t;
22 using std::string;
23 using std::vector;
24 
30 class Identiconpp
31 {
32 public:
45  explicit Identiconpp(const uint8_t rows, const uint8_t columns,
46  const string &background = "ffffffff",
47  const vector<string> &foreground = { "000000ff" } );
48 
49 private:
50  const uint8_t _rows;
51  const uint8_t _columns;
52  const string _background;
53  const vector<string> _foreground;
54 };
Identiconpp::Identiconpp
Identiconpp(const uint8_t rows, const uint8_t columns, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })
Initialises an instance of Identiconpp.
Definition: identiconpp.cpp:22
-
Identiconpp
Base class for identiconpp.
Definition: identiconpp.hpp:30
+
1 /* This file is part of identiconpp.
2  * Copyright © 2018 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 #include <cstdint>
18 #include <string>
19 #include <vector>
20 #include <tuple>
21 #include <Magick++/Image.h>
22 
23 using std::uint8_t;
24 using std::uint16_t;
25 using std::uint32_t;
26 using std::string;
27 using std::vector;
28 
35 class Identiconpp
36 {
37 public:
43  enum class identicon_type
44  {
45  simple,
46  libravatar,
47  sigil
48  };
49 
63  explicit Identiconpp(const uint8_t rows, const uint8_t columns,
64  identicon_type type,
65  const string background = "ffffffff",
66  const vector<string> &foreground = { "000000ff" } );
67 
76  Magick::Image generate(const string &digest, const uint16_t width = 100);
77 
78 private:
79  const uint8_t _rows;
80  const uint8_t _columns;
81  const identicon_type _type;
82  const string _background;
83  const vector<string> _foreground;
84 
94  Magick::Image generate_simple(const string &digest,
95  const uint16_t width,
96  const uint16_t height);
97 
107  Magick::Image generate_libravatar(const string &digest,
108  const uint16_t width,
109  const uint16_t height);
110 
119  void check_entropy(const string &digest, identicon_type type);
120 
129  bool get_bit(const uint16_t bit, const string &digest);
130 
141  Magick::Color get_color(const uint16_t firstbit, const string &digest);
142 };
Identiconpp::identicon_type
identicon_type
List of identicon types.
Definition: identiconpp.hpp:43
+
Identiconpp::generate
Magick::Image generate(const string &digest, const uint16_t width=100)
Generates identicon from digest.
Definition: identiconpp.cpp:53
+
Identiconpp::Identiconpp
Identiconpp(const uint8_t rows, const uint8_t columns, identicon_type type, const string background="ffffffff", const vector< string > &foreground={ "000000ff" })
Initialises an instance of Identiconpp.
Definition: identiconpp.cpp:25
+
Identiconpp
Base class for identiconpp.
Definition: identiconpp.hpp:35
diff --git a/docs/index.html b/docs/index.html index 87738eb..1f724fc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,7 +19,7 @@
identiconpp -  0.0.0 +  0.1.0
@@ -44,8 +44,10 @@ $(function() {

identiconpp is a library to generate identicons. Written in C++.

+

There are currently 2 types of identicons supported. libravatar/sigil and simple.

Features

-

Example

+

Usage

+

The HTML reference can be generated with build_doc.sh, if doxygen is installed. It is also available at doc.schlomp.space/identiconpp/.

Install

From source

Dependencies

diff --git a/docs/menudata.js b/docs/menudata.js index 4f66e0b..aea38c4 100644 --- a/docs/menudata.js +++ b/docs/menudata.js @@ -28,6 +28,7 @@ var menudata={children:[ {text:"Class Index",url:"classes.html"}, {text:"Class Members",url:"functions.html",children:[ {text:"All",url:"functions.html"}, -{text:"Functions",url:"functions_func.html"}]}]}, +{text:"Functions",url:"functions_func.html"}, +{text:"Enumerations",url:"functions_enum.html"}]}]}, {text:"Files",url:"files.html",children:[ {text:"File List",url:"files.html"}]}]} diff --git a/docs/structIdenticonpp_1_1Image-members.html b/docs/structIdenticonpp_1_1Image-members.html new file mode 100644 index 0000000..6f702e1 --- /dev/null +++ b/docs/structIdenticonpp_1_1Image-members.html @@ -0,0 +1,63 @@ + + + + + + + +identiconpp: Member List + + + + + + +
+
+ + + + + + +
+
identiconpp +  0.0.0 +
+
+
+ + + + + + + +
+
+
+
Identiconpp::Image Member List
+
+
+ +

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

+ + + +
data (defined in Identiconpp::Image)Identiconpp::Image
error (defined in Identiconpp::Image)Identiconpp::Image
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/structIdenticonpp_1_1Image.html b/docs/structIdenticonpp_1_1Image.html new file mode 100644 index 0000000..a90e672 --- /dev/null +++ b/docs/structIdenticonpp_1_1Image.html @@ -0,0 +1,82 @@ + + + + + + + +identiconpp: Identiconpp::Image Struct Reference + + + + + + +
+
+ + + + + + +
+
identiconpp +  0.0.0 +
+
+
+ + + + + + + +
+
+
+Public Attributes | +List of all members
+
+
Identiconpp::Image Struct Reference
+
+
+ +

Return type for images. + More...

+ +

#include <identiconpp.hpp>

+ + + + + + +

+Public Attributes

+uint8_t error
 
+Magick::Image data
 
+

Detailed Description

+

Return type for images.

+

Error number 0 means no error.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.14 +
+ +