5e4791b8b7a5a267da6f74b007b65aa131437c5e
[blender.git] / source / blender / makesrna / intern / rna_workspace.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup RNA
19  */
20
21 #include "RNA_define.h"
22 #include "RNA_enum_types.h"
23 #include "RNA_types.h"
24
25 #include "BKE_workspace.h"
26
27 #include "ED_render.h"
28
29 #include "RE_engine.h"
30
31 #include "WM_api.h"
32 #include "WM_types.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_workspace_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 #  include "BLI_listbase.h"
41
42 #  include "BKE_global.h"
43
44 #  include "DNA_object_types.h"
45 #  include "DNA_screen_types.h"
46 #  include "DNA_space_types.h"
47
48 #  include "RNA_access.h"
49
50 #  include "WM_toolsystem.h"
51
52 static void rna_window_update_all(Main *UNUSED(bmain),
53                                   Scene *UNUSED(scene),
54                                   PointerRNA *UNUSED(ptr))
55 {
56   WM_main_add_notifier(NC_WINDOW, NULL);
57 }
58
59 void rna_workspace_screens_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
60 {
61   WorkSpace *workspace = ptr->id.data;
62   rna_iterator_listbase_begin(iter, BKE_workspace_layouts_get(workspace), NULL);
63 }
64
65 static PointerRNA rna_workspace_screens_item_get(CollectionPropertyIterator *iter)
66 {
67   WorkSpaceLayout *layout = rna_iterator_listbase_get(iter);
68   bScreen *screen = BKE_workspace_layout_screen_get(layout);
69
70   return rna_pointer_inherit_refine(&iter->parent, &RNA_Screen, screen);
71 }
72
73 /* workspace.owner_ids */
74
75 static wmOwnerID *rna_WorkSpace_owner_ids_new(WorkSpace *workspace, const char *name)
76 {
77   wmOwnerID *owner_id = MEM_callocN(sizeof(*owner_id), __func__);
78   BLI_addtail(&workspace->owner_ids, owner_id);
79   BLI_strncpy(owner_id->name, name, sizeof(owner_id->name));
80   WM_main_add_notifier(NC_WINDOW, NULL);
81   return owner_id;
82 }
83
84 static void rna_WorkSpace_owner_ids_remove(WorkSpace *workspace,
85                                            ReportList *reports,
86                                            PointerRNA *wstag_ptr)
87 {
88   wmOwnerID *owner_id = wstag_ptr->data;
89   if (BLI_remlink_safe(&workspace->owner_ids, owner_id) == false) {
90     BKE_reportf(reports,
91                 RPT_ERROR,
92                 "wmOwnerID '%s' not in workspace '%s'",
93                 owner_id->name,
94                 workspace->id.name + 2);
95     return;
96   }
97
98   MEM_freeN(owner_id);
99   RNA_POINTER_INVALIDATE(wstag_ptr);
100
101   WM_main_add_notifier(NC_WINDOW, NULL);
102 }
103
104 static void rna_WorkSpace_owner_ids_clear(WorkSpace *workspace)
105 {
106   BLI_freelistN(&workspace->owner_ids);
107   WM_main_add_notifier(NC_OBJECT | ND_MODIFIER | NA_REMOVED, workspace);
108 }
109
110 static bToolRef *rna_WorkSpace_tools_from_tkey(WorkSpace *workspace,
111                                                const bToolKey *tkey,
112                                                bool create)
113 {
114   if (create) {
115     bToolRef *tref;
116     WM_toolsystem_ref_ensure(workspace, tkey, &tref);
117     return tref;
118   }
119   return WM_toolsystem_ref_find(workspace, tkey);
120 }
121
122 static bToolRef *rna_WorkSpace_tools_from_space_view3d_mode(WorkSpace *workspace,
123                                                             int mode,
124                                                             bool create)
125 {
126   return rna_WorkSpace_tools_from_tkey(workspace,
127                                        &(bToolKey){
128                                            .space_type = SPACE_VIEW3D,
129                                            .mode = mode,
130                                        },
131                                        create);
132 }
133
134 static bToolRef *rna_WorkSpace_tools_from_space_image_mode(WorkSpace *workspace,
135                                                            int mode,
136                                                            bool create)
137 {
138   return rna_WorkSpace_tools_from_tkey(workspace,
139                                        &(bToolKey){
140                                            .space_type = SPACE_IMAGE,
141                                            .mode = mode,
142                                        },
143                                        create);
144 }
145
146 static bToolRef *rna_WorkSpace_tools_from_space_node(WorkSpace *workspace, bool create)
147 {
148   return rna_WorkSpace_tools_from_tkey(workspace,
149                                        &(bToolKey){
150                                            .space_type = SPACE_NODE,
151                                            .mode = 0,
152                                        },
153                                        create);
154 }
155
156 const EnumPropertyItem *rna_WorkSpace_tools_mode_itemf(bContext *UNUSED(C),
157                                                        PointerRNA *ptr,
158                                                        PropertyRNA *UNUSED(prop),
159                                                        bool *UNUSED(r_free))
160 {
161   WorkSpace *workspace = ptr->id.data;
162
163   switch (workspace->tools_space_type) {
164     case SPACE_VIEW3D:
165       return rna_enum_context_mode_items;
166     case SPACE_IMAGE:
167       return rna_enum_space_image_mode_all_items;
168   }
169   return DummyRNA_DEFAULT_items;
170 }
171
172 static int rna_WorkSpaceTool_index_get(PointerRNA *ptr)
173 {
174   bToolRef *tref = ptr->data;
175   return (tref->runtime) ? tref->runtime->index : 0;
176 }
177
178 static int rna_WorkSpaceTool_has_datablock_get(PointerRNA *ptr)
179 {
180   bToolRef *tref = ptr->data;
181   return (tref->runtime) ? (tref->runtime->data_block[0] != '\0') : false;
182 }
183
184 static void rna_WorkSpaceTool_widget_get(PointerRNA *ptr, char *value)
185 {
186   bToolRef *tref = ptr->data;
187   strcpy(value, tref->runtime ? tref->runtime->gizmo_group : "");
188 }
189
190 static int rna_WorkSpaceTool_widget_length(PointerRNA *ptr)
191 {
192   bToolRef *tref = ptr->data;
193   return tref->runtime ? strlen(tref->runtime->gizmo_group) : 0;
194 }
195
196 #else /* RNA_RUNTIME */
197
198 static void rna_def_workspace_owner(BlenderRNA *brna)
199 {
200   StructRNA *srna;
201   PropertyRNA *prop;
202
203   srna = RNA_def_struct(brna, "wmOwnerID", NULL);
204   RNA_def_struct_sdna(srna, "wmOwnerID");
205   RNA_def_struct_clear_flag(srna, STRUCT_UNDO);
206   RNA_def_struct_ui_text(srna, "Work Space UI Tag", "");
207
208   prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
209   RNA_def_property_ui_text(prop, "Name", "");
210   RNA_def_struct_name_property(srna, prop);
211 }
212
213 static void rna_def_workspace_owner_ids(BlenderRNA *brna, PropertyRNA *cprop)
214 {
215   StructRNA *srna;
216
217   FunctionRNA *func;
218   PropertyRNA *parm;
219
220   RNA_def_property_srna(cprop, "wmOwnerIDs");
221   srna = RNA_def_struct(brna, "wmOwnerIDs", NULL);
222   RNA_def_struct_sdna(srna, "WorkSpace");
223   RNA_def_struct_ui_text(srna, "WorkSpace UI Tags", "");
224
225   /* add owner_id */
226   func = RNA_def_function(srna, "new", "rna_WorkSpace_owner_ids_new");
227   RNA_def_function_ui_description(func, "Add ui tag");
228   parm = RNA_def_string(func, "name", "Name", 0, "", "New name for the tag");
229   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
230   /* return type */
231   parm = RNA_def_pointer(func, "owner_id", "wmOwnerID", "", "");
232   RNA_def_function_return(func, parm);
233
234   /* remove owner_id */
235   func = RNA_def_function(srna, "remove", "rna_WorkSpace_owner_ids_remove");
236   RNA_def_function_flag(func, FUNC_USE_REPORTS);
237   RNA_def_function_ui_description(func, "Remove ui tag");
238   /* owner_id to remove */
239   parm = RNA_def_pointer(func, "owner_id", "wmOwnerID", "", "Tag to remove");
240   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
241   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
242
243   /* clear all modifiers */
244   func = RNA_def_function(srna, "clear", "rna_WorkSpace_owner_ids_clear");
245   RNA_def_function_ui_description(func, "Remove all tags");
246 }
247
248 static void rna_def_workspace_tool(BlenderRNA *brna)
249 {
250   StructRNA *srna;
251   PropertyRNA *prop;
252
253   srna = RNA_def_struct(brna, "WorkSpaceTool", NULL);
254   RNA_def_struct_sdna(srna, "bToolRef");
255   RNA_def_struct_clear_flag(srna, STRUCT_UNDO);
256   RNA_def_struct_ui_text(srna, "Work Space Tool", "");
257
258   prop = RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
259   RNA_def_property_ui_text(prop, "Identifier", "");
260   RNA_def_struct_name_property(srna, prop);
261
262   prop = RNA_def_property(srna, "index", PROP_INT, PROP_NONE);
263   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
264   RNA_def_property_ui_text(prop, "Index", "");
265   RNA_def_property_int_funcs(prop, "rna_WorkSpaceTool_index_get", NULL, NULL);
266
267   prop = RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
268   RNA_def_property_enum_sdna(prop, NULL, "space_type");
269   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
270   RNA_def_property_enum_items(prop, rna_enum_space_type_items);
271   RNA_def_property_ui_text(prop, "Space Type", "");
272
273   prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
274   RNA_def_property_enum_sdna(prop, NULL, "mode");
275   RNA_def_property_enum_items(prop, DummyRNA_DEFAULT_items);
276   RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_WorkSpace_tools_mode_itemf");
277   RNA_def_property_ui_text(prop, "Tool Mode", "");
278   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
279
280   RNA_define_verify_sdna(0);
281   prop = RNA_def_property(srna, "has_datablock", PROP_BOOLEAN, PROP_NONE);
282   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
283   RNA_def_property_ui_text(prop, "Has Datablock", "");
284   RNA_def_property_boolean_funcs(prop, "rna_WorkSpaceTool_has_datablock_get", NULL);
285   RNA_define_verify_sdna(1);
286
287   prop = RNA_def_property(srna, "widget", PROP_STRING, PROP_NONE);
288   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
289   RNA_def_property_ui_text(prop, "Widget", "");
290   RNA_def_property_string_funcs(
291       prop, "rna_WorkSpaceTool_widget_get", "rna_WorkSpaceTool_widget_length", NULL);
292   RNA_define_verify_sdna(1);
293
294   RNA_api_workspace_tool(srna);
295 }
296
297 static void rna_def_workspace_tools(BlenderRNA *brna, PropertyRNA *cprop)
298 {
299   StructRNA *srna;
300
301   FunctionRNA *func;
302   PropertyRNA *parm;
303
304   RNA_def_property_srna(cprop, "wmTools");
305   srna = RNA_def_struct(brna, "wmTools", NULL);
306   RNA_def_struct_sdna(srna, "WorkSpace");
307   RNA_def_struct_ui_text(srna, "WorkSpace UI Tags", "");
308
309   /* add owner_id */
310   func = RNA_def_function(
311       srna, "from_space_view3d_mode", "rna_WorkSpace_tools_from_space_view3d_mode");
312   RNA_def_function_ui_description(func, "");
313   parm = RNA_def_enum(func, "mode", rna_enum_context_mode_items, 0, "", "");
314   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
315   RNA_def_boolean(func, "create", false, "Create", "");
316   /* return type */
317   parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
318   RNA_def_function_return(func, parm);
319
320   func = RNA_def_function(
321       srna, "from_space_image_mode", "rna_WorkSpace_tools_from_space_image_mode");
322   RNA_def_function_ui_description(func, "");
323   parm = RNA_def_enum(func, "mode", rna_enum_space_image_mode_all_items, 0, "", "");
324   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
325   RNA_def_boolean(func, "create", false, "Create", "");
326   /* return type */
327   parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
328   RNA_def_function_return(func, parm);
329
330   func = RNA_def_function(srna, "from_space_node", "rna_WorkSpace_tools_from_space_node");
331   RNA_def_function_ui_description(func, "");
332   RNA_def_boolean(func, "create", false, "Create", "");
333   /* return type */
334   parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
335   RNA_def_function_return(func, parm);
336 }
337
338 static void rna_def_workspace(BlenderRNA *brna)
339 {
340   StructRNA *srna;
341   PropertyRNA *prop;
342
343   srna = RNA_def_struct(brna, "WorkSpace", "ID");
344   RNA_def_struct_sdna(srna, "WorkSpace");
345   RNA_def_struct_ui_text(
346       srna, "Workspace", "Workspace data-block, defining the working environment for the user");
347   /* TODO: real icon, just to show something */
348   RNA_def_struct_ui_icon(srna, ICON_WORKSPACE);
349
350   prop = RNA_def_property(srna, "screens", PROP_COLLECTION, PROP_NONE);
351   RNA_def_property_collection_sdna(prop, NULL, "layouts", NULL);
352   RNA_def_property_struct_type(prop, "Screen");
353   RNA_def_property_collection_funcs(prop,
354                                     "rna_workspace_screens_begin",
355                                     NULL,
356                                     NULL,
357                                     "rna_workspace_screens_item_get",
358                                     NULL,
359                                     NULL,
360                                     NULL,
361                                     NULL);
362   RNA_def_property_ui_text(prop, "Screens", "Screen layouts of a workspace");
363
364   prop = RNA_def_property(srna, "owner_ids", PROP_COLLECTION, PROP_NONE);
365   RNA_def_property_struct_type(prop, "wmOwnerID");
366   RNA_def_property_ui_text(prop, "UI Tags", "");
367   rna_def_workspace_owner_ids(brna, prop);
368
369   prop = RNA_def_property(srna, "tools", PROP_COLLECTION, PROP_NONE);
370   RNA_def_property_collection_sdna(prop, NULL, "tools", NULL);
371   RNA_def_property_struct_type(prop, "WorkSpaceTool");
372   RNA_def_property_ui_text(prop, "Tools", "");
373   rna_def_workspace_tools(brna, prop);
374
375   prop = RNA_def_property(srna, "tools_space_type", PROP_ENUM, PROP_NONE);
376   RNA_def_property_enum_sdna(prop, NULL, "tools_space_type");
377   RNA_def_property_enum_items(prop, rna_enum_space_type_items);
378   RNA_def_property_ui_text(prop, "Active Tool Space", "");
379   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
380
381   prop = RNA_def_property(srna, "tools_mode", PROP_ENUM, PROP_NONE);
382   RNA_def_property_enum_sdna(prop, NULL, "tools_mode");
383   RNA_def_property_enum_items(prop, DummyRNA_DEFAULT_items);
384   RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_WorkSpace_tools_mode_itemf");
385   RNA_def_property_ui_text(prop, "Active Tool Mode", "");
386   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
387
388   prop = RNA_def_property(srna, "object_mode", PROP_ENUM, PROP_NONE);
389   RNA_def_property_enum_items(prop, rna_enum_workspace_object_mode_items);
390   RNA_def_property_ui_text(
391       prop, "Object Mode", "Switch to this object mode when activating the workspace");
392
393   /* Flags */
394   prop = RNA_def_property(srna, "use_filter_by_owner", PROP_BOOLEAN, PROP_NONE);
395   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
396   RNA_def_property_boolean_sdna(prop, NULL, "flags", WORKSPACE_USE_FILTER_BY_ORIGIN);
397   RNA_def_property_ui_text(prop, "Use UI Tags", "Filter the UI by tags");
398   RNA_def_property_update(prop, 0, "rna_window_update_all");
399
400   RNA_api_workspace(srna);
401 }
402
403 void RNA_def_workspace(BlenderRNA *brna)
404 {
405   rna_def_workspace_owner(brna);
406   rna_def_workspace_tool(brna);
407
408   rna_def_workspace(brna);
409 }
410
411 #endif /* RNA_RUNTIME */