/* MIT License
 *
 * Copyright (c) 2019 - 2023 Andreas Merkle <web@blue-andi.de>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/*******************************************************************************
    DESCRIPTION
*******************************************************************************/
/**
 * @brief  Fonts
 * @author Andreas Merkle <web@blue-andi.de>
 *
 * @addtogroup gfx
 *
 * @{
 */

#ifndef FONTS_HPP
#define FONTS_HPP

/******************************************************************************
 * Compile Switches
 *****************************************************************************/

/******************************************************************************
 * Includes
 *****************************************************************************/
#include <YAFont.h>

/** Fonts */
namespace Fonts
{

/******************************************************************************
 * Macros
 *****************************************************************************/

/******************************************************************************
 * Types and Classes
 *****************************************************************************/

/**
 * Supported font types.
 */
typedef enum
{
    FONT_TYPE_DEFAULT = 0,  /**< Default font */
    FONT_TYPE_NORMAL,       /**< Normal font */
    FONT_TYPE_LARGE         /**< A font with larger height. */

} FontType;

/******************************************************************************
 * Functions
 *****************************************************************************/

/**
 * Get font type as string.
 * 
 * @param[in] type  The font type.
 * 
 * @return Font type as string.
 */
extern const char* fontTypeToStr(FontType type);

/**
 * Get font type from string.
 * If the string is empty or its content is invalid, it will return the default font type.
 * 
 * @param[in] str   String which contains the font type user friendly.
 * 
 * @return Font type
 */
extern FontType strToFontType(const char* str);

/**
 * Get the font by type.
 * 
 * @param[in] type  Choosen font type.
 * 
 * @return Reference to the font.
 */
extern YAFont& getFontByType(FontType type);

}

#endif  /* FONTS_HPP */

/** @} */