44aa86f98c3e5977893faae20feee41e70b6dbdb
[blender.git] / source / blender / python / api2_2x / gen_utils.c
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
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30 */
31
32 #include "gen_utils.h"
33 #include "constant.h"
34
35 /*****************************************************************************/
36 /* Description: This function clamps an int to the given interval            */
37 /*              [min, max].                                                  */
38 /*****************************************************************************/
39 int EXPP_ClampInt (int value, int min, int max)
40 {
41         if (value < min) return min;
42         else if (value > max) return max;
43         return value;
44 }
45
46 /*****************************************************************************/
47 /* Description: This function clamps a float to the given interval           */
48 /*              [min, max].                                                  */
49 /*****************************************************************************/
50 float EXPP_ClampFloat (float value, float min, float max)
51 {
52         if (value < min) return min;
53         else if (value > max) return max;
54         return value;
55 }
56
57 /*****************************************************************************/
58 /* Description: This function returns true if both given strings are equal,  */
59 /*              otherwise it returns false.                                  */
60 /*****************************************************************************/
61 int StringEqual (const char * string1, const char * string2)
62 {
63         return (strcmp(string1, string2)==0);
64 }
65
66 /*****************************************************************************/
67 /* Description: This function returns the name of the given ID struct        */
68 /*              without the Object type identifying characters prepended.    */
69 /*****************************************************************************/
70 char * GetIdName (ID *id)
71 {
72         return ((id->name)+2);
73 }
74
75 /*****************************************************************************/
76 /* Description: This function returns the ID of the object with given name   */
77 /*              from a given list.                                           */
78 /*****************************************************************************/
79 ID *GetIdFromList(ListBase *list, char *name)
80 {
81         ID *id = list->first;
82
83         while (id) {
84                 if(strcmp(name, id->name+2) == 0) break;
85                         id= id->next;
86         }
87
88         return id;
89 }
90
91 /*****************************************************************************/
92 /* Description: These functions set an internal string with the given type   */
93 /*              and error_msg arguments.                                     */
94 /*****************************************************************************/
95
96 PyObject *EXPP_ReturnPyObjError (PyObject * type, char * error_msg)
97 { /* same as above, just to change its name smoothly */
98         PyErr_SetString (type, error_msg);
99         return NULL;
100 }
101
102 int EXPP_ReturnIntError (PyObject *type, char *error_msg)
103 {
104         PyErr_SetString (type, error_msg);
105         return -1;
106 }
107
108 /*****************************************************************************/
109 /* Description: This function increments the reference count of the given    */
110 /*              Python object (usually Py_None) and returns it.              */
111 /*****************************************************************************/
112
113 PyObject *EXPP_incr_ret (PyObject *object)
114 {
115         Py_INCREF (object);
116         return (object);
117 }
118
119 /*****************************************************************************/
120 /* Description: This function maps the event identifier to a string.         */
121 /*****************************************************************************/
122 char * event_to_name(short event)
123 {
124         switch (event)
125         {
126                 case SCRIPT_FRAMECHANGED:
127                         return "FrameChanged";
128                 case SCRIPT_ONLOAD:
129                         return "OnLoad";
130                 case SCRIPT_REDRAW:
131                         return "Redraw";
132                 default:
133                         return "Unknown";
134         }
135 }       
136
137 /*****************************************************************************/
138 /* Description: Checks whether all objects in a PySequence are of a same     */
139 /*              given type.  Returns 0 if not, 1 on success.                 */
140 /*****************************************************************************/
141 int EXPP_check_sequence_consistency(PyObject *seq, PyTypeObject *against)
142 {
143         PyObject *ob;
144         int len = PySequence_Length(seq);
145         int i;
146
147         for (i = 0; i < len; i++) {
148                 ob = PySequence_GetItem(seq, i);
149                 if (ob->ob_type != against) {
150                         Py_DECREF(ob);
151                         return 0;
152                 }
153                 Py_DECREF(ob);
154         }
155         return 1;
156 }
157
158 PyObject *EXPP_tuple_repr(PyObject *self, int size)
159 {
160         PyObject *repr, *item;
161         int i;
162
163 /*@     note: a value must be built because the list is decrefed!
164  * otherwise we have nirvana pointers inside python.. */
165
166         repr = PyString_FromString("");
167         if (!repr) return 0;
168
169         item = PySequence_GetItem(self, 0); 
170         PyString_ConcatAndDel(&repr, PyObject_Repr(item));
171         Py_DECREF(item);
172
173         for (i = 1; i < size; i++) {
174                 item = PySequence_GetItem(self, i);
175                 PyString_ConcatAndDel(&repr, PyObject_Repr(item));
176                 Py_DECREF(item);
177         }
178
179         return repr;
180 }
181
182 /****************************************************************************/
183 /* Description: searches through a map for a pair with a given name. If the */
184 /*              pair is present, its ival is stored in *ival and nonzero is */
185 /*              returned. If the pair is absent, zero is returned.          */
186 /****************************************************************************/
187 int EXPP_map_getIntVal (const EXPP_map_pair *map, const char *sval, int *ival)
188 {
189     while (map->sval)
190     {
191         if (StringEqual(sval, map->sval))
192         {
193             *ival = map->ival;
194             return 1;
195         }
196         ++map;
197     }
198     return 0;
199 }
200
201 /****************************************************************************/
202 /* Description: searches through a map for a pair with a given name. If the */
203 /*              pair is present, its ival is stored in *ival and nonzero is */
204 /*              returned. If the pair is absent, zero is returned.          */
205 /* note: this function is identical to EXPP_map_getIntVal except that the   */
206 /*       output is stored in a short value.                                 */
207 /****************************************************************************/
208 int EXPP_map_getShortVal (const EXPP_map_pair *map, 
209                                         const char *sval, short *ival)
210 {
211     while (map->sval)
212     {
213         if (StringEqual(sval, map->sval))
214         {
215             *ival = map->ival;
216             return 1;
217         }
218         ++map;
219     }
220     return 0;
221 }
222
223 /****************************************************************************/
224 /* Description: searches through a map for a pair with a given ival. If the */
225 /*              pair is present, a pointer to its name is stored in *sval   */
226 /*              and nonzero is returned. If the pair is absent, zero is     */
227 /*              returned.                                                   */
228 /****************************************************************************/
229 int EXPP_map_getStrVal (const EXPP_map_pair *map, int ival, const char **sval)
230 {
231   while (map->sval)
232   {
233     if (ival == map->ival)
234     {
235       *sval = map->sval;
236       return 1;
237     }
238     ++map;
239   }
240   return 0;
241 }