diff --git a/docs/annotated.html b/docs/annotated.html index 18dbea5..fc613da 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
diff --git a/docs/classIdenticonpp-members.html b/docs/classIdenticonpp-members.html index 6271a56..bce9372 100644 --- a/docs/classIdenticonpp-members.html +++ b/docs/classIdenticonpp-members.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
@@ -46,9 +46,9 @@ $(function() {

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

- - - + + +
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=identicon_type::simple, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })Identiconppexplicit
algorithm enum nameIdenticonpp
generate(const string &digest, const uint16_t width=100)Identiconpp
Identiconpp(const uint8_t rows, const uint8_t columns, algorithm type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })Identiconppexplicit
diff --git a/docs/classIdenticonpp.html b/docs/classIdenticonpp.html index 72b6483..b34a7a9 100644 --- a/docs/classIdenticonpp.html +++ b/docs/classIdenticonpp.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
@@ -55,18 +55,17 @@ $(function() { - - - + +

Public Types

enum  identicon_type { simple, -libravatar, +
enum  algorithm { ltr_symmetric, sigil }
 List of identicon types. More...
 
 List of identicon algorithms.
 
- - - + + + @@ -74,35 +73,9 @@ Public Member Functions

Detailed Description

Base class for identiconpp.

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

-

Member Enumeration Documentation

- -

◆ identicon_type

- -
-
-

Public Member Functions

 Identiconpp (const uint8_t rows, const uint8_t columns, identicon_type type=identicon_type::simple, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })
 Initialises an instance of Identiconpp. More...
 
 Identiconpp (const uint8_t rows, const uint8_t columns, algorithm type=algorithm::ltr_symmetric, 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...
 
- - - - -
- - - - -
enum Identiconpp::identicon_type
- 		-strong
-
- -

List of identicon types.

-

libravatar and sigil are synonymous.

-
42  {
43  simple,
44  libravatar,
45  sigil
46  };
-
- -

Constructor & Destructor Documentation

- -

◆ Identiconpp()

+

Constructor & Destructor Documentation

+ +

◆ Identiconpp()

@@ -125,8 +98,8 @@ Public Member Functions - identicon_type  - type = identicon_type::simple, + algorithm  + type = algorithm::ltr_symmetric, @@ -204,15 +177,15 @@ Public Member Functions
Returns
The image
-
43 {
44  check_entropy(digest, _type);
45  const uint16_t height = width / _columns * _rows;
46  ttdebug << "width: " << std::to_string(width)
47  << ", height: " << std::to_string(height) << "\n";
48 
49  switch (_type)
50  {
51  case identicon_type::simple:
52  {
53  return generate_simple(digest, width, height);
54  }
55  case identicon_type::libravatar:
56  case identicon_type::sigil:
57  {
58  return generate_libravatar(digest, width, height);
59  }
60  }
61 }
+
43 {
44  check_entropy(digest, _type);
45  const uint16_t height = width / _columns * _rows;
46  ttdebug << "width: " << std::to_string(width)
47  << ", height: " << std::to_string(height) << "\n";
48 
49  switch (_type)
50  {
51  case algorithm::ltr_symmetric:
52  {
53  return generate_ltr_symmetric(digest, width, height);
54  }
55  case algorithm::sigil:
56  {
57  return generate_sigil(digest, width, height);
58  }
59  }
60 }
The documentation for this class was generated from the following files: diff --git a/docs/classes.html b/docs/classes.html index 5d53edc..854d8e1 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
diff --git a/docs/debug_8hpp_source.html b/docs/debug_8hpp_source.html index 2ab618f..c2eb5ac 100644 --- a/docs/debug_8hpp_source.html +++ b/docs/debug_8hpp_source.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 1681bdd..9f539d2 100644 --- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
diff --git a/docs/files.html b/docs/files.html index 8b37fcb..4a15e12 100644 --- a/docs/files.html +++ b/docs/files.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
diff --git a/docs/functions.html b/docs/functions.html index 8f88632..e09e787 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
@@ -40,14 +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 index 61a1352..49a533b 100644 --- a/docs/functions_enum.html +++ b/docs/functions_enum.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
@@ -40,8 +40,8 @@ $(function() {
 
diff --git a/docs/functions_func.html b/docs/functions_func.html index 12df465..3ee3cf2 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -19,7 +19,7 @@
identiconpp -  0.1.2 +  0.2.0
@@ -44,7 +44,7 @@ $(function() { : Identiconpp
  • Identiconpp() -: Identiconpp +: Identiconpp
    • diff --git a/docs/identiconpp_8hpp_source.html b/docs/identiconpp_8hpp_source.html index d525da2..8c5bb72 100644 --- a/docs/identiconpp_8hpp_source.html +++ b/docs/identiconpp_8hpp_source.html @@ -19,7 +19,7 @@
    identiconpp -  0.1.2 +  0.2.0
    @@ -47,10 +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 #include <Magick++/Image.h>
    21 
    22 using std::uint8_t;
    23 using std::uint16_t;
    24 using std::string;
    25 using std::vector;
    26 
    33 class Identiconpp
    34 {
    35 public:
    41  enum class identicon_type
    42  {
    43  simple,
    44  libravatar,
    45  sigil
    46  };
    47 
    61  explicit Identiconpp(const uint8_t rows, const uint8_t columns,
    62  identicon_type type = identicon_type::simple,
    63  const string &background = "ffffffff",
    64  const vector<string> &foreground = { "000000ff" } );
    65 
    74  Magick::Image generate(const string &digest, const uint16_t width = 100);
    75 
    76 private:
    77  const uint8_t _rows;
    78  const uint8_t _columns;
    79  const identicon_type _type;
    80  const string _background;
    81  const vector<string> _foreground;
    82 
    92  Magick::Image generate_simple(const string &digest,
    93  const uint16_t width,
    94  const uint16_t height);
    95 
    105  Magick::Image generate_libravatar(const string &digest,
    106  const uint16_t width,
    107  const uint16_t height);
    108 
    117  void check_entropy(const string &digest, identicon_type type);
    118 
    127  bool get_bit(const uint16_t bit, const string &digest);
    128 
    139  Magick::Color get_color(const uint16_t firstbit, const string &digest);
    140 
    148  static bool not_hex(const char c);
    149 
    155  void check_color(const string &color);
    156 };
    Identiconpp::identicon_type
    identicon_type
    List of identicon types.
    Definition: identiconpp.hpp:41
    +
    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 <Magick++/Image.h>
    21 
    22 using std::uint8_t;
    23 using std::uint16_t;
    24 using std::string;
    25 using std::vector;
    26 
    33 class Identiconpp
    34 {
    35 public:
    39  enum class algorithm
    40  {
    41  ltr_symmetric,
    42  sigil
    43  };
    44 
    58  explicit Identiconpp(const uint8_t rows, const uint8_t columns,
    59  algorithm type = algorithm::ltr_symmetric,
    60  const string &background = "ffffffff",
    61  const vector<string> &foreground = { "000000ff" } );
    62 
    71  Magick::Image generate(const string &digest, const uint16_t width = 100);
    72 
    73 private:
    74  const uint8_t _rows;
    75  const uint8_t _columns;
    76  const algorithm _type;
    77  const string _background;
    78  const vector<string> _foreground;
    79 
    93  Magick::Image generate_ltr_symmetric(const string &digest,
    94  const uint16_t width,
    95  const uint16_t height);
    96 
    110  Magick::Image generate_sigil(const string &digest,
    111  const uint16_t width,
    112  const uint16_t height);
    113 
    122  void check_entropy(const string &digest, algorithm type);
    123 
    132  bool get_bit(const uint16_t bit, const string &digest);
    133 
    144  Magick::Color get_color(const uint16_t firstbit, const string &digest);
    145 
    153  static bool not_hex(const char c);
    154 
    160  void check_color(const string &color);
    161 };
    Identiconpp::algorithm
    algorithm
    List of identicon algorithms.
    Definition: identiconpp.hpp:39
    Identiconpp::generate
    Magick::Image generate(const string &digest, const uint16_t width=100)
    Generates identicon from digest.
    Definition: identiconpp.cpp:42
    Identiconpp
    Base class for identiconpp.
    Definition: identiconpp.hpp:33
    -
    Identiconpp::Identiconpp
    Identiconpp(const uint8_t rows, const uint8_t columns, identicon_type type=identicon_type::simple, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })
    Initialises an instance of Identiconpp.
    Definition: identiconpp.cpp:24
    +
    Identiconpp::Identiconpp
    Identiconpp(const uint8_t rows, const uint8_t columns, algorithm type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" })
    Initialises an instance of Identiconpp.
    Definition: identiconpp.cpp:24
    diff --git a/docs/index.html b/docs/index.html index 74ddb7c..7a2e58b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,7 +19,7 @@
    identiconpp -  0.1.2 +  0.2.0
    @@ -47,13 +47,15 @@ $(function() {

    You get the images as Magick::Image. This allows you to make all kinds of modifications.

    Features

      -
    • [x] Simple identicons
      • -
    • [ ] libravatar/sigil identicons
      • +
    • [x] Symmetric identicons
      • +
    • [x] sigil identicons
      • +
    • [ ] Asymmetric identicons

    Usage

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

    +

    You need to generate hashes yourself, any hexadecimal string will do. Make sure to use a safe hashing algorithm for sensitive data (not MD5). You can select as many columns and rows as you like, but make sure you have enough entropy. If something seems to be wrong, exceptions will be thrown.

    Example

    -
    {C++}
    // Compile with g++ $(Magick++-config --cppflags --ldflags) -lidenticonpp
    #include <identiconpp.hpp>
    #include <Magick++/Image.h>
    int main()
    {
    Identiconpp identicon(5, 5, Identiconpp::identicon_type::simple,
    "ffffff88", { "800000ff" });
    Magick::Image img;
    img = identicon.generate("55502f40dc8b7c769880b10874abc9d0", 200);
    img.write("identicon.png");
    }

    Install

    +
    {C++}
    // Compile with g++ $(Magick++-config --cppflags --ldflags) -lidenticonpp
    #include <identiconpp.hpp>
    #include <Magick++/Image.h>
    int main()
    {
    Identiconpp identicon(5, 5, Identiconpp::algorithm::ltr_symmetric,
    "ffffff88", { "800000ff" });
    Magick::Image img;
    img = identicon.generate("55502f40dc8b7c769880b10874abc9d0", 200);
    img.write("identicon.png");
    }

    Install

    Gentoo

    Gentoo ebuilds are available via my repository.

    Automatically generated packages

    @@ -88,7 +90,38 @@ $(function() {

    Contact

    See https://tastytea.de/

    License & Copyright

    -
    Copyright © 2018 tastytea <tastytea@tastytea.de>.
    License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
    This program comes with ABSOLUTELY NO WARRANTY. This is free software,
    and you are welcome to redistribute it under certain conditions.
    +
    Copyright © 2018 tastytea <tastytea@tastytea.de>.
    License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
    This program comes with ABSOLUTELY NO WARRANTY. This is free software,
    and you are welcome to redistribute it under certain conditions.

    Algorithms

    +

    ltr_symmetric

    +
      +
    • Create image with width=columns, height=rows.
      • +
    • Set background color.
      • +
    • Select half of the columns, or half of the columns + 1 if uneven.
        +
      • columns / 2 + columns % 2
        • +
      +
      • +
    • Pixels are drawn from left to right, top to bottom.
      • +
    • Use bits from digest to determine if a pixel is painted(1) or not(0).
      • +
    • Mirror the pixels vertically.
      • +
    • Use the following bits to pick the foreground color.
      • +
    • Scale image proportionally to requested width.
      • +
    +
    0111 0011 1101 1100 […] 1111 0111 0101 0111
    ^ ^
    +----------------------------+-------------->
    | |
    pixel matrix foreground color

    Implemented in ltr_symmetric.cpp

    +

    sigil

    +
      +
    • Create image with width=columns, height=rows.
      • +
    • Set background color.
      • +
    • Select half of the columns, or half of the columns + 1 if uneven.
        +
      • columns / 2 + columns % 2
        • +
      +
      • +
    • Pixels are drawn from top to bottom, left to right.
      • +
    • Use the first 8 bits to pick the foreground color.
      • +
    • Use the following bits to determine if a pixel is painted(1) or not(0).
      • +
    • Mirror the pixels vertically.
      • +
    • Scale image proportionally to requested width.
      • +
    +
    0111 0011 1101 1100
    ^ ^
    +---------+--------->
    | |
    foreground color |
    pixel matrix

    Implemented in sigil.cpp

    +
    Generated by