Any script can now register a unique key combination as part of its bpy header. For...
[blender-staging.git] / 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 IpoDriver; /* DNA_curve_types.h */
40 struct ScriptLink; /* DNA_scriptlink_types.h */
41 struct ListBase; /* DNA_listBase.h */
42 struct SpaceText; /* DNA_space_types.h */
43 struct SpaceScript; /* DNA_space_types.h */
44 struct ScrArea; /* DNA_screen_types.h */
45 struct bScreen; /* DNA_screen_types.h */
46 struct bConstraint; /* DNA_constraint_types.h */
47 struct bPythonConstraint; /* DNA_constraint_types.h */
48 struct bConstraintOb; /* DNA_constraint_types.h */
49 struct bConstraintTarget; /* DNA_constraint_types.h*/
50 struct Script;                          /* DNA_screen_types.h */
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54
55         /*These two next functions are important for making sure the Draw module
56           works correctly.  Before calling any gui callback using the Draw module,
57           the following code must be executed:
58           
59                 if (some_drawspace_pylist) {
60                         BPy_Set_DrawButtonsList(some_drawspace_pylist->but_refs);
61                         BPy_Free_DrawButtonsList();
62                 }
63                 some_drawspace_pylist = PyList_New(0);
64                 BPy_Set_DrawButtonsList(some_drawspace_pylist);
65
66       Also, BPy_Free_DrawButtonsList() must be called as necassary when a drawspace
67       with python callbacks is destroyed.
68       
69       This is necassary to avoid blender buttons storing invalid pointers to freed
70       python data.*/
71         void BPy_Set_DrawButtonsList(void *list);
72         void BPy_Free_DrawButtonsList(void);
73         
74         void BPY_pyconstraint_eval(struct bPythonConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
75         void BPY_pyconstraint_settings(void *arg1, void *arg2);
76         void BPY_pyconstraint_target(struct bPythonConstraint *con, struct bConstraintTarget *ct);
77         void BPY_pyconstraint_update(struct Object *owner, struct bConstraint *con);
78         int BPY_is_pyconstraint(struct Text *text);
79         void BPY_free_pyconstraint_links(struct Text *text);
80         
81         void BPY_start_python( int argc, char **argv );
82         void BPY_end_python( void );
83         void BPY_post_start_python( void );
84         void init_syspath( int first_time );
85         void syspath_append( char *dir );
86         void BPY_rebuild_syspath( void );
87         int BPY_path_update( void );
88         
89         int BPY_Err_getLinenumber( void );
90         const char *BPY_Err_getFilename( void );
91
92         int BPY_txt_do_python_Text( struct Text *text );
93         int BPY_menu_do_python( short menutype, int event );
94         int BPY_menu_do_shortcut( short menutype, unsigned short key, unsigned short modifiers );
95         int BPY_menu_invoke( struct BPyMenu *pym, short menutype );
96         void BPY_run_python_script( char *filename );
97         int BPY_run_script(struct Script *script);
98         void BPY_free_compiled_text( struct Text *text );
99
100         void BPY_clear_bad_scriptlinks( struct Text *byebye );
101         int BPY_has_onload_script( void );
102         void BPY_do_all_scripts( short event );
103         int BPY_check_all_scriptlinks( struct Text *text );
104         void BPY_do_pyscript( struct ID *id, short event );
105         void BPY_free_scriptlink( struct ScriptLink *slink );
106         void BPY_copy_scriptlink( struct ScriptLink *scriptlink );
107
108         int BPY_is_spacehandler(struct Text *text, char spacetype);
109         int BPY_del_spacehandler(struct Text *text, struct ScrArea *sa);
110         int BPY_add_spacehandler(struct Text *txt, struct ScrArea *sa,char spacetype);
111         int BPY_has_spacehandler(struct Text *text, struct ScrArea *sa);
112         void BPY_screen_free_spacehandlers(struct bScreen *sc);
113         int BPY_do_spacehandlers(struct ScrArea *sa, unsigned short event,
114                 unsigned short space_event);
115
116         void BPY_pydriver_update(void);
117         float BPY_pydriver_eval(struct IpoDriver *driver);
118         struct Object **BPY_pydriver_get_objects(struct IpoDriver *driver);
119
120         int BPY_button_eval(char *expr, double *value);
121
122 /* format importer hook */
123         int BPY_call_importloader( char *name );
124
125         void BPY_spacescript_do_pywin_draw( struct SpaceScript *sc );
126         void BPY_spacescript_do_pywin_event( struct SpaceScript *sc,
127                                              unsigned short event, short val, char ascii );
128         void BPY_clear_script( struct Script *script );
129         void BPY_free_finished_script( struct Script *script );
130         void BPY_scripts_clear_pyobjects( void );
131         
132         void error_pyscript( void );
133         
134 /* void BPY_Err_Handle(struct Text *text); */
135 /* void BPY_clear_bad_scriptlink(struct ID *id, struct Text *byebye); */
136 /* void BPY_clear_bad_scriptlist(struct ListBase *, struct Text *byebye); */
137 /* int BPY_spacetext_is_pywin(struct SpaceText *st); */
138
139 #ifdef __cplusplus
140 }                               /* extern "C" */
141 #endif
142
143 #endif  /* BPY_EXTERN_H */