e31f29cec8c448957d281494ebc3975fd231d7ce
[blender.git] / source / blender / editors / space_topbar / space_topbar.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  * The Original Code is Copyright (C) 2017 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup sptopbar
22  */
23
24
25 #include <string.h>
26 #include <stdio.h>
27
28 #include "MEM_guardedalloc.h"
29
30 #include "BLI_blenlib.h"
31 #include "BLI_utildefines.h"
32
33 #include "BLO_readfile.h"
34 #include "BLT_translation.h"
35
36 #include "BKE_context.h"
37 #include "BKE_global.h"
38 #include "BKE_screen.h"
39
40 #include "ED_screen.h"
41 #include "ED_space_api.h"
42 #include "ED_undo.h"
43
44 #include "UI_interface.h"
45 #include "UI_resources.h"
46 #include "UI_view2d.h"
47
48 #include "RNA_access.h"
49
50 #include "WM_api.h"
51 #include "WM_types.h"
52 #include "WM_message.h"
53
54 /* ******************** default callbacks for topbar space ***************** */
55
56 static SpaceLink *topbar_new(const ScrArea *UNUSED(area), const Scene *UNUSED(scene))
57 {
58         ARegion *ar;
59         SpaceTopBar *stopbar;
60
61         stopbar = MEM_callocN(sizeof(*stopbar), "init topbar");
62         stopbar->spacetype = SPACE_TOPBAR;
63
64         /* header */
65         ar = MEM_callocN(sizeof(ARegion), "left aligned header for topbar");
66         BLI_addtail(&stopbar->regionbase, ar);
67         ar->regiontype = RGN_TYPE_HEADER;
68         ar->alignment = RGN_ALIGN_TOP;
69         ar = MEM_callocN(sizeof(ARegion), "right aligned header for topbar");
70         BLI_addtail(&stopbar->regionbase, ar);
71         ar->regiontype = RGN_TYPE_HEADER;
72         ar->alignment = RGN_ALIGN_RIGHT | RGN_SPLIT_PREV;
73
74         /* main regions */
75         ar = MEM_callocN(sizeof(ARegion), "left aligned main region for topbar");
76         BLI_addtail(&stopbar->regionbase, ar);
77         ar->regiontype = RGN_TYPE_WINDOW;
78         ar->alignment = RGN_ALIGN_LEFT;
79         ar = MEM_callocN(sizeof(ARegion), "right aligned main region for topbar");
80         BLI_addtail(&stopbar->regionbase, ar);
81         ar->regiontype = RGN_TYPE_WINDOW;
82         ar->alignment = RGN_ALIGN_RIGHT;
83         ar = MEM_callocN(sizeof(ARegion), "center main region for topbar");
84         BLI_addtail(&stopbar->regionbase, ar);
85         ar->regiontype = RGN_TYPE_WINDOW;
86
87         return (SpaceLink *)stopbar;
88 }
89
90 /* not spacelink itself */
91 static void topbar_free(SpaceLink *UNUSED(sl))
92 {
93
94 }
95
96
97 /* spacetype; init callback */
98 static void topbar_init(struct wmWindowManager *UNUSED(wm), ScrArea *UNUSED(sa))
99 {
100
101 }
102
103 static SpaceLink *topbar_duplicate(SpaceLink *sl)
104 {
105         SpaceTopBar *stopbarn = MEM_dupallocN(sl);
106
107         /* clear or remove stuff from old */
108
109         return (SpaceLink *)stopbarn;
110 }
111
112
113
114 /* add handlers, stuff you only do once or on area/region changes */
115 static void topbar_main_region_init(wmWindowManager *wm, ARegion *region)
116 {
117         wmKeyMap *keymap;
118
119         /* force delayed UI_view2d_region_reinit call */
120         if (ELEM(region->alignment, RGN_ALIGN_LEFT, RGN_ALIGN_RIGHT)) {
121                 region->flag |= RGN_FLAG_DYNAMIC_SIZE;
122         }
123         UI_view2d_region_reinit(&region->v2d, V2D_COMMONVIEW_HEADER, region->winx, region->winy);
124
125         keymap = WM_keymap_ensure(wm->defaultconf, "View2D Buttons List", 0, 0);
126         WM_event_add_keymap_handler(&region->handlers, keymap);
127 }
128
129 static void topbar_operatortypes(void)
130 {
131
132 }
133
134 static void topbar_keymap(struct wmKeyConfig *UNUSED(keyconf))
135 {
136
137 }
138
139 /* add handlers, stuff you only do once or on area/region changes */
140 static void topbar_header_region_init(wmWindowManager *UNUSED(wm), ARegion *ar)
141 {
142         if ((ar->alignment & ~RGN_SPLIT_PREV) == RGN_ALIGN_RIGHT) {
143                 ar->flag |= RGN_FLAG_DYNAMIC_SIZE;
144         }
145         ED_region_header_init(ar);
146 }
147
148 static void topbar_main_region_listener(wmWindow *UNUSED(win), ScrArea *UNUSED(sa), ARegion *ar,
149                                         wmNotifier *wmn, const Scene *UNUSED(scene))
150 {
151         /* context changes */
152         switch (wmn->category) {
153                 case NC_WM:
154                         if (wmn->data == ND_HISTORY)
155                                 ED_region_tag_redraw(ar);
156                         break;
157                 case NC_SCENE:
158                         if (wmn->data == ND_MODE)
159                                 ED_region_tag_redraw(ar);
160                         break;
161                 case NC_SPACE:
162                         if (wmn->data == ND_SPACE_VIEW3D)
163                                 ED_region_tag_redraw(ar);
164                         break;
165                 case NC_GPENCIL:
166                         if (wmn->data == ND_DATA)
167                                 ED_region_tag_redraw(ar);
168                         break;
169         }
170 }
171
172 static void topbar_header_listener(wmWindow *UNUSED(win), ScrArea *UNUSED(sa), ARegion *ar,
173                                    wmNotifier *wmn, const Scene *UNUSED(scene))
174 {
175         /* context changes */
176         switch (wmn->category) {
177                 case NC_WM:
178                         if (wmn->data == ND_JOB)
179                                 ED_region_tag_redraw(ar);
180                         break;
181                 case NC_SPACE:
182                         if (wmn->data == ND_SPACE_INFO)
183                                 ED_region_tag_redraw(ar);
184                         break;
185                 case NC_SCREEN:
186                         if (wmn->data == ND_LAYER)
187                                 ED_region_tag_redraw(ar);
188                         break;
189                 case NC_SCENE:
190                         if (wmn->data == ND_SCENEBROWSE)
191                                 ED_region_tag_redraw(ar);
192                         break;
193         }
194 }
195
196 static void topbar_header_region_message_subscribe(
197         const struct bContext *UNUSED(C),
198         struct WorkSpace *workspace, struct Scene *UNUSED(scene),
199         struct bScreen *UNUSED(screen), struct ScrArea *UNUSED(sa), struct ARegion *ar,
200         struct wmMsgBus *mbus)
201 {
202         wmMsgSubscribeValue msg_sub_value_region_tag_redraw = {
203                 .owner = ar,
204                 .user_data = ar,
205                 .notify = ED_region_do_msg_notify_tag_redraw,
206         };
207
208         WM_msg_subscribe_rna_prop(
209                 mbus, &workspace->id, workspace,
210                 WorkSpace, tools, &msg_sub_value_region_tag_redraw);
211 }
212
213 static void recent_files_menu_draw(const bContext *UNUSED(C), Menu *menu)
214 {
215         struct RecentFile *recent;
216         uiLayout *layout = menu->layout;
217         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_REGION_WIN);
218         if (!BLI_listbase_is_empty(&G.recent_files)) {
219                 for (recent = G.recent_files.first; (recent); recent = recent->next) {
220                         const char *file = BLI_path_basename(recent->filepath);
221                         const int icon = BLO_has_bfile_extension(file) ? ICON_FILE_BLEND : ICON_FILE_BACKUP;
222                         uiItemStringO(layout, file, icon, "WM_OT_open_mainfile", "filepath", recent->filepath);
223                 }
224         }
225         else {
226                 uiItemL(layout, IFACE_("No Recent Files"), ICON_NONE);
227         }
228 }
229
230 static void recent_files_menu_register(void)
231 {
232         MenuType *mt;
233
234         mt = MEM_callocN(sizeof(MenuType), "spacetype info menu recent files");
235         strcpy(mt->idname, "TOPBAR_MT_file_open_recent");
236         strcpy(mt->label, N_("Open Recent"));
237         strcpy(mt->translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
238         mt->draw = recent_files_menu_draw;
239         WM_menutype_add(mt);
240 }
241
242
243 /* only called once, from space/spacetypes.c */
244 void ED_spacetype_topbar(void)
245 {
246         SpaceType *st = MEM_callocN(sizeof(SpaceType), "spacetype topbar");
247         ARegionType *art;
248
249         st->spaceid = SPACE_TOPBAR;
250         strncpy(st->name, "Top Bar", BKE_ST_MAXNAME);
251
252         st->new = topbar_new;
253         st->free = topbar_free;
254         st->init = topbar_init;
255         st->duplicate = topbar_duplicate;
256         st->operatortypes = topbar_operatortypes;
257         st->keymap = topbar_keymap;
258
259         /* regions: main window */
260         art = MEM_callocN(sizeof(ARegionType), "spacetype topbar main region");
261         art->regionid = RGN_TYPE_WINDOW;
262         art->init = topbar_main_region_init;
263         art->layout = ED_region_header_layout;
264         art->draw = ED_region_header_draw;
265         art->listener = topbar_main_region_listener;
266         art->prefsizex = UI_UNIT_X * 5; /* Mainly to avoid glitches */
267         art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_VIEW2D | ED_KEYMAP_HEADER;
268
269         BLI_addhead(&st->regiontypes, art);
270
271         /* regions: header */
272         art = MEM_callocN(sizeof(ARegionType), "spacetype topbar header region");
273         art->regionid = RGN_TYPE_HEADER;
274         art->prefsizey = HEADERY;
275         art->prefsizex = UI_UNIT_X * 5; /* Mainly to avoid glitches */
276         art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_VIEW2D | ED_KEYMAP_HEADER;
277         art->listener = topbar_header_listener;
278         art->message_subscribe = topbar_header_region_message_subscribe;
279         art->init = topbar_header_region_init;
280         art->layout = ED_region_header_layout;
281         art->draw = ED_region_header_draw;
282
283         BLI_addhead(&st->regiontypes, art);
284
285         recent_files_menu_register();
286
287         BKE_spacetype_register(st);
288 }