taisei/src/resource/font.h

/*
 * This software is licensed under the terms of the MIT License.
 * See COPYING for further information.
 * ---
 * Copyright (c) 2011-2019, Lukas Weber <laochailan@web.de>.
 * Copyright (c) 2012-2019, Andrei Alexeyev <akari@taisei-project.org>.
 */

#ifndef IGUARD_resource_font_h
#define IGUARD_resource_font_h

#include "taisei.h"

#include "sprite.h"
#include "hashtable.h"
#include "resource.h"
#include "renderer/api.h"

typedef enum {
	ALIGN_LEFT = 0, // must be 0
	ALIGN_CENTER,
	ALIGN_RIGHT,
} Alignment;

typedef ulong charcode_t;
typedef struct Font Font;

typedef struct FontMetrics {
	int ascent;
	int descent;
	int max_glyph_height;
	int lineskip;
	double scale;
} FontMetrics;

typedef struct GlyphMetrics {
	int bearing_x;
	int bearing_y;
	int width;
	int height;
	int advance;
} GlyphMetrics;

// TODO: maybe move this into util/geometry.h
typedef struct BBox {
	struct {
		int min;
		int max;
	} x;

	struct {
		int min;
		int max;
	} y;
} BBox;

// FIXME: this is a quite crude low-level-ish hack, and probably should be replaced with some kind of markup system.
typedef int (*GlyphDrawCallback)(Font *font, charcode_t charcode, SpriteInstanceAttribs *spr_instance, void *userdata);

typedef struct TextParams {
	const char *font;
	Font *font_ptr;
	const char *shader;
	ShaderProgram *shader_ptr;
	struct {
		GlyphDrawCallback func;
		void *userdata;
	} glyph_callback;
	struct { double x, y; } pos;
	const Color *color;
	const ShaderCustomParams *shader_params;
	Texture *aux_textures[R_NUM_SPRITE_AUX_TEXTURES];
	double max_width;
	FloatRect *overlay_projection;
	BlendMode blend;
	Alignment align;
} TextParams;

DEFINE_RESOURCE_GETTER(Font, res_font, RES_FONT)
DEFINE_OPTIONAL_RESOURCE_GETTER(Font, res_font_optional, RES_FONT)
DEFINE_DEPRECATED_RESOURCE_GETTER(Font, get_font, res_font)

ShaderProgram* text_get_default_shader(void)
	attr_returns_nonnull;

const FontMetrics* font_get_metrics(Font *font) attr_nonnull(1) attr_returns_nonnull;

double font_get_ascent(Font *font) attr_nonnull(1);
double font_get_descent(Font *font) attr_nonnull(1);
double font_get_lineskip(Font *font) attr_nonnull(1);

const GlyphMetrics* font_get_char_metrics(Font *font, charcode_t c) attr_nonnull(1);

double text_draw(const char *text, const TextParams *params) attr_nonnull(1, 2);
double text_ucs4_draw(const uint32_t *text, const TextParams *params) attr_nonnull(1, 2);

double text_draw_wrapped(const char *text, double max_width, const TextParams *params) attr_nonnull(1, 3);

void text_render(const char *text, Font *font, Sprite *out_sprite, BBox *out_bbox) attr_nonnull(1, 2, 3, 4);

void text_ucs4_shorten(Font *font, uint32_t *text, double width) attr_nonnull(1, 2);

void text_wrap(Font *font, const char *src, double width, char *buf, size_t bufsize) attr_nonnull(1, 2, 4);

void text_bbox(Font *font, const char *text, uint maxlines, BBox *bbox) attr_nonnull(1, 2, 4);
void text_ucs4_bbox(Font *font, const uint32_t *text, uint maxlines, BBox *bbox) attr_nonnull(1, 2, 4);

int text_width_raw(Font *font, const char *text, uint maxlines) attr_nonnull(1, 2);
int text_ucs4_width_raw(Font *font, const uint32_t *text, uint maxlines) attr_nonnull(1, 2);

double text_width(Font *font, const char *text, uint maxlines) attr_nonnull(1, 2);
double text_ucs4_width(Font *font, const uint32_t *text, uint maxlines) attr_nonnull(1, 2);

int text_height_raw(Font *font, const char *text, uint maxlines) attr_nonnull(1, 2);
int text_ucs4_height_raw(Font *font, const uint32_t *text, uint maxlines) attr_nonnull(1, 2);

double text_height(Font *font, const char *text, uint maxlines) attr_nonnull(1, 2);
double text_ucs4_height(Font *font, const uint32_t *text, uint maxlines) attr_nonnull(1, 2);

// FIXME: come up with a better, stateless API for this
bool font_get_kerning_available(Font *font) attr_nonnull(1);
bool font_get_kerning_enabled(Font *font) attr_nonnull(1);
void font_set_kerning_enabled(Font *font, bool newval) attr_nonnull(1);

extern ResourceHandler font_res_handler;

#define FONT_PATH_PREFIX "res/fonts/"
#define FONT_EXTENSION ".font"

#endif // IGUARD_resource_font_h