bpy_interface.c

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Michel Selten, Willian P. Germano, Stephen Swaney,
 * Chris Keith, Chris Want, Ken Hughes, Campbell Barton
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/* grr, python redefines */
#ifdef _POSIX_C_SOURCE
#  undef _POSIX_C_SOURCE
#endif

#include <Python.h>

#include "MEM_guardedalloc.h"

#include "RNA_types.h"

#include "bpy.h"
#include "gpu.h"
#include "bpy_rna.h"
#include "bpy_util.h"
#include "bpy_traceback.h"
#include "bpy_intern_string.h"

#include "DNA_space_types.h"
#include "DNA_text_types.h"

#include "BLI_path_util.h"
#include "BLI_math_base.h"
#include "BLI_string.h"
#include "BLI_string_utf8.h"
#include "BLI_utildefines.h"

#include "BKE_context.h"
#include "BKE_text.h"
#include "BKE_main.h"
#include "BKE_global.h" /* only for script checking */

#include "CCL_api.h"

#include "BPY_extern.h"

#include "../generic/bpy_internal_import.h" // our own imports
#include "../generic/py_capi_utils.h"

/* inittab initialization functions */
#include "../generic/bgl.h"
#include "../generic/blf_py_api.h"
#include "../mathutils/mathutils.h"

/* for internal use, when starting and ending python scripts */

/* incase a python script triggers another python call, stop bpy_context_clear from invalidating */
static int py_call_level = 0;
BPy_StructRNA *bpy_context_module = NULL; /* for fast access */

// #define TIME_PY_RUN // simple python tests. prints on exit.

#ifdef TIME_PY_RUN
#include "PIL_time.h"
static int      bpy_timer_count = 0;
static double   bpy_timer; /* time since python starts */
static double   bpy_timer_run; /* time for each python script run */
static double   bpy_timer_run_tot; /* accumulate python runs */
#endif

/* use for updating while a python script runs - in case of file load */
void bpy_context_update(bContext *C)
{
    BPy_SetContext(C);
    bpy_import_main_set(CTX_data_main(C));
    BPY_modules_update(C); /* can give really bad results if this isnt here */
}

void bpy_context_set(bContext *C, PyGILState_STATE *gilstate)
{
    py_call_level++;

    if (gilstate)
        *gilstate = PyGILState_Ensure();

    if (py_call_level == 1) {
        bpy_context_update(C);

#ifdef TIME_PY_RUN
        if (bpy_timer_count == 0) {
            /* record time from the beginning */
            bpy_timer = PIL_check_seconds_timer();
            bpy_timer_run = bpy_timer_run_tot = 0.0;
        }
        bpy_timer_run = PIL_check_seconds_timer();


        bpy_timer_count++;
#endif
    }
}

/* context should be used but not now because it causes some bugs */
void bpy_context_clear(bContext *UNUSED(C), PyGILState_STATE *gilstate)
{
    py_call_level--;

    if (gilstate)
        PyGILState_Release(*gilstate);

    if (py_call_level < 0) {
        fprintf(stderr, "ERROR: Python context internal state bug. this should not happen!\n");
    }
    else if (py_call_level == 0) {
        /* XXX - Calling classes currently wont store the context :\,
         * cant set NULL because of this. but this is very flakey still. */
#if 0
        BPy_SetContext(NULL);
        bpy_import_main_set(NULL);
#endif

#ifdef TIME_PY_RUN
        bpy_timer_run_tot += PIL_check_seconds_timer() - bpy_timer_run;
        bpy_timer_count++;
#endif

    }
}

void BPY_text_free_code(Text *text)
{
    if (text->compiled) {
        Py_DECREF((PyObject *)text->compiled);
        text->compiled = NULL;
    }
}

void BPY_modules_update(bContext *C)
{
#if 0 // slow, this runs all the time poll, draw etc 100's of time a sec.
    PyObject *mod = PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
    PyModule_AddObject(mod, "data", BPY_rna_module());
    PyModule_AddObject(mod, "types", BPY_rna_types()); // atm this does not need updating
#endif

    /* refreshes the main struct */
    BPY_update_rna_module();
    bpy_context_module->ptr.data = (void *)C;
}

void BPY_context_set(bContext *C)
{
    BPy_SetContext(C);
}

/* defined in AUD_C-API.cpp */
extern PyObject *AUD_initPython(void);

#ifdef WITH_CYCLES
/* defined in cycles module */
static PyObject *CCL_initPython(void)
{
    return (PyObject*)CCL_python_module_init();
}
#endif

static struct _inittab bpy_internal_modules[] = {
    {(char *)"mathutils", PyInit_mathutils},
//  {(char *)"mathutils.geometry", PyInit_mathutils_geometry},
//  {(char *)"mathutils.noise", PyInit_mathutils_noise},
    {(char *)"bgl", BPyInit_bgl},
    {(char *)"blf", BPyInit_blf},
#ifdef WITH_AUDASPACE
    {(char *)"aud", AUD_initPython},
#endif
#ifdef WITH_CYCLES
    {(char *)"_cycles", CCL_initPython},
#endif
    {(char *)"gpu", GPU_initPython},
    {NULL, NULL}
};

/* call BPY_context_set first */
void BPY_python_start(int argc, const char **argv)
{
#ifndef WITH_PYTHON_MODULE
    PyThreadState *py_tstate = NULL;

    /* not essential but nice to set our name */
    static wchar_t program_path_wchar[FILE_MAX]; /* python holds a reference */
    BLI_strncpy_wchar_from_utf8(program_path_wchar, BLI_program_path(), sizeof(program_path_wchar) / sizeof(wchar_t));
    Py_SetProgramName(program_path_wchar);

    /* must run before python initializes */
    PyImport_ExtendInittab(bpy_internal_modules);

    /* allow to use our own included python */
    PyC_SetHomePath(BLI_get_folder(BLENDER_SYSTEM_PYTHON, NULL));

    /* without this the sys.stdout may be set to 'ascii'
     * (it is on my system at least), where printing unicode values will raise
     * an error, this is highly annoying, another stumbling block for devs,
     * so use a more relaxed error handler and enforce utf-8 since the rest of
     * blender is utf-8 too - campbell */
    BLI_setenv("PYTHONIOENCODING", "utf-8:surrogateescape");

    /* Python 3.2 now looks for '2.xx/python/include/python3.2d/pyconfig.h' to
     * parse from the 'sysconfig' module which is used by 'site',
     * so for now disable site. alternatively we could copy the file. */
    Py_NoSiteFlag = 1;

    Py_Initialize();

    // PySys_SetArgv(argc, argv); // broken in py3, not a huge deal
    /* sigh, why do python guys not have a char** version anymore? :( */
    {
        int i;
        PyObject *py_argv = PyList_New(argc);
        for (i = 0; i < argc; i++) {
            /* should fix bug #20021 - utf path name problems, by replacing
             * PyUnicode_FromString, with this one */
            PyList_SET_ITEM(py_argv, i, PyC_UnicodeFromByte(argv[i]));
        }

        PySys_SetObject("argv", py_argv);
        Py_DECREF(py_argv);
    }
    
    /* Initialize thread support (also acquires lock) */
    PyEval_InitThreads();
#else
    (void)argc;
    (void)argv;

    /* must run before python initializes */
    PyImport_ExtendInittab(bpy_internal_modules);
#endif

    bpy_intern_string_init();

    /* bpy.* and lets us import it */
    BPy_init_modules();

    bpy_import_init(PyEval_GetBuiltins());
    
    pyrna_alloc_types();

    BPY_atexit_register(); /* this can init any time */

#ifndef WITH_PYTHON_MODULE
    py_tstate = PyGILState_GetThisThreadState();
    PyEval_ReleaseThread(py_tstate);
#endif
}

void BPY_python_end(void)
{
    // fprintf(stderr, "Ending Python!\n");

    PyGILState_Ensure(); /* finalizing, no need to grab the state */
    
    // free other python data.
    pyrna_free_types();

    /* clear all python data from structs */

    bpy_intern_string_exit();

    BPY_atexit_unregister(); /* without this we get recursive calls to WM_exit */

    Py_Finalize();
    
#ifdef TIME_PY_RUN
    // measure time since py started
    bpy_timer = PIL_check_seconds_timer() - bpy_timer;

    printf("*bpy stats* - ");
    printf("tot exec: %d,  ", bpy_timer_count);
    printf("tot run: %.4fsec,  ", bpy_timer_run_tot);
    if (bpy_timer_count > 0)
        printf("average run: %.6fsec,  ", (bpy_timer_run_tot/bpy_timer_count));

    if (bpy_timer > 0.0)
        printf("tot usage %.4f%%", (bpy_timer_run_tot/bpy_timer) * 100.0);

    printf("\n");

    // fprintf(stderr, "Ending Python Done!\n");

#endif

}

static void python_script_error_jump_text(struct Text *text)
{
    int lineno;
    int offset;
    python_script_error_jump(text->id.name + 2, &lineno, &offset);
    if (lineno != -1) {
        /* select the line with the error */
        txt_move_to(text, lineno - 1, INT_MAX, FALSE);
        txt_move_to(text, lineno - 1, offset, TRUE);
    }
}

/* super annoying, undo _PyModule_Clear(), bug [#23871] */
#define PYMODULE_CLEAR_WORKAROUND

#ifdef PYMODULE_CLEAR_WORKAROUND
/* bad!, we should never do this, but currently only safe way I could find to keep namespace.
 * from being cleared. - campbell */
typedef struct {
    PyObject_HEAD
    PyObject *md_dict;
    /* ommit other values, we only want the dict. */
} PyModuleObject;
#endif

static int python_script_exec(bContext *C, const char *fn, struct Text *text,
                              struct ReportList *reports, const short do_jump)
{
    PyObject *main_mod = NULL;
    PyObject *py_dict = NULL, *py_result = NULL;
    PyGILState_STATE gilstate;

    BLI_assert(fn || text);

    if (fn == NULL && text == NULL) {
        return 0;
    }

    bpy_context_set(C, &gilstate);

    PyC_MainModule_Backup(&main_mod);

    if (text) {
        char fn_dummy[FILE_MAXDIR];
        bpy_text_filename_get(fn_dummy, sizeof(fn_dummy), text);

        if (text->compiled == NULL) {   /* if it wasn't already compiled, do it now */
            char *buf = txt_to_buf(text);

            text->compiled = Py_CompileString(buf, fn_dummy, Py_file_input);

            MEM_freeN(buf);

            if (PyErr_Occurred()) {
                if (do_jump) {
                    python_script_error_jump_text(text);
                }
                BPY_text_free_code(text);
            }
        }

        if (text->compiled) {
            py_dict = PyC_DefaultNameSpace(fn_dummy);
            py_result =  PyEval_EvalCode(text->compiled, py_dict, py_dict);
        }

    }
    else {
        FILE *fp = fopen(fn, "r");

        if (fp) {
            py_dict = PyC_DefaultNameSpace(fn);

#ifdef _WIN32
            /* Previously we used PyRun_File to run directly the code on a FILE
             * object, but as written in the Python/C API Ref Manual, chapter 2,
             * 'FILE structs for different C libraries can be different and
             * incompatible'.
             * So now we load the script file data to a buffer */
            {
                char *pystring;

                fclose(fp);

                pystring = MEM_mallocN(strlen(fn) + 32, "pystring");
                pystring[0] = '\0';
                sprintf(pystring, "exec(open(r'%s').read())", fn);
                py_result = PyRun_String(pystring, Py_file_input, py_dict, py_dict);
                MEM_freeN(pystring);
            }
#else
            py_result = PyRun_File(fp, fn, Py_file_input, py_dict, py_dict);
            fclose(fp);
#endif
        }
        else {
            PyErr_Format(PyExc_IOError,
                         "Python file \"%s\" could not be opened: %s",
                         fn, strerror(errno));
            py_result = NULL;
        }
    }

    if (!py_result) {
        if (text) {
            if (do_jump) {
                python_script_error_jump_text(text);
            }
        }
        BPy_errors_to_report(reports);
    }
    else {
        Py_DECREF(py_result);
    }

    if (py_dict) {
#ifdef PYMODULE_CLEAR_WORKAROUND
        PyModuleObject *mmod = (PyModuleObject *)PyDict_GetItemString(PyThreadState_GET()->interp->modules, "__main__");
        PyObject *dict_back = mmod->md_dict;
        /* freeing the module will clear the namespace,
         * gives problems running classes defined in this namespace being used later. */
        mmod->md_dict = NULL;
        Py_DECREF(dict_back);
#endif

#undef PYMODULE_CLEAR_WORKAROUND
    }

    PyC_MainModule_Restore(main_mod);

    bpy_context_clear(C, &gilstate);

    return (py_result != NULL);
}

/* Can run a file or text block */
int BPY_filepath_exec(bContext *C, const char *filepath, struct ReportList *reports)
{
    return python_script_exec(C, filepath, NULL, reports, FALSE);
}


int BPY_text_exec(bContext *C, struct Text *text, struct ReportList *reports, const short do_jump)
{
    return python_script_exec(C, NULL, text, reports, do_jump);
}

void BPY_DECREF(void *pyob_ptr)
{
    PyGILState_STATE gilstate = PyGILState_Ensure();
    Py_DECREF((PyObject *)pyob_ptr);
    PyGILState_Release(gilstate);
}

/* return -1 on error, else 0 */
int BPY_button_exec(bContext *C, const char *expr, double *value, const short verbose)
{
    PyGILState_STATE gilstate;
    PyObject *py_dict, *mod, *retval;
    int error_ret = 0;
    PyObject *main_mod = NULL;
    
    if (!value || !expr) return -1;

    if (expr[0] == '\0') {
        *value = 0.0;
        return error_ret;
    }

    bpy_context_set(C, &gilstate);

    PyC_MainModule_Backup(&main_mod);

    py_dict = PyC_DefaultNameSpace("<blender button>");

    mod = PyImport_ImportModule("math");
    if (mod) {
        PyDict_Merge(py_dict, PyModule_GetDict(mod), 0); /* 0 - dont overwrite existing values */
        Py_DECREF(mod);
    }
    else { /* highly unlikely but possibly */
        PyErr_Print();
        PyErr_Clear();
    }
    
    retval = PyRun_String(expr, Py_eval_input, py_dict, py_dict);
    
    if (retval == NULL) {
        error_ret = -1;
    }
    else {
        double val;

        if (PyTuple_Check(retval)) {
            /* Users my have typed in 10km, 2m
             * add up all values */
            int i;
            val = 0.0;

            for (i = 0; i < PyTuple_GET_SIZE(retval); i++) {
                val += PyFloat_AsDouble(PyTuple_GET_ITEM(retval, i));
            }
        }
        else {
            val = PyFloat_AsDouble(retval);
        }
        Py_DECREF(retval);
        
        if (val == -1 && PyErr_Occurred()) {
            error_ret = -1;
        }
        else if (!finite(val)) {
            *value = 0.0;
        }
        else {
            *value = val;
        }
    }
    
    if (error_ret) {
        if (verbose) {
            BPy_errors_to_report(CTX_wm_reports(C));
        }
        else {
            PyErr_Clear();
        }
    }

    PyC_MainModule_Backup(&main_mod);
    
    bpy_context_clear(C, &gilstate);
    
    return error_ret;
}

int BPY_string_exec(bContext *C, const char *expr)
{
    PyGILState_STATE gilstate;
    PyObject *main_mod = NULL;
    PyObject *py_dict, *retval;
    int error_ret = 0;
    Main *bmain_back; /* XXX, quick fix for release (Copy Settings crash), needs further investigation */

    if (!expr) return -1;

    if (expr[0] == '\0') {
        return error_ret;
    }

    bpy_context_set(C, &gilstate);

    PyC_MainModule_Backup(&main_mod);

    py_dict = PyC_DefaultNameSpace("<blender string>");

    bmain_back = bpy_import_main_get();
    bpy_import_main_set(CTX_data_main(C));

    retval = PyRun_String(expr, Py_eval_input, py_dict, py_dict);

    bpy_import_main_set(bmain_back);

    if (retval == NULL) {
        error_ret = -1;

        BPy_errors_to_report(CTX_wm_reports(C));
    }
    else {
        Py_DECREF(retval);
    }

    PyC_MainModule_Restore(main_mod);

    bpy_context_clear(C, &gilstate);
    
    return error_ret;
}


void BPY_modules_load_user(bContext *C)
{
    PyGILState_STATE gilstate;
    Main *bmain = CTX_data_main(C);
    Text *text;

    /* can happen on file load */
    if (bmain == NULL)
        return;

    /* update pointers since this can run from a nested script
     * on file load */
    if (py_call_level) {
        bpy_context_update(C);
    }

    bpy_context_set(C, &gilstate);

    for (text = CTX_data_main(C)->text.first; text; text = text->id.next) {
        if (text->flags & TXT_ISSCRIPT && BLI_testextensie(text->id.name + 2, ".py")) {
            if (!(G.f & G_SCRIPT_AUTOEXEC)) {
                printf("scripts disabled for \"%s\", skipping '%s'\n", bmain->name, text->id.name + 2);
            }
            else {
                PyObject *module = bpy_text_import(text);

                if (module == NULL) {
                    PyErr_Print();
                    PyErr_Clear();
                }
                else {
                    Py_DECREF(module);
                }
            }
        }
    }
    bpy_context_clear(C, &gilstate);
}

int BPY_context_member_get(bContext *C, const char *member, bContextDataResult *result)
{
    PyObject *pyctx = (PyObject *)CTX_py_dict_get(C);
    PyObject *item = PyDict_GetItemString(pyctx, member);
    PointerRNA *ptr = NULL;
    int done = 0;

    if (item == NULL) {
        /* pass */
    }
    else if (item == Py_None) {
        /* pass */
    }
    else if (BPy_StructRNA_Check(item)) {
        ptr = &(((BPy_StructRNA *)item)->ptr);

        //result->ptr = ((BPy_StructRNA *)item)->ptr;
        CTX_data_pointer_set(result, ptr->id.data, ptr->type, ptr->data);
        done = 1;
    }
    else if (PySequence_Check(item)) {
        PyObject *seq_fast = PySequence_Fast(item, "bpy_context_get sequence conversion");
        if (seq_fast == NULL) {
            PyErr_Print();
            PyErr_Clear();
        }
        else {
            int len = PySequence_Fast_GET_SIZE(seq_fast);
            int i;
            for (i = 0; i < len; i++) {
                PyObject *list_item = PySequence_Fast_GET_ITEM(seq_fast, i);

                if (BPy_StructRNA_Check(list_item)) {
                    /*
                    CollectionPointerLink *link = MEM_callocN(sizeof(CollectionPointerLink), "bpy_context_get");
                    link->ptr = ((BPy_StructRNA *)item)->ptr;
                    BLI_addtail(&result->list, link);
                    */
                    ptr = &(((BPy_StructRNA *)list_item)->ptr);
                    CTX_data_list_add(result, ptr->id.data, ptr->type, ptr->data);
                }
                else {
                    printf("List item not a valid type\n");
                }

            }
            Py_DECREF(seq_fast);

            done = 1;
        }
    }

    if (done == 0) {
        if (item)   printf("PyContext '%s' not a valid type\n", member);
        else        printf("PyContext '%s' not found\n", member);
    }
    else {
        if (G.f & G_DEBUG) {
            printf("PyContext '%s' found\n", member);
        }
    }

    return done;
}


#ifdef WITH_PYTHON_MODULE
#include "BLI_fileops.h"
/* TODO, reloading the module isnt functional at the moment. */

static void bpy_module_free(void *mod);
extern int main_python_enter(int argc, const char **argv);
extern void main_python_exit(void);
static struct PyModuleDef bpy_proxy_def = {
    PyModuleDef_HEAD_INIT,
    "bpy",  /* m_name */
    NULL,  /* m_doc */
    0,  /* m_size */
    NULL,  /* m_methods */
    NULL,  /* m_reload */
    NULL,  /* m_traverse */
    NULL,  /* m_clear */
    bpy_module_free,  /* m_free */
};

typedef struct {
    PyObject_HEAD
    /* Type-specific fields go here. */
    PyObject *mod;
} dealloc_obj;

/* call once __file__ is set */
void bpy_module_delay_init(PyObject *bpy_proxy)
{
    const int argc = 1;
    const char *argv[2];

    /* updating the module dict below will loose the reference to __file__ */
    PyObject *filename_obj = PyModule_GetFilenameObject(bpy_proxy);

    const char *filename_rel = _PyUnicode_AsString(filename_obj); /* can be relative */
    char filename_abs[1024];

    BLI_strncpy(filename_abs, filename_rel, sizeof(filename_abs));
    BLI_path_cwd(filename_abs);

    argv[0] = filename_abs;
    argv[1] = NULL;
    
    // printf("module found %s\n", argv[0]);

    main_python_enter(argc, argv);

    /* initialized in BPy_init_modules() */
    PyDict_Update(PyModule_GetDict(bpy_proxy), PyModule_GetDict(bpy_package_py));
}

static void dealloc_obj_dealloc(PyObject *self);

static PyTypeObject dealloc_obj_Type = {{{0}}};

/* use our own dealloc so we can free a property if we use one */
static void dealloc_obj_dealloc(PyObject *self)
{
    bpy_module_delay_init(((dealloc_obj *)self)->mod);

    /* Note, for subclassed PyObjects we cant just call PyObject_DEL() directly or it will crash */
    dealloc_obj_Type.tp_free(self);
}

PyMODINIT_FUNC
PyInit_bpy(void)
{
    PyObject *bpy_proxy = PyModule_Create(&bpy_proxy_def);
    
    /* Problem:
     * 1) this init function is expected to have a private member defined - 'md_def'
     *    but this is only set for C defined modules (not py packages)
     *    so we cant return 'bpy_package_py' as is.
     *
     * 2) there is a 'bpy' C module for python to load which is basically all of blender,
     *    and there is scripts/bpy/__init__.py, 
     *    we may end up having to rename this module so there is no naming conflict here eg:
     *    'from blender import bpy'
     *
     * 3) we dont know the filename at this point, workaround by assigning a dummy value
     *    which calls back when its freed so the real loading can take place.
     */

    /* assign an object which is freed after __file__ is assigned */
    dealloc_obj *dob;
    
    /* assign dummy type */
    dealloc_obj_Type.tp_name = "dealloc_obj";
    dealloc_obj_Type.tp_basicsize = sizeof(dealloc_obj);
    dealloc_obj_Type.tp_dealloc = dealloc_obj_dealloc;
    dealloc_obj_Type.tp_flags = Py_TPFLAGS_DEFAULT;
    
    if (PyType_Ready(&dealloc_obj_Type) < 0)
        return NULL;

    dob = (dealloc_obj *) dealloc_obj_Type.tp_alloc(&dealloc_obj_Type, 0);
    dob->mod = bpy_proxy; /* borrow */
    PyModule_AddObject(bpy_proxy, "__file__", (PyObject *)dob); /* borrow */

    return bpy_proxy;
}

static void bpy_module_free(void *UNUSED(mod))
{
    main_python_exit();
}

#endif