utils.hh

/* Module: Utils
 * ----------
 * COMP.CS.110 SPRING 2021
 * ----------
 * Module for different kinds of utilities needed in the program.
 * */

#ifndef UTILS_HH
#define UTILS_HH

#include <player.hh>
#include <QIcon>
#include <vector>
#include <algorithm>

namespace utils
{
    /**
     * Returns an icon based off the input icon number.
     *
     * \param icon Int number corresponding to the desired icon
     * \return QIcon object of the desired icon
     */
    QIcon get_icon(int icon);

    /**
     * Calculates factors for the desired value so that the factors
     * are as near to each other as possible.
     *
     * \param value Int Input value to calculate factor of
     * \param smaller_factor UInt byref specified for the smaller factor
     * \param larger_factor UInt byref specified for the larger factor
     * \return bool true for success, false for failure
     */
    void calculate_factors(int value, unsigned& smaller_factor,
                           unsigned& larger_factor);

    /**
     * Gets the specified amount of random card icon pairs.
     *
     * \param card_count int count of cards in the playing field
     * \return int vector of card icons
     */
    std::vector<int> get_random_card_icons(int card_count);

    /**
     * Converts a seconds to a min:sec format string.
     *
     * \param seconds uint second amount
     * \return QString time format
     */
    QString seconds_to_time_string(unsigned seconds);

    /**
     * Gets the plural form for an icon's name.
     *
     * \param icon int icon id
     * \return QString icon name in plural
     */
    QString icon_name_to_plural(int icon);

    /**
     * Converts a vector of player objects to a comma separeted string list.\n
     * Output in "player1, player2 and player3" -format.
     *
     * \param players vector of player object pointers
     * \return QString of comma separated player names
     */
    QString player_vector_to_names(const std::vector<Player*>& players);

    /**
     * \brief Splits input by the specified delimiter.
     * 
     * \param text String to split
     * \param separator char separator character
     * \param include_empty bool include empty parts, default false (= no)
     * \return String vector of the split parts
     */
    std::vector<QString> split(const QString& text, char separator,
                                   bool include_empty = false);

    const QString ICON_SUFFIX = ":/icons/";
    const QString ICON_FILE_TYPE = ".png";
    const int MAX_CARD_COUNT = 40;
    const int ANIMAL_ICON_COUNT = 20;

    //enum to easily refer to different icons
    //first element has to be none, and second has to be the cards' backside
    enum icons
    {
        none,
        back,
        bird,
        bunny,
        camel,
        cat,
        chicken,
        cow,
        dog,
        donkey,
        duck,
        elephant,
        flamingo,
        horse,
        lizard,
        llama,
        monke,
        panda,
        pig,
        rooster,
        sheep,
        squirrel
    };

    //names of all the icons. names are in same order as the enum above
    static const std::vector<QString> icon_names = { 
        "", "card_back", "bird", "bunny", "camel", "cat", "chicken", "cow",
        "dog", "donkey", "duck", "elephant", "flamingo", "horse", "lizard",
        "llama", "monke", "panda", "pig", "rooster", "sheep", "squirrel" };
};

#endif // UTILS_HH