identiconpp/src/identiconpp.hpp

/*  This file is part of identiconpp.
 *  Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
 *
 *  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, version 3.
 *
 *  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, see <http://www.gnu.org/licenses/>.
 */

#ifndef IDENTICONPP_HPP
#define IDENTICONPP_HPP

#include <cstdint>
#include <string>
#include <vector>
#include <array>
#include <Magick++/Image.h>

using std::uint8_t;
using std::uint16_t;
using std::string;
using std::vector;
using std::array;

/*!
 *  @example example.cpp
 */

/*!
 *  @brief  Base class for identiconpp.
 *
 *          Use this class for all your identicons. Exceptions will be thrown on
 *          error.
 */
class Identiconpp
{
public:
    friend class Testiconpp;
    /*!
     * @brief  List of identicon algorithms
     */
    enum class algorithm
    {
        //! Generates symmetric (vertically mirrored) identicons.
        ltr_symmetric,
        //! Generates asymmetric identicons.
        ltr_asymmetric,
        /*!
         * Generates the same results as
         * [sigil](https://github.com/cupcake/sigil/) and
         * [pydenticon](https://github.com/azaghal/pydenticon/).
         */
        sigil
    };

    /*!
     *  @brief  Initialises an instance of Identiconpp.
     *
     *          The instance can be used for creating identicons with differing
     *          image formats and sizes. The colors must consist of exactly 8
     *          digits.
     *
     *  @param  columns     Number of columns
     *  @param  rows        Number of rows
     *  @param  type        The algorithm to use
     *  @param  background  Background color, hexadecimal, rrggbbaa
     *  @param  foreground  vector of foreground colors
     *  @param  padding     Padding in pixels { left & right, top & down }
     */
    explicit 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 });

    /*!
     *  @brief  Generates identicon from digest.
     *
     *  @param  digest  The pre-computed digest
     *  @param  width   The width of the image in pixels
     *
     *  @return The image as Magick::Image
     */
    Magick::Image generate(const string &digest, const uint16_t width = 100);

private:
    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;

    /*!
     *  @brief  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.
     *
     *  @param  digest  The pre-computed digest
     *
     *  @return The image
     */
    Magick::Image generate_ltr_symmetric(const string &digest);

    /*!
     *  @brief  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.
     *
     *  @param  digest  The pre-computed digest
     *
     *  @return The image
     */
    Magick::Image generate_ltr_asymmetric(const string &digest);

    /*!
     *  @brief  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.
     *
     *  @param  digest  The pre-computed digest
     *
     *  @return The image
     */
    Magick::Image generate_sigil(const string &digest);

    /*!
     *  @brief  Check if the digest contains enough entropy.
     *
     *          Throws `std::invalid_argument` if not.
     *
     *  @param  digest  The pre-computed digest
     *  @param  type    The type of identicon
     */
    void check_entropy(const string &digest, algorithm type);

    /*!
     *  @brief  Determines if the n-th bit of passed digest is 1 or 0.
     *
     *  @param  bit     Bit to get
     *  @param  digest  The digest
     *
     *  @return The bit.
     */
    bool get_bit(const uint16_t bit, const string &digest);

    /*!
     *  @brief  Chooses a foreground color.
     *
     *          Extracts the right bits from the digest and returns a color.
     *
     *  @param  firstbit  The first bit of the digest to choose a color
     *  @param  digest    The digest
     *
     *  @return A foreground color.
     */
    Magick::Color get_color(const uint16_t firstbit, const string &digest);

    /*!
     *  @brief  Checks if character is not hexadecimal.
     *
     *  @param  c       Character to check
     *
     *  @return true if not hex.
     */
    static bool not_hex(const char c);

    /*!
     *  @brief  Performs checks on a color definition in a string.
     *
     *  @param  color   The color as string
     */
    void check_color(const string &color);
};

#endif  // IDENTICONPP_HPP