lv_txt.h

Go to the documentation of this file.

 
#ifndef LV_TXT_H
#define LV_TXT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#include <stdbool.h>
#include <stdarg.h>
#include "lv_area.h"
#include "../font/lv_font.h"
#include "lv_printf.h"
#include "lv_types.h"
 
/*********************
 *      DEFINES
 *********************/
#ifndef LV_TXT_COLOR_CMD
#define LV_TXT_COLOR_CMD "#"
#endif
 
#define LV_TXT_ENC_UTF8 1
#define LV_TXT_ENC_ASCII 2
 
/**********************
 *      TYPEDEFS
 **********************/
 
enum {
    LV_TEXT_FLAG_NONE    = 0x00,
    LV_TEXT_FLAG_RECOLOR = 0x01, 
    LV_TEXT_FLAG_EXPAND  = 0x02, 
    LV_TEXT_FLAG_FIT     = 0x04, 
};
typedef uint8_t lv_text_flag_t;
 
enum {
    LV_TEXT_CMD_STATE_WAIT, 
    LV_TEXT_CMD_STATE_PAR,  
    LV_TEXT_CMD_STATE_IN,   
};
typedef uint8_t lv_text_cmd_state_t;
 
enum {
    LV_TEXT_ALIGN_AUTO, 
    LV_TEXT_ALIGN_LEFT, 
    LV_TEXT_ALIGN_CENTER, 
    LV_TEXT_ALIGN_RIGHT, 
};
typedef uint8_t lv_text_align_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
void lv_txt_get_size(lv_point_t * size_res, const char * text, const lv_font_t * font, lv_coord_t letter_space,
                     lv_coord_t line_space, lv_coord_t max_width, lv_text_flag_t flag);
 
uint32_t _lv_txt_get_next_line(const char * txt, const lv_font_t * font, lv_coord_t letter_space,
                               lv_coord_t max_width, lv_coord_t * used_width, lv_text_flag_t flag);
 
lv_coord_t lv_txt_get_width(const char * txt, uint32_t length, const lv_font_t * font, lv_coord_t letter_space,
                            lv_text_flag_t flag);
 
bool _lv_txt_is_cmd(lv_text_cmd_state_t * state, uint32_t c);
 
void _lv_txt_ins(char * txt_buf, uint32_t pos, const char * ins_txt);
 
void _lv_txt_cut(char * txt, uint32_t pos, uint32_t len);
 
char * _lv_txt_set_text_vfmt(const char * fmt, va_list ap) LV_FORMAT_ATTRIBUTE(1, 0);
 
void _lv_txt_encoded_letter_next_2(const char * txt, uint32_t * letter, uint32_t * letter_next, uint32_t * ofs);
 
static inline bool _lv_txt_is_break_char(uint32_t letter)
{
    uint8_t i;
    bool ret = false;
 
    /* each chinese character can be break */
    if(letter >= 0x4E00 && letter <= 0x9FA5) {
        return true;
    }
 
    /*Compare the letter to TXT_BREAK_CHARS*/
    for(i = 0; LV_TXT_BREAK_CHARS[i] != '\0'; i++) {
        if(letter == (uint32_t)LV_TXT_BREAK_CHARS[i]) {
            ret = true; /*If match then it is break char*/
            break;
        }
    }
 
    return ret;
}
 
/***************************************************************
 *  GLOBAL FUNCTION POINTERS FOR CHARACTER ENCODING INTERFACE
 ***************************************************************/
 
extern uint8_t (*_lv_txt_encoded_size)(const char *);
 
extern uint32_t (*_lv_txt_unicode_to_encoded)(uint32_t);
 
extern uint32_t (*_lv_txt_encoded_conv_wc)(uint32_t c);
 
extern uint32_t (*_lv_txt_encoded_next)(const char *, uint32_t *);
 
extern uint32_t (*_lv_txt_encoded_prev)(const char *, uint32_t *);
 
extern uint32_t (*_lv_txt_encoded_get_byte_id)(const char *, uint32_t);
 
extern uint32_t (*_lv_txt_encoded_get_char_id)(const char *, uint32_t);
 
extern uint32_t (*_lv_txt_get_encoded_length)(const char *);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_TXT_H*/