Code cleanup: use r_ prefix for return args
[blender.git] / source / blender / blenkernel / BKE_font.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_FONT_H__
28 #define __BKE_FONT_H__
29
30 /** \file BKE_font.h
31  *  \ingroup bke
32  */
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 #include <wchar.h>
39
40 struct VFont;
41 struct Object;
42 struct Curve;
43 struct objfnt;
44 struct TmpFont;
45 struct CharInfo;
46 struct Main;
47
48 struct CharTrans {
49         float xof, yof;
50         float rot;
51         short linenr, charnr;
52         char dobreak;
53 };
54
55 typedef struct EditFontSelBox {
56         float x, y, w, h;
57         float rot;
58 } EditFontSelBox;
59
60 typedef struct EditFont {
61         wchar_t *copybuf;
62         struct CharInfo *copybufinfo;
63         
64         wchar_t *textbuf;
65         struct CharInfo *textbufinfo;
66         
67         /* array of rectangles & rotation */
68         EditFontSelBox *selboxes;
69         float textcurs[4][2];
70
71         /* positional vars relative to the textbuf, textbufinfo (not utf8 bytes)
72          * a copy of these is kept in Curve, but use these in editmode */
73         int len, pos;
74         int selstart, selend;
75         
76 } EditFont;
77
78
79 bool BKE_vfont_is_builtin(struct VFont *vfont);
80 void BKE_vfont_builtin_register(void *mem, int size);
81
82 void BKE_vfont_free_data(struct VFont *vfont);
83 void BKE_vfont_free(struct VFont *sc); 
84 struct VFont *BKE_vfont_builtin_get(void);
85 struct VFont *BKE_vfont_load(struct Main *bmain, const char *name);
86
87 bool BKE_vfont_to_curve_ex(struct Main *bmain, struct Object *ob, int mode,
88                            struct ListBase *r_nubase,
89                            const wchar_t **r_text, int *r_text_len, bool *r_text_free,
90                            struct CharTrans **r_chartransdata);
91 bool BKE_vfont_to_curve_nubase(struct Main *bmain, struct Object *ob, int mode,
92                                struct ListBase *r_nubase);
93 bool BKE_vfont_to_curve(struct Main *bmain, struct Object *ob, int mode);
94
95 int BKE_vfont_select_get(struct Object *ob, int *r_start, int *r_end);
96
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif
102