nbgl_fonts.h

Go to the documentation of this file.

 
#ifndef NBGL_FONTS_H
#define NBGL_FONTS_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "nbgl_types.h"
#ifdef HAVE_LANGUAGE_PACK
#include "ux_loc_nbgl.h"
#endif  // HAVE_LANGUAGE_PACK
 
/*********************
 *      DEFINES
 *********************/
#define PIC_CHAR(x) ((const nbgl_font_character_t *) PIC(x))
#define PIC_BMP(x)  ((uint8_t const *) PIC(x))
 
#ifndef HAVE_LANGUAGE_PACK
#define LANGUAGE_PACK void
#endif  // HAVE_LANGUAGE_PACK
 
#if SMALL_FONT_HEIGHT == 24
#define SMALL_REGULAR_FONT      BAGL_FONT_INTER_REGULAR_24px
#define SMALL_BOLD_FONT         BAGL_FONT_INTER_SEMIBOLD_24px
#define LARGE_MEDIUM_FONT       BAGL_FONT_INTER_MEDIUM_32px
#define SMALL_REGULAR_1BPP_FONT BAGL_FONT_INTER_REGULAR_24px_1bpp
#define SMALL_BOLD_1BPP_FONT    BAGL_FONT_INTER_SEMIBOLD_24px_1bpp
#define LARGE_MEDIUM_1BPP_FONT  BAGL_FONT_INTER_MEDIUM_32px_1bpp
#elif SMALL_FONT_HEIGHT == 28
#define SMALL_REGULAR_FONT      BAGL_FONT_INTER_REGULAR_28px
#define SMALL_BOLD_FONT         BAGL_FONT_INTER_SEMIBOLD_28px
#define LARGE_MEDIUM_FONT       BAGL_FONT_INTER_MEDIUM_36px
#define SMALL_REGULAR_1BPP_FONT BAGL_FONT_INTER_REGULAR_28px_1bpp
#define SMALL_BOLD_1BPP_FONT    BAGL_FONT_INTER_SEMIBOLD_28px_1bpp
#define LARGE_MEDIUM_1BPP_FONT  BAGL_FONT_INTER_MEDIUM_36px_1bpp
#endif  // SMALL_FONT_HEIGHT
 
/**********************
 *      TYPEDEFS
 **********************/
 
// WARNING: please DON'T CHANGE the order/values of the fields below!
// (otherwise python tools that generate data will need to be modified too)
typedef struct {
    uint32_t bitmap_offset;     
    uint32_t encoding : 1;      
    uint32_t width : 6;         
    uint32_t x_min_offset : 4;  
    uint32_t y_min_offset : 6;  
    uint32_t x_max_offset : 4;  
    uint32_t y_max_offset : 6;  
} nbgl_font_character_t;
 
typedef struct {
    uint32_t bitmap_len;    
    uint8_t  font_id;       
    uint8_t  bpp;           
    uint8_t  height;        
    uint8_t  line_height;   
    uint8_t  char_kerning;  
    uint8_t  crop;          
    uint8_t  y_min;         
    uint8_t
        first_char;  
    uint8_t
        last_char;  
    const nbgl_font_character_t
        *const     characters;  
    uint8_t const *bitmap;      
} nbgl_font_t;
 
#define BAGL_ENCODING_LATIN1  0
#define BAGL_ENCODING_UTF8    1
#define BAGL_ENCODING_DEFAULT BAGL_ENCODING_UTF8
 
// WARNING: please DON'T CHANGE the order of the fields below!
// (otherwise python tools that generate data will need to be modified too)
typedef struct {
    uint32_t char_unicode : 21;   
    uint32_t encoding : 1;        
    uint32_t width : 6;           
    uint32_t x_min_offset : 4;    
    uint32_t y_min_offset : 6;    
    uint32_t x_max_offset : 4;    
    uint32_t y_max_offset : 6;    
    uint32_t bitmap_offset : 16;  
} nbgl_font_unicode_character_t;
typedef struct {
    uint16_t bitmap_len;    
    uint8_t  font_id;       
    uint8_t  bpp;           
    uint8_t  height;        
    uint8_t  line_height;   
    uint8_t  char_kerning;  
    uint8_t  crop;          
    uint8_t  y_min;         
    uint8_t  unused[3];     
#if !defined(HAVE_LANGUAGE_PACK)
    // When using language packs, those 2 pointers does not exists
    const nbgl_font_unicode_character_t
        *const     characters;  
    uint8_t const *bitmap;      
#endif                          
} nbgl_font_unicode_t;
 
typedef enum {
    BAGL_FONT_INTER_REGULAR_24px,
    BAGL_FONT_INTER_SEMIBOLD_24px,
    BAGL_FONT_INTER_MEDIUM_32px,
    BAGL_FONT_INTER_REGULAR_24px_1bpp,
    BAGL_FONT_INTER_SEMIBOLD_24px_1bpp,
    BAGL_FONT_INTER_MEDIUM_32px_1bpp,
    BAGL_FONT_OPEN_SANS_EXTRABOLD_11px_1bpp = 8u,   // on Nano
    BAGL_FONT_OPEN_SANS_LIGHT_16px_1bpp     = 9u,   // on Nano
    BAGL_FONT_OPEN_SANS_REGULAR_11px_1bpp   = 10u,  // on Nano
    BAGL_FONT_INTER_REGULAR_28px            = 11u,
    BAGL_FONT_INTER_SEMIBOLD_28px           = 12u,
    BAGL_FONT_INTER_MEDIUM_36px             = 13u,
    BAGL_FONT_INTER_REGULAR_28px_1bpp       = 14u,
    BAGL_FONT_INTER_SEMIBOLD_28px_1bpp      = 15u,
    BAGL_FONT_INTER_MEDIUM_36px_1bpp        = 16u,
    BAGL_FONT_LAST  // MUST ALWAYS BE THE LAST, FOR AUTOMATED INVALID VALUE CHECKS
} nbgl_font_id_e;
 
typedef struct nbgl_unicode_ctx_s {
    const nbgl_font_unicode_t           *font;
    const nbgl_font_unicode_character_t *characters;
    const uint8_t                       *bitmap;
    uint32_t                             unicode_character_byte_count;
} nbgl_unicode_ctx_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
const nbgl_font_t *nbgl_getFont(nbgl_font_id_e fontId);
uint16_t           nbgl_getSingleLineTextWidth(nbgl_font_id_e fontId, const char *text);
uint16_t nbgl_getSingleLineTextWidthInLen(nbgl_font_id_e fontId, const char *text, uint16_t maxLen);
uint16_t nbgl_getTextWidth(nbgl_font_id_e fontId, const char *text);
uint8_t  nbgl_getCharWidth(nbgl_font_id_e fontId, const char *text);
uint8_t  nbgl_getFontHeight(nbgl_font_id_e fontId);
uint8_t  nbgl_getFontLineHeight(nbgl_font_id_e fontId);
uint16_t nbgl_getTextNbLines(const char *text);
uint16_t nbgl_getTextHeight(nbgl_font_id_e fontId, const char *text);
uint16_t nbgl_getTextLength(const char *text);
void     nbgl_getTextMaxLenAndWidth(nbgl_font_id_e fontId,
                                    const char    *text,
                                    uint16_t       maxWidth,
                                    uint16_t      *len,
                                    uint16_t      *width,
                                    bool           wrapping);
uint16_t nbgl_getTextNbLinesInWidth(nbgl_font_id_e fontId,
                                    const char    *text,
                                    uint16_t       maxWidth,
                                    bool           wrapping);
uint16_t nbgl_getTextHeightInWidth(nbgl_font_id_e fontId,
                                   const char    *text,
                                   uint16_t       maxWidth,
                                   bool           wrapping);
bool     nbgl_getTextMaxLenAndWidthFromEnd(nbgl_font_id_e fontId,
                                           const char    *text,
                                           uint16_t       maxWidth,
                                           uint16_t      *len,
                                           uint16_t      *width);
bool     nbgl_getTextMaxLenInNbLines(nbgl_font_id_e fontId,
                                     const char    *text,
                                     uint16_t       maxWidth,
                                     uint16_t       maxNbLines,
                                     uint16_t      *len,
                                     bool           wrapping);
void nbgl_textWrapOnNbLines(nbgl_font_id_e fontId, char *text, uint16_t maxWidth, uint8_t nbLines);
void nbgl_textReduceOnNbLines(nbgl_font_id_e fontId,
                              const char    *origText,
                              uint16_t       maxWidth,
                              uint8_t        nbLines,
                              char          *reducedText,
                              uint16_t       reducedTextLen);
uint8_t nbgl_getTextNbPagesInWidth(nbgl_font_id_e fontId,
                                   const char    *text,
                                   uint8_t        nbLinesPerPage,
                                   uint16_t       maxWidth);
 
uint32_t nbgl_popUnicodeChar(const uint8_t **text, uint16_t *text_length, bool *is_unicode);
#ifdef HAVE_UNICODE_SUPPORT
nbgl_unicode_ctx_t                  *nbgl_getUnicodeFont(nbgl_font_id_e font_id);
const nbgl_font_unicode_character_t *nbgl_getUnicodeFontCharacter(uint32_t unicode);
uint32_t                             nbgl_getUnicodeFontCharacterByteCount(void);
void                                 nbgl_refreshUnicodeFont(const LANGUAGE_PACK *lp);
#endif  // HAVE_UNICODE_SUPPORT
 
/**********************
 *      MACROS
 **********************/
#define IS_UNICODE(__value) ((__value) > 0xF0)
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_FONTS_H */