doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / python / generic / blf_py_api.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <Python.h>
26 #include "blf_py_api.h"
27
28 #include "../../blenfont/BLF_api.h"
29
30 #include "BLI_utildefines.h"
31
32
33
34 static char py_blf_position_doc[] =
35 ".. function:: position(fontid, x, y, z)\n"
36 "\n"
37 "   Set the position for drawing text.\n"
38 "\n"
39 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
40 "   :type fontid: int\n"
41 "   :arg x: X axis position to draw the text.\n"
42 "   :type x: float\n"
43 "   :arg y: Y axis position to draw the text.\n"
44 "   :type y: float\n"
45 "   :arg z: Z axis position to draw the text.\n"
46 "   :type z: float\n";
47
48 static PyObject *py_blf_position(PyObject *UNUSED(self), PyObject *args)
49 {
50         int fontid;
51         float x, y, z;
52
53         if (!PyArg_ParseTuple(args, "ifff:blf.position", &fontid, &x, &y, &z))
54                 return NULL;
55
56         BLF_position(fontid, x, y, z);
57
58         Py_RETURN_NONE;
59 }
60
61
62 static char py_blf_size_doc[] =
63 ".. function:: size(fontid, size, dpi)\n"
64 "\n"
65 "   Set the size and dpi for drawing text.\n"
66 "\n"
67 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
68 "   :type fontid: int\n"
69 "   :arg size: Point size of the font.\n"
70 "   :type size: int\n"
71 "   :arg dpi: dots per inch value to use for drawing.\n"
72 "   :type dpi: int\n";
73
74 static PyObject *py_blf_size(PyObject *UNUSED(self), PyObject *args)
75 {
76         int fontid, size, dpi;
77
78         if (!PyArg_ParseTuple(args, "iii:blf.size", &fontid, &size, &dpi))
79                 return NULL;
80
81         BLF_size(fontid, size, dpi);
82
83         Py_RETURN_NONE;
84 }
85
86
87 static char py_blf_aspect_doc[] =
88 ".. function:: aspect(fontid, aspect)\n"
89 "\n"
90 "   Set the aspect for drawing text.\n"
91 "\n"
92 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
93 "   :type fontid: int\n"
94 "   :arg aspect: The aspect ratio for text drawing to use.\n"
95 "   :type aspect: float\n";
96
97 static PyObject *py_blf_aspect(PyObject *UNUSED(self), PyObject *args)
98 {
99         float aspect;
100         int fontid;
101
102         if (!PyArg_ParseTuple(args, "if:blf.aspect", &fontid, &aspect))
103                 return NULL;
104
105         BLF_aspect(fontid, aspect, aspect, 1.0);
106
107         Py_RETURN_NONE;
108 }
109
110
111 static char py_blf_blur_doc[] =
112 ".. function:: blur(fontid, radius)\n"
113 "\n"
114 "   Set the blur radius for drawing text.\n"
115 "\n"
116 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
117 "   :type fontid: int\n"
118 "   :arg radius: The radius for blurring text (in pixels).\n"
119 "   :type radius: int\n";
120
121 static PyObject *py_blf_blur(PyObject *UNUSED(self), PyObject *args)
122 {
123         int blur, fontid;
124
125         if (!PyArg_ParseTuple(args, "ii:blf.blur", &fontid, &blur))
126                 return NULL;
127
128         BLF_blur(fontid, blur);
129
130         Py_RETURN_NONE;
131 }
132
133
134 static char py_blf_draw_doc[] =
135 ".. function:: draw(fontid, text)\n"
136 "\n"
137 "   Draw text in the current context.\n"
138 "\n"
139 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
140 "   :type fontid: int\n"
141 "   :arg text: the text to draw.\n"
142 "   :type text: string\n";
143
144 static PyObject *py_blf_draw(PyObject *UNUSED(self), PyObject *args)
145 {
146         char *text;
147         int text_length;
148         int fontid;
149
150         if (!PyArg_ParseTuple(args, "is#:blf.draw", &fontid, &text, &text_length))
151                 return NULL;
152
153         BLF_draw(fontid, text, (unsigned int)text_length);
154
155         Py_RETURN_NONE;
156 }
157
158 static char py_blf_dimensions_doc[] =
159 ".. function:: dimensions(fontid, text)\n"
160 "\n"
161 "   Return the width and height of the text.\n"
162 "\n"
163 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
164 "   :type fontid: int\n"
165 "   :arg text: the text to draw.\n"
166 "   :type text: string\n"
167 "   :return: the width and height of the text.\n"
168 "   :rtype: tuple of 2 floats\n";
169
170 static PyObject *py_blf_dimensions(PyObject *UNUSED(self), PyObject *args)
171 {
172         char *text;
173         float r_width, r_height;
174         PyObject *ret;
175         int fontid;
176
177         if (!PyArg_ParseTuple(args, "is:blf.dimensions", &fontid, &text))
178                 return NULL;
179
180         BLF_width_and_height(fontid, text, &r_width, &r_height);
181
182         ret= PyTuple_New(2);
183         PyTuple_SET_ITEM(ret, 0, PyFloat_FromDouble(r_width));
184         PyTuple_SET_ITEM(ret, 1, PyFloat_FromDouble(r_height));
185         return ret;
186 }
187
188 static char py_blf_clipping_doc[] =
189 ".. function:: clipping(fontid, xmin, ymin, xmax, ymax)\n"
190 "\n"
191 "   Set the clipping, enable/disable using CLIPPING.\n"
192 "\n"
193 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
194 "   :type fontid: int\n"
195 "   :arg xmin: Clip the drawing area by these bounds.\n"
196 "   :type xmin: float\n"
197 "   :arg ymin: Clip the drawing area by these bounds.\n"
198 "   :type ymin: float\n"
199 "   :arg xmax: Clip the drawing area by these bounds.\n"
200 "   :type xmax: float\n"
201 "   :arg ymax: Clip the drawing area by these bounds.\n"
202 "   :type ymax: float\n";
203
204 static PyObject *py_blf_clipping(PyObject *UNUSED(self), PyObject *args)
205 {
206         float xmin, ymin, xmax, ymax;
207         int fontid;
208
209         if (!PyArg_ParseTuple(args, "iffff:blf.clipping", &fontid, &xmin, &ymin, &xmax, &ymax))
210                 return NULL;
211
212         BLF_clipping(fontid, xmin, ymin, xmax, ymax);
213
214         Py_RETURN_NONE;
215 }
216
217 static char py_blf_disable_doc[] =
218 ".. function:: disable(fontid, option)\n"
219 "\n"
220 "   Disable option.\n"
221 "\n"
222 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
223 "   :type fontid: int\n"
224 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
225 "   :type option: int\n";
226
227 static PyObject *py_blf_disable(PyObject *UNUSED(self), PyObject *args)
228 {
229         int option, fontid;
230
231         if (!PyArg_ParseTuple(args, "ii:blf.disable", &fontid, &option))
232                 return NULL;
233
234         BLF_disable(fontid, option);
235
236         Py_RETURN_NONE;
237 }
238
239 static char py_blf_enable_doc[] =
240 ".. function:: enable(fontid, option)\n"
241 "\n"
242 "   Enable option.\n"
243 "\n"
244 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
245 "   :type fontid: int\n"
246 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
247 "   :type option: int\n";
248
249 static PyObject *py_blf_enable(PyObject *UNUSED(self), PyObject *args)
250 {
251         int option, fontid;
252
253         if (!PyArg_ParseTuple(args, "ii:blf.enable", &fontid, &option))
254                 return NULL;
255
256         BLF_enable(fontid, option);
257
258         Py_RETURN_NONE;
259 }
260
261 static char py_blf_rotation_doc[] =
262 ".. function:: rotation(fontid, angle)\n"
263 "\n"
264 "   Set the text rotation angle, enable/disable using ROTATION.\n"
265 "\n"
266 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
267 "   :type fontid: int\n"
268 "   :arg angle: The angle for text drawing to use.\n"
269 "   :type angle: float\n";
270
271 static PyObject *py_blf_rotation(PyObject *UNUSED(self), PyObject *args)
272 {
273         float angle;
274         int fontid;
275
276         if (!PyArg_ParseTuple(args, "if:blf.rotation", &fontid, &angle))
277                 return NULL;
278                 
279         BLF_rotation(fontid, angle);
280
281         Py_RETURN_NONE;
282 }
283
284 static char py_blf_shadow_doc[] =
285 ".. function:: shadow(fontid, level, r, g, b, a)\n"
286 "\n"
287 "   Shadow options, enable/disable using SHADOW .\n"
288 "\n"
289 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
290 "   :type fontid: int\n"
291 "   :arg level: The blur level, can be 3, 5 or 0.\n"
292 "   :type level: int\n"
293 "   :arg r: Shadow color (red channel 0.0 - 1.0).\n"
294 "   :type r: float\n"
295 "   :arg g: Shadow color (green channel 0.0 - 1.0).\n"
296 "   :type g: float\n"
297 "   :arg b: Shadow color (blue channel 0.0 - 1.0).\n"
298 "   :type b: float\n"
299 "   :arg a: Shadow color (alpha channel 0.0 - 1.0).\n"
300 "   :type a: float\n";
301
302 static PyObject *py_blf_shadow(PyObject *UNUSED(self), PyObject *args)
303 {
304         int level, fontid;
305         float r, g, b, a;
306
307         if (!PyArg_ParseTuple(args, "iiffff:blf.shadow", &fontid, &level, &r, &g, &b, &a))
308                 return NULL;
309
310         if (level != 0 && level != 3 && level != 5) {
311                 PyErr_SetString(PyExc_TypeError, "blf.shadow expected arg to be in (0, 3, 5)");
312                 return NULL;
313         }
314
315         BLF_shadow(fontid, level, r, g, b, a);
316
317         Py_RETURN_NONE;
318 }
319
320 static char py_blf_shadow_offset_doc[] =
321 ".. function:: shadow_offset(fontid, x, y)\n"
322 "\n"
323 "   Set the offset for shadow text.\n"
324 "\n"
325 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
326 "   :type fontid: int\n"
327 "   :arg x: Vertical shadow offset value in pixels.\n"
328 "   :type x: float\n"
329 "   :arg y: Horizontal shadow offset value in pixels.\n"
330 "   :type y: float\n";
331
332 static PyObject *py_blf_shadow_offset(PyObject *UNUSED(self), PyObject *args)
333 {
334         int x, y, fontid;
335
336         if (!PyArg_ParseTuple(args, "iii:blf.shadow_offset", &fontid, &x, &y))
337                 return NULL;
338
339         BLF_shadow_offset(fontid, x, y);
340
341         Py_RETURN_NONE;
342 }
343
344 static char py_blf_load_doc[] =
345 ".. function:: load(filename)\n"
346 "\n"
347 "   Load a new font.\n"
348 "\n"
349 "   :arg filename: the filename of the font.\n"
350 "   :type filename: string\n"
351 "   :return: the new font's fontid or -1 if there was an error.\n"
352 "   :rtype: integer\n";
353
354 static PyObject *py_blf_load(PyObject *UNUSED(self), PyObject *args)
355 {
356         char* filename;
357
358         if (!PyArg_ParseTuple(args, "s:blf.load", &filename))
359                 return NULL;
360
361         return PyLong_FromLong(BLF_load(filename));
362 }
363
364 /*----------------------------MODULE INIT-------------------------*/
365 static PyMethodDef BLF_methods[] = {
366         {"aspect", (PyCFunction) py_blf_aspect, METH_VARARGS, py_blf_aspect_doc},
367         {"blur", (PyCFunction) py_blf_blur, METH_VARARGS, py_blf_blur_doc},
368         {"clipping", (PyCFunction) py_blf_clipping, METH_VARARGS, py_blf_clipping_doc},
369         {"disable", (PyCFunction) py_blf_disable, METH_VARARGS, py_blf_disable_doc},
370         {"dimensions", (PyCFunction) py_blf_dimensions, METH_VARARGS, py_blf_dimensions_doc},
371         {"draw", (PyCFunction) py_blf_draw, METH_VARARGS, py_blf_draw_doc},
372         {"enable", (PyCFunction) py_blf_enable, METH_VARARGS, py_blf_enable_doc},
373         {"position", (PyCFunction) py_blf_position, METH_VARARGS, py_blf_position_doc},
374         {"rotation", (PyCFunction) py_blf_rotation, METH_VARARGS, py_blf_rotation_doc},
375         {"shadow", (PyCFunction) py_blf_shadow, METH_VARARGS, py_blf_shadow_doc},
376         {"shadow_offset", (PyCFunction) py_blf_shadow_offset, METH_VARARGS, py_blf_shadow_offset_doc},
377         {"size", (PyCFunction) py_blf_size, METH_VARARGS, py_blf_size_doc},
378         {"load", (PyCFunction) py_blf_load, METH_VARARGS, py_blf_load_doc},
379         {NULL, NULL, 0, NULL}
380 };
381
382 static char BLF_doc[] =
383 "This module provides access to blenders text drawing functions.\n";
384
385 static struct PyModuleDef BLF_module_def = {
386         PyModuleDef_HEAD_INIT,
387         "blf",  /* m_name */
388         BLF_doc,  /* m_doc */
389         0,  /* m_size */
390         BLF_methods,  /* m_methods */
391         NULL,  /* m_reload */
392         NULL,  /* m_traverse */
393         NULL,  /* m_clear */
394         NULL,  /* m_free */
395 };
396
397 PyObject *BPyInit_blf(void)
398 {
399         PyObject *submodule;
400
401         submodule = PyModule_Create(&BLF_module_def);
402
403         PyModule_AddIntConstant(submodule, "ROTATION", BLF_ROTATION);
404         PyModule_AddIntConstant(submodule, "CLIPPING", BLF_CLIPPING);
405         PyModule_AddIntConstant(submodule, "SHADOW", BLF_SHADOW);
406         PyModule_AddIntConstant(submodule, "KERNING_DEFAULT", BLF_KERNING_DEFAULT);
407
408         return submodule;
409 }