source/blender/blenkernel/BKE_context.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  * Contributor(s): Blender Foundation (2008).
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 #ifndef BKE_CONTEXT_H
  29 #define BKE_CONTEXT_H
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include "DNA_listBase.h"
  36 #include "RNA_types.h"
  37
  38 struct ARegion;
  39 struct bScreen;
  40 struct EditMesh;
  41 struct ListBase;
  42 struct Main;
  43 struct Object;
  44 struct PointerRNA;
  45 struct ReportList;
  46 struct Scene;
  47 struct ScrArea;
  48 struct SpaceLink;
  49 struct View3D;
  50 struct RegionView3D;
  51 struct StructRNA;
  52 struct ToolSettings;
  53 struct Image;
  54 struct Text;
  55 struct ImBuf;
  56 struct EditBone;
  57 struct bPoseChannel;
  58 struct wmWindow;
  59 struct wmWindowManager;
  60 struct SpaceText;
  61 struct SpaceImage;
  62 struct ID;
  63
  64 /* Structs */
  65
  66 struct bContext;
  67 typedef struct bContext bContext;
  68
  69 struct bContextDataResult;
  70 typedef struct bContextDataResult bContextDataResult;
  71
  72 typedef int (*bContextDataCallback)(const bContext *C,
  73         const char *member, bContextDataResult *result);
  74
  75 typedef struct bContextStoreEntry {
  76         struct bContextStoreEntry *next, *prev;
  77
  78         char name[128];
  79         PointerRNA ptr;
  80 } bContextStoreEntry;
  81
  82 typedef struct bContextStore {
  83         struct bContextStore *next, *prev;
  84
  85         ListBase entries;
  86         int used;
  87 } bContextStore;
  88
  89 /* Context */
  90
  91 bContext *CTX_create(void);
  92 void CTX_free(bContext *C);
  93
  94 bContext *CTX_copy(const bContext *C);
  95
  96 /* Stored Context */
  97
  98 bContextStore *CTX_store_add(ListBase *contexts, char *name, PointerRNA *ptr);
  99 void CTX_store_set(bContext *C, bContextStore *store);
 100 bContextStore *CTX_store_copy(bContextStore *store);
 101 void CTX_store_free(bContextStore *store);
 102 void CTX_store_free_list(ListBase *contexts);
 103
 104 /* Window Manager Context */
 105
 106 struct wmWindowManager *CTX_wm_manager(const bContext *C);
 107 struct wmWindow *CTX_wm_window(const bContext *C);
 108 struct bScreen *CTX_wm_screen(const bContext *C);
 109 struct ScrArea *CTX_wm_area(const bContext *C);
 110 struct SpaceLink *CTX_wm_space_data(const bContext *C);
 111 struct ARegion *CTX_wm_region(const bContext *C);
 112 void *CTX_wm_region_data(const bContext *C);
 113 struct ARegion *CTX_wm_menu(const bContext *C);
 114
 115 struct View3D *CTX_wm_view3d(const bContext *C);
 116 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
 117 struct SpaceText *CTX_wm_space_text(const bContext *C);
 118 struct SpaceImage *CTX_wm_space_image(const bContext *C);
 119
 120 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
 121 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
 122 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
 123 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
 124 void CTX_wm_region_set(bContext *C, struct ARegion *region);
 125 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
 126
 127 /* Data Context
 128
 129    - listbases consist of CollectionPointerLink items and must be
 130      freed with BLI_freelistN!
 131    - the dir listbase consits of LinkData items */
 132
 133 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
 134 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
 135 ListBase CTX_data_collection_get(const bContext *C, const char *member);
 136 ListBase CTX_data_dir_get(const bContext *C);
 137 void CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb);
 138
 139 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
 140 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
 141
 142 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
 143 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
 144
 145 void CTX_data_dir_set(bContextDataResult *result, const char **member);
 146
 147 int CTX_data_equals(const char *member, const char *str);
 148 int CTX_data_dir(const char *member);
 149
 150 /*void CTX_data_pointer_set(bContextDataResult *result, void *data);
 151 void CTX_data_list_add(bContextDataResult *result, void *data);*/
 152
 153 #define CTX_DATA_BEGIN(C, Type, instance, member) \
 154         { \
 155                 ListBase ctx_data_list; \
 156                 CollectionPointerLink *ctx_link; \
 157                 CTX_data_##member(C, &ctx_data_list); \
 158                 for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
 159                         Type instance= ctx_link->ptr.data;
 160
 161 #define CTX_DATA_END \
 162                 } \
 163                 BLI_freelistN(&ctx_data_list); \
 164         }
 165
 166 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
 167
 168 #define CTX_DATA_COUNT(C, member) \
 169         ctx_data_list_count(C, CTX_data_##member)
 170
 171 /* Data Context Members */
 172
 173 struct Main *CTX_data_main(const bContext *C);
 174 struct Scene *CTX_data_scene(const bContext *C);
 175 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
 176
 177 void CTX_data_main_set(bContext *C, struct Main *bmain);
 178 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
 179
 180 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
 181 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
 182
 183 int CTX_data_selected_objects(const bContext *C, ListBase *list);
 184 int CTX_data_selected_bases(const bContext *C, ListBase *list);
 185
 186 int CTX_data_visible_objects(const bContext *C, ListBase *list);
 187 int CTX_data_visible_bases(const bContext *C, ListBase *list);
 188
 189 struct Object *CTX_data_active_object(const bContext *C);
 190 struct Base *CTX_data_active_base(const bContext *C);
 191 struct Object *CTX_data_edit_object(const bContext *C);
 192
 193 struct Image *CTX_data_edit_image(const bContext *C);
 194
 195 struct Text *CTX_data_edit_text(const bContext *C);
 196
 197 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
 198
 199 struct EditBone *CTX_data_active_bone(const bContext *C);
 200 int CTX_data_selected_bones(const bContext *C, ListBase *list);
 201 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
 202 int CTX_data_visible_bones(const bContext *C, ListBase *list);
 203 int CTX_data_editable_bones(const bContext *C, ListBase *list);
 204
 205 struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
 206 int CTX_data_selected_pchans(const bContext *C, ListBase *list);
 207 int CTX_data_visible_pchans(const bContext *C, ListBase *list);
 208
 209 #ifdef __cplusplus
 210 }
 211 #endif
 212
 213 #endif
 214