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