Changed frame numbering to only alter hashes if they are in the filename (not the...
[blender.git] / source / blender / python / api2_2x / Sys.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., 59 Temple Place - Suite 330, Boston, MA        02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * This is a new part of Blender.
24  *
25  * Contributor(s): Willian P. Germano, Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28 */
29
30 #include "Sys.h" /*This must come first*/
31
32 #include "BKE_utildefines.h"
33 #include "BKE_global.h"
34 #include "BLI_blenlib.h"
35 #include "DNA_scene_types.h" /* G.scene-"r.cfra */
36 #include "PIL_time.h"
37 #include "gen_utils.h"
38
39 #ifdef WIN32
40 #define DIRSEP '\\'
41 #define DIRSEP_STR "\\"
42 #else
43 #define DIRSEP '/'
44 #define DIRSEP_STR "/"
45 #endif
46
47
48 /*****************************************************************************/
49 /* Python API function prototypes for the sys module.                        */
50 /*****************************************************************************/
51 static PyObject *M_sys_basename( PyObject * self, PyObject * value );
52 static PyObject *M_sys_dirname( PyObject * self, PyObject * value );
53 static PyObject *M_sys_join( PyObject * self, PyObject * args );
54 static PyObject *M_sys_splitext( PyObject * self, PyObject * value );
55 static PyObject *M_sys_makename( PyObject * self, PyObject * args,
56         PyObject * kw );
57 static PyObject *M_sys_exists( PyObject * self, PyObject * value );
58 static PyObject *M_sys_time( PyObject * self );
59 static PyObject *M_sys_sleep( PyObject * self, PyObject * args );
60 static PyObject *M_sys_expandpath( PyObject *self, PyObject *value);
61
62 /*****************************************************************************/
63 /* The following string definitions are used for documentation strings.      */
64 /* In Python these will be written to the console when doing a               */
65 /* Blender.sys.__doc__                                                       */
66 /*****************************************************************************/
67 static char M_sys_doc[] = "The Blender.sys submodule\n\
68 \n\
69 This is a minimal system module to supply simple functionality available\n\
70 in the default Python module os.";
71
72 static char M_sys_basename_doc[] =
73         "(path) - Split 'path' in dir and filename.\n\
74 Return the filename.";
75
76 static char M_sys_dirname_doc[] =
77         "(path) - Split 'path' in dir and filename.\n\
78 Return the dir.";
79
80 static char M_sys_join_doc[] =
81         "(dir, file) - Join dir and file to form a full filename.\n\
82 Return the filename.";
83
84 static char M_sys_splitext_doc[] =
85         "(path) - Split 'path' in root and extension:\n\
86 /this/that/file.ext -> ('/this/that/file','.ext').\n\
87 Return the pair (root, extension).";
88
89 static char M_sys_makename_doc[] =
90         "(path = Blender.Get('filename'), ext = \"\", strip = 0) -\n\
91 Strip dir and extension from path, leaving only a name, then append 'ext'\n\
92 to it (if given) and return the resulting string.\n\n\
93 (path) - string: a pathname -- Blender.Get('filename') if 'path' isn't given;\n\
94 (ext = \"\") - string: the extension to append.\n\
95 (strip = 0) - int: strip dirname from 'path' if given and non-zero.\n\
96 Ex: makename('/path/to/file/myfile.foo','-01.abc') returns 'myfile-01.abc'\n\
97 Ex: makename(ext='.txt') returns 'untitled.txt' if Blender.Get('filename')\n\
98 returns a path to the file 'untitled.blend'";
99
100 static char M_sys_time_doc[] =
101         "() - Return a float representing time elapsed in seconds.\n\
102 Each successive call is garanteed to return values greater than or\n\
103 equal to the previous call.";
104
105 static char M_sys_sleep_doc[] =
106         "(milliseconds = 10) - Sleep for the specified time.\n\
107 (milliseconds = 10) - the amount of time in milliseconds to sleep.\n\
108 This function can be necessary in tight 'get event' loops.";
109
110 static char M_sys_exists_doc[] =
111         "(path) - Check if the given pathname exists.\n\
112 The return value is as follows:\n\
113 \t 0: path doesn't exist;\n\
114 \t 1: path is an existing filename;\n\
115 \t 2: path is an existing dirname;\n\
116 \t-1: path exists but is neither a regular file nor a dir.";
117
118 static char M_sys_expandpath_doc[] =
119 "(path) - Expand this Blender internal path to a proper file system path.\n\
120 (path) - the string path to convert.\n\n\
121 Note: internally Blender paths can contain two special character sequences:\n\
122 - '//' (at start) for base path directory (the current .blend's dir path);\n\
123 - '#' (at ending) for current frame number.\n\n\
124 This function expands these to their actual content, returning a valid path.\n\
125 If the special chars are not found in the given path, it is simply returned.";
126
127 /*****************************************************************************/
128 /* Python method structure definition for Blender.sys module:                */
129 /*****************************************************************************/
130 struct PyMethodDef M_sys_methods[] = {
131         {"basename", M_sys_basename, METH_O, M_sys_basename_doc},
132         {"dirname", M_sys_dirname, METH_O, M_sys_dirname_doc},
133         {"join", M_sys_join, METH_VARARGS, M_sys_join_doc},
134         {"splitext", M_sys_splitext, METH_O, M_sys_splitext_doc},
135         {"makename", ( PyCFunction ) M_sys_makename,
136          METH_VARARGS | METH_KEYWORDS,
137          M_sys_makename_doc},
138         {"exists", M_sys_exists, METH_O, M_sys_exists_doc},
139         {"sleep", M_sys_sleep, METH_VARARGS, M_sys_sleep_doc},
140         {"time", ( PyCFunction ) M_sys_time, METH_NOARGS, M_sys_time_doc},
141         {"expandpath", M_sys_expandpath, METH_O, M_sys_expandpath_doc},
142         {NULL, NULL, 0, NULL}
143 };
144
145 /* Module Functions */
146
147 static PyObject *g_sysmodule = NULL;    /* pointer to Blender.sys module */
148
149 PyObject *sys_Init( void )
150 {
151         PyObject *submodule, *dict;
152
153         submodule = Py_InitModule3( "Blender.sys", M_sys_methods, M_sys_doc );
154
155         g_sysmodule = submodule;
156
157         dict = PyModule_GetDict( submodule );
158         
159         EXPP_dict_set_item_str( dict, "dirsep", PyString_FromString(DIRSEP_STR) );
160         EXPP_dict_set_item_str( dict, "sep", PyString_FromString(DIRSEP_STR) );
161
162         return submodule;
163 }
164
165 static PyObject *M_sys_basename( PyObject * self, PyObject * value )
166 {
167         char *name = PyString_AsString(value);
168         char *p, basename[FILE_MAXDIR + FILE_MAXFILE];
169         int n, len;
170
171         if( !name )
172                 return EXPP_ReturnPyObjError( PyExc_TypeError,
173                                               "expected string argument" );
174
175         len = strlen( name );
176         
177 #ifdef WIN32
178         p = MAX2(strrchr( name, '/' ), strrchr( name, '\\' ));
179 #else
180         p = strrchr( name, DIRSEP );
181 #endif
182
183         if( p ) {
184                 n = name + len - p - 1; /* - 1 because we don't want the sep */
185
186                 if( n > FILE_MAXDIR + FILE_MAXFILE )
187                         return EXPP_ReturnPyObjError( PyExc_RuntimeError,
188                                                       "path too long" );
189
190                 BLI_strncpy( basename, p + 1, n + 1 );
191                 return PyString_FromString( basename );
192         }
193
194         return PyString_FromString( name );
195 }
196
197 static PyObject *M_sys_dirname( PyObject * self, PyObject * value )
198 {
199         char *name = PyString_AsString(value);
200         char *p, dirname[FILE_MAXDIR + FILE_MAXFILE];
201         int n;
202
203         if( !name )
204                 return EXPP_ReturnPyObjError( PyExc_TypeError,
205                                               "expected string argument" );
206
207 #ifdef WIN32
208         p = MAX2(strrchr( name, '/' ), strrchr( name, '\\' ));
209 #else
210         p = strrchr( name, DIRSEP );
211 #endif
212
213         if( p ) {
214                 n = p - name;
215
216                 if( n > FILE_MAXDIR + FILE_MAXFILE )
217                         return EXPP_ReturnPyObjError( PyExc_RuntimeError,
218                                                       "path too long" );
219
220                 BLI_strncpy( dirname, name, n + 1 );
221                 return PyString_FromString( dirname );
222         }
223
224         return PyString_FromString( "." );
225 }
226
227 static PyObject *M_sys_join( PyObject * self, PyObject * args )
228 {
229         char *name = NULL, *path = NULL;
230         char filename[FILE_MAXDIR + FILE_MAXFILE];
231         int pathlen = 0, namelen = 0;
232
233         if( !PyArg_ParseTuple( args, "ss", &path, &name ) )
234                 return EXPP_ReturnPyObjError( PyExc_TypeError,
235                                               "expected string argument" );
236
237         pathlen = strlen( path ) + 1;
238         namelen = strlen( name ) + 1;   /* + 1 to account for '\0' for BLI_strncpy */
239
240         if( pathlen + namelen > FILE_MAXDIR + FILE_MAXFILE - 1 )
241                 return EXPP_ReturnPyObjError( PyExc_RuntimeError,
242                                               "filename is too long." );
243
244         BLI_strncpy( filename, path, pathlen );
245
246         if( filename[pathlen - 2] != DIRSEP ) {
247                 filename[pathlen - 1] = DIRSEP;
248                 pathlen += 1;
249         }
250
251         BLI_strncpy( filename + pathlen - 1, name, namelen );
252
253         return PyString_FromString( filename );
254 }
255
256 static PyObject *M_sys_splitext( PyObject * self, PyObject * value )
257 {
258         char *name = PyString_AsString(value);
259         char *dot, *p, path[FILE_MAXDIR + FILE_MAXFILE], ext[FILE_MAXDIR + FILE_MAXFILE];
260         int n, len;
261
262         if( !name )
263                 return EXPP_ReturnPyObjError( PyExc_TypeError,
264                                               "expected string argument" );
265
266         len = strlen( name );
267         dot = strrchr( name, '.' );
268
269         if( !dot )
270                 return Py_BuildValue( "ss", name, "" );
271
272         p = strrchr( name, DIRSEP );
273
274         if( p ) {
275                 if( p > dot )
276                         return Py_BuildValue( "ss", name, "" );
277         }
278
279         n = name + len - dot;
280
281         /* loong extensions are supported -- foolish, but Python's os.path.splitext
282          * supports them, so ... */
283          
284         if( n >= FILE_MAXDIR + FILE_MAXFILE || ( len - n ) >= FILE_MAXDIR + FILE_MAXFILE )
285                 return EXPP_ReturnPyObjError( PyExc_RuntimeError, "path too long" );
286
287         BLI_strncpy( ext, dot, n + 1 );
288         BLI_strncpy( path, name, dot - name + 1 );
289
290         return Py_BuildValue( "ss", path, ext );
291 }
292
293 static PyObject *M_sys_makename( PyObject * self, PyObject * args,
294                                  PyObject * kw )
295 {
296         char *path = G.sce, *ext = NULL;
297         int strip = 0;
298         static char *kwlist[] = { "path", "ext", "strip", NULL };
299         char *dot = NULL, *p = NULL, basename[FILE_MAXDIR + FILE_MAXFILE];
300         int n, len, lenext = 0;
301
302         if( !PyArg_ParseTupleAndKeywords( args, kw, "|ssi", kwlist,
303                                           &path, &ext, &strip ) )
304                 return EXPP_ReturnPyObjError( PyExc_TypeError,
305                                               "expected one or two strings and an int (or nothing) as arguments" );
306
307         len = strlen( path ) + 1;       /* + 1 to consider ending '\0' */
308         if( ext )
309                 lenext = strlen( ext ) + 1;
310
311         if( ( len + lenext ) > FILE_MAXDIR + FILE_MAXFILE )
312                 return EXPP_ReturnPyObjError( PyExc_RuntimeError,
313                                               "path too long" );
314
315         p = strrchr( path, DIRSEP );
316
317         if( p && strip ) {
318                 n = path + len - p;
319                 BLI_strncpy( basename, p + 1, n );      /* + 1 to skip the sep */
320         } else
321                 BLI_strncpy( basename, path, len );
322
323         dot = strrchr( basename, '.' );
324
325         /* now the extension: always remove the one in basename */
326         if( dot || ext ) {
327                 if( !ext )
328                         basename[dot - basename] = '\0';
329                 else {          /* if user gave an ext, append it */
330
331                         if( dot )
332                                 n = dot - basename;
333                         else
334                                 n = strlen( basename );
335
336                         BLI_strncpy( basename + n, ext, lenext );
337                 }
338         }
339
340         return PyString_FromString( basename );
341 }
342
343 static PyObject *M_sys_time( PyObject * self )
344 {       
345         return PyFloat_FromDouble( PIL_check_seconds_timer(  ) );
346 }
347
348 static PyObject *M_sys_sleep( PyObject * self, PyObject * args )
349 {
350         int millisecs = 10;
351
352         if( !PyArg_ParseTuple( args, "|i", &millisecs ) )
353                 return EXPP_ReturnPyObjError( PyExc_TypeError,
354                                               "expected int argument" );
355
356         PIL_sleep_ms( millisecs );
357
358         return EXPP_incr_ret( Py_None );
359 }
360
361 static PyObject *M_sys_exists( PyObject * self, PyObject * value )
362 {
363         char *fname = PyString_AsString(value);
364         
365         int mode = 0, i = -1;
366
367         if( !fname )
368                 return EXPP_ReturnPyObjError( PyExc_TypeError,
369                                               "expected string (pathname) argument" );
370
371         mode = BLI_exist(fname);
372         
373         if( mode == 0 )
374                 i = 0;
375         else if( S_ISREG( mode ) )
376                 i = 1;
377         else if( S_ISDIR( mode ) )
378                 i = 2;
379         /* i stays as -1 if path exists but is neither a regular file nor a dir */
380         
381         return PyInt_FromLong(i);
382 }
383
384 static PyObject *M_sys_expandpath( PyObject * self, PyObject * value )
385 {
386         char *path = PyString_AsString(value);
387         char expanded[FILE_MAXDIR + FILE_MAXFILE];
388
389         if (!path)
390                 return EXPP_ReturnPyObjError( PyExc_TypeError,
391                         "expected string argument" );
392         
393         BLI_strncpy(expanded, path, FILE_MAXDIR + FILE_MAXFILE);
394         BLI_convertstringcode(expanded, G.sce);
395         BLI_convertstringframe(expanded, G.scene->r.cfra);
396
397         return PyString_FromString(expanded);
398 }