BKE_vfont.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
 
#include "BLI_sys_types.h"

 
struct CharInfo;
struct Curve;
struct ListBase;
struct Main;
struct Object;
struct VFont;
 
struct CharTrans {
  float xof, yof;
  float rot;
  short linenr, charnr;
 
  uint dobreak : 1;
  uint is_overflow : 1;
  uint is_wrap : 1;
  uint is_smallcaps : 1;
};
 
struct EditFontSelBox {
  float x, y, w, h;
  float rot;
};

struct EditFont {
  char32_t *textbuf;
  CharInfo *textbufinfo;

  float font_size_eval;

  float textcurs[4][2];
  EditFontSelBox *selboxes;
  int selboxes_len;
 
  /* Positional vars relative to the `textbuf` (not UTF8 bytes)
   * a copy of these is kept in Curve, but use these in edit-mode. */

  int len;
  int pos;
  int selstart, selend;

  int select_char_info_flag;

  char needs_flush_to_id;
};
 
enum eEditFontMode {
  FO_EDIT = 0,
  FO_CURS = 1,
  FO_CURSUP = 2,
  FO_CURSDOWN = 3,
  FO_DUPLI = 4,
  FO_PAGEUP = 8,
  FO_PAGEDOWN = 9,
  FO_LINE_BEGIN = 10,
  FO_LINE_END = 11,
  FO_SELCHANGE = 12,
};

#define FO_CURS_IS_MOTION(mode) \
  (ELEM(mode, FO_CURSUP, FO_CURSDOWN, FO_PAGEUP, FO_PAGEDOWN, FO_LINE_BEGIN, FO_LINE_END))
 
/* -------------------------------------------------------------------- */
 
bool BKE_vfont_is_builtin(const VFont *vfont);
void BKE_vfont_builtin_register(const void *mem, int size);
VFont *BKE_vfont_builtin_ensure();
 
void BKE_vfont_data_ensure(VFont *vfont);
void BKE_vfont_data_free(VFont *vfont);
 
VFont *BKE_vfont_load(Main *bmain, const char *filepath);
VFont *BKE_vfont_load_exists_ex(Main *bmain, const char *filepath, bool *r_exists);
VFont *BKE_vfont_load_exists(Main *bmain, const char *filepath);
 
int BKE_vfont_select_get(const Curve *cu, int *r_start, int *r_end);
void BKE_vfont_select_clamp(Curve *cu);
 
void BKE_vfont_clipboard_free();
void BKE_vfont_clipboard_set(const char32_t *text_buf, const CharInfo *info_buf, size_t len);
void BKE_vfont_clipboard_get(char32_t **r_text_buf,
                             CharInfo **r_info_buf,
                             size_t *r_len_utf8,
                             size_t *r_len_utf32);

 
/* -------------------------------------------------------------------- */
 
int BKE_vfont_cursor_to_text_index(Object *ob, const float cursor_location[2]);

bool BKE_vfont_to_curve(Object *ob, eEditFontMode mode);
void BKE_vfont_char_build(Curve *cu,
                          ListBase *nubase,
                          unsigned int charcode,
                          const CharInfo *info,
                          bool is_smallcaps,
                          float ofsx,
                          float ofsy,
                          float rot,
                          int charidx,
                          float fsize);
 
bool BKE_vfont_to_curve_ex(Object *ob,
                           Curve *cu,
                           eEditFontMode mode,
                           ListBase *r_nubase,
                           const char32_t **r_text,
                           int *r_text_len,
                           bool *r_text_free,
                           CharTrans **r_chartransdata,
                           float *r_font_size_eval);
bool BKE_vfont_to_curve_nubase(Object *ob, eEditFontMode mode, ListBase *r_nubase);