svn merge ^/trunk/blender -r47070:47099
[blender.git] / source / blender / blenkernel / intern / context.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation (2008).
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/context.c
27  *  \ingroup bke
28  */
29
30
31 #include <string.h>
32 #include <stddef.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_scene_types.h"
37 #include "DNA_screen_types.h"
38 #include "DNA_space_types.h"
39 #include "DNA_view3d_types.h"
40 #include "DNA_windowmanager_types.h"
41 #include "DNA_object_types.h"
42
43 #include "RNA_access.h"
44
45 #include "BLI_listbase.h"
46 #include "BLI_string.h"
47 #include "BLI_utildefines.h"
48
49 #include "BKE_context.h"
50 #include "BKE_main.h"
51 #include "BKE_screen.h"
52
53 #ifdef WITH_PYTHON
54 #include "BPY_extern.h"
55 #endif
56
57 /* struct */
58
59 struct bContext {
60         int thread;
61
62         /* windowmanager context */
63         struct {
64                 struct wmWindowManager *manager;
65                 struct wmWindow *window;
66                 struct bScreen *screen;
67                 struct ScrArea *area;
68                 struct ARegion *region;
69                 struct ARegion *menu;
70                 struct bContextStore *store;
71                 const char *operator_poll_msg; /* reason for poll failing */
72         } wm;
73         
74         /* data context */
75         struct {
76                 struct Main *main;
77                 struct Scene *scene;
78
79                 int recursion;
80                 int py_init; /* true if python is initialized */
81                 void *py_context;
82         } data;
83         
84         /* data evaluation */
85         struct {
86                 int render;
87         } eval;
88 };
89
90 /* context */
91
92 bContext *CTX_create(void)
93 {
94         bContext *C;
95         
96         C = MEM_callocN(sizeof(bContext), "bContext");
97
98         return C;
99 }
100
101 bContext *CTX_copy(const bContext *C)
102 {
103         bContext *newC = MEM_dupallocN((void *)C);
104
105         return newC;
106 }
107
108 void CTX_free(bContext *C)
109 {
110         MEM_freeN(C);
111 }
112
113 /* store */
114
115 bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr)
116 {
117         bContextStoreEntry *entry;
118         bContextStore *ctx, *lastctx;
119
120         /* ensure we have a context to put the entry in, if it was already used
121          * we have to copy the context to ensure */
122         ctx = contexts->last;
123
124         if (!ctx || ctx->used) {
125                 if (ctx) {
126                         lastctx = ctx;
127                         ctx = MEM_dupallocN(lastctx);
128                         BLI_duplicatelist(&ctx->entries, &lastctx->entries);
129                 }
130                 else
131                         ctx = MEM_callocN(sizeof(bContextStore), "bContextStore");
132
133                 BLI_addtail(contexts, ctx);
134         }
135
136         entry = MEM_callocN(sizeof(bContextStoreEntry), "bContextStoreEntry");
137         BLI_strncpy(entry->name, name, sizeof(entry->name));
138         entry->ptr = *ptr;
139
140         BLI_addtail(&ctx->entries, entry);
141
142         return ctx;
143 }
144
145 bContextStore *CTX_store_add_all(ListBase *contexts, bContextStore *context)
146 {
147         bContextStoreEntry *entry, *tentry;
148         bContextStore *ctx, *lastctx;
149
150         /* ensure we have a context to put the entries in, if it was already used
151          * we have to copy the context to ensure */
152         ctx = contexts->last;
153
154         if (!ctx || ctx->used) {
155                 if (ctx) {
156                         lastctx = ctx;
157                         ctx = MEM_dupallocN(lastctx);
158                         BLI_duplicatelist(&ctx->entries, &lastctx->entries);
159                 }
160                 else
161                         ctx = MEM_callocN(sizeof(bContextStore), "bContextStore");
162
163                 BLI_addtail(contexts, ctx);
164         }
165
166         for (tentry = context->entries.first; tentry; tentry = tentry->next) {
167                 entry = MEM_dupallocN(tentry);
168                 BLI_addtail(&ctx->entries, entry);
169         }
170
171         return ctx;
172 }
173
174 void CTX_store_set(bContext *C, bContextStore *store)
175 {
176         C->wm.store = store;
177 }
178
179 bContextStore *CTX_store_copy(bContextStore *store)
180 {
181         bContextStore *ctx;
182
183         ctx = MEM_dupallocN(store);
184         BLI_duplicatelist(&ctx->entries, &store->entries);
185
186         return ctx;
187 }
188
189 void CTX_store_free(bContextStore *store)
190 {
191         BLI_freelistN(&store->entries);
192         MEM_freeN(store);
193 }
194
195 void CTX_store_free_list(ListBase *contexts)
196 {
197         bContextStore *ctx;
198
199         while ((ctx = contexts->first)) {
200                 BLI_remlink(contexts, ctx);
201                 CTX_store_free(ctx);
202         }
203 }
204
205 /* is python initialied? */
206
207 int CTX_py_init_get(bContext *C)
208 {
209         return C->data.py_init;
210 }
211 void CTX_py_init_set(bContext *C, int value)
212 {
213         C->data.py_init = value;
214 }
215
216 void *CTX_py_dict_get(const bContext *C)
217 {
218         return C->data.py_context;
219 }
220 void CTX_py_dict_set(bContext *C, void *value)
221 {
222         C->data.py_context = value;
223 }
224
225 /* data context utility functions */
226
227 struct bContextDataResult {
228         PointerRNA ptr;
229         ListBase list;
230         const char **dir;
231         short type; /* 0: normal, 1: seq */
232 };
233
234 static void *ctx_wm_python_context_get(const bContext *C, const char *member, void *fall_through)
235 {
236 #ifdef WITH_PYTHON
237         bContextDataResult result;
238
239         if (C && CTX_py_dict_get(C)) {
240                 memset(&result, 0, sizeof(bContextDataResult));
241                 BPY_context_member_get((bContext *)C, member, &result);
242                 if (result.ptr.data)
243                         return result.ptr.data;
244         }
245 #endif
246
247         return fall_through;
248 }
249
250 static int ctx_data_get(bContext *C, const char *member, bContextDataResult *result)
251 {
252         bScreen *sc;
253         ScrArea *sa;
254         ARegion *ar;
255         int done = FALSE, recursion = C->data.recursion;
256         int ret = 0;
257
258         memset(result, 0, sizeof(bContextDataResult));
259 #ifdef WITH_PYTHON
260         if (CTX_py_dict_get(C)) {
261                 return BPY_context_member_get(C, member, result);
262 //              if (BPY_context_member_get(C, member, result))
263 //                      return 1;
264         }
265 #endif
266         /* we check recursion to ensure that we do not get infinite
267          * loops requesting data from ourselfs in a context callback */
268
269         /* Ok, this looks evil...
270          * if (ret) done = -(-ret | -done);
271          *
272          * Values in order of importance
273          * (0, -1, 1) - Where 1 is highest priority
274          * */
275         if (done != 1 && recursion < 1 && C->wm.store) {
276                 bContextStoreEntry *entry;
277
278                 C->data.recursion = 1;
279
280                 entry = BLI_rfindstring(&C->wm.store->entries, member, offsetof(bContextStoreEntry, name));
281                 if (entry) {
282                         result->ptr = entry->ptr;
283                         done = TRUE;
284                 }
285         }
286         if (done != 1 && recursion < 2 && (ar = CTX_wm_region(C))) {
287                 C->data.recursion = 2;
288                 if (ar->type && ar->type->context) {
289                         ret = ar->type->context(C, member, result);
290                         if (ret) done = -(-ret | -done);
291
292                 }
293         }
294         if (done != 1 && recursion < 3 && (sa = CTX_wm_area(C))) {
295                 C->data.recursion = 3;
296                 if (sa->type && sa->type->context) {
297                         ret = sa->type->context(C, member, result);
298                         if (ret) done = -(-ret | -done);
299                 }
300         }
301         if (done != 1 && recursion < 4 && (sc = CTX_wm_screen(C))) {
302                 bContextDataCallback cb = sc->context;
303                 C->data.recursion = 4;
304                 if (cb) {
305                         ret = cb(C, member, result);
306                         if (ret) done = -(-ret | -done);
307                 }
308         }
309
310         C->data.recursion = recursion;
311
312         return done;
313 }
314
315 static void *ctx_data_pointer_get(const bContext *C, const char *member)
316 {
317         bContextDataResult result;
318
319         if (C && ctx_data_get((bContext *)C, member, &result) == 1)
320                 return result.ptr.data;
321
322         return NULL;
323 }
324
325 static int ctx_data_pointer_verify(const bContext *C, const char *member, void **pointer)
326 {
327         bContextDataResult result;
328
329         /* if context is NULL, pointer must be NULL too and that is a valid return */
330         if (C == NULL) {
331                 *pointer = NULL;
332                 return 1;
333         }
334         else if (ctx_data_get((bContext *)C, member, &result) == 1) {
335                 *pointer = result.ptr.data;
336                 return 1;
337         }
338         else {
339                 *pointer = NULL;
340                 return 0;
341         }
342 }
343
344 static int ctx_data_collection_get(const bContext *C, const char *member, ListBase *list)
345 {
346         bContextDataResult result;
347
348         if (ctx_data_get((bContext *)C, member, &result) == 1) {
349                 *list = result.list;
350                 return 1;
351         }
352
353         list->first = NULL;
354         list->last = NULL;
355
356         return 0;
357 }
358
359 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member)
360 {
361         bContextDataResult result;
362
363         if (ctx_data_get((bContext *)C, member, &result) == 1)
364                 return result.ptr;
365         else
366                 return PointerRNA_NULL;
367 }
368
369 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type)
370 {
371         PointerRNA ptr = CTX_data_pointer_get(C, member);
372
373         if (ptr.data && RNA_struct_is_a(ptr.type, type))
374                 return ptr;
375         
376         return PointerRNA_NULL;
377 }
378
379 ListBase CTX_data_collection_get(const bContext *C, const char *member)
380 {
381         bContextDataResult result;
382
383         if (ctx_data_get((bContext *)C, member, &result) == 1) {
384                 return result.list;
385         }
386         else {
387                 ListBase list = {NULL, NULL};
388                 return list;
389         }
390 }
391
392 /* 1:found,  -1:found but not set,  0:not found */
393 int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type)
394 {
395         bContextDataResult result;
396         int ret = ctx_data_get((bContext *)C, member, &result);
397
398         if (ret == 1) {
399                 *r_ptr = result.ptr;
400                 *r_lb = result.list;
401                 *r_type = result.type;
402         }
403         else {
404                 memset(r_ptr, 0, sizeof(*r_ptr));
405                 memset(r_lb, 0, sizeof(*r_lb));
406                 *r_type = 0;
407         }
408
409         return ret;
410 }
411
412 static void data_dir_add(ListBase *lb, const char *member)
413 {
414         LinkData *link;
415         
416         if (strcmp(member, "scene") == 0) /* exception */
417                 return;
418
419         if (BLI_findstring(lb, member, offsetof(LinkData, data)))
420                 return;
421         
422         link = MEM_callocN(sizeof(LinkData), "LinkData");
423         link->data = (void *)member;
424         BLI_addtail(lb, link);
425 }
426
427 ListBase CTX_data_dir_get(const bContext *C)
428 {
429         bContextDataResult result;
430         ListBase lb;
431         bScreen *sc;
432         ScrArea *sa;
433         ARegion *ar;
434         int a;
435
436         memset(&lb, 0, sizeof(lb));
437
438         if (C->wm.store) {
439                 bContextStoreEntry *entry;
440
441                 for (entry = C->wm.store->entries.first; entry; entry = entry->next)
442                         data_dir_add(&lb, entry->name);
443         }
444         if ((ar = CTX_wm_region(C)) && ar->type && ar->type->context) {
445                 memset(&result, 0, sizeof(result));
446                 ar->type->context(C, "", &result);
447
448                 if (result.dir)
449                         for (a = 0; result.dir[a]; a++)
450                                 data_dir_add(&lb, result.dir[a]);
451         }
452         if ((sa = CTX_wm_area(C)) && sa->type && sa->type->context) {
453                 memset(&result, 0, sizeof(result));
454                 sa->type->context(C, "", &result);
455
456                 if (result.dir)
457                         for (a = 0; result.dir[a]; a++)
458                                 data_dir_add(&lb, result.dir[a]);
459         }
460         if ((sc = CTX_wm_screen(C)) && sc->context) {
461                 bContextDataCallback cb = sc->context;
462                 memset(&result, 0, sizeof(result));
463                 cb(C, "", &result);
464
465                 if (result.dir)
466                         for (a = 0; result.dir[a]; a++)
467                                 data_dir_add(&lb, result.dir[a]);
468         }
469
470         return lb;
471 }
472
473 int CTX_data_equals(const char *member, const char *str)
474 {
475         return (strcmp(member, str) == 0);
476 }
477
478 int CTX_data_dir(const char *member)
479 {
480         return member[0] == '\0';
481 }
482
483 void CTX_data_id_pointer_set(bContextDataResult *result, ID *id)
484 {
485         RNA_id_pointer_create(id, &result->ptr);
486 }
487
488 void CTX_data_pointer_set(bContextDataResult *result, ID *id, StructRNA *type, void *data)
489 {
490         RNA_pointer_create(id, type, data, &result->ptr);
491 }
492
493 void CTX_data_id_list_add(bContextDataResult *result, ID *id)
494 {
495         CollectionPointerLink *link;
496
497         link = MEM_callocN(sizeof(CollectionPointerLink), "CTX_data_id_list_add");
498         RNA_id_pointer_create(id, &link->ptr);
499
500         BLI_addtail(&result->list, link);
501 }
502
503 void CTX_data_list_add(bContextDataResult *result, ID *id, StructRNA *type, void *data)
504 {
505         CollectionPointerLink *link;
506
507         link = MEM_callocN(sizeof(CollectionPointerLink), "CTX_data_list_add");
508         RNA_pointer_create(id, type, data, &link->ptr);
509
510         BLI_addtail(&result->list, link);
511 }
512
513 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *))
514 {
515         ListBase list;
516
517         if (func(C, &list)) {
518                 int tot = BLI_countlist(&list);
519                 BLI_freelistN(&list);
520                 return tot;
521         }
522         else
523                 return 0;
524 }
525
526 void CTX_data_dir_set(bContextDataResult *result, const char **dir)
527 {
528         result->dir = dir;
529 }
530
531 void CTX_data_type_set(bContextDataResult *result, short type)
532 {
533         result->type = type;
534 }
535
536 short CTX_data_type_get(bContextDataResult *result)
537 {
538         return result->type;
539 }
540
541
542
543 /* window manager context */
544
545 wmWindowManager *CTX_wm_manager(const bContext *C)
546 {
547         return C->wm.manager;
548 }
549
550 wmWindow *CTX_wm_window(const bContext *C)
551 {
552         return ctx_wm_python_context_get(C, "window", C->wm.window);
553 }
554
555 bScreen *CTX_wm_screen(const bContext *C)
556 {
557         return ctx_wm_python_context_get(C, "screen", C->wm.screen);
558 }
559
560 ScrArea *CTX_wm_area(const bContext *C)
561 {
562         return ctx_wm_python_context_get(C, "area", C->wm.area);
563 }
564
565 SpaceLink *CTX_wm_space_data(const bContext *C)
566 {
567         ScrArea *sa = CTX_wm_area(C);
568         return (sa) ? sa->spacedata.first : NULL;
569 }
570
571 ARegion *CTX_wm_region(const bContext *C)
572 {
573         return ctx_wm_python_context_get(C, "region", C->wm.region);
574 }
575
576 void *CTX_wm_region_data(const bContext *C)
577 {
578         ARegion *ar = CTX_wm_region(C);
579         return (ar) ? ar->regiondata : NULL;
580 }
581
582 struct ARegion *CTX_wm_menu(const bContext *C)
583 {
584         return C->wm.menu;
585 }
586
587 struct ReportList *CTX_wm_reports(const bContext *C)
588 {
589         if (C->wm.manager)
590                 return &(C->wm.manager->reports);
591
592         return NULL;
593 }
594
595 View3D *CTX_wm_view3d(const bContext *C)
596 {
597         ScrArea *sa = CTX_wm_area(C);
598         if (sa && sa->spacetype == SPACE_VIEW3D)
599                 return sa->spacedata.first;
600         return NULL;
601 }
602
603 RegionView3D *CTX_wm_region_view3d(const bContext *C)
604 {
605         ScrArea *sa = CTX_wm_area(C);
606         ARegion *ar = CTX_wm_region(C);
607
608         if (sa && sa->spacetype == SPACE_VIEW3D)
609                 if (ar)
610                         return ar->regiondata;
611         return NULL;
612 }
613
614 struct SpaceText *CTX_wm_space_text(const bContext *C)
615 {
616         ScrArea *sa = CTX_wm_area(C);
617         if (sa && sa->spacetype == SPACE_TEXT)
618                 return sa->spacedata.first;
619         return NULL;
620 }
621
622 struct SpaceConsole *CTX_wm_space_console(const bContext *C)
623 {
624         ScrArea *sa = CTX_wm_area(C);
625         if (sa && sa->spacetype == SPACE_CONSOLE)
626                 return sa->spacedata.first;
627         return NULL;
628 }
629
630 struct SpaceImage *CTX_wm_space_image(const bContext *C)
631 {
632         ScrArea *sa = CTX_wm_area(C);
633         if (sa && sa->spacetype == SPACE_IMAGE)
634                 return sa->spacedata.first;
635         return NULL;
636 }
637
638 struct SpaceButs *CTX_wm_space_buts(const bContext *C)
639 {
640         ScrArea *sa = CTX_wm_area(C);
641         if (sa && sa->spacetype == SPACE_BUTS)
642                 return sa->spacedata.first;
643         return NULL;
644 }
645
646 struct SpaceFile *CTX_wm_space_file(const bContext *C)
647 {
648         ScrArea *sa = CTX_wm_area(C);
649         if (sa && sa->spacetype == SPACE_FILE)
650                 return sa->spacedata.first;
651         return NULL;
652 }
653
654 struct SpaceSeq *CTX_wm_space_seq(const bContext *C)
655 {
656         ScrArea *sa = CTX_wm_area(C);
657         if (sa && sa->spacetype == SPACE_SEQ)
658                 return sa->spacedata.first;
659         return NULL;
660 }
661
662 struct SpaceOops *CTX_wm_space_outliner(const bContext *C)
663 {
664         ScrArea *sa = CTX_wm_area(C);
665         if (sa && sa->spacetype == SPACE_OUTLINER)
666                 return sa->spacedata.first;
667         return NULL;
668 }
669
670 struct SpaceNla *CTX_wm_space_nla(const bContext *C)
671 {
672         ScrArea *sa = CTX_wm_area(C);
673         if (sa && sa->spacetype == SPACE_NLA)
674                 return sa->spacedata.first;
675         return NULL;
676 }
677
678 struct SpaceTime *CTX_wm_space_time(const bContext *C)
679 {
680         ScrArea *sa = CTX_wm_area(C);
681         if (sa && sa->spacetype == SPACE_TIME)
682                 return sa->spacedata.first;
683         return NULL;
684 }
685
686 struct SpaceNode *CTX_wm_space_node(const bContext *C)
687 {
688         ScrArea *sa = CTX_wm_area(C);
689         if (sa && sa->spacetype == SPACE_NODE)
690                 return sa->spacedata.first;
691         return NULL;
692 }
693
694 struct SpaceLogic *CTX_wm_space_logic(const bContext *C)
695 {
696         ScrArea *sa = CTX_wm_area(C);
697         if (sa && sa->spacetype == SPACE_LOGIC)
698                 return sa->spacedata.first;
699         return NULL;
700 }
701
702 struct SpaceIpo *CTX_wm_space_graph(const bContext *C)
703 {
704         ScrArea *sa = CTX_wm_area(C);
705         if (sa && sa->spacetype == SPACE_IPO)
706                 return sa->spacedata.first;
707         return NULL;
708 }
709
710 struct SpaceAction *CTX_wm_space_action(const bContext *C)
711 {
712         ScrArea *sa = CTX_wm_area(C);
713         if (sa && sa->spacetype == SPACE_ACTION)
714                 return sa->spacedata.first;
715         return NULL;
716 }
717
718 struct SpaceInfo *CTX_wm_space_info(const bContext *C)
719 {
720         ScrArea *sa = CTX_wm_area(C);
721         if (sa && sa->spacetype == SPACE_INFO)
722                 return sa->spacedata.first;
723         return NULL;
724 }
725
726 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C)
727 {
728         ScrArea *sa = CTX_wm_area(C);
729         if (sa && sa->spacetype == SPACE_USERPREF)
730                 return sa->spacedata.first;
731         return NULL;
732 }
733
734 struct SpaceClip *CTX_wm_space_clip(const bContext *C)
735 {
736         ScrArea *sa = CTX_wm_area(C);
737         if (sa && sa->spacetype == SPACE_CLIP)
738                 return sa->spacedata.first;
739         return NULL;
740 }
741
742 void CTX_wm_manager_set(bContext *C, wmWindowManager *wm)
743 {
744         C->wm.manager = wm;
745         C->wm.window = NULL;
746         C->wm.screen = NULL;
747         C->wm.area = NULL;
748         C->wm.region = NULL;
749 }
750
751 void CTX_wm_window_set(bContext *C, wmWindow *win)
752 {
753         C->wm.window = win;
754         C->wm.screen = (win) ? win->screen : NULL;
755         if (C->wm.screen)
756                 C->data.scene = C->wm.screen->scene;
757         C->wm.area = NULL;
758         C->wm.region = NULL;
759 }
760
761 void CTX_wm_screen_set(bContext *C, bScreen *screen)
762 {
763         C->wm.screen = screen;
764         if (C->wm.screen)
765                 C->data.scene = C->wm.screen->scene;
766         C->wm.area = NULL;
767         C->wm.region = NULL;
768 }
769
770 void CTX_wm_area_set(bContext *C, ScrArea *area)
771 {
772         C->wm.area = area;
773         C->wm.region = NULL;
774 }
775
776 void CTX_wm_region_set(bContext *C, ARegion *region)
777 {
778         C->wm.region = region;
779 }
780
781 void CTX_wm_menu_set(bContext *C, ARegion *menu)
782 {
783         C->wm.menu = menu;
784 }
785
786 void CTX_wm_operator_poll_msg_set(bContext *C, const char *msg)
787 {
788         C->wm.operator_poll_msg = msg;
789 }
790
791 const char *CTX_wm_operator_poll_msg_get(bContext *C)
792 {
793         return C->wm.operator_poll_msg;
794 }
795
796 /* data context */
797
798 Main *CTX_data_main(const bContext *C)
799 {
800         Main *bmain;
801
802         if (ctx_data_pointer_verify(C, "blend_data", (void *)&bmain))
803                 return bmain;
804         else
805                 return C->data.main;
806 }
807
808 void CTX_data_main_set(bContext *C, Main *bmain)
809 {
810         C->data.main = bmain;
811 }
812
813 Scene *CTX_data_scene(const bContext *C)
814 {
815         Scene *scene;
816
817         if (ctx_data_pointer_verify(C, "scene", (void *)&scene))
818                 return scene;
819         else
820                 return C->data.scene;
821 }
822
823 int CTX_data_mode_enum(const bContext *C)
824 {
825         Object *obedit = CTX_data_edit_object(C);
826
827         if (obedit) {
828                 switch (obedit->type) {
829                         case OB_MESH:
830                                 return CTX_MODE_EDIT_MESH;
831                         case OB_CURVE:
832                                 return CTX_MODE_EDIT_CURVE;
833                         case OB_SURF:
834                                 return CTX_MODE_EDIT_SURFACE;
835                         case OB_FONT:
836                                 return CTX_MODE_EDIT_TEXT;
837                         case OB_ARMATURE:
838                                 return CTX_MODE_EDIT_ARMATURE;
839                         case OB_MBALL:
840                                 return CTX_MODE_EDIT_METABALL;
841                         case OB_LATTICE:
842                                 return CTX_MODE_EDIT_LATTICE;
843                 }
844         }
845         else {
846                 Object *ob = CTX_data_active_object(C);
847
848                 if (ob) {
849                         if (ob->mode & OB_MODE_POSE) return CTX_MODE_POSE;
850                         else if (ob->mode & OB_MODE_SCULPT) return CTX_MODE_SCULPT;
851                         else if (ob->mode & OB_MODE_WEIGHT_PAINT) return CTX_MODE_PAINT_WEIGHT;
852                         else if (ob->mode & OB_MODE_VERTEX_PAINT) return CTX_MODE_PAINT_VERTEX;
853                         else if (ob->mode & OB_MODE_TEXTURE_PAINT) return CTX_MODE_PAINT_TEXTURE;
854                         else if (ob->mode & OB_MODE_PARTICLE_EDIT) return CTX_MODE_PARTICLE;
855                 }
856         }
857
858         return CTX_MODE_OBJECT;
859 }
860
861
862 /* would prefer if we can use the enum version below over this one - Campbell */
863 /* must be aligned with above enum  */
864 static const char *data_mode_strings[] = {
865         "mesh_edit",
866         "curve_edit",
867         "surface_edit",
868         "text_edit",
869         "armature_edit",
870         "mball_edit",
871         "lattice_edit",
872         "posemode",
873         "sculpt_mode",
874         "weightpaint",
875         "vertexpaint",
876         "imagepaint",
877         "particlemode",
878         "objectmode",
879         NULL
880 };
881 const char *CTX_data_mode_string(const bContext *C)
882 {
883         return data_mode_strings[CTX_data_mode_enum(C)];
884 }
885
886 void CTX_data_scene_set(bContext *C, Scene *scene)
887 {
888         C->data.scene = scene;
889 }
890
891 ToolSettings *CTX_data_tool_settings(const bContext *C)
892 {
893         Scene *scene = CTX_data_scene(C);
894
895         if (scene)
896                 return scene->toolsettings;
897         else
898                 return NULL;
899 }
900
901 int CTX_data_selected_nodes(const bContext *C, ListBase *list)
902 {
903         return ctx_data_collection_get(C, "selected_nodes", list);
904 }
905
906 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list)
907 {
908         return ctx_data_collection_get(C, "selected_editable_objects", list);
909 }
910
911 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list)
912 {
913         return ctx_data_collection_get(C, "selected_editable_bases", list);
914 }
915
916 int CTX_data_selected_objects(const bContext *C, ListBase *list)
917 {
918         return ctx_data_collection_get(C, "selected_objects", list);
919 }
920
921 int CTX_data_selected_bases(const bContext *C, ListBase *list)
922 {
923         return ctx_data_collection_get(C, "selected_bases", list);
924 }
925
926 int CTX_data_visible_objects(const bContext *C, ListBase *list)
927 {
928         return ctx_data_collection_get(C, "visible_objects", list);
929 }
930
931 int CTX_data_visible_bases(const bContext *C, ListBase *list)
932 {
933         return ctx_data_collection_get(C, "visible_bases", list);
934 }
935
936 int CTX_data_selectable_objects(const bContext *C, ListBase *list)
937 {
938         return ctx_data_collection_get(C, "selectable_objects", list);
939 }
940
941 int CTX_data_selectable_bases(const bContext *C, ListBase *list)
942 {
943         return ctx_data_collection_get(C, "selectable_bases", list);
944 }
945
946 struct Object *CTX_data_active_object(const bContext *C)
947 {
948         return ctx_data_pointer_get(C, "active_object");
949 }
950
951 struct Base *CTX_data_active_base(const bContext *C)
952 {
953         return ctx_data_pointer_get(C, "active_base");
954 }
955
956 struct Object *CTX_data_edit_object(const bContext *C)
957 {
958         return ctx_data_pointer_get(C, "edit_object");
959 }
960
961 struct Image *CTX_data_edit_image(const bContext *C)
962 {
963         return ctx_data_pointer_get(C, "edit_image");
964 }
965
966 struct Text *CTX_data_edit_text(const bContext *C)
967 {
968         return ctx_data_pointer_get(C, "edit_text");
969 }
970
971 struct MovieClip *CTX_data_edit_movieclip(const bContext *C)
972 {
973         return ctx_data_pointer_get(C, "edit_movieclip");
974 }
975
976 struct Mask *CTX_data_edit_mask(const bContext *C)
977 {
978         return ctx_data_pointer_get(C, "edit_mask");
979 }
980
981 struct EditBone *CTX_data_active_bone(const bContext *C)
982 {
983         return ctx_data_pointer_get(C, "active_bone");
984 }
985
986 int CTX_data_selected_bones(const bContext *C, ListBase *list)
987 {
988         return ctx_data_collection_get(C, "selected_bones", list);
989 }
990
991 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list)
992 {
993         return ctx_data_collection_get(C, "selected_editable_bones", list);
994 }
995
996 int CTX_data_visible_bones(const bContext *C, ListBase *list)
997 {
998         return ctx_data_collection_get(C, "visible_bones", list);
999 }
1000
1001 int CTX_data_editable_bones(const bContext *C, ListBase *list)
1002 {
1003         return ctx_data_collection_get(C, "editable_bones", list);
1004 }
1005
1006 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C)
1007 {
1008         return ctx_data_pointer_get(C, "active_pose_bone");
1009 }
1010
1011 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list)
1012 {
1013         return ctx_data_collection_get(C, "selected_pose_bones", list);
1014 }
1015
1016 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list)
1017 {
1018         return ctx_data_collection_get(C, "visible_pose_bones", list);
1019 }
1020