Function declaration for BPY_context_get
[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 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 bContextDataResult;
53 struct ReportList;
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58
59         /*These two next functions are important for making sure the Draw module
60           works correctly.  Before calling any gui callback using the Draw module,
61           the following code must be executed:
62           
63                 if (some_drawspace_pylist) {
64                         BPy_Set_DrawButtonsList(some_drawspace_pylist->but_refs);
65                         BPy_Free_DrawButtonsList();
66                 }
67                 some_drawspace_pylist = PyList_New(0);
68                 BPy_Set_DrawButtonsList(some_drawspace_pylist);
69
70       Also, BPy_Free_DrawButtonsList() must be called as necassary when a drawspace
71       with python callbacks is destroyed.
72       
73       This is necassary to avoid blender buttons storing invalid pointers to freed
74       python data.*/
75         void BPy_Set_DrawButtonsList(void *list);
76         void BPy_Free_DrawButtonsList(void);
77         
78         void BPY_pyconstraint_eval(struct bPythonConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
79         void BPY_pyconstraint_settings(void *arg1, void *arg2);
80         void BPY_pyconstraint_target(struct bPythonConstraint *con, struct bConstraintTarget *ct);
81         void BPY_pyconstraint_update(struct Object *owner, struct bConstraint *con);
82         int BPY_is_pyconstraint(struct Text *text);
83         void BPY_free_pyconstraint_links(struct Text *text);
84         
85         void BPY_start_python( int argc, char **argv );
86         void BPY_end_python( void );
87         void BPY_post_start_python( void );
88         void init_syspath( int first_time );
89         void syspath_append( char *dir );
90         void BPY_rebuild_syspath( void );
91         int BPY_path_update( void );
92         
93         int BPY_Err_getLinenumber( void );
94         const char *BPY_Err_getFilename( void );
95
96         int BPY_txt_do_python_Text( struct Text *text );
97         int BPY_menu_do_python( short menutype, int event );
98         int BPY_menu_do_shortcut( short menutype, unsigned short key, unsigned short modifiers );
99         int BPY_menu_invoke( struct BPyMenu *pym, short menutype );
100         
101         /* 2.5 UI Scripts */
102         int BPY_run_python_script( struct bContext *C, const char *filename, struct Text *text, struct ReportList *reports ); // 2.5 working
103         int BPY_run_script_space_draw(const struct bContext *C, struct SpaceScript * sc); // 2.5 working
104         void BPY_run_ui_scripts(struct bContext *C, int reload);
105 //      int BPY_run_script_space_listener(struct bContext *C, struct SpaceScript * sc, struct ARegion *ar, struct wmNotifier *wmn); // 2.5 working
106         void BPY_update_modules( void ); // XXX - annoying, need this for pointers that get out of date
107         
108         int BPY_context_get(struct bContext *C, const char *member, struct bContextDataResult *result);
109         
110         int BPY_run_script(struct Script *script);
111         void BPY_free_compiled_text( struct Text *text );
112
113         int BPY_has_onload_script( void );
114
115         int BPY_is_spacehandler(struct Text *text, char spacetype);
116         int BPY_del_spacehandler(struct Text *text, struct ScrArea *sa);
117         int BPY_add_spacehandler(struct Text *txt, struct ScrArea *sa,char spacetype);
118         int BPY_has_spacehandler(struct Text *text, struct ScrArea *sa);
119         void BPY_screen_free_spacehandlers(struct bScreen *sc);
120         int BPY_do_spacehandlers(struct ScrArea *sa, unsigned short event,
121                 short eventValue, unsigned short space_event);
122
123         void BPY_pydriver_update(void);
124         float BPY_pydriver_eval(struct ChannelDriver *driver);
125
126         int BPY_button_eval(struct bContext *C, char *expr, double *value);
127
128 /* format importer hook */
129         int BPY_call_importloader( char *name );
130
131         void BPY_spacescript_do_pywin_draw( struct SpaceScript *sc );
132         void BPY_spacescript_do_pywin_event( struct SpaceScript *sc,
133                                              unsigned short event, short val, char ascii );
134         void BPY_clear_script( struct Script *script );
135         void BPY_free_finished_script( struct Script *script );
136         void BPY_scripts_clear_pyobjects( void );
137         
138         void error_pyscript( void );
139         void BPY_DECREF(void *pyob_ptr);        /* Py_DECREF() */
140
141 /* void BPY_Err_Handle(struct Text *text); */
142 /* int BPY_spacetext_is_pywin(struct SpaceText *st); */
143
144 #ifdef __cplusplus
145 }                               /* extern "C" */
146 #endif
147
148 #endif  /* BPY_EXTERN_H */