gp_text_metric.h

// SPDX-License-Identifier: LGPL-2.1-or-later
/*
 * Copyright (C) 2009-2010 Jiri "BlueBear" Dluhos
 *                         <jiri.bluebear.dluhos@gmail.com>
 *
 * Copyright (C) 2009-2021 Cyril Hrubis <metan@ucw.cz>
 */
 
#ifndef TEXT_GP_TEXT_METRIC_H
#define TEXT_GP_TEXT_METRIC_H
 
#include <core/gp_types.h>
#include <text/gp_text_style.h>
 
enum gp_text_len_type {
        /*
         * Return bounding box, i.e. for the last letter return the greater of
         * advance and letter width. This makes sure that the resulting size
         * will fit the text.
         */
        GP_TEXT_LEN_BBOX,
        /*
         * Returns advance, i.e. where next letter would start after a string
         * would have been printed. This may return slightly less than the
         * GP_TEXT_LEN_BBOX.
         */
        GP_TEXT_LEN_ADVANCE,
};
 
gp_size gp_glyph_advance_x(const gp_text_style *style, uint32_t ch);
 
gp_ssize gp_glyph_bearing_x(const gp_text_style *style, uint32_t ch);
 
gp_size gp_text_width_len(const gp_text_style *style, enum gp_text_len_type type,
                          const char *str, size_t len);
 
static inline gp_size gp_text_wbbox_len(const gp_text_style *style, const char *str, size_t len)
{
        return gp_text_width_len(style, GP_TEXT_LEN_BBOX, str, len);
}
 
gp_size gp_text_width(const gp_text_style *style, enum gp_text_len_type type, const char *str);
 
static inline gp_size gp_text_wbbox(const gp_text_style *style, const char *str)
{
        return gp_text_width(style, GP_TEXT_LEN_BBOX, str);
}
 
/*
 * Maximal text width for string with len characters.
 */
gp_size gp_text_max_width(const gp_text_style *style, unsigned int len);
 
/*
 * Returns average width for len characters.
 */
gp_size gp_text_avg_width(const gp_text_style *style, unsigned int len);
 
/*
 * Returns maximal width for text written with len characters from str.
 */
gp_size gp_text_max_width_chars(const gp_text_style *style, const char *chars,
                                unsigned int len);
 
/*
 * Returns maximal text height, in pixels.
 */
gp_size gp_text_height(const gp_text_style *style);
 
/*
 * Returns the ascent (height from the baseline to the top of characters),
 * for the given text style. (Result is in pixels.)
 */
gp_size gp_text_ascent(const gp_text_style *style);
 
/*
 * Returns the descent (height from the baseline to the bottom of characters),
 * for the given text style. (Result is in pixels.)
 */
gp_size gp_text_descent(const gp_text_style *style);
 
size_t gp_text_fit_width(const gp_text_style *style, const char *str,
                         gp_size width);
 
gp_size gp_text_cur_pos(const gp_text_style *style, const char *str, gp_coord x_off);
 
#endif /* TEXT_GP_TEXT_METRIC_H */