3212ddb335e549dfe19efc81e0fe76b73759a1a7
[blender.git] / source / blender / makesdna / DNA_workspace_types.h
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 DNA
19  *
20  * Use API in BKE_workspace.h!
21  * Struct members marked with DNA_PRIVATE_WORKSPACE will throw a
22  * warning saying it's deprecated when used outside of workspace.c.
23  */
24
25 #ifndef __DNA_WORKSPACE_TYPES_H__
26 #define __DNA_WORKSPACE_TYPES_H__
27
28 #include "DNA_scene_types.h"
29
30 /* Same logic as DNA_DEPRECATED_ALLOW, but throws 'deprecated'
31  * warnings if DNA_PRIVATE_WORKSPACE_ALLOW is not defined */
32 #ifdef DNA_PRIVATE_WORKSPACE_ALLOW
33    /* allow use of private items */
34 #  define DNA_PRIVATE_WORKSPACE
35 #else
36 #  ifndef DNA_PRIVATE_WORKSPACE
37 #    define DNA_PRIVATE_WORKSPACE DNA_PRIVATE_ATTR
38 #  endif
39 #endif
40
41 #ifdef DNA_PRIVATE_READ_WRITE_ALLOW
42 #  define DNA_PRIVATE_WORKSPACE_READ_WRITE
43 #else
44 #  ifndef DNA_PRIVATE_WORKSPACE_READ_WRITE
45 #    define DNA_PRIVATE_WORKSPACE_READ_WRITE DNA_PRIVATE_WORKSPACE
46 #  endif
47 #endif
48
49 /* Currently testing, allow to disable. */
50 #define USE_WORKSPACE_TOOL
51
52 #
53 #
54 typedef struct bToolRef_Runtime {
55         int cursor;
56
57         /** One of these 3 must be defined. */
58         char keymap[64];
59         char gizmo_group[64];
60         char data_block[64];
61
62         /** Use to infer primary operator to use when setting accelerator keys. */
63         char op[64];
64
65         /** Index when a tool is a member of a group. */
66         int index;
67 } bToolRef_Runtime;
68
69
70 /* Stored per mode. */
71 typedef struct bToolRef {
72         struct bToolRef *next, *prev;
73         char idname[64];
74
75         /** Use to avoid initializing the same tool multiple times. */
76         short tag;
77
78         /** #bToolKey (spacetype, mode), used in 'WM_api.h' */
79         short space_type;
80         /**
81          * Value depends ont the 'space_type', object mode for 3D view, image editor has own mode too.
82          * RNA needs to handle using item function.
83          */
84         int mode;
85
86         /**
87          * Use for tool options, each group's name must match a tool name:
88          *
89          *    {"Tool Name": {"SOME_OT_operator": {...}, ..}, ..}
90          *
91          * This is done since different tools may call the same operators with their own options.
92          */
93         IDProperty *properties;
94
95         /** Variables needed to operate the tool. */
96         bToolRef_Runtime *runtime;
97 } bToolRef;
98
99
100 /**
101  * \brief Wrapper for bScreen.
102  *
103  * bScreens are IDs and thus stored in a main list-base. We also want to store a list-base of them within the
104  * workspace (so each workspace can have its own set of screen-layouts) which would mess with the next/prev pointers.
105  * So we use this struct to wrap a bScreen pointer with another pair of next/prev pointers.
106  */
107 typedef struct WorkSpaceLayout {
108         struct WorkSpaceLayout *next, *prev;
109
110         struct bScreen *screen;
111         /* The name of this layout, we override the RNA name of the screen with this
112          * (but not ID name itself) */
113         /** MAX_NAME. */
114         char name[64] DNA_PRIVATE_WORKSPACE;
115 } WorkSpaceLayout;
116
117 /** Optional tags, which features to use, aligned with #bAddon names by convention. */
118 typedef struct wmOwnerID {
119         struct wmOwnerID *next, *prev;
120         /** MAX_NAME. */
121         char name[64] DNA_PRIVATE_WORKSPACE;
122 } wmOwnerID;
123
124 typedef struct WorkSpace {
125         ID id;
126
127         /** WorkSpaceLayout. */
128         ListBase layouts DNA_PRIVATE_WORKSPACE;
129         /* Store for each hook (so for each window) which layout has
130          * been activated the last time this workspace was visible. */
131         /** WorkSpaceDataRelation. */
132         ListBase hook_layout_relations DNA_PRIVATE_WORKSPACE_READ_WRITE;
133
134         /* Feature tagging (use for addons) */
135         /** #wmOwnerID. */
136         ListBase owner_ids;
137
138         /* should be: '#ifdef USE_WORKSPACE_TOOL'. */
139
140         /** List of #bToolRef */
141         ListBase tools;
142
143         /**
144          * BAD DESIGN WARNING:
145          * This is a workaround for the topbar not knowing which tools spec. */
146         char tools_space_type;
147         /** Type is different for each space-type. */
148         char tools_mode;
149         char _pad[2];
150
151         int object_mode;
152
153         /** Enum eWorkSpaceFlags. */
154         int flags;
155
156         /* Number for workspace tab reordering in the UI. */
157         int order;
158
159         /* Info text from modal operators (runtime). */
160         char *status_text;
161 } WorkSpace;
162
163 /* internal struct, but exported for read/write */
164 #if defined(DNA_PRIVATE_READ_WRITE_ALLOW) || defined(DNA_PRIVATE_WORKSPACE_ALLOW)
165
166 /**
167  * Generic (and simple/primitive) struct for storing a history of assignments/relations
168  * of workspace data to non-workspace data in a listbase inside the workspace.
169  *
170  * Using this we can restore the old state of a workspace if the user switches back to it.
171  *
172  * Usage
173  * =====
174  * When activating a workspace, it should activate the screen-layout that was active in that
175  * workspace before *in this window*.
176  * More concretely:
177  * * There are two windows, win1 and win2.
178  * * Both show workspace ws1, but both also had workspace ws2 activated at some point before.
179  * * Last time ws2 was active in win1, screen-layout sl1 was activated.
180  * * Last time ws2 was active in win2, screen-layout sl2 was activated.
181  * * When changing from ws1 to ws2 in win1, screen-layout sl1 should be activated again.
182  * * When changing from ws1 to ws2 in win2, screen-layout sl2 should be activated again.
183  * So that means we have to store the active screen-layout in a per workspace, per window
184  * relation. This struct is used to store an active screen-layout for each window within the
185  * workspace.
186  * To find the screen-layout to activate for this window-workspace combination, simply lookup
187  * the WorkSpaceDataRelation with the workspace-hook of the window set as parent.
188  */
189 typedef struct WorkSpaceDataRelation {
190         struct WorkSpaceDataRelation *next, *prev;
191
192         /* the data used to identify the relation
193          * (e.g. to find screen-layout (= value) from/for a hook) */
194         void *parent;
195         /* The value for this parent-data/workspace relation */
196         void *value;
197 } WorkSpaceDataRelation;
198
199 #endif /* DNA_PRIVATE_WORKSPACE_READ_WRITE */
200
201 /**
202  * Little wrapper to store data that is going to be per window, but coming from the workspace.
203  * It allows us to keep workspace and window data completely separate.
204  */
205 typedef struct WorkSpaceInstanceHook {
206         WorkSpace *active DNA_PRIVATE_WORKSPACE;
207         struct WorkSpaceLayout *act_layout DNA_PRIVATE_WORKSPACE;
208
209         /* Needed because we can't change workspaces/layouts in running handler loop,
210          * it would break context. */
211         WorkSpace *temp_workspace_store;
212         struct WorkSpaceLayout *temp_layout_store;
213 } WorkSpaceInstanceHook;
214
215 typedef enum eWorkSpaceFlags {
216         WORKSPACE_USE_FILTER_BY_ORIGIN = (1 << 1),
217 } eWorkSpaceFlags;
218
219 #endif /* __DNA_WORKSPACE_TYPES_H__ */