source/blender/python/intern/bpy.c

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * Contributor(s): Campbell Barton
  19  *
  20  * ***** END GPL LICENSE BLOCK *****
  21  */
  22
  23 /** \file blender/python/intern/bpy.c
  24  *  \ingroup pythonintern
  25  *
  26  * This file defines the '_bpy' module which is used by python's 'bpy' package
  27  * to access C defined builtin functions.
  28  * A script writer should never directly access this module.
  29  */
  30
  31 #include <Python.h>
  32
  33 #include "BLI_utildefines.h"
  34 #include "BLI_path_util.h"
  35 #include "BLI_string.h"
  36
  37 #include "BKE_main.h"
  38 #include "BKE_global.h" /* XXX, G.main only */
  39 #include "BKE_blender.h"
  40 #include "BKE_bpath.h"
  41
  42 #include "RNA_types.h"
  43 #include "RNA_access.h"
  44
  45 #include "bpy.h"
  46 #include "bpy_util.h"
  47 #include "bpy_rna.h"
  48 #include "bpy_app.h"
  49 #include "bpy_props.h"
  50 #include "bpy_library.h"
  51 #include "bpy_operator.h"
  52
  53 #include "MEM_guardedalloc.h"
  54
  55 /* external util modules */
  56 #include "../generic/idprop_py_api.h"
  57 #include "../generic/bgl.h"
  58 #include "../generic/blf_py_api.h"
  59 #include "../mathutils/mathutils.h"
  60
  61 #ifdef WITH_FREESTYLE
  62 #  include "BPy_Freestyle.h"
  63 #endif
  64
  65 PyObject *bpy_package_py = NULL;
  66
  67 PyDoc_STRVAR(bpy_script_paths_doc,
  68 ".. function:: script_paths()\n"
  69 "\n"
  70 "   Return 2 paths to blender scripts directories.\n"
  71 "\n"
  72 "   :return: (system, user) strings will be empty when not found.\n"
  73 "   :rtype: tuple of strings\n"
  74 );
  75 static PyObject *bpy_script_paths(PyObject *UNUSED(self))
  76 {
  77         PyObject *ret = PyTuple_New(2);
  78         PyObject *item;
  79         const char *path;
  80
  81         path = BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, NULL);
  82         item = PyUnicode_DecodeFSDefault(path ? path : "");
  83         BLI_assert(item != NULL);
  84         PyTuple_SET_ITEM(ret, 0, item);
  85         path = BLI_get_folder(BLENDER_USER_SCRIPTS, NULL);
  86         item = PyUnicode_DecodeFSDefault(path ? path : "");
  87         BLI_assert(item != NULL);
  88         PyTuple_SET_ITEM(ret, 1, item);
  89
  90         return ret;
  91 }
  92
  93 static bool bpy_blend_paths_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src)
  94 {
  95         PyObject *list = (PyObject *)userdata;
  96         PyObject *item = PyUnicode_DecodeFSDefault(path_src);
  97         PyList_Append(list, item);
  98         Py_DECREF(item);
  99         return false; /* never edits the path */
 100 }
 101
 102 PyDoc_STRVAR(bpy_blend_paths_doc,
 103 ".. function:: blend_paths(absolute=False, packed=False, local=False)\n"
 104 "\n"
 105 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
 106 "\n"
 107 "   :arg absolute: When true the paths returned are made absolute.\n"
 108 "   :type absolute: boolean\n"
 109 "   :arg packed: When true skip file paths for packed data.\n"
 110 "   :type packed: boolean\n"
 111 "   :arg local: When true skip linked library paths.\n"
 112 "   :type local: boolean\n"
 113 "   :return: path list.\n"
 114 "   :rtype: list of strings\n"
 115 );
 116 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 117 {
 118         int flag = 0;
 119         PyObject *list;
 120
 121         int absolute = false;
 122         int packed   = false;
 123         int local    = false;
 124         static const char *kwlist[] = {"absolute", "packed", "local", NULL};
 125
 126         if (!PyArg_ParseTupleAndKeywords(args, kw, "|iii:blend_paths",
 127                                          (char **)kwlist, &absolute, &packed, &local))
 128         {
 129                 return NULL;
 130         }
 131
 132         if (absolute) flag |= BKE_BPATH_TRAVERSE_ABS;
 133         if (!packed)  flag |= BKE_BPATH_TRAVERSE_SKIP_PACKED;
 134         if (local)    flag |= BKE_BPATH_TRAVERSE_SKIP_LIBRARY;
 135
 136         list = PyList_New(0);
 137
 138         BKE_bpath_traverse_main(G.main, bpy_blend_paths_visit_cb, flag, (void *)list);
 139
 140         return list;
 141 }
 142
 143
 144 // PyDoc_STRVAR(bpy_user_resource_doc[] = // now in bpy/utils.py
 145 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 146 {
 147         const char *type;
 148         const char *subdir = NULL;
 149         int folder_id;
 150         static const char *kwlist[] = {"type", "subdir", NULL};
 151
 152         const char *path;
 153
 154         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", (char **)kwlist, &type, &subdir))
 155                 return NULL;
 156
 157         /* stupid string compare */
 158         if      (STREQ(type, "DATAFILES")) folder_id = BLENDER_USER_DATAFILES;
 159         else if (STREQ(type, "CONFIG"))    folder_id = BLENDER_USER_CONFIG;
 160         else if (STREQ(type, "SCRIPTS"))   folder_id = BLENDER_USER_SCRIPTS;
 161         else if (STREQ(type, "AUTOSAVE"))  folder_id = BLENDER_USER_AUTOSAVE;
 162         else {
 163                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
 164                 return NULL;
 165         }
 166
 167         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
 168         path = BLI_get_folder(folder_id, subdir);
 169
 170         if (!path)
 171                 path = BLI_get_user_folder_notest(folder_id, subdir);
 172
 173         return PyUnicode_DecodeFSDefault(path ? path : "");
 174 }
 175
 176 PyDoc_STRVAR(bpy_resource_path_doc,
 177 ".. function:: resource_path(type, major=bpy.app.version[0], minor=bpy.app.version[1])\n"
 178 "\n"
 179 "   Return the base path for storing system files.\n"
 180 "\n"
 181 "   :arg type: string in ['USER', 'LOCAL', 'SYSTEM'].\n"
 182 "   :type type: string\n"
 183 "   :arg major: major version, defaults to current.\n"
 184 "   :type major: int\n"
 185 "   :arg minor: minor version, defaults to current.\n"
 186 "   :type minor: string\n"
 187 "   :return: the resource path (not necessarily existing).\n"
 188 "   :rtype: string\n"
 189 );
 190 static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
 191 {
 192         const char *type;
 193         int major = BLENDER_VERSION / 100, minor = BLENDER_VERSION % 100;
 194         static const char *kwlist[] = {"type", "major", "minor", NULL};
 195         int folder_id;
 196         const char *path;
 197
 198         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ii:resource_path", (char **)kwlist, &type, &major, &minor))
 199                 return NULL;
 200
 201         /* stupid string compare */
 202         if      (STREQ(type, "USER"))    folder_id = BLENDER_RESOURCE_PATH_USER;
 203         else if (STREQ(type, "LOCAL"))   folder_id = BLENDER_RESOURCE_PATH_LOCAL;
 204         else if (STREQ(type, "SYSTEM"))  folder_id = BLENDER_RESOURCE_PATH_SYSTEM;
 205         else {
 206                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
 207                 return NULL;
 208         }
 209
 210         path = BLI_get_folder_version(folder_id, (major * 100) + minor, false);
 211
 212         return PyUnicode_DecodeFSDefault(path ? path : "");
 213 }
 214
 215 PyDoc_STRVAR(bpy_escape_identifier_doc,
 216 ".. function:: escape_identifier(string)\n"
 217 "\n"
 218 "   Simple string escaping function used for animation paths.\n"
 219 "\n"
 220 "   :arg string: text\n"
 221 "   :type string: string\n"
 222 "   :return: The escaped string.\n"
 223 "   :rtype: string\n"
 224 );
 225 static PyObject *bpy_escape_identifier(PyObject *UNUSED(self), PyObject *value)
 226 {
 227         const char *value_str;
 228         Py_ssize_t  value_str_len;
 229
 230         char       *value_escape_str;
 231         Py_ssize_t  value_escape_str_len;
 232         PyObject   *value_escape;
 233         size_t size;
 234
 235         value_str = _PyUnicode_AsStringAndSize(value, &value_str_len);
 236
 237         if (value_str == NULL) {
 238                 PyErr_SetString(PyExc_TypeError, "expected a string");
 239                 return NULL;
 240         }
 241
 242         size = (value_str_len * 2) + 1;
 243         value_escape_str = PyMem_MALLOC(size);
 244         value_escape_str_len = BLI_strescape(value_escape_str, value_str, size);
 245
 246         if (value_escape_str_len == value_str_len) {
 247                 Py_INCREF(value);
 248                 value_escape = value;
 249         }
 250         else {
 251                 value_escape = PyUnicode_FromStringAndSize(value_escape_str, value_escape_str_len);
 252         }
 253
 254         PyMem_FREE(value_escape_str);
 255
 256         return value_escape;
 257 }
 258
 259 static PyMethodDef meth_bpy_script_paths =
 260         {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
 261 static PyMethodDef meth_bpy_blend_paths =
 262         {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS | METH_KEYWORDS, bpy_blend_paths_doc};
 263 static PyMethodDef meth_bpy_user_resource =
 264         {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS | METH_KEYWORDS, NULL};
 265 static PyMethodDef meth_bpy_resource_path =
 266         {"resource_path", (PyCFunction)bpy_resource_path, METH_VARARGS | METH_KEYWORDS, bpy_resource_path_doc};
 267 static PyMethodDef meth_bpy_escape_identifier =
 268         {"escape_identifier", (PyCFunction)bpy_escape_identifier, METH_O, bpy_escape_identifier_doc};
 269
 270 static PyObject *bpy_import_test(const char *modname)
 271 {
 272         PyObject *mod = PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
 273         if (mod) {
 274                 Py_DECREF(mod);
 275         }
 276         else {
 277                 PyErr_Print();
 278                 PyErr_Clear();
 279         }
 280
 281         return mod;
 282 }
 283
 284
 285 /******************************************************************************
 286  * Description: Creates the bpy module and adds it to sys.modules for importing
 287  ******************************************************************************/
 288 void BPy_init_modules(void)
 289 {
 290         extern BPy_StructRNA *bpy_context_module;
 291         PointerRNA ctx_ptr;
 292         PyObject *mod;
 293
 294         /* Needs to be first since this dir is needed for future modules */
 295         const char * const modpath = BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, "modules");
 296         if (modpath) {
 297                 // printf("bpy: found module path '%s'.\n", modpath);
 298                 PyObject *sys_path = PySys_GetObject("path"); /* borrow */
 299                 PyObject *py_modpath = PyUnicode_FromString(modpath);
 300                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
 301                 Py_DECREF(py_modpath);
 302         }
 303         else {
 304                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
 305         }
 306         /* stand alone utility modules not related to blender directly */
 307         IDProp_Init_Types(); /* not actually a submodule, just types */
 308 #ifdef WITH_FREESTYLE
 309         Freestyle_Init();
 310 #endif
 311
 312         mod = PyModule_New("_bpy");
 313
 314         /* add the module so we can import it */
 315         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
 316         Py_DECREF(mod);
 317
 318         /* run first, initializes rna types */
 319         BPY_rna_init();
 320
 321         /* needs to be first so bpy_types can run */
 322         PyModule_AddObject(mod, "types", BPY_rna_types());
 323
 324         /* metaclass for idprop types, bpy_types.py needs access */
 325         PyModule_AddObject(mod, "StructMetaPropGroup", (PyObject *)&pyrna_struct_meta_idprop_Type);
 326
 327         /* needs to be first so bpy_types can run */
 328         BPY_library_module(mod);
 329
 330         bpy_import_test("bpy_types");
 331         PyModule_AddObject(mod, "data", BPY_rna_module()); /* imports bpy_types by running this */
 332         bpy_import_test("bpy_types");
 333         PyModule_AddObject(mod, "props", BPY_rna_props());
 334         /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
 335         PyModule_AddObject(mod, "ops", BPY_operator_module());
 336         PyModule_AddObject(mod, "app", BPY_app_struct());
 337
 338         /* bpy context */
 339         RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
 340         bpy_context_module = (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
 341         /* odd that this is needed, 1 ref on creation and another for the module
 342          * but without we get a crash on exit */
 343         Py_INCREF(bpy_context_module);
 344
 345         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
 346
 347         /* register bpy/rna classmethod callbacks */
 348         BPY_rna_register_cb();
 349
 350         /* utility func's that have nowhere else to go */
 351         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
 352         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
 353         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
 354         PyModule_AddObject(mod, meth_bpy_resource_path.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL));
 355         PyModule_AddObject(mod, meth_bpy_escape_identifier.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_escape_identifier, NULL));
 356
 357         /* register funcs (bpy_rna.c) */
 358         PyModule_AddObject(mod, meth_bpy_register_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
 359         PyModule_AddObject(mod, meth_bpy_unregister_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
 360
 361         /* add our own modules dir, this is a python package */
 362         bpy_package_py = bpy_import_test("bpy");
 363 }