Pydrivers: Ipo Drivers controlled by Python expressions
[blender.git] / source / blender / python / api2_2x / EXPP_interface.c
1 /* 
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA        02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * This is a new part of Blender.
27  *
28  * Contributor(s): Michel Selten
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31 */
32
33 #include <Python.h>
34
35 #include "EXPP_interface.h" 
36 #include "BLI_blenlib.h"
37 #include "MEM_guardedalloc.h"
38 #include "BLI_linklist.h" /* linked list: LinkNode struct and functions */
39 #include "DNA_object_types.h"
40 #include "DNA_space_types.h" /* for FILE_MAXDIR, FILE_MAXFILE */
41 #include "Blender.h"
42
43 extern char bprogname[]; /* argv[0] from creator.c */
44
45 /* this makes sure BLI_gethome() returns a path with '.blender' appended
46  * Besides, this function now either returns userhome/.blender (if it exists)
47  * or blenderInstallDir/.blender/ otherwise (can also be cvs dir).
48  * If append_scriptsdir is non NULL, "scripts/" is appended to the dir, to
49  * get the path to the scripts folder ("release/scripts/" if cvs  dir).
50  * Finally, if all else fails BLI_gethome() is returned
51  * (or NULL if append_scriptdir != 0).
52 */
53 char *bpy_gethome(int append_scriptsdir)
54 {
55         static char homedir[FILE_MAXDIR];
56         static char scriptsdir[FILE_MAXDIR];
57         char tmpdir[FILE_MAXDIR];
58         char bprogdir[FILE_MAXDIR];
59         char *s;
60         int i;
61
62         if (append_scriptsdir) {
63                 if (scriptsdir[0] != '\0')
64                         return scriptsdir;
65         }
66         else if (homedir[0] != '\0')
67                 return homedir;
68
69         /* BLI_gethome() can return NULL if env vars are not set */
70         s = BLI_gethome();
71
72         if( !s )  /* bail if no $HOME */
73         {
74                 printf("$HOME is NOT set\n");
75                 return NULL;
76         }
77
78         if( strstr( s, ".blender" ) )
79                 PyOS_snprintf( homedir, FILE_MAXDIR, s );
80         else
81                 BLI_make_file_string( "/", homedir, s, ".blender" );
82
83         /* if userhome/.blender/ exists, return it */
84         if( BLI_exists( homedir ) ) {
85                 if (append_scriptsdir) {
86                         BLI_make_file_string("/", scriptsdir, homedir, "scripts");
87                         if (BLI_exists (scriptsdir)) return scriptsdir;
88                 }
89                 else return homedir;
90         }
91         else homedir[0] = '\0';
92
93         /* if either:
94          * no homedir was found or
95          * append_scriptsdir = 1 but there's no scripts/ inside homedir,
96          * use argv[0] (bprogname) to get .blender/ in
97          * Blender's installation dir */
98         s = BLI_last_slash( bprogname );
99
100         i = s - bprogname + 1;
101
102         PyOS_snprintf( bprogdir, i, "%s", bprogname );
103
104         /* using tmpdir to preserve homedir (if) found above:
105          * the ideal is to have a home dir with scripts dir inside
106          * it, but if that isn't available, it's possible to
107          * have a 'broken' home dir somewhere and a scripts dir in the
108          * cvs sources */
109         BLI_make_file_string( "/", tmpdir, bprogdir, ".blender" );
110
111         if (BLI_exists(tmpdir)) {
112                 if (append_scriptsdir) {
113                         BLI_make_file_string("/", scriptsdir, tmpdir, "scripts");
114                         if (BLI_exists(scriptsdir)) {
115                                 PyOS_snprintf(homedir, FILE_MAXDIR, "%s", tmpdir);
116                                 return scriptsdir;
117                         }
118                         else {
119                                 homedir[0] = '\0';
120                                 scriptsdir[0] = '\0';
121                         }
122                 }
123                 else return homedir;
124         }
125
126         /* last try for scripts dir: blender in cvs dir, scripts/ inside release/: */
127         if (append_scriptsdir) {
128                 BLI_make_file_string("/", scriptsdir, bprogdir, "release/scripts");
129                 if (BLI_exists(scriptsdir)) return scriptsdir;
130                 else scriptsdir[0] = '\0';
131         }
132
133         return NULL;
134 }
135
136 /* PyDrivers */
137
138 /*
139  * Pydrivers are Blender Ipo Drivers defined by Python expressions.
140  * We need to tell DAG about objects used in these expressions, so we
141  * eval each expression to collect the ob refs. in it.
142  */
143
144 /* these are checked for example in Object.c: M_Object_Get (Object.Get())
145  * to collect the refs. */
146 static int pydriver_running = 0;
147
148 int bpy_during_pydriver(void)
149 {
150         return pydriver_running;
151 }
152
153 void bpy_pydriver_running(int state)
154 {
155         pydriver_running = state;
156 }
157
158 /* Obj references are collected in this extern linked list: */
159 LinkNode *bpy_pydriver_oblist = NULL;
160
161 void bpy_pydriver_freeList(void)
162 {
163         BLI_linklist_free(bpy_pydriver_oblist, NULL);
164         bpy_pydriver_oblist = NULL;
165 }
166
167 void bpy_pydriver_appendToList(struct Object *ob)
168 {
169         LinkNode *ln = bpy_pydriver_oblist;
170
171         /* check that the expression is not referencing its owner object */
172
173 /* XXX COMMENTED OUT TO TEST IF WE REALLY NEED TO IMPOSE THIS RESTRICTION
174         if (ln && ln->link) {
175                 if (ob == (Object *)ln->link) {
176                         PyErr_SetString(PyExc_AttributeError,
177                                 "Python driver expression can't reference its own object");
178                         return;
179                 }
180                 else
181                         ln = ln->next;
182         }
183 */
184         while (ln) { /* is ob already in list? ... */
185                 if (ob == (Object *)ln->link)
186                         break;
187                 ln = ln->next;
188         }
189
190         if (!ln) /* ... not yet, append it */
191                 BLI_linklist_append(&bpy_pydriver_oblist, (void *)ob);
192
193         return;
194 }
195
196 /* Get an array from our linked list of objs referenced in the
197  * current pydriver. The first node in the list is discarded,
198  * since it is the actual pydriver owner, which shouldn't be
199  * passed to the depsgraph (no self references). */
200 struct Object **bpy_pydriver_obArrayFromList(void)
201 {
202         Object **obarray = NULL;
203         
204         if (bpy_pydriver_oblist) {
205                 int i;
206                 short len = BLI_linklist_length(bpy_pydriver_oblist);
207
208                 if (len > 1) {
209
210                         obarray = (Object **)MEM_mallocN(sizeof(Object*)*len,
211                                         "pydriver array");
212
213                         if (obarray) {
214                                 LinkNode *ln = bpy_pydriver_oblist;
215                                 ln = ln->next; /* skip first ob, which is the pydriver owner */ 
216
217                                 for (i = 0; i < len-1; i++) {
218                                         obarray[i] = (Object *)ln->link;
219                                         ln = ln->next;
220                                 }
221
222                                 obarray[len-1] = NULL; /* NULL-terminated array */
223                         }
224                 }
225                 bpy_pydriver_freeList();
226         }
227
228         return obarray;
229 }
230