BPython:
[blender.git] / source / blender / python / api2_2x / gen_utils.h
1 /* 
2  *
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA        02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * This is a new part of Blender.
26  *
27  * Contributor(s): Michel Selten, Willian P. Germano, Alex Mole, Joseph Gilbert
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30 */
31
32 #ifndef EXPP_gen_utils_h
33 #define EXPP_gen_utils_h
34
35 #include <Python.h>
36 #include "compile.h"
37 #include "eval.h" /* for PyEval_GetLocals */
38 #include <stdio.h>
39 #include <string.h>
40
41 #include <BKE_global.h>
42 #include <BKE_main.h>
43 #include <BPI_script.h>
44
45 #include <DNA_ID.h>
46 #include <DNA_object_types.h>
47 #include <DNA_material_types.h>
48 #include <DNA_scriptlink_types.h>
49 #include <DNA_listBase.h>
50
51 #define Py_PI  3.14159265358979323846
52
53 int StringEqual (const char * string1, const char * string2);
54 char * GetIdName (ID *id);
55 ID *GetIdFromList(ListBase *list, char *name);
56
57 PyObject *PythonReturnErrorObject (PyObject * type, char * error_msg);
58 PyObject *PythonIncRef (PyObject *object);
59
60 char * event_to_name (short event);
61
62 float EXPP_ClampFloat (float value, float min, float max);
63 int             EXPP_ClampInt (int value, int min, int max);
64
65 PyObject *EXPP_incr_ret (PyObject *object);
66 PyObject *EXPP_ReturnPyObjError (PyObject * type, char * error_msg);
67 int EXPP_ReturnIntError (PyObject *type, char *error_msg);
68
69 int EXPP_check_sequence_consistency (PyObject *seq, PyTypeObject *against);
70 PyObject *EXPP_tuple_repr(PyObject *self, int size);
71
72 /* mapping utilities - see Texture.c for an example of how to use these */
73 typedef struct {
74                 const char *sval;
75                 int ival;
76 } EXPP_map_pair;
77
78 /* maps must end with a pair that has NULL as sval */
79 int EXPP_map_getIntVal (const EXPP_map_pair *map, 
80                                                                                                                                                                 const char *sval, int *ival);
81 int EXPP_map_getShortVal (const EXPP_map_pair *map, 
82                                                                                                                                                                 const char *sval, short *ival);
83 int EXPP_map_getStrVal (const EXPP_map_pair *map,
84                                                                                                                                                                 int ival, const char **sval);
85
86 /* scriplinks-related: */
87 PyObject *EXPP_getScriptLinks (ScriptLink *slink, PyObject *args, int is_scene);
88 int EXPP_clearScriptLinks (ScriptLink *slink);
89 int EXPP_addScriptLink (ScriptLink *slink, PyObject *args, int is_scene);
90
91 #endif /* EXPP_gen_utils_h */