RNA:
[blender-staging.git] / source / blender / editors / space_outliner / space_outliner.c
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) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "DNA_color_types.h"
33 #include "DNA_object_types.h"
34 #include "DNA_oops_types.h"
35 #include "DNA_space_types.h"
36 #include "DNA_scene_types.h"
37 #include "DNA_screen_types.h"
38 #include "DNA_space_types.h"
39 #include "DNA_texture_types.h"
40 #include "DNA_vec_types.h"
41 #include "DNA_windowmanager_types.h"
42
43 #include "MEM_guardedalloc.h"
44
45 #include "BLI_blenlib.h"
46 #include "BLI_arithb.h"
47 #include "BLI_rand.h"
48
49 #include "BKE_colortools.h"
50 #include "BKE_global.h"
51 #include "BKE_screen.h"
52 #include "BKE_texture.h"
53 #include "BKE_utildefines.h"
54
55 #include "ED_space_api.h"
56 #include "ED_screen.h"
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61 #include "BIF_gl.h"
62 #include "BIF_glutil.h"
63
64 #include "UI_interface.h"
65 #include "UI_text.h"
66 #include "UI_resources.h"
67 #include "UI_view2d.h"
68
69 #include "RNA_access.h"
70 #include "RNA_types.h"
71
72 #include "outliner_intern.h"
73
74 #define SET_INT_IN_POINTER(i) ((void*)(intptr_t)(i))
75 #define GET_INT_FROM_POINTER(i) ((int)(intptr_t)(i))
76
77 #define ROW_HEIGHT              19
78 #define COLUMN_WIDTH    150
79
80 typedef void (*uiTableCellFunc)(void *userdata, int row, int col, struct rcti *rct, struct uiBlock *block);
81
82 typedef struct uiTable {
83         rcti rct;
84         int rows, cols;
85
86         uiTableCellFunc cellfunc;
87         void *userdata;
88 } uiTable;
89
90 uiTable *UI_table_create(int rows, int cols, rcti *rct, uiTableCellFunc cellfunc, void *userdata)
91 {
92         uiTable *table;
93
94         table= MEM_callocN(sizeof(uiTable), "uiTable");
95         table->rct= *rct;
96         table->cellfunc= cellfunc;
97         table->rows= rows;
98         table->cols= cols;
99         table->userdata= userdata;
100
101         return table;
102 }
103
104 void UI_table_free(uiTable *table)
105 {
106         MEM_freeN(table);
107 }
108
109 void UI_table_draw(const bContext *C, uiTable *table)
110 {
111         uiBlock *block;
112         View2D *v2d;
113         rcti *rct, cellrct;
114         int y, row, col;
115         
116         v2d= &C->region->v2d;
117         rct= &table->rct;
118         
119         block= uiBeginBlock(C, C->region, "table outliner", UI_EMBOSST, UI_HELV);
120         
121         for(y=rct->ymax, row=0; y>rct->ymin; y-=ROW_HEIGHT, row++) {
122                 if(row%2 == 0) {
123                         UI_ThemeColorShade(TH_BACK, 6);
124                         glRecti(v2d->cur.xmin, y-ROW_HEIGHT, v2d->cur.xmax, y);
125                 }
126
127                 if(row >= table->rows)
128                         continue;
129
130                 for(col=0; col<table->cols; col++) {
131                         cellrct.xmin= rct->xmin+COLUMN_WIDTH*col + 1;
132                         cellrct.xmax= rct->xmin+COLUMN_WIDTH*(col+1);
133                         cellrct.ymin= y-ROW_HEIGHT;
134                         cellrct.ymax= y;
135
136                         table->cellfunc(table->userdata, row, col, &cellrct, block);
137                 }
138         }
139
140         UI_ThemeColorShadeAlpha(TH_BACK, -15, -200);
141
142         for(col=0; col<table->cols; col++)
143                 fdrawline(rct->xmin+COLUMN_WIDTH*(col+1), rct->ymin, rct->xmin+COLUMN_WIDTH*(col+1), rct->ymax);
144
145         uiEndBlock(C, block);
146         uiDrawBlock(block);
147 }
148
149
150 /* ************************ main outliner area region *********************** */
151
152 typedef struct CellRNA {
153         SpaceOops *space;
154         StructRNA *srna;
155         PropertyRNA *prop;
156         PointerRNA ptr;
157         int lastrow, index;
158
159         CollectionPropertyIterator iter;
160 } CellRNA;
161
162 static void rna_back_cb(bContext *C, void *arg_unused, void *arg_unused2)
163 {
164         SpaceOops *soutliner= C->area->spacedata.first;
165         char *newpath;
166
167         newpath= RNA_path_back(soutliner->rnapath);
168         if(soutliner->rnapath)
169                 MEM_freeN(soutliner->rnapath);
170         soutliner->rnapath= newpath;
171 }
172
173 static void rna_pointer_cb(bContext *C, void *arg_prop, void *arg_index)
174 {
175         SpaceOops *soutliner= C->area->spacedata.first;
176         PropertyRNA *prop= arg_prop;
177         char *newpath;
178         int index= GET_INT_FROM_POINTER(arg_index);;
179
180         newpath= RNA_path_append(soutliner->rnapath, NULL, prop, index, NULL);
181         if(soutliner->rnapath)
182                 MEM_freeN(soutliner->rnapath);
183         soutliner->rnapath= newpath;
184 }
185
186 static void rna_label(CellRNA *cell, rcti *rct, uiBlock *block)
187 {
188         PropertySubType subtype;
189         PropertyType type;
190         PropertyRNA *prop;
191         char *vectoritem[4]= {"x", "y", "z", "w"};
192         char *quatitem[4]= {"w", "x", "y", "z"};
193         char *coloritem[4]= {"r", "g", "b", "a"};
194         char item[32];
195         int arraylength;
196
197         prop= cell->prop;
198         type= RNA_property_type(&cell->ptr, prop);
199         subtype= RNA_property_subtype(&cell->ptr, prop);
200         arraylength= RNA_property_array_length(&cell->ptr, prop);
201
202         if(cell->index == -1) {
203                 uiDefBut(block, LABEL, 0, (char*)RNA_property_ui_name(&cell->ptr, prop), rct->xmin, rct->ymin, rct->xmax-rct->xmin, rct->ymax-rct->ymin, 0, 0, 0, 0, 0, (char*)RNA_property_ui_description(&cell->ptr, prop));
204         }
205         else if (type != PROP_COLLECTION) {
206                 if(arraylength == 4 && subtype == PROP_ROTATION)
207                         sprintf(item, "    %s", quatitem[cell->index]);
208                 else if(arraylength <= 4 && (subtype == PROP_VECTOR || subtype == PROP_ROTATION))
209                         sprintf(item, "    %s", vectoritem[cell->index]);
210                 else if(arraylength <= 4 && subtype == PROP_COLOR)
211                         sprintf(item, "    %s", coloritem[cell->index]);
212                 else
213                         sprintf(item, "    %d", cell->index+1);
214
215                 uiDefBut(block, LABEL, 0, item, rct->xmin, rct->ymin, rct->xmax-rct->xmin, rct->ymax-rct->ymin, 0, 0, 0, 0, 0, "");
216         }
217 }
218
219 static void rna_collection_but(CellRNA *cell, rcti *rct, uiBlock *block)
220 {
221         uiBut *but;
222         PointerRNA lookup;
223         PropertyRNA *nameprop;
224         char name[256]= "", *nameptr= name;
225
226         RNA_property_collection_lookup_int(&cell->ptr, cell->prop, cell->index, &lookup);
227
228         if(lookup.data) {
229                 nameprop= RNA_struct_name_property(&lookup);
230
231                 if(nameprop)
232                         nameptr= RNA_property_string_get_alloc(&lookup, nameprop, name, sizeof(name));
233
234                 if(!nameprop || strlen(nameptr) == 0)
235                         sprintf(nameptr, "%d", cell->index+1);
236         }
237
238         but= uiDefBut(block, BUT, 0, nameptr, rct->xmin, rct->ymin, rct->xmax-rct->xmin, rct->ymax-rct->ymin, 0, 0, 0, 0, 0, "");
239         uiButSetFlag(but, UI_TEXT_LEFT);
240
241         if(nameptr != name)
242                 MEM_freeN(nameptr);
243
244         uiButSetFunc(but, rna_pointer_cb, cell->prop, SET_INT_IN_POINTER(cell->index));
245 }
246
247 static void rna_but(CellRNA *cell, rcti *rct, uiBlock *block)
248 {
249         uiBut *but;
250         PropertyRNA *prop;
251         PropertyType type;
252         int arraylength, index;
253
254         prop= cell->prop;
255         type= RNA_property_type(&cell->ptr, prop);
256         arraylength= RNA_property_array_length(&cell->ptr, prop);
257
258         if(type == PROP_COLLECTION) {
259                 /* item in a collection */
260                 if(cell->index >= 0)
261                         rna_collection_but(cell, rct, block);
262         }
263         else {
264                 /* other cases */
265                 index= (arraylength)? cell->index: 0;
266
267                 if(index >= 0) {
268                         but= uiDefRNABut(block, 0, &cell->ptr, prop, index, rct->xmin, rct->ymin, rct->xmax-rct->xmin, rct->ymax-rct->ymin);
269
270                         if(type == PROP_POINTER)
271                                 uiButSetFunc(but, rna_pointer_cb, prop, SET_INT_IN_POINTER(0));
272                 }
273         }
274 }
275
276 static void rna_path_but(CellRNA *cell, rcti *rct, uiBlock *block)
277 {
278         uiBut *but;
279
280         but= uiDefBut(block, BUT, 0, (cell->space->rnapath)? "..": ".", rct->xmin, rct->ymin, rct->xmax-rct->xmin, rct->ymax-rct->ymin, 0, 0, 0, 0, 0, "");
281         uiButSetFlag(but, UI_TEXT_LEFT);
282         uiButSetFunc(but, rna_back_cb, cell->space, NULL);
283 }
284
285 static void rna_table_cell_func(void *userdata, int row, int col, rcti *rct, uiBlock *block)
286 {
287         CellRNA *cell= userdata;
288         PropertyType type;
289         int length;
290
291         /* path button */
292         if(row == 0) {
293                 if(col == 0)
294                         rna_path_but(cell, rct, block);
295
296                 return;
297         }
298
299         /* set next property for new row */
300         if(row != cell->lastrow) {
301                 if(cell->prop) {
302                         cell->index++;
303
304                         type= RNA_property_type(&cell->ptr, cell->prop);
305                         if(type == PROP_COLLECTION)
306                                 length= RNA_property_collection_length(&cell->ptr, cell->prop);
307                         else
308                                 length= RNA_property_array_length(&cell->ptr, cell->prop);
309
310                         /* verify if we need to go to the next property */
311                         if(type == PROP_COLLECTION && cell->index < length);
312                         else if(length && cell->index < length);
313                         else {
314                                 RNA_property_collection_next(&cell->iter);
315                                 cell->prop= cell->iter.ptr.data;
316                                 cell->index= -1;
317                         }
318                 }
319                 else {
320                         /* initialize */
321                         cell->prop= cell->iter.ptr.data;
322                         cell->index= -1;
323                 }
324
325                 cell->lastrow= row;
326         }
327
328         /* make button */
329         if(col == 0)
330                 rna_label(cell, rct, block);
331         else if(col == 1)
332                 rna_but(cell, rct, block);
333 }
334
335 static void outliner_main_area_init(wmWindowManager *wm, ARegion *ar)
336 {
337         UI_view2d_size_update(&ar->v2d, ar->winx, ar->winy);
338
339 }
340
341 static void outliner_main_area_draw(const bContext *C, ARegion *ar)
342 {
343         uiTable *table;
344         rcti rct;
345         CellRNA cell;
346         PropertyRNA *prop, *iterprop;
347         PointerRNA newptr;
348         float col[3];
349         int rows, cols, awidth, aheight, width, height;
350         SpaceOops *soutliner= C->area->spacedata.first;
351         View2D *v2d= &ar->v2d;
352         View2DScrollers *scrollers;
353
354         /* clear */
355         UI_GetThemeColor3fv(TH_BACK, col);
356         glClearColor(col[0], col[1], col[2], 0.0);
357         glClear(GL_COLOR_BUFFER_BIT);
358         
359         awidth= width= ar->winx;
360         aheight= height= ar->winy;
361         
362         /* create table */
363         cell.space= soutliner;
364         cell.lastrow= -1;
365         RNA_main_pointer_create(G.main, &cell.ptr);
366         cell.prop= NULL;
367
368         /* solve RNA path or reset if fails */
369         if(soutliner->rnapath) {
370                 if(!RNA_path_resolve(&cell.ptr, soutliner->rnapath, &newptr, &prop)) {
371                         newptr.data= NULL;
372                         printf("RNA outliner: failed resolving path. (%s)\n", soutliner->rnapath);
373                 }
374
375                 if(newptr.data && newptr.type) {
376                         cell.ptr= newptr;
377                 }
378                 else {
379                         MEM_freeN(soutliner->rnapath);
380                         soutliner->rnapath= NULL;
381                 }
382         }
383
384         /* compute number of rows and columns */
385         rows= 1;
386         cols= 2;
387
388         iterprop= RNA_struct_iterator_property(&cell.ptr);
389         RNA_property_collection_begin(&cell.ptr, iterprop, &cell.iter);
390
391         for(; cell.iter.valid; RNA_property_collection_next(&cell.iter)) {
392                 prop= cell.iter.ptr.data;
393
394                 rows += 1 + RNA_property_array_length(&cell.ptr, prop);
395                 if(RNA_property_type(&cell.ptr, prop) == PROP_COLLECTION)
396                         rows += RNA_property_collection_length(&cell.ptr, prop);
397         }
398
399         RNA_property_collection_end(&cell.iter);
400         
401         /* determine extents of data
402          *      - height must be at least the height of the mask area
403          *      - width is columns + 1, as otherwise, part of last column 
404          *        will be obscured by scrollers
405          */
406         if ((rows*ROW_HEIGHT) > height)
407                 height= rows * ROW_HEIGHT;
408         width= (cols + 1) * COLUMN_WIDTH;
409         
410         /* update size of tot-rect (extents of data/viewable area) */
411         UI_view2d_totRect_set(v2d, width, height);
412         
413         rct.xmin= 0;
414         rct.ymin= -height;
415         rct.xmax= width;
416         rct.ymax= 0;
417         
418         /* set matrix for 2d-view controls */
419         UI_view2d_view_ortho(C, v2d);
420         
421         /* create and draw table */
422         table= UI_table_create(rows, 2, &rct, rna_table_cell_func, &cell);
423
424         RNA_property_collection_begin(&cell.ptr, iterprop, &cell.iter);
425         UI_table_draw(C, table);
426         RNA_property_collection_end(&cell.iter);
427
428         UI_table_free(table);
429         
430         /* reset view matrix */
431         UI_view2d_view_restore(C);
432         
433         /* scrollers */
434         scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
435         UI_view2d_scrollers_draw(C, v2d, scrollers);
436         UI_view2d_scrollers_free(scrollers);
437 }
438
439 static void outliner_main_area_free(ARegion *ar)
440 {
441 }
442
443 /* ************************ header outliner area region *********************** */
444
445
446 static void outliner_header_area_draw(const bContext *C, ARegion *ar)
447 {
448         float col[3];
449         
450         if(ED_screen_area_active(C))
451                 UI_GetThemeColor3fv(TH_HEADER, col);
452         else
453                 UI_GetThemeColor3fv(TH_HEADERDESEL, col);
454         
455         glClearColor(col[0], col[1], col[2], 0.0);
456         glClear(GL_COLOR_BUFFER_BIT);
457
458         outliner_header_buttons(C, ar);
459 }
460
461 static void outliner_header_area_free(ARegion *ar)
462 {
463 }
464
465 /* ******************** default callbacks for outliner space ***************** */
466
467 static SpaceLink *outliner_new(void)
468 {
469         ARegion *ar;
470         SpaceOops *soutliner;
471
472         soutliner= MEM_callocN(sizeof(SpaceOops), "initoutliner");
473
474         /* header */
475         ar= MEM_callocN(sizeof(ARegion), "header for outliner");
476         
477         BLI_addtail(&soutliner->regionbase, ar);
478         ar->regiontype= RGN_TYPE_HEADER;
479         ar->alignment= RGN_ALIGN_BOTTOM;
480         UI_view2d_header_default(&ar->v2d);
481         
482         /* main area */
483         ar= MEM_callocN(sizeof(ARegion), "main area for outliner");
484         
485         BLI_addtail(&soutliner->regionbase, ar);
486         ar->regiontype= RGN_TYPE_WINDOW;
487         
488         ar->v2d.scroll = (V2D_SCROLL_RIGHT|V2D_SCROLL_BOTTOM_O);
489         ar->v2d.align = (V2D_ALIGN_NO_NEG_X|V2D_ALIGN_NO_POS_Y);
490         ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_KEEPZOOM|V2D_KEEPASPECT);
491         ar->v2d.keeptot= 2;     /* XXX make define */
492         
493         return (SpaceLink*)soutliner;
494 }
495
496 static void free_oops(Oops *oops)       /* also oops itself */
497 {
498         BLI_freelistN(&oops->link);
499         MEM_freeN(oops);
500 }
501
502 static void outliner_free_tree(ListBase *lb)
503 {
504         
505         while(lb->first) {
506                 TreeElement *te= lb->first;
507                 
508                 outliner_free_tree(&te->subtree);
509                 BLI_remlink(lb, te);
510                 MEM_freeN(te);
511         }
512 }
513
514 /* not spacelink itself */
515 static void outliner_free(SpaceLink *sl)
516 {
517         SpaceOops *soutliner= (SpaceOops*)sl;
518         Oops *oops;
519
520         if(soutliner->rnapath) {
521                 MEM_freeN(soutliner->rnapath);
522                 soutliner->rnapath= NULL;
523         }
524         
525         while( (oops= soutliner->oops.first) ) {
526                 BLI_remlink(&soutliner->oops, oops);
527                 free_oops(oops);
528         }
529         
530         outliner_free_tree(&soutliner->tree);
531         if(soutliner->treestore) {
532                 if(soutliner->treestore->data) MEM_freeN(soutliner->treestore->data);
533                 MEM_freeN(soutliner->treestore);
534         }
535         
536 }
537
538 /* spacetype; init callback */
539 static void outliner_init(wmWindowManager *wm, ScrArea *sa)
540 {
541         
542 }
543
544 static SpaceLink *outliner_duplicate(SpaceLink *sl)
545 {
546         SpaceOops *soutliner= (SpaceOops *)sl;
547         SpaceOops *soutlinern= MEM_dupallocN(soutliner);
548
549         if(soutlinern->rnapath)
550                 soutlinern->rnapath= MEM_dupallocN(soutlinern->rnapath);
551         
552         soutlinern->oops.first= soutlinern->oops.last= NULL;
553         soutlinern->tree.first= soutlinern->tree.last= NULL;
554         soutlinern->treestore= NULL;
555         
556         return (SpaceLink *)soutlinern;
557 }
558
559 /* only called once, from space_api/spacetypes.c */
560 void ED_spacetype_outliner(void)
561 {
562         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype time");
563         ARegionType *art;
564         
565         st->spaceid= SPACE_OOPS;
566         strncpy(st->name, "Outliner", BKE_ST_MAXNAME);
567         
568         st->new= outliner_new;
569         st->free= outliner_free;
570         st->init= outliner_init;
571         st->duplicate= outliner_duplicate;
572         st->operatortypes= outliner_operatortypes;
573         st->keymap= outliner_keymap;
574         
575         /* regions: main window */
576         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
577         art->regionid = RGN_TYPE_WINDOW;
578         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
579         
580         art->init= outliner_main_area_init;
581         art->draw= outliner_main_area_draw;
582         art->free= outliner_main_area_free;
583         BLI_addhead(&st->regiontypes, art);
584         
585         /* regions: header */
586         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
587         art->regionid = RGN_TYPE_HEADER;
588         art->minsizey= HEADERY;
589         art->keymapflag= ED_KEYMAP_UI;
590         
591         art->draw= outliner_header_area_draw;
592         art->free= outliner_header_area_free;
593         BLI_addhead(&st->regiontypes, art);
594         
595         BKE_spacetype_register(st);
596 }
597