Scripts:
[blender-staging.git] / source / blender / python / api2_2x / Sys.c
index 56f3a64d4897f69b2ada184e783e5cf8749a7b58..de6da24496f041d31560913d804b79f9ad9652e6 100644 (file)
  * ***** END GPL/BL DUAL LICENSE BLOCK *****
 */
 
-#include "BKE_utildefines.h"
-#include "PIL_time.h"
-
-#include "Sys.h"
+#include <BKE_utildefines.h>
+#include <BLI_blenlib.h>
+#include <PIL_time.h>
+#include <Python.h>
+#include "gen_utils.h"
+#include "modules.h"
+
+/*****************************************************************************/
+/* Python API function prototypes for the sys module.                        */
+/*****************************************************************************/
+static PyObject *M_sys_basename (PyObject *self, PyObject *args);
+static PyObject *M_sys_dirname (PyObject *self, PyObject *args);
+static PyObject *M_sys_join (PyObject *self, PyObject *args);
+static PyObject *M_sys_splitext (PyObject *self, PyObject *args);
+static PyObject *M_sys_makename (PyObject *self, PyObject *args, PyObject *kw);
+static PyObject *M_sys_exists (PyObject *self, PyObject *args);
+static PyObject *M_sys_time (PyObject *self);
+
+/*****************************************************************************/
+/* The following string definitions are used for documentation strings.      */
+/* In Python these will be written to the console when doing a               */
+/* Blender.sys.__doc__                                                       */
+/*****************************************************************************/
+static char M_sys_doc[] =
+"The Blender.sys submodule\n\
+\n\
+This is a minimal system module to supply simple functionality available\n\
+in the default Python module os.";
+
+static char M_sys_basename_doc[] =
+"(path) - Split 'path' in dir and filename.\n\
+Return the filename.";
+
+static char M_sys_dirname_doc[] =
+"(path) - Split 'path' in dir and filename.\n\
+Return the dir.";
+
+static char M_sys_join_doc[] =
+"(dir, file) - Join dir and file to form a full filename.\n\
+Return the filename.";
+
+static char M_sys_splitext_doc[] =
+"(path) - Split 'path' in root and extension:\n\
+/this/that/file.ext -> ('/this/that/file','.ext').\n\
+Return the pair (root, extension).";
+
+static char M_sys_makename_doc[] =
+"(path = Blender.Get('filename'), ext = \"\", strip = 0) -\n\
+Strip dir and extension from path, leaving only a name, then append 'ext'\n\
+to it (if given) and return the resulting string.\n\n\
+(path) - string: a pathname -- Blender.Get('filename') if 'path' isn't given;\n\
+(ext = \"\") - string: the extension to append.\n\
+(strip = 0) - int: strip dirname from 'path' if given and non-zero.\n\
+Ex: makename('/path/to/file/myfile.foo','-01.abc') returns 'myfile-01.abc'\n\
+Ex: makename(ext='.txt') returns 'untitled.txt' if Blender.Get('filename')\n\
+returns a path to the file 'untitled.blend'";
+
+static char M_sys_time_doc[] =
+"() - Return a float representing time elapsed in seconds.\n\
+Each successive call is garanteed to return values greater than or\n\
+equal to the previous call.";
+
+static char M_sys_exists_doc[] =
+"(path) - Return 1 if given pathname (file or dir) exists, 0 otherwise.";
+
+/*****************************************************************************/
+/* Python method structure definition for Blender.sys module:                */
+/*****************************************************************************/
+struct PyMethodDef M_sys_methods[] = {
+  {"basename",    M_sys_basename,        METH_VARARGS, M_sys_basename_doc},
+  {"dirname",     M_sys_dirname,         METH_VARARGS, M_sys_dirname_doc},
+  {"join",        M_sys_join,            METH_VARARGS, M_sys_join_doc},
+  {"splitext",    M_sys_splitext,        METH_VARARGS, M_sys_splitext_doc},
+  {"makename", (PyCFunction)M_sys_makename, METH_VARARGS|METH_KEYWORDS,
+               M_sys_makename_doc},
+  {"exists",      M_sys_exists,          METH_VARARGS, M_sys_exists_doc},
+  {"time", (PyCFunction)M_sys_time,      METH_NOARGS,  M_sys_time_doc},
+  {NULL, NULL, 0, NULL}
+};
+
+/* Module Functions */
 
 static PyObject *g_sysmodule = NULL; /* pointer to Blender.sys module */
 
@@ -87,8 +164,7 @@ static PyObject *M_sys_basename (PyObject *self, PyObject *args)
                if (n > FILE_MAXFILE)
                        return EXPP_ReturnPyObjError(PyExc_RuntimeError, "path too long");
 
-               strncpy(basename, p+1, n); /* + 1 to skip the sep */
-               basename[n] = 0;
+               BLI_strncpy(basename, p + 1, n + 1);
                return Py_BuildValue("s", basename);
        }
 
@@ -119,12 +195,45 @@ static PyObject *M_sys_dirname (PyObject *self, PyObject *args)
                if (n > FILE_MAXDIR)
                        return EXPP_ReturnPyObjError (PyExc_RuntimeError, "path too long");
 
-               strncpy(dirname, name, n);
-               dirname[n] = 0;
+               BLI_strncpy(dirname, name, n + 1);
                return Py_BuildValue("s", dirname);
        }
 
-       return Py_BuildValue("s", "."); /* XXX need to fix this? (is crossplatform?)*/
+       return Py_BuildValue("s", ".");
+}
+
+static PyObject *M_sys_join (PyObject *self, PyObject *args)
+{
+       PyObject *c = NULL;
+       char *name = NULL, *path = NULL;
+       char filename[FILE_MAXDIR+FILE_MAXFILE];
+       char sep;
+       int pathlen = 0, namelen = 0;
+
+       if (!PyArg_ParseTuple(args, "ss", &path, &name))
+               return EXPP_ReturnPyObjError (PyExc_TypeError,
+                                                       "expected string argument");
+
+       pathlen = strlen(path) + 1;
+       namelen = strlen(name) + 1; /* + 1 to account for '\0' for BLI_strncpy */
+
+       if (pathlen + namelen > FILE_MAXDIR+FILE_MAXFILE - 1)
+               return EXPP_ReturnPyObjError (PyExc_RuntimeError, "filename is too long.");
+
+       c = PyObject_GetAttrString (g_sysmodule, "dirsep");
+       sep = PyString_AsString(c)[0];
+       Py_DECREF(c);
+       
+       BLI_strncpy(filename, path, pathlen);
+
+       if (filename[pathlen - 2] != sep) {
+               filename[pathlen - 1] = sep;
+               pathlen += 1;
+       }
+
+       BLI_strncpy(filename + pathlen - 1, name, namelen);
+
+       return Py_BuildValue("s", filename);
 }
 
 static PyObject *M_sys_splitext (PyObject *self, PyObject *args)
@@ -162,17 +271,82 @@ static PyObject *M_sys_splitext (PyObject *self, PyObject *args)
        if (n > FILE_MAXFILE || (len - n ) > FILE_MAXFILE)
                EXPP_ReturnPyObjError(PyExc_RuntimeError, "path too long");
 
-       strncpy(ext, dot, n);
-       ext[n] = 0;
-       strncpy(path, name, dot - name);
-       path[dot - name] = 0;
+       BLI_strncpy(ext, dot, n + 1);
+       BLI_strncpy(path, name, dot - name + 1);
 
        return Py_BuildValue("ss", path, ext);
 }
 
+static PyObject *M_sys_makename(PyObject *self, PyObject *args, PyObject *kw)
+{
+       char *path = G.sce, *ext = NULL;
+       int strip = 0;
+       static char *kwlist[] = {"path", "ext", "strip", NULL};
+       char *dot = NULL, *p = NULL, basename[FILE_MAXFILE];
+       char sep;
+       int n, len, lenext = 0;
+       PyObject *c;
+
+       if (!PyArg_ParseTupleAndKeywords(args, kw, "|ssi", kwlist,
+                       &path, &ext, &strip))
+               return EXPP_ReturnPyObjError (PyExc_TypeError,
+                       "expected one or two strings and an int (or nothing) as arguments");
+
+       len = strlen(path) + 1; /* + 1 to consider ending '\0' */
+       if (ext) lenext = strlen(ext) + 1;
+
+       if ((len + lenext) > FILE_MAXFILE)
+               return EXPP_ReturnPyObjError(PyExc_RuntimeError, "path too long");
+
+       c = PyObject_GetAttrString (g_sysmodule, "dirsep");
+       sep = PyString_AsString(c)[0];
+       Py_DECREF(c);
+
+       p = strrchr(path, sep);
+
+       if (p && strip) {
+               n = path + len - p;
+               BLI_strncpy(basename, p + 1, n); /* + 1 to skip the sep */
+       }
+       else
+               BLI_strncpy(basename, path, len);
+
+       dot = strrchr(basename, '.');
+
+       /* now the extension: always remove the one in basename */
+       if (dot || ext) {
+               if (!ext)
+                       basename[dot - basename] = '\0';
+               else { /* if user gave an ext, append it */
+
+                       if (dot) n = dot - basename;
+                       else n = strlen(basename);
+
+                       BLI_strncpy(basename + n, ext, lenext);
+               }
+       }
+
+       return PyString_FromString(basename);
+}
+
 static PyObject *M_sys_time (PyObject *self)
 {
        double t = PIL_check_seconds_timer();
        return Py_BuildValue("d", t);
 }
 
+static PyObject *M_sys_exists (PyObject *self, PyObject *args)
+{
+       char *fname = NULL;
+       int i = 0;
+
+       if (!PyArg_ParseTuple(args, "s", &fname))
+               return EXPP_ReturnPyObjError (PyExc_TypeError,
+                                                       "expected string (file path) argument");
+
+       i = BLI_exists(fname);
+
+       if (i) return Py_BuildValue("i", 1); /* path was found */
+
+       return Py_BuildValue("i", 0); /* path doesn't exist */
+}