py operators - don't use the screen as an operators ID anymore, screen's don't store...
authorCampbell Barton <ideasman42@gmail.com>
Sat, 5 Nov 2011 08:40:07 +0000 (08:40 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Sat, 5 Nov 2011 08:40:07 +0000 (08:40 +0000)
also add some more py api file descriptions.

source/blender/editors/interface/interface.c
source/blender/makesrna/intern/rna_wm.c
source/blender/python/generic/bgl.c
source/blender/python/generic/bgl.h
source/blender/python/generic/blf_py_api.c
source/blender/python/generic/bpy_internal_import.c
source/blender/python/generic/noise_py_api.c
source/blender/python/generic/py_capi_utils.c
source/blender/python/intern/bpy_driver.c
source/blender/python/intern/bpy_library.c
source/blender/python/intern/bpy_util.c

index eff4d1f6397c6056942417602b803bf4ffe6741f..dd75f506be858f9509c22b2c7662fa8a576b5532 100644 (file)
@@ -766,7 +766,7 @@ static void ui_menu_block_set_keyaccels(uiBlock *block)
 {
        uiBut *but;
 
-       unsigned int meny_key_mask= 0;
+       unsigned int menu_key_mask= 0;
        unsigned char menu_key;
        const char *str_pt;
        int pass;
@@ -788,8 +788,8 @@ static void ui_menu_block_set_keyaccels(uiBlock *block)
                                if(but->str) {
                                        for(str_pt= but->str; *str_pt; ) {
                                                menu_key= tolower(*str_pt);
-                                               if((menu_key >= 'a' && menu_key <= 'z') && !(meny_key_mask & 1<<(menu_key-'a'))) {
-                                                       meny_key_mask |= 1<<(menu_key-'a');
+                                               if((menu_key >= 'a' && menu_key <= 'z') && !(menu_key_mask & 1<<(menu_key-'a'))) {
+                                                       menu_key_mask |= 1<<(menu_key-'a');
                                                        break;
                                                }
 
@@ -816,7 +816,7 @@ static void ui_menu_block_set_keyaccels(uiBlock *block)
                                        }
 
                                        /* if all keys have been used just exit, unlikely */
-                                       if(meny_key_mask == (1<<26)-1) {
+                                       if(menu_key_mask == (1<<26)-1) {
                                                return;
                                        }
                                }
index c7f7fe5feea6126cfac922ad8f4408cb20dcff38..dfbdafd7d18c90c19d40faa8e12013eea03be2ee 100644 (file)
@@ -821,7 +821,7 @@ static int operator_execute(bContext *C, wmOperator *op)
        void *ret;
        int result;
 
-       RNA_pointer_create(&CTX_wm_screen(C)->id, op->type->ext.srna, op, &opr);
+       RNA_pointer_create(NULL, op->type->ext.srna, op, &opr);
        func= &rna_Operator_execute_func; /* RNA_struct_find_function(&opr, "execute"); */
 
        RNA_parameter_list_create(&list, &opr, func);
@@ -847,7 +847,7 @@ static int operator_check(bContext *C, wmOperator *op)
        void *ret;
        int result;
 
-       RNA_pointer_create(&CTX_wm_screen(C)->id, op->type->ext.srna, op, &opr);
+       RNA_pointer_create(NULL, op->type->ext.srna, op, &opr);
        func= &rna_Operator_check_func; /* RNA_struct_find_function(&opr, "check"); */
 
        RNA_parameter_list_create(&list, &opr, func);
@@ -872,7 +872,7 @@ static int operator_invoke(bContext *C, wmOperator *op, wmEvent *event)
        void *ret;
        int result;
 
-       RNA_pointer_create(&CTX_wm_screen(C)->id, op->type->ext.srna, op, &opr);
+       RNA_pointer_create(NULL, op->type->ext.srna, op, &opr);
        func= &rna_Operator_invoke_func; /* RNA_struct_find_function(&opr, "invoke"); */
 
        RNA_parameter_list_create(&list, &opr, func);
@@ -899,7 +899,7 @@ static int operator_modal(bContext *C, wmOperator *op, wmEvent *event)
        void *ret;
        int result;
 
-       RNA_pointer_create(&CTX_wm_screen(C)->id, op->type->ext.srna, op, &opr);
+       RNA_pointer_create(NULL, op->type->ext.srna, op, &opr);
        func= &rna_Operator_modal_func; /* RNA_struct_find_function(&opr, "modal"); */
 
        RNA_parameter_list_create(&list, &opr, func);
@@ -923,7 +923,7 @@ static void operator_draw(bContext *C, wmOperator *op)
        ParameterList list;
        FunctionRNA *func;
 
-       RNA_pointer_create(&CTX_wm_screen(C)->id, op->type->ext.srna, op, &opr);
+       RNA_pointer_create(NULL, op->type->ext.srna, op, &opr);
        func= &rna_Operator_draw_func; /* RNA_struct_find_function(&opr, "draw"); */
 
        RNA_parameter_list_create(&list, &opr, func);
@@ -944,7 +944,7 @@ static int operator_cancel(bContext *C, wmOperator *op)
        void *ret;
        int result;
 
-       RNA_pointer_create(&CTX_wm_screen(C)->id, op->type->ext.srna, op, &opr);
+       RNA_pointer_create(NULL, op->type->ext.srna, op, &opr);
        func= &rna_Operator_cancel_func; /* RNA_struct_find_function(&opr, "cancel"); */
 
        RNA_parameter_list_create(&list, &opr, func);
index 441c4b6438af77fc1626fffeabf3883cb138fc85..03d66e918d5bedcb88518f4946638e2b86eb0c9a 100644 (file)
@@ -1,5 +1,4 @@
-/* 
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  *
  * This is a new part of Blender.
  *
- * Contributor(s): Willian P. Germano
+ * Contributor(s): Willian P. Germano, Campbell Barton
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
 /** \file blender/python/generic/bgl.c
  *  \ingroup pygen
+ *
+ * This file is the 'bgl' module which wraps OpenGL functions and constants,
+ * allowing script writers to make OpenGL calls in their Python scripts.
+ *
+ * \note
+ * This module is very similar to 'PyOpenGL' which could replace 'bgl' one day.
  */
 
-
-/* This file is the 'bgl' module.
- * The BGL submodule "wraps" OpenGL functions and constants,
- * allowing script writers to make OpenGL calls in their Python scripts. */
-
 #include <Python.h>
 
 #include "bgl.h" /*This must come first */
index 6df534a39407c3bb57348551594de6f130833a83..2e02900d69ff50da17f5ebab89c7e7ccfe858876 100644 (file)
@@ -1,5 +1,4 @@
-/* 
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
index a9cd16c70f0388c1d97bcc2fd38b44fa2730a8d5..a4373e46e230378620679765d2dfff87b63cf6c4 100644 (file)
 
 /** \file blender/python/generic/blf_py_api.c
  *  \ingroup pygen
+ *
+ * This file defines the 'bgl' module, used for drawing text in OpenGL.
  */
 
-
 #include <Python.h>
 #include "blf_py_api.h"
 
index acfe6ee80bfb6a9390a8db630c03dc1342d62c42..88e2da16eb5271cbfeb679a2c598f5e91d3517fd 100644 (file)
  *
  * This is a new part of Blender.
  *
- * Contributor(s): Willian P. Germano,
- *                 Campbell Barton
+ * Contributor(s): Willian P. Germano, Campbell Barton
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
 /** \file blender/python/generic/bpy_internal_import.c
  *  \ingroup pygen
+ *
+ * This file defines replacements for pythons '__import__' and 'imp.reload'
+ * functions which can import from blender textblocks.
+ *
+ * \note
+ * This should eventually be replaced by import hooks (pep 302).
  */
 
 
index 6afb1a00e2f3ff478f0fffbddc4f434f80ab6492..c12cc1ccdd2d64392b129a9462bec9714241bf3d 100644 (file)
@@ -1,8 +1,4 @@
 /*
- *
- * Blender.Noise BPython module implementation.
- * This submodule has functions to generate noise of various types.
- * 
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  *
  * This is a new part of Blender.
  *
- * Contributor(s): eeshlo
+ * Contributor(s): eeshlo, Campbell Barton
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
 /** \file blender/python/generic/noise_py_api.c
  *  \ingroup pygen
+ *
+ * This file defines the 'noise' module, a general purpose module to access
+ * blenders noise functions.
  */
 
 
index eb4ecf799419f53841c7dabd27ce88d20bdcb0c1..7fbd8baa558955720b020f9c809cb1a22c0dae6c 100644 (file)
 
 /** \file blender/python/generic/py_capi_utils.c
  *  \ingroup pygen
+ *
+ * Extend upon CPython's API, filling in some gaps, these functions use PyC_
+ * prefix to distinguish them apart from CPython.
+ *
+ * \note
+ * This module should only depend on CPython, however it currently uses
+ * BLI_string_utf8() for unicode conversion.
  */
 
 
index 98b4786607ff15df3b022e97a559db1d9cc9808b..12fb5ed43b4e95abab07e55f6927abd9ca34a253 100644 (file)
@@ -23,7 +23,7 @@
 /** \file blender/python/intern/bpy_driver.c
  *  \ingroup pythonintern
  *
- * This file defines the 'BPY_driver_exec' to execute python drivers,
+ * This file defines the 'BPY_driver_exec' to execute python driver expressions,
  * called by the animation system, there are also some utility functions
  * to deal with the namespace used for driver execution.
  */
index 54398f75a1d78e34894dcb1c1cb37ba0ca30de3e..b91948cc0b889b433d2e82f3cb3e2bf9ca54d966 100644 (file)
@@ -27,7 +27,8 @@
  * this would be done via RNA api but in this case a hand written python api
  * allows us to use pythons context manager (__enter__ and __exit__).
  *
- * Everything here is exposed via bpy.data.libraries.load(...) context manager.
+ * Everything here is exposed via bpy.data.libraries.load(...) which returns
+ * a context manager.
  */
 
 /* nifty feature. swap out strings for RNA data */
@@ -77,8 +78,8 @@ static PyObject *bpy_lib_dir(BPy_Library *self);
 
 static PyMethodDef bpy_lib_methods[]= {
        {"__enter__", (PyCFunction)bpy_lib_enter, METH_NOARGS},
-       {"__exit__", (PyCFunction)bpy_lib_exit, METH_VARARGS},
-       {"__dir__", (PyCFunction)bpy_lib_dir, METH_NOARGS},
+       {"__exit__",  (PyCFunction)bpy_lib_exit,  METH_VARARGS},
+       {"__dir__",   (PyCFunction)bpy_lib_dir,   METH_NOARGS},
        {NULL}           /* sentinel */
 };
 
@@ -289,7 +290,7 @@ static void bpy_lib_exit_warn_idname(BPy_Library *self, const char *name_plural,
        PyObject *exc, *val, *tb;
        PyErr_Fetch(&exc, &val, &tb);
        if (PyErr_WarnFormat(PyExc_UserWarning, 1,
-                                                "load: '%s' does not contain %s[\"%s\"]",
+                            "load: '%s' does not contain %s[\"%s\"]",
                             self->abspath, name_plural, idname)) {
                /* Spurious errors can appear at shutdown */
                if (PyErr_ExceptionMatches(PyExc_Warning)) {
@@ -304,7 +305,7 @@ static void bpy_lib_exit_warn_type(BPy_Library *self, PyObject *item)
        PyObject *exc, *val, *tb;
        PyErr_Fetch(&exc, &val, &tb);
        if (PyErr_WarnFormat(PyExc_UserWarning, 1,
-                                                "load: '%s' expected a string type, not a %.200s",
+                            "load: '%s' expected a string type, not a %.200s",
                             self->abspath, Py_TYPE(item)->tp_name)) {
                /* Spurious errors can appear at shutdown */
                if (PyErr_ExceptionMatches(PyExc_Warning)) {
index 43ca4da7ae22e43dddfd275b22fb91f419b7eb39..fb42f7d59e06f8bc994c2d2d1044a4ec95f61f7d 100644 (file)
@@ -27,7 +27,6 @@
  * use (unrelated to 'bpy.utils')
  */
 
-
 #include <Python.h>
 
 #include "bpy_util.h"