source/blender/python/BPY_extern.h

   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  * The Original Code was in: source/blender/bpython/include/BPY_extern.h
  24  *
  25  * Contributor(s): Michel Selten, Willian P. Germano, Chris Keith
  26  *
  27  * ***** END GPL LICENSE BLOCK *****
  28  */
  29
  30 #ifndef BPY_EXTERN_H
  31 #define BPY_EXTERN_H
  32
  33 extern char bprogname[];        /* holds a copy of argv[0], from creator.c */
  34 extern char btempdir[];         /* use this to store a valid temp directory */
  35
  36 struct Text; /* defined in DNA_text_types.h */
  37 struct ID; /* DNA_ID.h */
  38 struct Object; /* DNA_object_types.h */
  39 struct ChannelDriver; /* DNA_anim_types.h */
  40 struct ListBase; /* DNA_listBase.h */
  41 struct SpaceText; /* DNA_space_types.h */
  42 struct SpaceScript; /* DNA_space_types.h */
  43 struct ScrArea; /* DNA_screen_types.h */
  44 struct bScreen; /* DNA_screen_types.h */
  45 struct bConstraint; /* DNA_constraint_types.h */
  46 struct bPythonConstraint; /* DNA_constraint_types.h */
  47 struct bConstraintOb; /* DNA_constraint_types.h */
  48 struct bConstraintTarget; /* DNA_constraint_types.h*/
  49 struct Script;                          /* DNA_screen_types.h */
  50 struct BPyMenu;
  51 struct bContext;
  52 struct ReportList;
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58         /*These two next functions are important for making sure the Draw module
  59           works correctly.  Before calling any gui callback using the Draw module,
  60           the following code must be executed:
  61
  62                 if (some_drawspace_pylist) {
  63                         BPy_Set_DrawButtonsList(some_drawspace_pylist->but_refs);
  64                         BPy_Free_DrawButtonsList();
  65                 }
  66                 some_drawspace_pylist = PyList_New(0);
  67                 BPy_Set_DrawButtonsList(some_drawspace_pylist);
  68
  69       Also, BPy_Free_DrawButtonsList() must be called as necassary when a drawspace
  70       with python callbacks is destroyed.
  71
  72       This is necassary to avoid blender buttons storing invalid pointers to freed
  73       python data.*/
  74         void BPy_Set_DrawButtonsList(void *list);
  75         void BPy_Free_DrawButtonsList(void);
  76
  77         void BPY_pyconstraint_eval(struct bPythonConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
  78         void BPY_pyconstraint_settings(void *arg1, void *arg2);
  79         void BPY_pyconstraint_target(struct bPythonConstraint *con, struct bConstraintTarget *ct);
  80         void BPY_pyconstraint_update(struct Object *owner, struct bConstraint *con);
  81         int BPY_is_pyconstraint(struct Text *text);
  82         void BPY_free_pyconstraint_links(struct Text *text);
  83
  84         void BPY_start_python( int argc, char **argv );
  85         void BPY_end_python( void );
  86         void BPY_post_start_python( void );
  87         void init_syspath( int first_time );
  88         void syspath_append( char *dir );
  89         void BPY_rebuild_syspath( void );
  90         int BPY_path_update( void );
  91
  92         int BPY_Err_getLinenumber( void );
  93         const char *BPY_Err_getFilename( void );
  94
  95         int BPY_txt_do_python_Text( struct Text *text );
  96         int BPY_menu_do_python( short menutype, int event );
  97         int BPY_menu_do_shortcut( short menutype, unsigned short key, unsigned short modifiers );
  98         int BPY_menu_invoke( struct BPyMenu *pym, short menutype );
  99
 100         /* 2.5 UI Scripts */
 101         int BPY_run_python_script( struct bContext *C, const char *filename, struct Text *text, struct ReportList *reports ); // 2.5 working
 102         int BPY_run_script_space_draw(const struct bContext *C, struct SpaceScript * sc); // 2.5 working
 103         void BPY_run_ui_scripts(struct bContext *C, int reload);
 104 //      int BPY_run_script_space_listener(struct bContext *C, struct SpaceScript * sc, struct ARegion *ar, struct wmNotifier *wmn); // 2.5 working
 105         void BPY_update_modules( void ); // XXX - annoying, need this for pointers that get out of date
 106
 107
 108
 109         int BPY_run_script(struct Script *script);
 110         void BPY_free_compiled_text( struct Text *text );
 111
 112         int BPY_has_onload_script( void );
 113
 114         int BPY_is_spacehandler(struct Text *text, char spacetype);
 115         int BPY_del_spacehandler(struct Text *text, struct ScrArea *sa);
 116         int BPY_add_spacehandler(struct Text *txt, struct ScrArea *sa,char spacetype);
 117         int BPY_has_spacehandler(struct Text *text, struct ScrArea *sa);
 118         void BPY_screen_free_spacehandlers(struct bScreen *sc);
 119         int BPY_do_spacehandlers(struct ScrArea *sa, unsigned short event,
 120                 short eventValue, unsigned short space_event);
 121
 122         void BPY_pydriver_update(void);
 123         float BPY_pydriver_eval(struct ChannelDriver *driver);
 124
 125         int BPY_button_eval(char *expr, double *value);
 126
 127 /* format importer hook */
 128         int BPY_call_importloader( char *name );
 129
 130         void BPY_spacescript_do_pywin_draw( struct SpaceScript *sc );
 131         void BPY_spacescript_do_pywin_event( struct SpaceScript *sc,
 132                                              unsigned short event, short val, char ascii );
 133         void BPY_clear_script( struct Script *script );
 134         void BPY_free_finished_script( struct Script *script );
 135         void BPY_scripts_clear_pyobjects( void );
 136
 137         void error_pyscript( void );
 138         void BPY_DECREF(void *pyob_ptr);        /* Py_DECREF() */
 139
 140 /* void BPY_Err_Handle(struct Text *text); */
 141 /* int BPY_spacetext_is_pywin(struct SpaceText *st); */
 142
 143 #ifdef __cplusplus
 144 }                               /* extern "C" */
 145 #endif
 146
 147 #endif  /* BPY_EXTERN_H */