Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const...
[blender.git] / source / blender / editors / interface / interface_utils.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) 2009 Blender Foundation.
19  * All rights reserved.
20  * 
21  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29
30 #include "DNA_object_types.h"
31
32 #include "BKE_context.h"
33 #include "BKE_utildefines.h"
34
35 #include "RNA_access.h"
36
37 #include "UI_interface.h"
38 #include "UI_resources.h"
39
40
41 /*************************** RNA Utilities ******************************/
42
43 uiBut *uiDefAutoButR(uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, int index, const char *name, int icon, int x1, int y1, int x2, int y2)
44 {
45         uiBut *but=NULL;
46         const char *propname= RNA_property_identifier(prop);
47         char prop_item[sizeof(((IDProperty *)NULL)->name)+4]; /* size of the ID prop name + room for [""] */
48         int arraylen= RNA_property_array_length(ptr, prop);
49
50         /* support for custom props */
51         if(RNA_property_is_idprop(prop)) {
52                 sprintf(prop_item, "[\"%s\"]", propname);
53                 propname= prop_item;
54         }
55
56         switch(RNA_property_type(prop)) {
57                 case PROP_BOOLEAN: {
58                         int value, length;
59
60                         if(arraylen && index == -1)
61                                 return NULL;
62
63                         length= RNA_property_array_length(ptr, prop);
64
65                         if(length)
66                                 value= RNA_property_boolean_get_index(ptr, prop, index);
67                         else
68                                 value= RNA_property_boolean_get(ptr, prop);
69                         
70                         if(icon && name && strcmp(name, "") == 0)
71                                 but= uiDefIconButR(block, ICONTOG, 0, icon, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
72                         else if(icon)
73                                 but= uiDefIconTextButR(block, ICONTOG, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
74                         else
75                                 but= uiDefButR(block, OPTION, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
76                         break;
77                 }
78                 case PROP_INT:
79                 case PROP_FLOAT:
80                         if(arraylen && index == -1) {
81                                 if(ELEM(RNA_property_subtype(prop), PROP_COLOR, PROP_COLOR_GAMMA))
82                                         but= uiDefButR(block, COL, 0, name, x1, y1, x2, y2, ptr, propname, 0, 0, 0, -1, -1, NULL);
83                         }
84                         else if(RNA_property_subtype(prop) == PROP_PERCENTAGE || RNA_property_subtype(prop) == PROP_FACTOR)
85                                 but= uiDefButR(block, NUMSLI, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
86                         else
87                                 but= uiDefButR(block, NUM, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
88                         break;
89                 case PROP_ENUM:
90                         if(icon && name && strcmp(name, "") == 0)
91                                 but= uiDefIconButR(block, MENU, 0, icon, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
92                         else if(icon)
93                                 but= uiDefIconTextButR(block, MENU, 0, icon, NULL, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
94                         else
95                                 but= uiDefButR(block, MENU, 0, NULL, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
96                         break;
97                 case PROP_STRING:
98                         if(icon && name && strcmp(name, "") == 0)
99                                 but= uiDefIconButR(block, TEX, 0, icon, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
100                         else if(icon)
101                                 but= uiDefIconTextButR(block, TEX, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
102                         else
103                                 but= uiDefButR(block, TEX, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
104                         break;
105                 case PROP_POINTER: {
106                         PointerRNA pptr;
107                         int icon;
108
109                         pptr= RNA_property_pointer_get(ptr, prop);
110                         if(!pptr.type)
111                                 pptr.type= RNA_property_pointer_type(ptr, prop);
112                         icon= RNA_struct_ui_icon(pptr.type);
113                         if(icon == ICON_DOT)
114                                 icon= 0;
115
116                         but= uiDefIconTextButR(block, IDPOIN, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
117                         break;
118                 }
119                 case PROP_COLLECTION: {
120                         char text[256];
121                         sprintf(text, "%d items", RNA_property_collection_length(ptr, prop));
122                         but= uiDefBut(block, LABEL, 0, text, x1, y1, x2, y2, NULL, 0, 0, 0, 0, NULL);
123                         uiButSetFlag(but, UI_BUT_DISABLED);
124                         break;
125                 }
126                 default:
127                         but= NULL;
128                         break;
129         }
130
131         return but;
132 }
133
134 void uiDefAutoButsRNA(uiLayout *layout, PointerRNA *ptr, int columns)
135 {
136         uiLayout *split, *col;
137         int flag;
138         char *name;
139
140         RNA_STRUCT_BEGIN(ptr, prop) {
141                 flag= RNA_property_flag(prop);
142                 if(flag & PROP_HIDDEN)
143                         continue;
144
145                 name= (char*)RNA_property_ui_name(prop);
146
147                 if(columns == 1) {
148                         col= uiLayoutColumn(layout, 1);
149                         uiItemL(col, name, 0);
150                 }
151                 else if(columns == 2) {
152                         split = uiLayoutSplit(layout, 0.5f, 0);
153
154                         uiItemL(uiLayoutColumn(split, 0), name, 0);
155                         col= uiLayoutColumn(split, 0);
156                 }
157                 else
158                         col= NULL;
159
160                 uiItemFullR(col, ptr, prop, -1, 0, 0, "", 0);
161         }
162         RNA_STRUCT_END;
163 }
164
165 /***************************** ID Utilities *******************************/
166
167 int uiIconFromID(ID *id)
168 {
169         Object *ob;
170         PointerRNA ptr;
171         short idcode;
172
173         if(id==NULL)
174                 return 0;
175         
176         idcode= GS(id->name);
177
178         /* exception for objects */
179         if(idcode == ID_OB) {
180                 ob= (Object*)id;
181
182                 if(ob->type == OB_EMPTY)
183                         return ICON_EMPTY_DATA;
184                 else
185                         return uiIconFromID(ob->data);
186         }
187
188         /* otherwise get it through RNA, creating the pointer
189            will set the right type, also with subclassing */
190         RNA_id_pointer_create(id, &ptr);
191
192         return (ptr.type)? RNA_struct_ui_icon(ptr.type): 0;
193 }