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