ab68b3cfcf8377e9c815a432b5503656c58dbd30
[blender.git] / source / blender / editors / screen / area.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) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edscr
22  */
23
24 #include <string.h>
25 #include <stdio.h>
26
27 #include "MEM_guardedalloc.h"
28
29 #include "DNA_userdef_types.h"
30
31 #include "BLI_blenlib.h"
32 #include "BLI_math.h"
33 #include "BLI_utildefines.h"
34 #include "BLI_linklist_stack.h"
35
36 #include "BKE_context.h"
37 #include "BKE_global.h"
38 #include "BKE_image.h"
39 #include "BKE_screen.h"
40 #include "BKE_workspace.h"
41
42 #include "RNA_access.h"
43 #include "RNA_types.h"
44
45 #include "WM_api.h"
46 #include "WM_types.h"
47 #include "WM_message.h"
48 #include "WM_toolsystem.h"
49
50 #include "ED_screen.h"
51 #include "ED_screen_types.h"
52 #include "ED_space_api.h"
53
54 #include "GPU_immediate.h"
55 #include "GPU_immediate_util.h"
56 #include "GPU_matrix.h"
57 #include "GPU_draw.h"
58 #include "GPU_state.h"
59 #include "GPU_framebuffer.h"
60
61 #include "BLF_api.h"
62
63 #include "IMB_imbuf.h"
64 #include "IMB_imbuf_types.h"
65 #include "IMB_metadata.h"
66
67 #include "UI_interface.h"
68 #include "UI_interface_icons.h"
69 #include "UI_resources.h"
70 #include "UI_view2d.h"
71
72 #include "screen_intern.h"
73
74 enum RegionEmbossSide {
75   REGION_EMBOSS_LEFT = (1 << 0),
76   REGION_EMBOSS_TOP = (1 << 1),
77   REGION_EMBOSS_BOTTOM = (1 << 2),
78   REGION_EMBOSS_RIGHT = (1 << 3),
79   REGION_EMBOSS_ALL = REGION_EMBOSS_LEFT | REGION_EMBOSS_TOP | REGION_EMBOSS_RIGHT |
80                       REGION_EMBOSS_BOTTOM,
81 };
82
83 /* general area and region code */
84
85 static void region_draw_emboss(const ARegion *ar, const rcti *scirct, int sides)
86 {
87   rcti rect;
88
89   /* translate scissor rect to region space */
90   rect.xmin = scirct->xmin - ar->winrct.xmin;
91   rect.ymin = scirct->ymin - ar->winrct.ymin;
92   rect.xmax = scirct->xmax - ar->winrct.xmin;
93   rect.ymax = scirct->ymax - ar->winrct.ymin;
94
95   /* set transp line */
96   GPU_blend(true);
97   GPU_blend_set_func_separate(
98       GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
99
100   float color[4] = {0.0f, 0.0f, 0.0f, 0.25f};
101   UI_GetThemeColor3fv(TH_EDITOR_OUTLINE, color);
102
103   GPUVertFormat *format = immVertexFormat();
104   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
105   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
106   immUniformColor4fv(color);
107
108   immBeginAtMost(GPU_PRIM_LINES, 8);
109
110   /* right */
111   if (sides & REGION_EMBOSS_RIGHT) {
112     immVertex2f(pos, rect.xmax, rect.ymax);
113     immVertex2f(pos, rect.xmax, rect.ymin);
114   }
115
116   /* bottom */
117   if (sides & REGION_EMBOSS_BOTTOM) {
118     immVertex2f(pos, rect.xmax, rect.ymin);
119     immVertex2f(pos, rect.xmin, rect.ymin);
120   }
121
122   /* left */
123   if (sides & REGION_EMBOSS_LEFT) {
124     immVertex2f(pos, rect.xmin, rect.ymin);
125     immVertex2f(pos, rect.xmin, rect.ymax);
126   }
127
128   /* top */
129   if (sides & REGION_EMBOSS_TOP) {
130     immVertex2f(pos, rect.xmin, rect.ymax);
131     immVertex2f(pos, rect.xmax, rect.ymax);
132   }
133
134   immEnd();
135   immUnbindProgram();
136
137   GPU_blend(false);
138   glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
139 }
140
141 void ED_region_pixelspace(ARegion *ar)
142 {
143   wmOrtho2_region_pixelspace(ar);
144   GPU_matrix_identity_set();
145 }
146
147 /* only exported for WM */
148 void ED_region_do_listen(
149     wmWindow *win, ScrArea *sa, ARegion *ar, wmNotifier *note, const Scene *scene)
150 {
151   /* generic notes first */
152   switch (note->category) {
153     case NC_WM:
154       if (note->data == ND_FILEREAD) {
155         ED_region_tag_redraw(ar);
156       }
157       break;
158     case NC_WINDOW:
159       ED_region_tag_redraw(ar);
160       break;
161   }
162
163   if (ar->type && ar->type->listener) {
164     ar->type->listener(win, sa, ar, note, scene);
165   }
166 }
167
168 /* only exported for WM */
169 void ED_area_do_listen(wmWindow *win, ScrArea *sa, wmNotifier *note, Scene *scene)
170 {
171   /* no generic notes? */
172   if (sa->type && sa->type->listener) {
173     sa->type->listener(win, sa, note, scene);
174   }
175 }
176
177 /* only exported for WM */
178 void ED_area_do_refresh(bContext *C, ScrArea *sa)
179 {
180   /* no generic notes? */
181   if (sa->type && sa->type->refresh) {
182     sa->type->refresh(C, sa);
183   }
184   sa->do_refresh = false;
185 }
186
187 /**
188  * \brief Corner widget use for quitting fullscreen.
189  */
190 static void area_draw_azone_fullscreen(short x1, short y1, short x2, short y2, float alpha)
191 {
192   int x = x2 - ((float)x2 - x1) * 0.5f / UI_DPI_FAC;
193   int y = y2 - ((float)y2 - y1) * 0.5f / UI_DPI_FAC;
194
195   /* adjust the icon distance from the corner */
196   x += 36.0f / UI_DPI_FAC;
197   y += 36.0f / UI_DPI_FAC;
198
199   /* draws from the left bottom corner of the icon */
200   x -= UI_DPI_ICON_SIZE;
201   y -= UI_DPI_ICON_SIZE;
202
203   alpha = min_ff(alpha, 0.75f);
204
205   UI_icon_draw_aspect(x, y, ICON_FULLSCREEN_EXIT, 0.7f / UI_DPI_FAC, alpha, NULL);
206
207   /* debug drawing :
208    * The click_rect is the same as defined in fullscreen_click_rcti_init
209    * Keep them both in sync */
210
211   if (G.debug_value == 101) {
212     rcti click_rect;
213     float icon_size = UI_DPI_ICON_SIZE + 7 * UI_DPI_FAC;
214
215     BLI_rcti_init(&click_rect, x, x + icon_size, y, y + icon_size);
216
217     GPUVertFormat *format = immVertexFormat();
218     uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
219
220     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
221
222     immUniformColor4f(1.0f, 0.0f, 0.0f, alpha);
223     imm_draw_box_wire_2d(pos, click_rect.xmin, click_rect.ymin, click_rect.xmax, click_rect.ymax);
224
225     immUniformColor4f(0.0f, 1.0f, 1.0f, alpha);
226     immBegin(GPU_PRIM_LINES, 4);
227     immVertex2f(pos, click_rect.xmin, click_rect.ymin);
228     immVertex2f(pos, click_rect.xmax, click_rect.ymax);
229     immVertex2f(pos, click_rect.xmin, click_rect.ymax);
230     immVertex2f(pos, click_rect.xmax, click_rect.ymin);
231     immEnd();
232
233     immUnbindProgram();
234   }
235 }
236
237 /**
238  * \brief Corner widgets use for dragging and splitting the view.
239  */
240 static void area_draw_azone(short UNUSED(x1), short UNUSED(y1), short UNUSED(x2), short UNUSED(y2))
241 {
242   /* No drawing needed since all corners are action zone, and visually distinguishable. */
243 }
244
245 /**
246  * \brief Edge widgets to show hidden panels such as the toolbar and headers.
247  */
248 static void draw_azone_arrow(float x1, float y1, float x2, float y2, AZEdge edge)
249 {
250   const float size = 0.2f * U.widget_unit;
251   const float l = 1.0f;  /* arrow length */
252   const float s = 0.25f; /* arrow thickness */
253   const float hl = l / 2.0f;
254   const float points[6][2] = {
255       {0, -hl}, {l, hl}, {l - s, hl + s}, {0, s + s - hl}, {s - l, hl + s}, {-l, hl}};
256   const float center[2] = {(x1 + x2) / 2, (y1 + y2) / 2};
257
258   int axis;
259   int sign;
260   switch (edge) {
261     case AE_BOTTOM_TO_TOPLEFT:
262       axis = 0;
263       sign = 1;
264       break;
265     case AE_TOP_TO_BOTTOMRIGHT:
266       axis = 0;
267       sign = -1;
268       break;
269     case AE_LEFT_TO_TOPRIGHT:
270       axis = 1;
271       sign = 1;
272       break;
273     case AE_RIGHT_TO_TOPLEFT:
274       axis = 1;
275       sign = -1;
276       break;
277     default:
278       BLI_assert(0);
279       return;
280   }
281
282   GPUVertFormat *format = immVertexFormat();
283   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
284
285   GPU_blend(true);
286   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
287   immUniformColor4f(0.8f, 0.8f, 0.8f, 0.4f);
288
289   immBegin(GPU_PRIM_TRI_FAN, 6);
290   for (int i = 0; i < 6; i++) {
291     if (axis == 0) {
292       immVertex2f(pos, center[0] + points[i][0] * size, center[1] + points[i][1] * sign * size);
293     }
294     else {
295       immVertex2f(pos, center[0] + points[i][1] * sign * size, center[1] + points[i][0] * size);
296     }
297   }
298   immEnd();
299
300   immUnbindProgram();
301   GPU_blend(false);
302 }
303
304 static void region_draw_azone_tab_arrow(AZone *az)
305 {
306   GPU_blend(true);
307
308   /* add code to draw region hidden as 'too small' */
309   switch (az->edge) {
310     case AE_TOP_TO_BOTTOMRIGHT:
311       UI_draw_roundbox_corner_set(UI_CNR_TOP_LEFT | UI_CNR_TOP_RIGHT);
312       break;
313     case AE_BOTTOM_TO_TOPLEFT:
314       UI_draw_roundbox_corner_set(UI_CNR_BOTTOM_RIGHT | UI_CNR_BOTTOM_LEFT);
315       break;
316     case AE_LEFT_TO_TOPRIGHT:
317       UI_draw_roundbox_corner_set(UI_CNR_TOP_LEFT | UI_CNR_BOTTOM_LEFT);
318       break;
319     case AE_RIGHT_TO_TOPLEFT:
320       UI_draw_roundbox_corner_set(UI_CNR_TOP_RIGHT | UI_CNR_BOTTOM_RIGHT);
321       break;
322   }
323
324   float color[4] = {0.05f, 0.05f, 0.05f, 0.4f};
325   UI_draw_roundbox_aa(
326       true, (float)az->x1, (float)az->y1, (float)az->x2, (float)az->y2, 4.0f, color);
327
328   draw_azone_arrow((float)az->x1, (float)az->y1, (float)az->x2, (float)az->y2, az->edge);
329 }
330
331 static void area_azone_tag_update(ScrArea *sa)
332 {
333   sa->flag |= AREA_FLAG_ACTIONZONES_UPDATE;
334 }
335
336 static void region_draw_azones(ScrArea *sa, ARegion *ar)
337 {
338   AZone *az;
339
340   if (!sa) {
341     return;
342   }
343
344   GPU_line_width(1.0f);
345   GPU_blend(true);
346   GPU_blend_set_func_separate(
347       GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
348
349   GPU_matrix_push();
350   GPU_matrix_translate_2f(-ar->winrct.xmin, -ar->winrct.ymin);
351
352   for (az = sa->actionzones.first; az; az = az->next) {
353     /* test if action zone is over this region */
354     rcti azrct;
355     BLI_rcti_init(&azrct, az->x1, az->x2, az->y1, az->y2);
356
357     if (BLI_rcti_isect(&ar->drawrct, &azrct, NULL)) {
358       if (az->type == AZONE_AREA) {
359         area_draw_azone(az->x1, az->y1, az->x2, az->y2);
360       }
361       else if (az->type == AZONE_REGION) {
362         if (az->ar) {
363           /* only display tab or icons when the region is hidden */
364           if (az->ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL)) {
365             region_draw_azone_tab_arrow(az);
366           }
367         }
368       }
369       else if (az->type == AZONE_FULLSCREEN) {
370         area_draw_azone_fullscreen(az->x1, az->y1, az->x2, az->y2, az->alpha);
371       }
372     }
373     if (!IS_EQF(az->alpha, 0.0f) && ELEM(az->type, AZONE_FULLSCREEN, AZONE_REGION_SCROLL)) {
374       area_azone_tag_update(sa);
375     }
376   }
377
378   GPU_matrix_pop();
379
380   GPU_blend(false);
381 }
382
383 static void region_draw_status_text(ScrArea *sa, ARegion *ar)
384 {
385   bool overlap = ED_region_is_overlap(sa->spacetype, ar->regiontype);
386
387   if (overlap) {
388     GPU_clear_color(0.0, 0.0, 0.0, 0.0);
389     glClear(GL_COLOR_BUFFER_BIT);
390   }
391   else {
392     UI_ThemeClearColor(TH_HEADER);
393     glClear(GL_COLOR_BUFFER_BIT);
394   }
395
396   int fontid = BLF_set_default();
397
398   const float width = BLF_width(fontid, ar->headerstr, BLF_DRAW_STR_DUMMY_MAX);
399   const float x = UI_UNIT_X;
400   const float y = 0.4f * UI_UNIT_Y;
401
402   if (overlap) {
403     const float pad = 2.0f * UI_DPI_FAC;
404     const float x1 = x - (UI_UNIT_X - pad);
405     const float x2 = x + width + (UI_UNIT_X - pad);
406     const float y1 = pad;
407     const float y2 = ar->winy - pad;
408
409     GPU_blend_set_func_separate(
410         GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
411
412     float color[4] = {0.0f, 0.0f, 0.0f, 0.5f};
413     UI_GetThemeColor3fv(TH_BACK, color);
414     UI_draw_roundbox_corner_set(UI_CNR_ALL);
415     UI_draw_roundbox_aa(true, x1, y1, x2, y2, 4.0f, color);
416
417     UI_FontThemeColor(fontid, TH_TEXT);
418   }
419   else {
420     UI_FontThemeColor(fontid, TH_TEXT);
421   }
422
423   BLF_position(fontid, x, y, 0.0f);
424   BLF_draw(fontid, ar->headerstr, BLF_DRAW_STR_DUMMY_MAX);
425 }
426
427 void ED_region_do_msg_notify_tag_redraw(
428     /* Follow wmMsgNotifyFn spec */
429     bContext *UNUSED(C),
430     wmMsgSubscribeKey *UNUSED(msg_key),
431     wmMsgSubscribeValue *msg_val)
432 {
433   ARegion *ar = msg_val->owner;
434   ED_region_tag_redraw(ar);
435
436   /* This avoids _many_ situations where header/properties control display settings.
437    * the common case is space properties in the header */
438   if (ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER, RGN_TYPE_UI)) {
439     while (ar && ar->prev) {
440       ar = ar->prev;
441     }
442     for (; ar; ar = ar->next) {
443       if (ELEM(ar->regiontype, RGN_TYPE_WINDOW, RGN_TYPE_CHANNELS)) {
444         ED_region_tag_redraw(ar);
445       }
446     }
447   }
448 }
449
450 void ED_area_do_msg_notify_tag_refresh(
451     /* Follow wmMsgNotifyFn spec */
452     bContext *UNUSED(C),
453     wmMsgSubscribeKey *UNUSED(msg_key),
454     wmMsgSubscribeValue *msg_val)
455 {
456   ScrArea *sa = msg_val->user_data;
457   ED_area_tag_refresh(sa);
458 }
459
460 static void region_do_msg_notify_tag_redraw(
461     /* Follow wmMsgNotifyFn spec */
462     bContext *UNUSED(C),
463     wmMsgSubscribeKey *UNUSED(msg_key),
464     wmMsgSubscribeValue *msg_val)
465 {
466   ARegion *ar = msg_val->owner;
467   ED_region_tag_redraw(ar);
468
469   /* FIXME(campbell): shouldn't be needed. */
470   WM_main_add_notifier(NC_SPACE | ND_SPACE_VIEW3D, NULL);
471 }
472
473 void ED_area_do_mgs_subscribe_for_tool_header(
474     /* Follow ARegionType.message_subscribe */
475     const struct bContext *UNUSED(C),
476     struct WorkSpace *workspace,
477     struct Scene *UNUSED(scene),
478     struct bScreen *UNUSED(screen),
479     struct ScrArea *UNUSED(sa),
480     struct ARegion *ar,
481     struct wmMsgBus *mbus)
482 {
483   wmMsgSubscribeValue msg_sub_value_region_tag_redraw = {
484       .owner = ar,
485       .user_data = ar,
486       /* TODO(campbell): investigate why
487        * ED_region_do_msg_notify_tag_redraw doesn't work here. */
488       // .notify = ED_region_do_msg_notify_tag_redraw,
489       .notify = region_do_msg_notify_tag_redraw,
490   };
491   WM_msg_subscribe_rna_prop(
492       mbus, &workspace->id, workspace, WorkSpace, tools, &msg_sub_value_region_tag_redraw);
493 }
494
495 /**
496  * Although there's no general support for minimizing areas, the status-bar can
497  * be snapped to be only a few pixels high. A few pixels rather than 0 so it
498  * can be un-minimized again. We consider it pseudo-minimized and don't draw
499  * it then.
500  */
501 static bool area_is_pseudo_minimized(const ScrArea *area)
502 {
503   return (area->winx < 3) || (area->winy < 3);
504 }
505
506 /* only exported for WM */
507 void ED_region_do_layout(bContext *C, ARegion *ar)
508 {
509   /* This is optional, only needed for dynamically sized regions. */
510   ScrArea *sa = CTX_wm_area(C);
511   ARegionType *at = ar->type;
512
513   if (!at->layout) {
514     return;
515   }
516
517   if (at->do_lock || (sa && area_is_pseudo_minimized(sa))) {
518     return;
519   }
520
521   ar->do_draw |= RGN_DRAWING;
522
523   UI_SetTheme(sa ? sa->spacetype : 0, at->regionid);
524   at->layout(C, ar);
525 }
526
527 /* only exported for WM */
528 void ED_region_do_draw(bContext *C, ARegion *ar)
529 {
530   wmWindow *win = CTX_wm_window(C);
531   ScrArea *sa = CTX_wm_area(C);
532   ARegionType *at = ar->type;
533
534   /* see BKE_spacedata_draw_locks() */
535   if (at->do_lock) {
536     return;
537   }
538
539   ar->do_draw |= RGN_DRAWING;
540
541   /* Set viewport, scissor, ortho and ar->drawrct. */
542   wmPartialViewport(&ar->drawrct, &ar->winrct, &ar->drawrct);
543
544   wmOrtho2_region_pixelspace(ar);
545
546   UI_SetTheme(sa ? sa->spacetype : 0, at->regionid);
547
548   if (sa && area_is_pseudo_minimized(sa)) {
549     UI_ThemeClearColor(TH_EDITOR_OUTLINE);
550     glClear(GL_COLOR_BUFFER_BIT);
551     return;
552   }
553   /* optional header info instead? */
554   else if (ar->headerstr) {
555     region_draw_status_text(sa, ar);
556   }
557   else if (at->draw) {
558     at->draw(C, ar);
559   }
560
561   /* XXX test: add convention to end regions always in pixel space,
562    * for drawing of borders/gestures etc */
563   ED_region_pixelspace(ar);
564
565   ED_region_draw_cb_draw(C, ar, REGION_DRAW_POST_PIXEL);
566
567   region_draw_azones(sa, ar);
568
569   /* for debugging unneeded area redraws and partial redraw */
570 #if 0
571   GPU_blend(true);
572   GPUVertFormat *format = immVertexFormat();
573   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
574   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
575   immUniformColor4f(drand48(), drand48(), drand48(), 0.1f);
576   immRectf(pos,
577            ar->drawrct.xmin - ar->winrct.xmin,
578            ar->drawrct.ymin - ar->winrct.ymin,
579            ar->drawrct.xmax - ar->winrct.xmin,
580            ar->drawrct.ymax - ar->winrct.ymin);
581   immUnbindProgram();
582   GPU_blend(false);
583 #endif
584
585   memset(&ar->drawrct, 0, sizeof(ar->drawrct));
586
587   UI_blocklist_free_inactive(C, &ar->uiblocks);
588
589   if (sa) {
590     const bScreen *screen = WM_window_get_active_screen(win);
591
592     /* Only region emboss for top-bar */
593     if ((screen->state != SCREENFULL) && ED_area_is_global(sa)) {
594       region_draw_emboss(ar, &ar->winrct, (REGION_EMBOSS_LEFT | REGION_EMBOSS_RIGHT));
595     }
596     else if ((ar->regiontype == RGN_TYPE_WINDOW) && (ar->alignment == RGN_ALIGN_QSPLIT)) {
597
598       /* draw separating lines between the quad views */
599
600       float color[4] = {0.0f, 0.0f, 0.0f, 0.8f};
601       UI_GetThemeColor3fv(TH_EDITOR_OUTLINE, color);
602       GPUVertFormat *format = immVertexFormat();
603       uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
604       immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
605       immUniformColor4fv(color);
606       GPU_line_width(1.0f);
607       imm_draw_box_wire_2d(
608           pos, 0, 0, ar->winrct.xmax - ar->winrct.xmin + 1, ar->winrct.ymax - ar->winrct.ymin + 1);
609       immUnbindProgram();
610     }
611   }
612
613   /* We may want to detach message-subscriptions from drawing. */
614   {
615     WorkSpace *workspace = CTX_wm_workspace(C);
616     wmWindowManager *wm = CTX_wm_manager(C);
617     bScreen *screen = WM_window_get_active_screen(win);
618     Scene *scene = CTX_data_scene(C);
619     struct wmMsgBus *mbus = wm->message_bus;
620     WM_msgbus_clear_by_owner(mbus, ar);
621
622     /* Cheat, always subscribe to this space type properties.
623      *
624      * This covers most cases and avoids copy-paste similar code for each space type.
625      */
626     if (ELEM(ar->regiontype, RGN_TYPE_WINDOW, RGN_TYPE_CHANNELS, RGN_TYPE_UI, RGN_TYPE_TOOLS)) {
627       SpaceLink *sl = sa->spacedata.first;
628
629       PointerRNA ptr;
630       RNA_pointer_create(&screen->id, &RNA_Space, sl, &ptr);
631
632       wmMsgSubscribeValue msg_sub_value_region_tag_redraw = {
633           .owner = ar,
634           .user_data = ar,
635           .notify = ED_region_do_msg_notify_tag_redraw,
636       };
637       /* All properties for this space type. */
638       WM_msg_subscribe_rna(mbus, &ptr, NULL, &msg_sub_value_region_tag_redraw, __func__);
639     }
640
641     ED_region_message_subscribe(C, workspace, scene, screen, sa, ar, mbus);
642   }
643 }
644
645 /* **********************************
646  * maybe silly, but let's try for now
647  * to keep these tags protected
648  * ********************************** */
649
650 void ED_region_tag_redraw(ARegion *ar)
651 {
652   /* don't tag redraw while drawing, it shouldn't happen normally
653    * but python scripts can cause this to happen indirectly */
654   if (ar && !(ar->do_draw & RGN_DRAWING)) {
655     /* zero region means full region redraw */
656     ar->do_draw &= ~(RGN_DRAW_PARTIAL | RGN_DRAW_NO_REBUILD);
657     ar->do_draw |= RGN_DRAW;
658     memset(&ar->drawrct, 0, sizeof(ar->drawrct));
659   }
660 }
661
662 void ED_region_tag_redraw_overlay(ARegion *ar)
663 {
664   if (ar) {
665     ar->do_draw_overlay = RGN_DRAW;
666   }
667 }
668
669 void ED_region_tag_redraw_no_rebuild(ARegion *ar)
670 {
671   if (ar && !(ar->do_draw & (RGN_DRAWING | RGN_DRAW))) {
672     ar->do_draw &= ~RGN_DRAW_PARTIAL;
673     ar->do_draw |= RGN_DRAW_NO_REBUILD;
674     memset(&ar->drawrct, 0, sizeof(ar->drawrct));
675   }
676 }
677
678 void ED_region_tag_refresh_ui(ARegion *ar)
679 {
680   if (ar) {
681     ar->do_draw |= RGN_DRAW_REFRESH_UI;
682   }
683 }
684
685 void ED_region_tag_redraw_partial(ARegion *ar, const rcti *rct)
686 {
687   if (ar && !(ar->do_draw & RGN_DRAWING)) {
688     if (!(ar->do_draw & (RGN_DRAW | RGN_DRAW_NO_REBUILD | RGN_DRAW_PARTIAL))) {
689       /* no redraw set yet, set partial region */
690       ar->do_draw |= RGN_DRAW_PARTIAL;
691       ar->drawrct = *rct;
692     }
693     else if (ar->drawrct.xmin != ar->drawrct.xmax) {
694       BLI_assert((ar->do_draw & RGN_DRAW_PARTIAL) != 0);
695       /* partial redraw already set, expand region */
696       BLI_rcti_union(&ar->drawrct, rct);
697     }
698     else {
699       BLI_assert((ar->do_draw & (RGN_DRAW | RGN_DRAW_NO_REBUILD)) != 0);
700       /* Else, full redraw is already requested, nothing to do here. */
701     }
702   }
703 }
704
705 void ED_area_tag_redraw(ScrArea *sa)
706 {
707   ARegion *ar;
708
709   if (sa) {
710     for (ar = sa->regionbase.first; ar; ar = ar->next) {
711       ED_region_tag_redraw(ar);
712     }
713   }
714 }
715
716 void ED_area_tag_redraw_no_rebuild(ScrArea *sa)
717 {
718   ARegion *ar;
719
720   if (sa) {
721     for (ar = sa->regionbase.first; ar; ar = ar->next) {
722       ED_region_tag_redraw_no_rebuild(ar);
723     }
724   }
725 }
726
727 void ED_area_tag_redraw_regiontype(ScrArea *sa, int regiontype)
728 {
729   ARegion *ar;
730
731   if (sa) {
732     for (ar = sa->regionbase.first; ar; ar = ar->next) {
733       if (ar->regiontype == regiontype) {
734         ED_region_tag_redraw(ar);
735       }
736     }
737   }
738 }
739
740 void ED_area_tag_refresh(ScrArea *sa)
741 {
742   if (sa) {
743     sa->do_refresh = true;
744   }
745 }
746
747 /* *************************************************************** */
748
749 /* use NULL to disable it */
750 void ED_area_status_text(ScrArea *sa, const char *str)
751 {
752   ARegion *ar;
753
754   /* happens when running transform operators in background mode */
755   if (sa == NULL) {
756     return;
757   }
758
759   for (ar = sa->regionbase.first; ar; ar = ar->next) {
760     if (ar->regiontype == RGN_TYPE_HEADER) {
761       if (str) {
762         if (ar->headerstr == NULL) {
763           ar->headerstr = MEM_mallocN(UI_MAX_DRAW_STR, "headerprint");
764         }
765         BLI_strncpy(ar->headerstr, str, UI_MAX_DRAW_STR);
766         BLI_str_rstrip(ar->headerstr);
767       }
768       else if (ar->headerstr) {
769         MEM_freeN(ar->headerstr);
770         ar->headerstr = NULL;
771       }
772       ED_region_tag_redraw(ar);
773     }
774   }
775 }
776
777 void ED_workspace_status_text(bContext *C, const char *str)
778 {
779   wmWindow *win = CTX_wm_window(C);
780   WorkSpace *workspace = CTX_wm_workspace(C);
781
782   /* Can be NULL when running operators in background mode. */
783   if (workspace == NULL) {
784     return;
785   }
786
787   if (str) {
788     if (workspace->status_text == NULL) {
789       workspace->status_text = MEM_mallocN(UI_MAX_DRAW_STR, "headerprint");
790     }
791     BLI_strncpy(workspace->status_text, str, UI_MAX_DRAW_STR);
792   }
793   else if (workspace->status_text) {
794     MEM_freeN(workspace->status_text);
795     workspace->status_text = NULL;
796   }
797
798   /* Redraw status bar. */
799   for (ScrArea *sa = win->global_areas.areabase.first; sa; sa = sa->next) {
800     if (sa->spacetype == SPACE_STATUSBAR) {
801       ED_area_tag_redraw(sa);
802       break;
803     }
804   }
805 }
806
807 /* ************************************************************ */
808
809 static void area_azone_initialize(wmWindow *win, const bScreen *screen, ScrArea *sa)
810 {
811   AZone *az;
812
813   /* reinitialize entirely, regions and fullscreen add azones too */
814   BLI_freelistN(&sa->actionzones);
815
816   if (screen->state != SCREENNORMAL) {
817     return;
818   }
819
820   if (U.app_flag & USER_APP_LOCK_UI_LAYOUT) {
821     return;
822   }
823
824   if (ED_area_is_global(sa)) {
825     return;
826   }
827
828   if (screen->temp) {
829     return;
830   }
831
832   float coords[4][4] = {
833       /* Bottom-left. */
834       {sa->totrct.xmin - U.pixelsize,
835        sa->totrct.ymin - U.pixelsize,
836        sa->totrct.xmin + AZONESPOTW,
837        sa->totrct.ymin + AZONESPOTH},
838       /* Bottom-right. */
839       {sa->totrct.xmax - AZONESPOTW,
840        sa->totrct.ymin - U.pixelsize,
841        sa->totrct.xmax + U.pixelsize,
842        sa->totrct.ymin + AZONESPOTH},
843       /* Top-left. */
844       {sa->totrct.xmin - U.pixelsize,
845        sa->totrct.ymax - AZONESPOTH,
846        sa->totrct.xmin + AZONESPOTW,
847        sa->totrct.ymax + U.pixelsize},
848       /* Top-right. */
849       {sa->totrct.xmax - AZONESPOTW,
850        sa->totrct.ymax - AZONESPOTH,
851        sa->totrct.xmax + U.pixelsize,
852        sa->totrct.ymax + U.pixelsize},
853   };
854
855   for (int i = 0; i < 4; i++) {
856     /* can't click on bottom corners on OS X, already used for resizing */
857 #ifdef __APPLE__
858     if (!WM_window_is_fullscreen(win) &&
859         ((coords[i][0] == 0 && coords[i][1] == 0) ||
860          (coords[i][0] == WM_window_pixels_x(win) && coords[i][1] == 0))) {
861       continue;
862     }
863 #else
864     (void)win;
865 #endif
866
867     /* set area action zones */
868     az = (AZone *)MEM_callocN(sizeof(AZone), "actionzone");
869     BLI_addtail(&(sa->actionzones), az);
870     az->type = AZONE_AREA;
871     az->x1 = coords[i][0];
872     az->y1 = coords[i][1];
873     az->x2 = coords[i][2];
874     az->y2 = coords[i][3];
875     BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
876   }
877 }
878
879 static void fullscreen_azone_initialize(ScrArea *sa, ARegion *ar)
880 {
881   AZone *az;
882
883   if (ED_area_is_global(sa) || (ar->regiontype != RGN_TYPE_WINDOW)) {
884     return;
885   }
886
887   az = (AZone *)MEM_callocN(sizeof(AZone), "fullscreen action zone");
888   BLI_addtail(&(sa->actionzones), az);
889   az->type = AZONE_FULLSCREEN;
890   az->ar = ar;
891   az->alpha = 0.0f;
892
893   az->x1 = ar->winrct.xmax - (AZONEFADEOUT - 1);
894   az->y1 = ar->winrct.ymax - (AZONEFADEOUT - 1);
895   az->x2 = ar->winrct.xmax;
896   az->y2 = ar->winrct.ymax;
897   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
898 }
899
900 #define AZONEPAD_EDGE (0.1f * U.widget_unit)
901 #define AZONEPAD_ICON (0.45f * U.widget_unit)
902 static void region_azone_edge(AZone *az, ARegion *ar)
903 {
904   int clip_axis = -1;
905   switch (az->edge) {
906     case AE_TOP_TO_BOTTOMRIGHT:
907       az->x1 = ar->winrct.xmin;
908       az->y1 = ar->winrct.ymax - AZONEPAD_EDGE;
909       az->x2 = ar->winrct.xmax;
910       az->y2 = ar->winrct.ymax + AZONEPAD_EDGE;
911       if (ar->overlap) {
912         clip_axis = 0;
913       }
914       break;
915     case AE_BOTTOM_TO_TOPLEFT:
916       az->x1 = ar->winrct.xmin;
917       az->y1 = ar->winrct.ymin + AZONEPAD_EDGE;
918       az->x2 = ar->winrct.xmax;
919       az->y2 = ar->winrct.ymin - AZONEPAD_EDGE;
920       if (ar->overlap) {
921         clip_axis = 0;
922       }
923       break;
924     case AE_LEFT_TO_TOPRIGHT:
925       az->x1 = ar->winrct.xmin - AZONEPAD_EDGE;
926       az->y1 = ar->winrct.ymin;
927       az->x2 = ar->winrct.xmin + AZONEPAD_EDGE;
928       az->y2 = ar->winrct.ymax;
929       if (ar->overlap) {
930         clip_axis = 1;
931       }
932       break;
933     case AE_RIGHT_TO_TOPLEFT:
934       az->x1 = ar->winrct.xmax + AZONEPAD_EDGE;
935       az->y1 = ar->winrct.ymin;
936       az->x2 = ar->winrct.xmax - AZONEPAD_EDGE;
937       az->y2 = ar->winrct.ymax;
938       if (ar->overlap) {
939         clip_axis = 1;
940       }
941       break;
942   }
943
944   /* Constrain action zones to usable area of region.
945    * Needed so blank areas of the region are interactive and aciton zones don't get in the way. */
946   if (clip_axis == 0) {
947     az->x1 = max_ii(az->x1,
948                     (ar->winrct.xmin + UI_view2d_view_to_region_x(&ar->v2d, ar->v2d.tot.xmin)) -
949                         UI_REGION_OVERLAP_MARGIN);
950     az->x2 = min_ii(az->x2,
951                     (ar->winrct.xmin + UI_view2d_view_to_region_x(&ar->v2d, ar->v2d.tot.xmax)) +
952                         UI_REGION_OVERLAP_MARGIN);
953   }
954   else if (clip_axis == 1) {
955     az->y1 = max_ii(az->y1,
956                     (ar->winrct.ymin + UI_view2d_view_to_region_y(&ar->v2d, ar->v2d.tot.ymin)) -
957                         UI_REGION_OVERLAP_MARGIN);
958     az->y2 = min_ii(az->y2,
959                     (ar->winrct.ymin + UI_view2d_view_to_region_y(&ar->v2d, ar->v2d.tot.ymax)) +
960                         UI_REGION_OVERLAP_MARGIN);
961   }
962
963   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
964 }
965
966 /* region already made zero sized, in shape of edge */
967 static void region_azone_tab_plus(ScrArea *sa, AZone *az, ARegion *ar)
968 {
969   AZone *azt;
970   int tot = 0, add;
971   /* Edge offset multiplied by the  */
972
973   float edge_offset = 1.0f;
974   const float tab_size_x = 0.7f * U.widget_unit;
975   const float tab_size_y = 0.4f * U.widget_unit;
976
977   for (azt = sa->actionzones.first; azt; azt = azt->next) {
978     if (azt->edge == az->edge) {
979       tot++;
980     }
981   }
982
983   switch (az->edge) {
984     case AE_TOP_TO_BOTTOMRIGHT:
985       add = (ar->winrct.ymax == sa->totrct.ymin) ? 1 : 0;
986       az->x1 = ar->winrct.xmax - ((edge_offset + 1.0f) * tab_size_x);
987       az->y1 = ar->winrct.ymax - add;
988       az->x2 = ar->winrct.xmax - (edge_offset * tab_size_x);
989       az->y2 = ar->winrct.ymax - add + tab_size_y;
990       break;
991     case AE_BOTTOM_TO_TOPLEFT:
992       az->x1 = ar->winrct.xmax - ((edge_offset + 1.0f) * tab_size_x);
993       az->y1 = ar->winrct.ymin - tab_size_y;
994       az->x2 = ar->winrct.xmax - (edge_offset * tab_size_x);
995       az->y2 = ar->winrct.ymin;
996       break;
997     case AE_LEFT_TO_TOPRIGHT:
998       az->x1 = ar->winrct.xmin - tab_size_y;
999       az->y1 = ar->winrct.ymax - ((edge_offset + 1.0f) * tab_size_x);
1000       az->x2 = ar->winrct.xmin;
1001       az->y2 = ar->winrct.ymax - (edge_offset * tab_size_x);
1002       break;
1003     case AE_RIGHT_TO_TOPLEFT:
1004       az->x1 = ar->winrct.xmax;
1005       az->y1 = ar->winrct.ymax - ((edge_offset + 1.0f) * tab_size_x);
1006       az->x2 = ar->winrct.xmax + tab_size_y;
1007       az->y2 = ar->winrct.ymax - (edge_offset * tab_size_x);
1008       break;
1009   }
1010   /* rect needed for mouse pointer test */
1011   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
1012 }
1013
1014 static bool region_azone_edge_poll(const ARegion *ar, const bool is_fullscreen)
1015 {
1016   const bool is_hidden = (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL));
1017
1018   if (is_hidden && is_fullscreen) {
1019     return false;
1020   }
1021   if (!is_hidden && ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
1022     return false;
1023   }
1024
1025   return true;
1026 }
1027
1028 static void region_azone_edge_initialize(ScrArea *sa,
1029                                          ARegion *ar,
1030                                          AZEdge edge,
1031                                          const bool is_fullscreen)
1032 {
1033   AZone *az = NULL;
1034   const bool is_hidden = (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL));
1035
1036   if (!region_azone_edge_poll(ar, is_fullscreen)) {
1037     return;
1038   }
1039
1040   az = (AZone *)MEM_callocN(sizeof(AZone), "actionzone");
1041   BLI_addtail(&(sa->actionzones), az);
1042   az->type = AZONE_REGION;
1043   az->ar = ar;
1044   az->edge = edge;
1045
1046   if (is_hidden) {
1047     region_azone_tab_plus(sa, az, ar);
1048   }
1049   else {
1050     region_azone_edge(az, ar);
1051   }
1052 }
1053
1054 static void region_azone_scrollbar_initialize(ScrArea *sa,
1055                                               ARegion *ar,
1056                                               AZScrollDirection direction)
1057 {
1058   rcti scroller_vert = (direction == AZ_SCROLL_VERT) ? ar->v2d.vert : ar->v2d.hor;
1059   AZone *az = MEM_callocN(sizeof(*az), __func__);
1060
1061   BLI_addtail(&sa->actionzones, az);
1062   az->type = AZONE_REGION_SCROLL;
1063   az->ar = ar;
1064   az->direction = direction;
1065
1066   if (direction == AZ_SCROLL_VERT) {
1067     az->ar->v2d.alpha_vert = 0;
1068   }
1069   else if (direction == AZ_SCROLL_HOR) {
1070     az->ar->v2d.alpha_hor = 0;
1071   }
1072
1073   BLI_rcti_translate(&scroller_vert, ar->winrct.xmin, ar->winrct.ymin);
1074   az->x1 = scroller_vert.xmin - AZONEFADEIN;
1075   az->y1 = scroller_vert.ymin - AZONEFADEIN;
1076   az->x2 = scroller_vert.xmax + AZONEFADEIN;
1077   az->y2 = scroller_vert.ymax + AZONEFADEIN;
1078
1079   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
1080 }
1081
1082 static void region_azones_scrollbars_initialize(ScrArea *sa, ARegion *ar)
1083 {
1084   const View2D *v2d = &ar->v2d;
1085
1086   if ((v2d->scroll & V2D_SCROLL_VERTICAL) && ((v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) == 0)) {
1087     region_azone_scrollbar_initialize(sa, ar, AZ_SCROLL_VERT);
1088   }
1089   if ((v2d->scroll & V2D_SCROLL_HORIZONTAL) &&
1090       ((v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) == 0)) {
1091     region_azone_scrollbar_initialize(sa, ar, AZ_SCROLL_HOR);
1092   }
1093 }
1094
1095 /* *************************************************************** */
1096
1097 static void region_azones_add(const bScreen *screen, ScrArea *sa, ARegion *ar, const int alignment)
1098 {
1099   const bool is_fullscreen = screen->state == SCREENFULL;
1100
1101   /* Only display tab or icons when the header region is hidden
1102    * (not the tool header - they overlap). */
1103   if (ar->regiontype == RGN_TYPE_TOOL_HEADER) {
1104     return;
1105   }
1106
1107   /* edge code (t b l r) is along which area edge azone will be drawn */
1108   if (alignment == RGN_ALIGN_TOP) {
1109     region_azone_edge_initialize(sa, ar, AE_BOTTOM_TO_TOPLEFT, is_fullscreen);
1110   }
1111   else if (alignment == RGN_ALIGN_BOTTOM) {
1112     region_azone_edge_initialize(sa, ar, AE_TOP_TO_BOTTOMRIGHT, is_fullscreen);
1113   }
1114   else if (alignment == RGN_ALIGN_RIGHT) {
1115     region_azone_edge_initialize(sa, ar, AE_LEFT_TO_TOPRIGHT, is_fullscreen);
1116   }
1117   else if (alignment == RGN_ALIGN_LEFT) {
1118     region_azone_edge_initialize(sa, ar, AE_RIGHT_TO_TOPLEFT, is_fullscreen);
1119   }
1120
1121   if (is_fullscreen) {
1122     fullscreen_azone_initialize(sa, ar);
1123   }
1124
1125   region_azones_scrollbars_initialize(sa, ar);
1126 }
1127
1128 /* dir is direction to check, not the splitting edge direction! */
1129 static int rct_fits(const rcti *rect, char dir, int size)
1130 {
1131   if (dir == 'h') {
1132     return BLI_rcti_size_x(rect) + 1 - size;
1133   }
1134   else { /* 'v' */
1135     return BLI_rcti_size_y(rect) + 1 - size;
1136   }
1137 }
1138
1139 /* *************************************************************** */
1140
1141 /* ar should be overlapping */
1142 /* function checks if some overlapping region was defined before - on same place */
1143 static void region_overlap_fix(ScrArea *sa, ARegion *ar)
1144 {
1145   ARegion *ar1;
1146   const int align = ar->alignment & ~RGN_SPLIT_PREV;
1147   int align1 = 0;
1148
1149   /* find overlapping previous region on same place */
1150   for (ar1 = ar->prev; ar1; ar1 = ar1->prev) {
1151     if (ar1->flag & (RGN_FLAG_HIDDEN)) {
1152       continue;
1153     }
1154
1155     if (ar1->overlap && ((ar1->alignment & RGN_SPLIT_PREV) == 0)) {
1156       if (ELEM(ar1->alignment, RGN_ALIGN_FLOAT)) {
1157         continue;
1158       }
1159       align1 = ar1->alignment;
1160       if (BLI_rcti_isect(&ar1->winrct, &ar->winrct, NULL)) {
1161         if (align1 != align) {
1162           /* Left overlapping right or vice-versa, forbid this! */
1163           ar->flag |= RGN_FLAG_TOO_SMALL;
1164           return;
1165         }
1166         /* Else, we have our previous region on same side. */
1167         break;
1168       }
1169     }
1170   }
1171
1172   /* translate or close */
1173   if (ar1) {
1174     if (align1 == RGN_ALIGN_LEFT) {
1175       if (ar->winrct.xmax + ar1->winx > sa->winx - U.widget_unit) {
1176         ar->flag |= RGN_FLAG_TOO_SMALL;
1177         return;
1178       }
1179       else {
1180         BLI_rcti_translate(&ar->winrct, ar1->winx, 0);
1181       }
1182     }
1183     else if (align1 == RGN_ALIGN_RIGHT) {
1184       if (ar->winrct.xmin - ar1->winx < U.widget_unit) {
1185         ar->flag |= RGN_FLAG_TOO_SMALL;
1186         return;
1187       }
1188       else {
1189         BLI_rcti_translate(&ar->winrct, -ar1->winx, 0);
1190       }
1191     }
1192   }
1193
1194   /* At this point, 'ar' is in its final position and still open.
1195    * Make a final check it does not overlap any previous 'other side' region. */
1196   for (ar1 = ar->prev; ar1; ar1 = ar1->prev) {
1197     if (ar1->flag & (RGN_FLAG_HIDDEN)) {
1198       continue;
1199     }
1200     if (ELEM(ar1->alignment, RGN_ALIGN_FLOAT)) {
1201       continue;
1202     }
1203
1204     if (ar1->overlap && (ar1->alignment & RGN_SPLIT_PREV) == 0) {
1205       if ((ar1->alignment != align) && BLI_rcti_isect(&ar1->winrct, &ar->winrct, NULL)) {
1206         /* Left overlapping right or vice-versa, forbid this! */
1207         ar->flag |= RGN_FLAG_TOO_SMALL;
1208         return;
1209       }
1210     }
1211   }
1212 }
1213
1214 /* overlapping regions only in the following restricted cases */
1215 bool ED_region_is_overlap(int spacetype, int regiontype)
1216 {
1217   if (regiontype == RGN_TYPE_HUD) {
1218     return true;
1219   }
1220   if (U.uiflag2 & USER_REGION_OVERLAP) {
1221     if (spacetype == SPACE_NODE) {
1222       if (regiontype == RGN_TYPE_TOOLS) {
1223         return true;
1224       }
1225     }
1226     else if (ELEM(spacetype, SPACE_VIEW3D, SPACE_IMAGE)) {
1227       if (ELEM(regiontype,
1228                RGN_TYPE_TOOLS,
1229                RGN_TYPE_UI,
1230                RGN_TYPE_TOOL_PROPS,
1231                RGN_TYPE_HEADER,
1232                RGN_TYPE_FOOTER)) {
1233         return true;
1234       }
1235     }
1236   }
1237
1238   return false;
1239 }
1240
1241 static void region_rect_recursive(
1242     ScrArea *sa, ARegion *ar, rcti *remainder, rcti *overlap_remainder, int quad)
1243 {
1244   rcti *remainder_prev = remainder;
1245
1246   if (ar == NULL) {
1247     return;
1248   }
1249
1250   int prev_winx = ar->winx;
1251   int prev_winy = ar->winy;
1252
1253   /* no returns in function, winrct gets set in the end again */
1254   BLI_rcti_init(&ar->winrct, 0, 0, 0, 0);
1255
1256   /* for test; allow split of previously defined region */
1257   if (ar->alignment & RGN_SPLIT_PREV) {
1258     if (ar->prev) {
1259       remainder = &ar->prev->winrct;
1260     }
1261   }
1262
1263   int alignment = ar->alignment & ~RGN_SPLIT_PREV;
1264
1265   /* set here, assuming userpref switching forces to call this again */
1266   ar->overlap = ED_region_is_overlap(sa->spacetype, ar->regiontype);
1267
1268   /* clear state flags first */
1269   ar->flag &= ~(RGN_FLAG_TOO_SMALL | RGN_FLAG_SIZE_CLAMP_X | RGN_FLAG_SIZE_CLAMP_Y);
1270   /* user errors */
1271   if ((ar->next == NULL) && !ELEM(alignment, RGN_ALIGN_QSPLIT, RGN_ALIGN_FLOAT)) {
1272     alignment = RGN_ALIGN_NONE;
1273   }
1274
1275   /* prefsize, taking into account DPI */
1276   int prefsizex = UI_DPI_FAC * ((ar->sizex > 1) ? ar->sizex + 0.5f : ar->type->prefsizex);
1277   int prefsizey;
1278
1279   if (ar->flag & RGN_FLAG_PREFSIZE_OR_HIDDEN) {
1280     prefsizex = UI_DPI_FAC * ar->type->prefsizex;
1281     prefsizey = UI_DPI_FAC * ar->type->prefsizey;
1282   }
1283   else if (ar->regiontype == RGN_TYPE_HEADER) {
1284     prefsizey = ED_area_headersize();
1285   }
1286   else if (ar->regiontype == RGN_TYPE_TOOL_HEADER) {
1287     prefsizey = ED_area_headersize();
1288   }
1289   else if (ar->regiontype == RGN_TYPE_FOOTER) {
1290     prefsizey = ED_area_footersize();
1291   }
1292   else if (ED_area_is_global(sa)) {
1293     prefsizey = ED_region_global_size_y();
1294   }
1295   else if (ar->regiontype == RGN_TYPE_UI && sa->spacetype == SPACE_FILE) {
1296     prefsizey = UI_UNIT_Y * 2 + (UI_UNIT_Y / 2);
1297   }
1298   else {
1299     prefsizey = UI_DPI_FAC * (ar->sizey > 1 ? ar->sizey + 0.5f : ar->type->prefsizey);
1300   }
1301
1302   if (ar->flag & RGN_FLAG_HIDDEN) {
1303     /* hidden is user flag */
1304   }
1305   else if (alignment == RGN_ALIGN_FLOAT) {
1306     /**
1307      * \note Currently this window type is only used for #RGN_TYPE_HUD,
1308      * We expect the panel to resize it's self to be larger.
1309      *
1310      * This aligns to the lower left of the area.
1311      */
1312     const int size_min[2] = {UI_UNIT_X, UI_UNIT_Y};
1313     rcti overlap_remainder_margin = *overlap_remainder;
1314     BLI_rcti_resize(&overlap_remainder_margin,
1315                     max_ii(0, BLI_rcti_size_x(overlap_remainder) - UI_UNIT_X / 2),
1316                     max_ii(0, BLI_rcti_size_y(overlap_remainder) - UI_UNIT_Y / 2));
1317     ar->winrct.xmin = overlap_remainder_margin.xmin;
1318     ar->winrct.ymin = overlap_remainder_margin.ymin;
1319     ar->winrct.xmax = ar->winrct.xmin + prefsizex - 1;
1320     ar->winrct.ymax = ar->winrct.ymin + prefsizey - 1;
1321
1322     BLI_rcti_isect(&ar->winrct, &overlap_remainder_margin, &ar->winrct);
1323
1324     if (BLI_rcti_size_x(&ar->winrct) != prefsizex - 1) {
1325       ar->flag |= RGN_FLAG_SIZE_CLAMP_X;
1326     }
1327     if (BLI_rcti_size_y(&ar->winrct) != prefsizey - 1) {
1328       ar->flag |= RGN_FLAG_SIZE_CLAMP_Y;
1329     }
1330
1331     /* We need to use a test that wont have been previously clamped. */
1332     rcti winrct_test = {
1333         .xmin = ar->winrct.xmin,
1334         .ymin = ar->winrct.ymin,
1335         .xmax = ar->winrct.xmin + size_min[0],
1336         .ymax = ar->winrct.ymin + size_min[1],
1337     };
1338     BLI_rcti_isect(&winrct_test, &overlap_remainder_margin, &winrct_test);
1339     if (BLI_rcti_size_x(&winrct_test) < size_min[0] ||
1340         BLI_rcti_size_y(&winrct_test) < size_min[1]) {
1341       ar->flag |= RGN_FLAG_TOO_SMALL;
1342     }
1343   }
1344   else if (rct_fits(remainder, 'v', 1) < 0 || rct_fits(remainder, 'h', 1) < 0) {
1345     /* remainder is too small for any usage */
1346     ar->flag |= RGN_FLAG_TOO_SMALL;
1347   }
1348   else if (alignment == RGN_ALIGN_NONE) {
1349     /* typically last region */
1350     ar->winrct = *remainder;
1351     BLI_rcti_init(remainder, 0, 0, 0, 0);
1352   }
1353   else if (alignment == RGN_ALIGN_TOP || alignment == RGN_ALIGN_BOTTOM) {
1354     rcti *winrct = (ar->overlap) ? overlap_remainder : remainder;
1355
1356     if (rct_fits(winrct, 'v', prefsizey) < 0) {
1357       ar->flag |= RGN_FLAG_TOO_SMALL;
1358     }
1359     else {
1360       int fac = rct_fits(winrct, 'v', prefsizey);
1361
1362       if (fac < 0) {
1363         prefsizey += fac;
1364       }
1365
1366       ar->winrct = *winrct;
1367
1368       if (alignment == RGN_ALIGN_TOP) {
1369         ar->winrct.ymin = ar->winrct.ymax - prefsizey + 1;
1370         winrct->ymax = ar->winrct.ymin - 1;
1371       }
1372       else {
1373         ar->winrct.ymax = ar->winrct.ymin + prefsizey - 1;
1374         winrct->ymin = ar->winrct.ymax + 1;
1375       }
1376     }
1377   }
1378   else if (ELEM(alignment, RGN_ALIGN_LEFT, RGN_ALIGN_RIGHT)) {
1379     rcti *winrct = (ar->overlap) ? overlap_remainder : remainder;
1380
1381     if (rct_fits(winrct, 'h', prefsizex) < 0) {
1382       ar->flag |= RGN_FLAG_TOO_SMALL;
1383     }
1384     else {
1385       int fac = rct_fits(winrct, 'h', prefsizex);
1386
1387       if (fac < 0) {
1388         prefsizex += fac;
1389       }
1390
1391       ar->winrct = *winrct;
1392
1393       if (alignment == RGN_ALIGN_RIGHT) {
1394         ar->winrct.xmin = ar->winrct.xmax - prefsizex + 1;
1395         winrct->xmax = ar->winrct.xmin - 1;
1396       }
1397       else {
1398         ar->winrct.xmax = ar->winrct.xmin + prefsizex - 1;
1399         winrct->xmin = ar->winrct.xmax + 1;
1400       }
1401     }
1402   }
1403   else if (alignment == RGN_ALIGN_VSPLIT || alignment == RGN_ALIGN_HSPLIT) {
1404     /* percentage subdiv*/
1405     ar->winrct = *remainder;
1406
1407     if (alignment == RGN_ALIGN_HSPLIT) {
1408       if (rct_fits(remainder, 'h', prefsizex) > 4) {
1409         ar->winrct.xmax = BLI_rcti_cent_x(remainder);
1410         remainder->xmin = ar->winrct.xmax + 1;
1411       }
1412       else {
1413         BLI_rcti_init(remainder, 0, 0, 0, 0);
1414       }
1415     }
1416     else {
1417       if (rct_fits(remainder, 'v', prefsizey) > 4) {
1418         ar->winrct.ymax = BLI_rcti_cent_y(remainder);
1419         remainder->ymin = ar->winrct.ymax + 1;
1420       }
1421       else {
1422         BLI_rcti_init(remainder, 0, 0, 0, 0);
1423       }
1424     }
1425   }
1426   else if (alignment == RGN_ALIGN_QSPLIT) {
1427     ar->winrct = *remainder;
1428
1429     /* test if there's still 4 regions left */
1430     if (quad == 0) {
1431       ARegion *artest = ar->next;
1432       int count = 1;
1433
1434       while (artest) {
1435         artest->alignment = RGN_ALIGN_QSPLIT;
1436         artest = artest->next;
1437         count++;
1438       }
1439
1440       if (count != 4) {
1441         /* let's stop adding regions */
1442         BLI_rcti_init(remainder, 0, 0, 0, 0);
1443         if (G.debug & G_DEBUG) {
1444           printf("region quadsplit failed\n");
1445         }
1446       }
1447       else {
1448         quad = 1;
1449       }
1450     }
1451     if (quad) {
1452       if (quad == 1) { /* left bottom */
1453         ar->winrct.xmax = BLI_rcti_cent_x(remainder);
1454         ar->winrct.ymax = BLI_rcti_cent_y(remainder);
1455       }
1456       else if (quad == 2) { /* left top */
1457         ar->winrct.xmax = BLI_rcti_cent_x(remainder);
1458         ar->winrct.ymin = BLI_rcti_cent_y(remainder) + 1;
1459       }
1460       else if (quad == 3) { /* right bottom */
1461         ar->winrct.xmin = BLI_rcti_cent_x(remainder) + 1;
1462         ar->winrct.ymax = BLI_rcti_cent_y(remainder);
1463       }
1464       else { /* right top */
1465         ar->winrct.xmin = BLI_rcti_cent_x(remainder) + 1;
1466         ar->winrct.ymin = BLI_rcti_cent_y(remainder) + 1;
1467         BLI_rcti_init(remainder, 0, 0, 0, 0);
1468       }
1469
1470       quad++;
1471     }
1472   }
1473
1474   /* for speedup */
1475   ar->winx = BLI_rcti_size_x(&ar->winrct) + 1;
1476   ar->winy = BLI_rcti_size_y(&ar->winrct) + 1;
1477
1478   /* if region opened normally, we store this for hide/reveal usage */
1479   /* prevent rounding errors for UI_DPI_FAC mult and divide */
1480   if (ar->winx > 1) {
1481     ar->sizex = (ar->winx + 0.5f) / UI_DPI_FAC;
1482   }
1483   if (ar->winy > 1) {
1484     ar->sizey = (ar->winy + 0.5f) / UI_DPI_FAC;
1485   }
1486
1487   /* exception for multiple overlapping regions on same spot */
1488   if (ar->overlap && (alignment != RGN_ALIGN_FLOAT)) {
1489     region_overlap_fix(sa, ar);
1490   }
1491
1492   /* set winrect for azones */
1493   if (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL)) {
1494     ar->winrct = (ar->overlap) ? *overlap_remainder : *remainder;
1495
1496     switch (alignment) {
1497       case RGN_ALIGN_TOP:
1498         ar->winrct.ymin = ar->winrct.ymax;
1499         break;
1500       case RGN_ALIGN_BOTTOM:
1501         ar->winrct.ymax = ar->winrct.ymin;
1502         break;
1503       case RGN_ALIGN_RIGHT:
1504         ar->winrct.xmin = ar->winrct.xmax;
1505         break;
1506       case RGN_ALIGN_LEFT:
1507       default:
1508         /* prevent winrct to be valid */
1509         ar->winrct.xmax = ar->winrct.xmin;
1510         break;
1511     }
1512   }
1513
1514   /* restore prev-split exception */
1515   if (ar->alignment & RGN_SPLIT_PREV) {
1516     if (ar->prev) {
1517       remainder = remainder_prev;
1518       ar->prev->winx = BLI_rcti_size_x(&ar->prev->winrct) + 1;
1519       ar->prev->winy = BLI_rcti_size_y(&ar->prev->winrct) + 1;
1520     }
1521   }
1522
1523   /* After non-overlapping region, all following overlapping regions
1524    * fit within the remaining space again. */
1525   if (!ar->overlap) {
1526     *overlap_remainder = *remainder;
1527   }
1528
1529   region_rect_recursive(sa, ar->next, remainder, overlap_remainder, quad);
1530
1531   /* Tag for redraw if size changes. */
1532   if (ar->winx != prev_winx || ar->winy != prev_winy) {
1533     ED_region_tag_redraw(ar);
1534   }
1535 }
1536
1537 static void area_calc_totrct(ScrArea *sa, const rcti *window_rect)
1538 {
1539   short px = (short)U.pixelsize;
1540
1541   sa->totrct.xmin = sa->v1->vec.x;
1542   sa->totrct.xmax = sa->v4->vec.x;
1543   sa->totrct.ymin = sa->v1->vec.y;
1544   sa->totrct.ymax = sa->v2->vec.y;
1545
1546   /* scale down totrct by 1 pixel on all sides not matching window borders */
1547   if (sa->totrct.xmin > window_rect->xmin) {
1548     sa->totrct.xmin += px;
1549   }
1550   if (sa->totrct.xmax < (window_rect->xmax - 1)) {
1551     sa->totrct.xmax -= px;
1552   }
1553   if (sa->totrct.ymin > window_rect->ymin) {
1554     sa->totrct.ymin += px;
1555   }
1556   if (sa->totrct.ymax < (window_rect->ymax - 1)) {
1557     sa->totrct.ymax -= px;
1558   }
1559   /* Although the following asserts are correct they lead to a very unstable Blender.
1560    * And the asserts would fail even in 2.7x (they were added in 2.8x as part of the top-bar commit).
1561    * For more details see T54864. */
1562 #if 0
1563   BLI_assert(sa->totrct.xmin >= 0);
1564   BLI_assert(sa->totrct.xmax >= 0);
1565   BLI_assert(sa->totrct.ymin >= 0);
1566   BLI_assert(sa->totrct.ymax >= 0);
1567 #endif
1568
1569   /* for speedup */
1570   sa->winx = BLI_rcti_size_x(&sa->totrct) + 1;
1571   sa->winy = BLI_rcti_size_y(&sa->totrct) + 1;
1572 }
1573
1574 /* used for area initialize below */
1575 static void region_subwindow(ARegion *ar)
1576 {
1577   bool hidden = (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL)) != 0;
1578
1579   if ((ar->alignment & RGN_SPLIT_PREV) && ar->prev) {
1580     hidden = hidden || (ar->prev->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL));
1581   }
1582
1583   ar->visible = !hidden;
1584 }
1585
1586 /**
1587  * \param ar: Region, may be NULL when adding handlers for \a sa.
1588  */
1589 static void ed_default_handlers(
1590     wmWindowManager *wm, ScrArea *sa, ARegion *ar, ListBase *handlers, int flag)
1591 {
1592   BLI_assert(ar ? (&ar->handlers == handlers) : (&sa->handlers == handlers));
1593
1594   /* note, add-handler checks if it already exists */
1595
1596   /* XXX it would be good to have boundbox checks for some of these... */
1597   if (flag & ED_KEYMAP_UI) {
1598     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "User Interface", 0, 0);
1599     WM_event_add_keymap_handler(handlers, keymap);
1600
1601     /* user interface widgets */
1602     UI_region_handlers_add(handlers);
1603   }
1604   if (flag & ED_KEYMAP_GIZMO) {
1605     BLI_assert(ar && ar->type->regionid == RGN_TYPE_WINDOW);
1606     if (ar) {
1607       /* Anything else is confusing, only allow this. */
1608       BLI_assert(&ar->handlers == handlers);
1609       if (ar->gizmo_map == NULL) {
1610         ar->gizmo_map = WM_gizmomap_new_from_type(
1611             &(const struct wmGizmoMapType_Params){sa->spacetype, ar->type->regionid});
1612       }
1613       WM_gizmomap_add_handlers(ar, ar->gizmo_map);
1614     }
1615   }
1616   if (flag & ED_KEYMAP_TOOL) {
1617     WM_event_add_keymap_handler_dynamic(&ar->handlers, WM_event_get_keymap_from_toolsystem, sa);
1618   }
1619   if (flag & ED_KEYMAP_VIEW2D) {
1620     /* 2d-viewport handling+manipulation */
1621     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "View2D", 0, 0);
1622     WM_event_add_keymap_handler(handlers, keymap);
1623   }
1624   if (flag & ED_KEYMAP_MARKERS) {
1625     /* time-markers */
1626     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Markers", 0, 0);
1627
1628     /* use a boundbox restricted map */
1629     /* same local check for all areas */
1630     static rcti rect = {0, 10000, 0, -1};
1631     rect.ymax = UI_MARKER_MARGIN_Y;
1632     BLI_assert(ar->type->regionid == RGN_TYPE_WINDOW);
1633     WM_event_add_keymap_handler_bb(handlers, keymap, &rect, &ar->winrct);
1634   }
1635   if (flag & ED_KEYMAP_ANIMATION) {
1636     /* frame changing and timeline operators (for time spaces) */
1637     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Animation", 0, 0);
1638     WM_event_add_keymap_handler(handlers, keymap);
1639   }
1640   if (flag & ED_KEYMAP_FRAMES) {
1641     /* frame changing/jumping (for all spaces) */
1642     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Frames", 0, 0);
1643     WM_event_add_keymap_handler(handlers, keymap);
1644   }
1645   if (flag & ED_KEYMAP_HEADER) {
1646     /* standard keymap for headers regions */
1647     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Header", 0, 0);
1648     WM_event_add_keymap_handler(handlers, keymap);
1649   }
1650   if (flag & ED_KEYMAP_FOOTER) {
1651     /* standard keymap for footer regions */
1652     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Footer", 0, 0);
1653     WM_event_add_keymap_handler(handlers, keymap);
1654   }
1655
1656   /* Keep last because of LMB/RMB handling, see: T57527. */
1657   if (flag & ED_KEYMAP_GPENCIL) {
1658     /* grease pencil */
1659     /* NOTE: This is now 4 keymaps - One for basic functionality,
1660      *       and others for special stroke modes (edit, paint and sculpt).
1661      *
1662      *       For now, it's easier to just include all,
1663      *       since you hardly want one without the others.
1664      */
1665     wmKeyMap *keymap_general = WM_keymap_ensure(wm->defaultconf, "Grease Pencil", 0, 0);
1666     WM_event_add_keymap_handler(handlers, keymap_general);
1667
1668     wmKeyMap *keymap_edit = WM_keymap_ensure(
1669         wm->defaultconf, "Grease Pencil Stroke Edit Mode", 0, 0);
1670     WM_event_add_keymap_handler(handlers, keymap_edit);
1671
1672     wmKeyMap *keymap_paint = WM_keymap_ensure(
1673         wm->defaultconf, "Grease Pencil Stroke Paint Mode", 0, 0);
1674     WM_event_add_keymap_handler(handlers, keymap_paint);
1675
1676     wmKeyMap *keymap_paint_draw = WM_keymap_ensure(
1677         wm->defaultconf, "Grease Pencil Stroke Paint (Draw brush)", 0, 0);
1678     WM_event_add_keymap_handler(handlers, keymap_paint_draw);
1679
1680     wmKeyMap *keymap_paint_erase = WM_keymap_ensure(
1681         wm->defaultconf, "Grease Pencil Stroke Paint (Erase)", 0, 0);
1682     WM_event_add_keymap_handler(handlers, keymap_paint_erase);
1683
1684     wmKeyMap *keymap_paint_fill = WM_keymap_ensure(
1685         wm->defaultconf, "Grease Pencil Stroke Paint (Fill)", 0, 0);
1686     WM_event_add_keymap_handler(handlers, keymap_paint_fill);
1687
1688     wmKeyMap *keymap_sculpt = WM_keymap_ensure(
1689         wm->defaultconf, "Grease Pencil Stroke Sculpt Mode", 0, 0);
1690     WM_event_add_keymap_handler(handlers, keymap_sculpt);
1691   }
1692 }
1693
1694 void ED_area_update_region_sizes(wmWindowManager *wm, wmWindow *win, ScrArea *area)
1695 {
1696   rcti rect, overlap_rect;
1697   rcti window_rect;
1698
1699   if (!(area->flag & AREA_FLAG_REGION_SIZE_UPDATE)) {
1700     return;
1701   }
1702   const bScreen *screen = WM_window_get_active_screen(win);
1703
1704   WM_window_rect_calc(win, &window_rect);
1705   area_calc_totrct(area, &window_rect);
1706
1707   /* region rect sizes */
1708   rect = area->totrct;
1709   overlap_rect = rect;
1710   region_rect_recursive(area, area->regionbase.first, &rect, &overlap_rect, 0);
1711
1712   /* Dynamically sized regions may have changed region sizes, so we have to force azone update. */
1713   area_azone_initialize(win, screen, area);
1714
1715   for (ARegion *ar = area->regionbase.first; ar; ar = ar->next) {
1716     region_subwindow(ar);
1717
1718     /* region size may have changed, init does necessary adjustments */
1719     if (ar->type->init) {
1720       ar->type->init(wm, ar);
1721     }
1722
1723     /* Some AZones use View2D data which is only updated in region init, so call that first! */
1724     region_azones_add(screen, area, ar, ar->alignment & ~RGN_SPLIT_PREV);
1725   }
1726   ED_area_azones_update(area, &win->eventstate->x);
1727
1728   area->flag &= ~AREA_FLAG_REGION_SIZE_UPDATE;
1729 }
1730
1731 /* called in screen_refresh, or screens_init, also area size changes */
1732 void ED_area_initialize(wmWindowManager *wm, wmWindow *win, ScrArea *sa)
1733 {
1734   WorkSpace *workspace = WM_window_get_active_workspace(win);
1735   const bScreen *screen = BKE_workspace_active_screen_get(win->workspace_hook);
1736   ViewLayer *view_layer = WM_window_get_active_view_layer(win);
1737   ARegion *ar;
1738   rcti rect, overlap_rect;
1739   rcti window_rect;
1740
1741   if (ED_area_is_global(sa) && (sa->global->flag & GLOBAL_AREA_IS_HIDDEN)) {
1742     return;
1743   }
1744   WM_window_rect_calc(win, &window_rect);
1745
1746   /* set typedefinitions */
1747   sa->type = BKE_spacetype_from_id(sa->spacetype);
1748
1749   if (sa->type == NULL) {
1750     sa->spacetype = SPACE_VIEW3D;
1751     sa->type = BKE_spacetype_from_id(sa->spacetype);
1752   }
1753
1754   for (ar = sa->regionbase.first; ar; ar = ar->next) {
1755     ar->type = BKE_regiontype_from_id_or_first(sa->type, ar->regiontype);
1756   }
1757
1758   /* area sizes */
1759   area_calc_totrct(sa, &window_rect);
1760
1761   /* region rect sizes */
1762   rect = sa->totrct;
1763   overlap_rect = rect;
1764   region_rect_recursive(sa, sa->regionbase.first, &rect, &overlap_rect, 0);
1765   sa->flag &= ~AREA_FLAG_REGION_SIZE_UPDATE;
1766
1767   /* default area handlers */
1768   ed_default_handlers(wm, sa, NULL, &sa->handlers, sa->type->keymapflag);
1769   /* checks spacedata, adds own handlers */
1770   if (sa->type->init) {
1771     sa->type->init(wm, sa);
1772   }
1773
1774   /* clear all azones, add the area triangle widgets */
1775   area_azone_initialize(win, screen, sa);
1776
1777   /* region windows, default and own handlers */
1778   for (ar = sa->regionbase.first; ar; ar = ar->next) {
1779     region_subwindow(ar);
1780
1781     if (ar->visible) {
1782       /* default region handlers */
1783       ed_default_handlers(wm, sa, ar, &ar->handlers, ar->type->keymapflag);
1784       /* own handlers */
1785       if (ar->type->init) {
1786         ar->type->init(wm, ar);
1787       }
1788     }
1789     else {
1790       /* prevent uiblocks to run */
1791       UI_blocklist_free(NULL, &ar->uiblocks);
1792     }
1793
1794     /* Some AZones use View2D data which is only updated in region init, so call that first! */
1795     region_azones_add(screen, sa, ar, ar->alignment & ~RGN_SPLIT_PREV);
1796   }
1797
1798   /* Avoid re-initializing tools while resizing the window. */
1799   if ((G.moving & G_TRANSFORM_WM) == 0) {
1800     if ((1 << sa->spacetype) & WM_TOOLSYSTEM_SPACE_MASK) {
1801       WM_toolsystem_refresh_screen_area(workspace, view_layer, sa);
1802       sa->flag |= AREA_FLAG_ACTIVE_TOOL_UPDATE;
1803     }
1804     else {
1805       sa->runtime.tool = NULL;
1806       sa->runtime.is_tool_set = true;
1807     }
1808   }
1809 }
1810
1811 static void region_update_rect(ARegion *ar)
1812 {
1813   ar->winx = BLI_rcti_size_x(&ar->winrct) + 1;
1814   ar->winy = BLI_rcti_size_y(&ar->winrct) + 1;
1815
1816   /* v2d mask is used to subtract scrollbars from a 2d view. Needs initialize here. */
1817   BLI_rcti_init(&ar->v2d.mask, 0, ar->winx - 1, 0, ar->winy - 1);
1818 }
1819
1820 /**
1821  * Call to move a popup window (keep OpenGL context free!)
1822  */
1823 void ED_region_update_rect(ARegion *ar)
1824 {
1825   region_update_rect(ar);
1826 }
1827
1828 /* externally called for floating regions like menus */
1829 void ED_region_init(ARegion *ar)
1830 {
1831   /* refresh can be called before window opened */
1832   region_subwindow(ar);
1833
1834   region_update_rect(ar);
1835 }
1836
1837 void ED_region_cursor_set(wmWindow *win, ScrArea *sa, ARegion *ar)
1838 {
1839   if (ar && sa && ar->type && ar->type->cursor) {
1840     ar->type->cursor(win, sa, ar);
1841   }
1842   else {
1843     if (WM_cursor_set_from_tool(win, sa, ar)) {
1844       return;
1845     }
1846     WM_cursor_set(win, CURSOR_STD);
1847   }
1848 }
1849
1850 /* for use after changing visibility of regions */
1851 void ED_region_visibility_change_update(bContext *C, ScrArea *sa, ARegion *ar)
1852 {
1853   if (ar->flag & RGN_FLAG_HIDDEN) {
1854     WM_event_remove_handlers(C, &ar->handlers);
1855   }
1856
1857   ED_area_initialize(CTX_wm_manager(C), CTX_wm_window(C), sa);
1858   ED_area_tag_redraw(sa);
1859 }
1860
1861 /* for quick toggle, can skip fades */
1862 void region_toggle_hidden(bContext *C, ARegion *ar, const bool do_fade)
1863 {
1864   ScrArea *sa = CTX_wm_area(C);
1865
1866   ar->flag ^= RGN_FLAG_HIDDEN;
1867
1868   if (do_fade && ar->overlap) {
1869     /* starts a timer, and in end calls the stuff below itself (region_sblend_invoke()) */
1870     ED_region_visibility_change_update_animated(C, sa, ar);
1871   }
1872   else {
1873     ED_region_visibility_change_update(C, sa, ar);
1874   }
1875 }
1876
1877 /* exported to all editors, uses fading default */
1878 void ED_region_toggle_hidden(bContext *C, ARegion *ar)
1879 {
1880   region_toggle_hidden(C, ar, true);
1881 }
1882
1883 /**
1884  * we swap spaces for fullscreen to keep all allocated data area vertices were set
1885  */
1886 void ED_area_data_copy(ScrArea *sa_dst, ScrArea *sa_src, const bool do_free)
1887 {
1888   SpaceType *st;
1889   ARegion *ar;
1890   const char spacetype = sa_dst->spacetype;
1891   const short flag_copy = HEADER_NO_PULLDOWN;
1892
1893   sa_dst->spacetype = sa_src->spacetype;
1894   sa_dst->type = sa_src->type;
1895
1896   sa_dst->flag = (sa_dst->flag & ~flag_copy) | (sa_src->flag & flag_copy);
1897
1898   /* area */
1899   if (do_free) {
1900     BKE_spacedata_freelist(&sa_dst->spacedata);
1901   }
1902   BKE_spacedata_copylist(&sa_dst->spacedata, &sa_src->spacedata);
1903
1904   /* Note; SPACE_EMPTY is possible on new screens */
1905
1906   /* regions */
1907   if (do_free) {
1908     st = BKE_spacetype_from_id(spacetype);
1909     for (ar = sa_dst->regionbase.first; ar; ar = ar->next) {
1910       BKE_area_region_free(st, ar);
1911     }
1912     BLI_freelistN(&sa_dst->regionbase);
1913   }
1914   st = BKE_spacetype_from_id(sa_src->spacetype);
1915   for (ar = sa_src->regionbase.first; ar; ar = ar->next) {
1916     ARegion *newar = BKE_area_region_copy(st, ar);
1917     BLI_addtail(&sa_dst->regionbase, newar);
1918   }
1919 }
1920
1921 void ED_area_data_swap(ScrArea *sa_dst, ScrArea *sa_src)
1922 {
1923   SWAP(char, sa_dst->spacetype, sa_src->spacetype);
1924   SWAP(SpaceType *, sa_dst->type, sa_src->type);
1925
1926   SWAP(ListBase, sa_dst->spacedata, sa_src->spacedata);
1927   SWAP(ListBase, sa_dst->regionbase, sa_src->regionbase);
1928 }
1929
1930 /* *********** Space switching code *********** */
1931
1932 void ED_area_swapspace(bContext *C, ScrArea *sa1, ScrArea *sa2)
1933 {
1934   ScrArea *tmp = MEM_callocN(sizeof(ScrArea), "addscrarea");
1935
1936   ED_area_exit(C, sa1);
1937   ED_area_exit(C, sa2);
1938
1939   ED_area_data_copy(tmp, sa1, false);
1940   ED_area_data_copy(sa1, sa2, true);
1941   ED_area_data_copy(sa2, tmp, true);
1942   ED_area_initialize(CTX_wm_manager(C), CTX_wm_window(C), sa1);
1943   ED_area_initialize(CTX_wm_manager(C), CTX_wm_window(C), sa2);
1944
1945   BKE_screen_area_free(tmp);
1946   MEM_freeN(tmp);
1947
1948   /* tell WM to refresh, cursor types etc */
1949   WM_event_add_mousemove(C);
1950
1951   ED_area_tag_redraw(sa1);
1952   ED_area_tag_refresh(sa1);
1953   ED_area_tag_redraw(sa2);
1954   ED_area_tag_refresh(sa2);
1955 }
1956
1957 /**
1958  * \param skip_ar_exit: Skip calling area exit callback. Set for opening temp spaces.
1959  */
1960 void ED_area_newspace(bContext *C, ScrArea *sa, int type, const bool skip_ar_exit)
1961 {
1962   wmWindow *win = CTX_wm_window(C);
1963
1964   if (sa->spacetype != type) {
1965     SpaceType *st;
1966     SpaceLink *slold;
1967     SpaceLink *sl;
1968     /* store sa->type->exit callback */
1969     void *sa_exit = sa->type ? sa->type->exit : NULL;
1970     /* When the user switches between space-types from the type-selector,
1971      * changing the header-type is jarring (especially when using Ctrl-MouseWheel).
1972      *
1973      * However, add-on install for example, forces the header to the top which shouldn't
1974      * be applied back to the previous space type when closing - see: T57724
1975      *
1976      * Newly created windows wont have any space data, use the alignment
1977      * the space type defaults to in this case instead
1978      * (needed for preferences to have space-type on bottom).
1979      */
1980     int header_alignment = ED_area_header_alignment_or_fallback(sa, -1);
1981     const bool sync_header_alignment = ((header_alignment != -1) &&
1982                                         (sa->flag & AREA_FLAG_TEMP_TYPE) == 0);
1983
1984     /* in some cases (opening temp space) we don't want to
1985      * call area exit callback, so we temporarily unset it */
1986     if (skip_ar_exit && sa->type) {
1987       sa->type->exit = NULL;
1988     }
1989
1990     ED_area_exit(C, sa);
1991
1992     /* restore old area exit callback */
1993     if (skip_ar_exit && sa->type) {
1994       sa->type->exit = sa_exit;
1995     }
1996
1997     st = BKE_spacetype_from_id(type);
1998     slold = sa->spacedata.first;
1999
2000     sa->spacetype = type;
2001     sa->type = st;
2002
2003     /* If st->new may be called, don't use context until then. The
2004      * sa->type->context() callback has changed but data may be invalid
2005      * (e.g. with properties editor) until space-data is properly created */
2006
2007     /* check previously stored space */
2008     for (sl = sa->spacedata.first; sl; sl = sl->next) {
2009       if (sl->spacetype == type) {
2010         break;
2011       }
2012     }
2013
2014     /* old spacedata... happened during work on 2.50, remove */
2015     if (sl && BLI_listbase_is_empty(&sl->regionbase)) {
2016       st->free(sl);
2017       BLI_freelinkN(&sa->spacedata, sl);
2018       if (slold == sl) {
2019         slold = NULL;
2020       }
2021       sl = NULL;
2022     }
2023
2024     if (sl) {
2025       /* swap regions */
2026       slold->regionbase = sa->regionbase;
2027       sa->regionbase = sl->regionbase;
2028       BLI_listbase_clear(&sl->regionbase);
2029
2030       /* put in front of list */
2031       BLI_remlink(&sa->spacedata, sl);
2032       BLI_addhead(&sa->spacedata, sl);
2033     }
2034     else {
2035       /* new space */
2036       if (st) {
2037         /* Don't get scene from context here which may depend on space-data. */
2038         Scene *scene = WM_window_get_active_scene(win);
2039         sl = st->new (sa, scene);
2040         BLI_addhead(&sa->spacedata, sl);
2041
2042         /* swap regions */
2043         if (slold) {
2044           slold->regionbase = sa->regionbase;
2045         }
2046         sa->regionbase = sl->regionbase;
2047         BLI_listbase_clear(&sl->regionbase);
2048       }
2049     }
2050
2051     /* Sync header alignment. */
2052     if (sync_header_alignment) {
2053       /* Spaces with footer. */
2054       if (st->spaceid == SPACE_TEXT) {
2055         for (ARegion *ar = sa->regionbase.first; ar; ar = ar->next) {
2056           if (ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
2057             ar->alignment = header_alignment;
2058           }
2059           if (ar->regiontype == RGN_TYPE_FOOTER) {
2060             int footer_alignment = (header_alignment == RGN_ALIGN_BOTTOM) ? RGN_ALIGN_TOP :
2061                                                                             RGN_ALIGN_BOTTOM;
2062             ar->alignment = footer_alignment;
2063             break;
2064           }
2065         }
2066       }
2067       else {
2068         for (ARegion *ar = sa->regionbase.first; ar; ar = ar->next) {
2069           if (ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
2070             ar->alignment = header_alignment;
2071             break;
2072           }
2073         }
2074       }
2075     }
2076
2077     ED_area_initialize(CTX_wm_manager(C), win, sa);
2078
2079     /* tell WM to refresh, cursor types etc */
2080     WM_event_add_mousemove(C);
2081
2082     /* send space change notifier */
2083     WM_event_add_notifier(C, NC_SPACE | ND_SPACE_CHANGED, sa);
2084
2085     ED_area_tag_refresh(sa);
2086   }
2087
2088   /* also redraw when re-used */
2089   ED_area_tag_redraw(sa);
2090 }
2091
2092 void ED_area_prevspace(bContext *C, ScrArea *sa)
2093 {
2094   SpaceLink *sl = sa->spacedata.first;
2095
2096   if (sl && sl->next) {
2097     ED_area_newspace(C, sa, sl->next->spacetype, false);
2098
2099     /* keep old spacedata but move it to end, so calling
2100      * ED_area_prevspace once more won't open it again */
2101     BLI_remlink(&sa->spacedata, sl);
2102     BLI_addtail(&sa->spacedata, sl);
2103   }
2104   else {
2105     /* no change */
2106     return;
2107   }
2108   sa->flag &= ~(AREA_FLAG_STACKED_FULLSCREEN | AREA_FLAG_TEMP_TYPE);
2109
2110   ED_area_tag_redraw(sa);
2111
2112   /* send space change notifier */
2113   WM_event_add_notifier(C, NC_SPACE | ND_SPACE_CHANGED, sa);
2114 }
2115
2116 /* returns offset for next button in header */
2117 int ED_area_header_switchbutton(const bContext *C, uiBlock *block, int yco)
2118 {
2119   ScrArea *sa = CTX_wm_area(C);
2120   bScreen *scr = CTX_wm_screen(C);
2121   PointerRNA areaptr;
2122   int xco = 0.4 * U.widget_unit;
2123
2124   RNA_pointer_create(&(scr->id), &RNA_Area, sa, &areaptr);
2125
2126   uiDefButR(block,
2127             UI_BTYPE_MENU,
2128             0,
2129             "",
2130             xco,
2131             yco,
2132             1.6 * U.widget_unit,
2133             U.widget_unit,
2134             &areaptr,
2135             "ui_type",
2136             0,
2137             0.0f,
2138             0.0f,
2139             0.0f,
2140             0.0f,
2141             "");
2142
2143   return xco + 1.7 * U.widget_unit;
2144 }
2145
2146 /************************ standard UI regions ************************/
2147
2148 static ThemeColorID region_background_color_id(const bContext *C, const ARegion *region)
2149 {
2150   ScrArea *area = CTX_wm_area(C);
2151
2152   switch (region->regiontype) {
2153     case RGN_TYPE_HEADER:
2154     case RGN_TYPE_TOOL_HEADER:
2155       if (ED_screen_area_active(C) || ED_area_is_global(area)) {
2156         return TH_HEADER;
2157       }
2158       else {
2159         return TH_HEADERDESEL;
2160       }
2161     case RGN_TYPE_PREVIEW:
2162       return TH_PREVIEW_BACK;
2163     default:
2164       return TH_BACK;
2165   }
2166 }
2167
2168 static void region_clear_color(const bContext *C, const ARegion *ar, ThemeColorID colorid)
2169 {
2170   if (ar->alignment == RGN_ALIGN_FLOAT) {
2171     /* handle our own drawing. */
2172   }
2173   else if (ar->overlap) {
2174     /* view should be in pixelspace */
2175     UI_view2d_view_restore(C);
2176
2177     float back[4];
2178     UI_GetThemeColor4fv(colorid, back);
2179     GPU_clear_color(back[3] * back[0], back[3] * back[1], back[3] * back[2], back[3]);
2180     GPU_clear(GPU_COLOR_BIT);
2181   }
2182   else {
2183     UI_ThemeClearColor(colorid);
2184     GPU_clear(GPU_COLOR_BIT);
2185   }
2186 }
2187
2188 BLI_INLINE bool streq_array_any(const char *s, const char *arr[])
2189 {
2190   for (uint i = 0; arr[i]; i++) {
2191     if (STREQ(arr[i], s)) {
2192       return true;
2193     }
2194   }
2195   return false;
2196 }
2197
2198 static void ed_panel_draw(const bContext *C,
2199                           ScrArea *sa,
2200                           ARegion *ar,
2201                           ListBase *lb,
2202                           PanelType *pt,
2203                           Panel *panel,
2204                           int w,
2205                           int em,
2206                           bool vertical)
2207 {
2208   uiStyle *style = UI_style_get_dpi();
2209
2210   /* draw panel */
2211   uiBlock *block = UI_block_begin(C, ar, pt->idname, UI_EMBOSS);
2212
2213   bool open;
2214   panel = UI_panel_begin(sa, ar, lb, block, pt, panel, &open);
2215
2216   /* bad fixed values */
2217   int xco, yco, h = 0;
2218
2219   if (pt->draw_header_preset && !(pt->flag & PNL_NO_HEADER) && (open || vertical)) {
2220     /* for preset menu */
2221     panel->layout = UI_block_layout(block,
2222                                     UI_LAYOUT_HORIZONTAL,
2223                                     UI_LAYOUT_HEADER,
2224                                     0,
2225                                     (UI_UNIT_Y * 1.1f) + style->panelspace,
2226                                     UI_UNIT_Y,
2227                                     1,
2228                                     0,
2229                                     style);
2230
2231     pt->draw_header_preset(C, panel);
2232
2233     int headerend = w - UI_UNIT_X;
2234
2235     UI_block_layout_resolve(block, &xco, &yco);
2236     UI_block_translate(block, headerend - xco, 0);
2237     panel->layout = NULL;
2238   }
2239
2240   if (pt->draw_header && !(pt->flag & PNL_NO_HEADER) && (open || vertical)) {
2241     int labelx, labely;
2242     UI_panel_label_offset(block, &labelx, &labely);
2243
2244     /* for enabled buttons */
2245     panel->layout = UI_block_layout(
2246         block, UI_LAYOUT_HORIZONTAL, UI_LAYOUT_HEADER, labelx, labely, UI_UNIT_Y, 1, 0, style);
2247
2248     pt->draw_header(C, panel);
2249
2250     UI_block_layout_resolve(block, &xco, &yco);
2251     panel->labelofs = xco - labelx;
2252     panel->layout = NULL;
2253   }
2254   else {
2255     panel->labelofs = 0;
2256   }
2257
2258   if (open) {
2259     short panelContext;
2260
2261     /* panel context can either be toolbar region or normal panels region */
2262     if (pt->flag & PNL_LAYOUT_VERT_BAR) {
2263       panelContext = UI_LAYOUT_VERT_BAR;
2264     }
2265     else if (ar->regiontype == RGN_TYPE_TOOLS) {
2266       panelContext = UI_LAYOUT_TOOLBAR;
2267     }
2268     else {
2269       panelContext = UI_LAYOUT_PANEL;
2270     }
2271
2272     panel->layout = UI_block_layout(block,
2273                                     UI_LAYOUT_VERTICAL,
2274                                     panelContext,
2275                                     (pt->flag & PNL_LAYOUT_VERT_BAR) ? 0 : style->panelspace,
2276                                     0,
2277                                     (pt->flag & PNL_LAYOUT_VERT_BAR) ? 0 :
2278                                                                        w - 2 * style->panelspace,
2279                                     em,
2280                                     0,
2281                                     style);
2282
2283     pt->draw(C, panel);
2284
2285     UI_block_layout_resolve(block, &xco, &yco);
2286     panel->layout = NULL;
2287
2288     if (yco != 0) {
2289       h = -yco + 2 * style->panelspace;
2290     }
2291   }
2292
2293   UI_block_end(C, block);
2294
2295   /* Draw child panels. */
2296   if (open) {
2297     for (LinkData *link = pt->children.first; link; link = link->next) {
2298       PanelType *child_pt = link->data;
2299       Panel *child_panel = UI_panel_find_by_type(&panel->children, child_pt);
2300
2301       if (child_pt->draw && (!child_pt->poll || child_pt->poll(C, child_pt))) {
2302         ed_panel_draw(C, sa, ar, &panel->children, child_pt, child_panel, w, em, vertical);
2303       }
2304     }
2305   }
2306
2307   UI_panel_end(block, w, h);
2308 }
2309
2310 /**
2311  * \param contexts: A NULL terminated array of context strings to match against.
2312  * Matching against any of these strings will draw the panel.
2313  * Can be NULL to skip context checks.
2314  */
2315 void ED_region_panels_layout_ex(
2316     const bContext *C, ARegion *ar, const char *contexts[], int contextnr, const bool vertical)
2317 {
2318   ar->runtime.category = NULL;
2319
2320   const WorkSpace *workspace = CTX_wm_workspace(C);
2321   ScrArea *sa = CTX_wm_area(C);
2322   PanelType *pt;
2323   View2D *v2d = &ar->v2d;
2324   int x, y, w, em;
2325   bool is_context_new = 0;
2326   int scroll;
2327
2328   /* XXX, should use some better check? */
2329   /* For now also has hardcoded check for clip editor until it supports actual toolbar. */
2330   bool use_category_tabs = ((1 << ar->regiontype) & RGN_TYPE_HAS_CATEGORY_MASK) ||
2331                            (ar->regiontype == RGN_TYPE_TOOLS && sa->spacetype == SPACE_CLIP);
2332   /* offset panels for small vertical tab area */
2333   const char *category = NULL;
2334   const int category_tabs_width = UI_PANEL_CATEGORY_MARGIN_WIDTH;
2335   int margin_x = 0;
2336   const bool region_layout_based = ar->flag & RGN_FLAG_DYNAMIC_SIZE;
2337
2338   BLI_SMALLSTACK_DECLARE(pt_stack, PanelType *);
2339
2340   if (contextnr != -1) {
2341     is_context_new = UI_view2d_tab_set(v2d, contextnr);
2342   }
2343
2344   /* before setting the view */
2345   if (vertical) {
2346     /* only allow scrolling in vertical direction */
2347     v2d->keepofs |= V2D_LOCKOFS_X | V2D_KEEPOFS_Y;
2348     v2d->keepofs &= ~(V2D_LOCKOFS_Y | V2D_KEEPOFS_X);
2349     v2d->scroll &= ~(V2D_SCROLL_BOTTOM);
2350     v2d->scroll |= (V2D_SCROLL_RIGHT);
2351   }
2352   else {
2353     /* for now, allow scrolling in both directions (since layouts are optimized for vertical,
2354      * they often don't fit in horizontal layout)
2355      */
2356     v2d->keepofs &= ~(V2D_LOCKOFS_X | V2D_LOCKOFS_Y | V2D_KEEPOFS_X | V2D_KEEPOFS_Y);
2357     v2d->scroll |= (V2D_SCROLL_BOTTOM);
2358     v2d->scroll &= ~(V2D_SCROLL_RIGHT);
2359   }
2360
2361   scroll = v2d->scroll;
2362
2363   /* collect panels to draw */
2364   for (pt = ar->type->paneltypes.last; pt; pt = pt->prev) {
2365     /* Only draw top level panels. */
2366     if (pt->parent) {
2367       continue;
2368     }
2369
2370     /* verify context */
2371     if (contexts && pt->context[0] && !streq_array_any(pt->context, contexts)) {
2372       continue;
2373     }
2374
2375     /* If we're tagged, only use compatible. */
2376     if (pt->owner_id[0] && BKE_workspace_owner_id_check(workspace, pt->owner_id) == false) {
2377       continue;
2378     }
2379
2380     /* draw panel */
2381     if (pt->draw && (!pt->poll || pt->poll(C, pt))) {
2382       BLI_SMALLSTACK_PUSH(pt_stack, pt);
2383     }
2384   }
2385
2386   /* collect categories */
2387   if (use_category_tabs) {
2388     UI_panel_category_clear_all(ar);
2389
2390     /* gather unique categories */
2391     BLI_SMALLSTACK_ITER_BEGIN (pt_stack, pt) {
2392       if (pt->category[0]) {
2393         if (!UI_panel_category_find(ar, pt->category)) {
2394           UI_panel_category_add(ar, pt->category);
2395         }
2396       }
2397     }
2398     BLI_SMALLSTACK_ITER_END;
2399
2400     if (!UI_panel_category_is_visible(ar)) {
2401       use_category_tabs = false;
2402     }
2403     else {
2404       category = UI_panel_category_active_get(ar, true);
2405       margin_x = category_tabs_width;
2406     }
2407   }
2408
2409   if (vertical) {
2410     w = BLI_rctf_size_x(&v2d->cur);
2411     em = (ar->type->prefsizex) ? 10 : 20; /* works out to 10*UI_UNIT_X or 20*UI_UNIT_X */
2412   }
2413   else {
2414     w = UI_PANEL_WIDTH;
2415     em = (ar->type->prefsizex) ? 10 : 20;
2416   }
2417
2418   w -= margin_x;
2419
2420   /* create panels */
2421   UI_panels_begin(C, ar);
2422
2423   /* set view2d view matrix  - UI_block_begin() stores it */
2424   UI_view2d_view_ortho(v2d);
2425
2426   BLI_SMALLSTACK_ITER_BEGIN (pt_stack, pt) {
2427     Panel *panel = UI_panel_find_by_type(&ar->panels, pt);
2428
2429     if (use_category_tabs && pt->category[0] && !STREQ(category, pt->category)) {
2430       if ((panel == NULL) || ((panel->flag & PNL_PIN) == 0)) {
2431         continue;
2432       }
2433     }
2434
2435     ed_panel_draw(C, sa, ar, &ar->panels, pt, panel, w, em, vertical);
2436   }
2437   BLI_SMALLSTACK_ITER_END;
2438
2439   /* align panels and return size */
2440   UI_panels_end(C, ar, &x, &y);
2441
2442   /* before setting the view */
2443   if (region_layout_based) {
2444     /* XXX, only single panel support atm.
2445      * Can't use x/y values calculated above because they're not using the real height of panels,
2446      * instead they calculate offsets for the next panel to start drawing. */
2447     Panel *panel = ar->panels.last;
2448     if (panel != NULL) {
2449       int size_dyn[2] = {
2450           UI_UNIT_X * ((panel->flag & PNL_CLOSED) ? 8 : 14) / UI_DPI_FAC,
2451           UI_panel_size_y(panel) / UI_DPI_FAC,
2452       };
2453       /* region size is layout based and needs to be updated */
2454       if ((ar->sizex != size_dyn[0]) || (ar->sizey != size_dyn[1])) {
2455         ar->sizex = size_dyn[0];
2456         ar->sizey = size_dyn[1];
2457         sa->flag |= AREA_FLAG_REGION_SIZE_UPDATE;
2458       }
2459       y = ABS(ar->sizey * UI_DPI_FAC - 1);
2460     }
2461   }
2462   else if (vertical) {
2463     /* We always keep the scroll offset -
2464      * so the total view gets increased with the scrolled away part. */
2465     if (v2d->cur.ymax < -FLT_EPSILON) {
2466       /* Clamp to lower view boundary */
2467       if (v2d->tot.ymin < -v2d->winy) {
2468         y = min_ii(y, 0);
2469       }
2470       else {
2471         y = min_ii(y, v2d->cur.ymin);
2472       }
2473     }
2474
2475     y = -y;
2476   }
2477   else {
2478     /* don't jump back when panels close or hide */
2479     if (!is_context_new) {
2480       if (v2d->tot.xmax > v2d->winx) {
2481         x = max_ii(x, 0);
2482       }
2483       else {
2484         x = max_ii(x, v2d->cur.xmax);
2485       }
2486     }
2487
2488     y = -y;
2489   }
2490
2491   /* this also changes the 'cur' */
2492   UI_view2d_totRect_set(v2d, x, y);
2493
2494   if (scroll != v2d->scroll) {
2495     /* Note: this code scales fine, but because of rounding differences, positions of elements
2496      * flip +1 or -1 pixel compared to redoing the entire layout again.
2497      * Leaving in commented code for future tests */
2498 #if 0
2499     UI_panels_scale(ar, BLI_rctf_size_x(&v2d->cur));
2500     break;
2501 #endif
2502   }
2503
2504   if (use_category_tabs) {
2505     ar->runtime.category = category;
2506   }
2507 }
2508 void ED_region_panels_layout(const bContext *C, ARegion *ar)
2509 {
2510   ED_region_panels_layout_ex(C, ar, NULL, -1, true);
2511 }
2512
2513 void ED_region_panels_draw(const bContext *C, ARegion *ar)
2514 {
2515   View2D *v2d = &ar->v2d;
2516
2517   if (ar->alignment != RGN_ALIGN_FLOAT) {
2518     region_clear_color(
2519         C, ar, (ar->type->regionid == RGN_TYPE_PREVIEW) ? TH_PREVIEW_BACK : TH_BACK);
2520   }
2521
2522   /* reset line width for drawing tabs */
2523   GPU_line_width(1.0f);
2524
2525   /* set the view */
2526   UI_view2d_view_ortho(v2d);
2527
2528   /* View2D matrix might have changed due to dynamic sized regions. */
2529   UI_blocklist_update_window_matrix(C, &ar->uiblocks);
2530
2531   /* draw panels */
2532   UI_panels_draw(C, ar);
2533
2534   /* restore view matrix */
2535   UI_view2d_view_restore(C);
2536
2537   /* Set in layout. */
2538   if (ar->runtime.category) {
2539     UI_panel_category_draw_all(ar, ar->runtime.category);
2540   }
2541
2542   /* scrollers */
2543   const rcti *mask = NULL;
2544   rcti mask_buf;
2545   if (ar->runtime.category && (ar->alignment == RGN_ALIGN_RIGHT)) {
2546     UI_view2d_mask_from_win(v2d, &mask_buf);
2547     mask_buf.xmax -= UI_PANEL_CATEGORY_MARGIN_WIDTH;
2548     mask = &mask_buf;
2549   }
2550   View2DScrollers *scrollers = UI_view2d_scrollers_calc(
2551       C, v2d, mask, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
2552   UI_view2d_scrollers_draw(C, v2d, scrollers);
2553   UI_view2d_scrollers_free(scrollers);
2554 }
2555
2556 void ED_region_panels_ex(
2557     const bContext *C, ARegion *ar, const char *contexts[], int contextnr, const bool vertical)
2558 {
2559   /* TODO: remove? */
2560   ED_region_panels_layout_ex(C, ar, contexts, contextnr, vertical);
2561   ED_region_panels_draw(C, ar);
2562 }
2563
2564 void ED_region_panels(const bContext *C, ARegion *ar)
2565 {
2566   /* TODO: remove? */
2567   ED_region_panels_layout(C, ar);
2568   ED_region_panels_draw(C, ar);
2569 }
2570
2571 void ED_region_panels_init(wmWindowManager *wm, ARegion *ar)
2572 {
2573   wmKeyMap *keymap;
2574
2575   UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_PANELS_UI, ar->winx, ar->winy);
2576
2577   keymap = WM_keymap_ensure(wm->defaultconf, "View2D Buttons List", 0, 0);
2578   WM_event_add_keymap_handler(&ar->handlers, keymap);
2579 }
2580
2581 void ED_region_header_layout(const bContext *C, ARegion *ar)
2582 {
2583   uiStyle *style = UI_style_get_dpi();
2584   uiBlock *block;
2585   uiLayout *layout;
2586   HeaderType *ht;
2587   Header header = {NULL};
2588   bool region_layout_based = ar->flag & RGN_FLAG_DYNAMIC_SIZE;
2589
2590   /* Height of buttons and scaling needed to achieve it. */
2591   const int buttony = min_ii(UI_UNIT_Y, ar->winy - 2 * UI_DPI_FAC);
2592   const float buttony_scale = buttony / (float)UI_UNIT_Y;
2593
2594   /* Vertically center buttons. */
2595   int xco = UI_HEADER_OFFSET;
2596   int yco = buttony + (ar->winy - buttony) / 2;
2597   int maxco = xco;
2598
2599   /* XXX workaround for 1 px alignment issue. Not sure what causes it...
2600    * Would prefer a proper fix - Julian */
2601   if (!ELEM(CTX_wm_area(C)->spacetype, SPACE_TOPBAR, SPACE_STATUSBAR)) {
2602     yco -= 1;
2603   }
2604
2605   /* set view2d view matrix for scrolling (without scrollers) */
2606   UI_view2d_view_ortho(&ar->v2d);
2607
2608   /* draw all headers types */
2609   for (ht = ar->type->headertypes.first; ht; ht = ht->next) {
2610     if (ht->poll && !ht->poll(C, ht)) {
2611       continue;
2612     }
2613
2614     block = UI_block_begin(C, ar, ht->idname, UI_EMBOSS);
2615     layout = UI_block_layout(
2616         block, UI_LAYOUT_HORIZONTAL, UI_LAYOUT_HEADER, xco, yco, buttony, 1, 0, style);
2617
2618     if (buttony_scale != 1.0f) {
2619       uiLayoutSetScaleY(layout, buttony_scale);
2620     }
2621
2622     if (ht->draw) {
2623       header.type = ht;
2624       header.layout = layout;
2625       ht->draw(C, &header);
2626       if (ht->next) {
2627         uiItemS(layout);
2628       }
2629
2630       /* for view2d */
2631       xco = uiLayoutGetWidth(layout);
2632       if (xco > maxco) {
2633         maxco = xco;
2634       }
2635     }
2636
2637     UI_block_layout_resolve(block, &xco, &yco);
2638
2639     /* for view2d */
2640     if (xco > maxco) {
2641       maxco = xco;
2642     }
2643
2644     int new_sizex = (maxco + UI_HEADER_OFFSET) / UI_DPI_FAC;
2645
2646     if (region_layout_based && (ar->sizex != new_sizex)) {
2647       /* region size is layout based and needs to be updated */
2648       ScrArea *sa = CTX_wm_area(C);
2649
2650       ar->sizex = new_sizex;
2651       sa->flag |= AREA_FLAG_REGION_SIZE_UPDATE;
2652     }
2653
2654     UI_block_end(C, block);
2655   }
2656
2657   if (!region_layout_based) {
2658     maxco += UI_HEADER_OFFSET;
2659   }
2660
2661   /* always as last  */
2662   UI_view2d_totRect_set(&ar->v2d, maxco, ar->winy);
2663
2664   /* restore view matrix */
2665   UI_view2d_view_restore(C);
2666 }
2667
2668 void ED_region_header_draw(const bContext *C, ARegion *ar)
2669 {
2670   /* clear */
2671   region_clear_color(C, ar, region_background_color_id(C, ar));
2672
2673   UI_view2d_view_ortho(&ar->v2d);
2674
2675   /* View2D matrix might have changed due to dynamic sized regions. */
2676   UI_blocklist_update_window_matrix(C, &ar->uiblocks);
2677
2678   /* draw blocks */
2679   UI_blocklist_draw(C, &ar->uiblocks);
2680
2681   /* restore view matrix */
2682   UI_view2d_view_restore(C);
2683 }
2684
2685 void ED_region_header(const bContext *C, ARegion *ar)
2686 {
2687   /* TODO: remove? */
2688   ED_region_header_layout(C, ar);
2689   ED_region_header_draw(C, ar);
2690 }
2691
2692 void ED_region_header_init(ARegion *ar)
2693 {
2694   UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
2695 }
2696
2697 int ED_area_headersize(void)
2698 {
2699   /* Accomodate widget and padding. */
2700   return U.widget_unit + (int)(UI_DPI_FAC * HEADER_PADDING_Y);
2701 }
2702
2703 int ED_area_header_alignment_or_fallback(const ScrArea *area, int fallback)
2704 {
2705   for (ARegion *ar = area->regionbase.first; ar; ar = ar->next) {
2706     if (ar->regiontype == RGN_TYPE_HEADER) {
2707       return ar->alignment;
2708     }
2709   }
2710   return fallback;
2711 }
2712
2713 int ED_area_header_alignment(const ScrArea *area)
2714 {
2715   return ED_area_header_alignment_or_fallback(
2716       area, (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_BOTTOM : RGN_ALIGN_TOP);
2717 }
2718
2719 int ED_area_footersize(void)
2720 {
2721   return ED_area_headersize();
2722 }
2723
2724 int ED_area_footer_alignment_or_fallback(const ScrArea *area, int fallback)
2725 {
2726   for (ARegion *ar = area->regionbase.first; ar; ar = ar->next) {
2727     if (ar->regiontype == RGN_TYPE_FOOTER) {
2728       return ar->alignment;
2729     }
2730   }
2731   return fallback;
2732 }
2733
2734 int ED_area_footer_alignment(const ScrArea *area)
2735 {
2736   return ED_area_footer_alignment_or_fallback(
2737       area, (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_TOP : RGN_ALIGN_BOTTOM);
2738 }
2739
2740 /**
2741  * \return the final height of a global \a area, accounting for DPI.
2742  */
2743 int ED_area_global_size_y(const ScrArea *area)
2744 {
2745   BLI_assert(ED_area_is_global(area));
2746   return round_fl_to_int(area->global->cur_fixed_height * UI_DPI_FAC);
2747 }
2748 int ED_area_global_min_size_y(const ScrArea *area)
2749 {
2750   BLI_assert(ED_area_is_global(area));
2751   return round_fl_to_int(area->global->size_min * UI_DPI_FAC);
2752 }
2753 int ED_area_global_max_size_y(const ScrArea *area)
2754 {
2755   BLI_assert(ED_area_is_global(area));
2756   return round_fl_to_int(area->global->size_max * UI_DPI_FAC);
2757 }
2758
2759 bool ED_area_is_global(const ScrArea *area)
2760 {
2761   return area->global != NULL;
2762 }
2763
2764 ScrArea *ED_screen_areas_iter_first(const wmWindow *win, const bScreen *screen)
2765 {
2766   ScrArea *global_area = win->global_areas.areabase.first;
2767
2768   if (!global_area) {
2769     return screen->areabase.first;
2770   }
2771   else if ((global_area->global->flag & GLOBAL_AREA_IS_HIDDEN) == 0) {
2772     return global_area;
2773   }
2774   /* Find next visible area. */
2775   return ED_screen_areas_iter_next(screen, global_area);
2776 }
2777 ScrArea *ED_screen_areas_iter_next(const bScreen *screen, const ScrArea *area)
2778 {
2779   if (area->global) {
2780     for (ScrArea *area_iter = area->next; area_iter; area_iter = area_iter->next) {
2781       if ((area_iter->global->flag & GLOBAL_AREA_IS_HIDDEN) == 0) {
2782         return area_iter;
2783       }
2784     }
2785     /* No visible next global area found, start iterating over layout areas. */
2786     return screen->areabase.first;
2787   }
2788
2789   return area->next;
2790 }
2791
2792 /**
2793  * For now we just assume all global areas are made up out of horizontal bars
2794  * with the same size. A fixed size could be stored in ARegion instead if needed.
2795  *
2796  * \return the DPI aware height of a single bar/region in global areas.
2797  */
2798 int ED_region_global_size_y(void)
2799 {
2800   return ED_area_headersize(); /* same size as header */
2801 }
2802
2803 void ED_region_info_draw_multiline(ARegion *ar,
2804                                    const char *text_array[],
2805                                    float fill_color[4],
2806                                    const bool full_redraw)
2807 {
2808   const int header_height = UI_UNIT_Y;
2809   uiStyle *style = UI_style_get_dpi();
2810   int fontid = style->widget.uifont_id;
2811   int scissor[4];
2812   rcti rect;
2813   int num_lines = 0;
2814
2815   /* background box */
2816   ED_region_visible_rect(ar, &rect);
2817
2818   /* Box fill entire width or just around text. */
2819   if (!full_redraw) {
2820     const char **text = &text_array[0];
2821     while (*text) {
2822       rect.xmax = min_ii(rect.xmax,
2823                          rect.xmin + BLF_width(fontid, *text, BLF_DRAW_STR_DUMMY_MAX) +
2824                              1.2f * U.widget_unit);
2825       text++;
2826       num_lines++;
2827     }
2828   }
2829   /* Just count the line number. */
2830   else {
2831     const char **text = &text_array[0];
2832     while (*text) {
2833       text++;
2834       num_lines++;
2835     }
2836   }
2837
2838   rect.ymin = rect.ymax - header_height * num_lines;
2839
2840   /* setup scissor */
2841   GPU_scissor_get_i(scissor);
2842   GPU_scissor(rect.xmin, rect.ymin, BLI_rcti_size_x(&rect) + 1, BLI_rcti_size_y(&rect) + 1);
2843
2844   GPU_blend(true);
2845   GPU_blend_set_func_separate(
2846       GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
2847   GPUVertFormat *format = immVertexFormat();
2848   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
2849   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2850   immUniformColor4fv(fill_color);
2851   immRecti(pos, rect.xmin, rect.ymin, rect.xmax + 1, rect.ymax + 1);
2852   immUnbindProgram();
2853   GPU_blend(false);
2854
2855   /* text */
2856   UI_FontThemeColor(fontid, TH_TEXT_HI);
2857   BLF_clipping(fontid, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
2858   BLF_enable(fontid, BLF_CLIPPING);
2859   int offset = num_lines - 1;
2860   {
2861     const char **text = &text_array[0];
2862     while (*text) {
2863       BLF_position(fontid,
2864                    rect.xmin + 0.6f * U.widget_unit,
2865                    rect.ymin + 0.3f * U.widget_unit + offset * header_height,
2866                    0.0f);
2867       BLF_draw(fontid, *text, BLF_DRAW_STR_DUMMY_MAX);
2868       text++;
2869       offset--;
2870     }
2871   }
2872
2873   BLF_disable(fontid, BLF_CLIPPING);
2874
2875   /* restore scissor as it was before */
2876   GPU_scissor(scissor[0], scissor[1], scissor[2], scissor[3]);
2877 }
2878
2879 void ED_region_info_draw(ARegion *ar,
2880                          const char *text,
2881                          float fill_color[4],
2882                          const bool full_redraw)
2883 {
2884   ED_region_info_draw_multiline(ar, (const char * [2]){text, NULL}, fill_color, full_redraw);
2885 }
2886
2887 #define MAX_METADATA_STR 1024
2888
2889 static const char *meta_data_list[] = {
2890     "File",
2891     "Strip",
2892     "Date",
2893     "RenderTime",
2894     "Note",
2895     "Marker",
2896     "Time",
2897     "Frame",
2898     "Camera",
2899     "Scene",
2900 };
2901
2902 BLI_INLINE bool metadata_is_valid(ImBuf *ibuf, char *r_str, short index, int offset)
2903 {
2904   return (IMB_metadata_get_field(
2905               ibuf->metadata, meta_data_list[index], r_str + offset, MAX_METADATA_STR - offset) &&
2906           r_str[0]);
2907 }
2908
2909 BLI_INLINE bool metadata_is_custom_drawable(const char *field)
2910 {
2911   /* Metadata field stored by Blender for multilayer EXR images. Is rather
2912    * useless to be viewed all the time. Can still be seen in the Metadata
2913    * panel. */
2914   if (STREQ(field, "BlenderMultiChannel")) {
2915     return false;
2916   }
2917   /* Is almost always has value "scanlineimage", also useless to be seen
2918    * all the time. */
2919   if (STREQ(field, "type")) {
2920     return false;
2921   }
2922   return !BKE_stamp_is_known_field(field);
2923 }
2924
2925 typedef struct MetadataCustomDrawContext {
2926   int fontid;
2927   int xmin, ymin;
2928   int vertical_offset;
2929   int current_y;
2930 } MetadataCustomDrawContext;
2931
2932 static void metadata_custom_draw_fields(const char *field, const char *value, void *ctx_v)
2933 {
2934   if (!metadata_is_custom_drawable(field)) {
2935     return;
2936   }
2937   MetadataCustomDrawContext *ctx = (MetadataCustomDrawContext *)ctx_v;
2938   char temp_str[MAX_METADATA_STR];
2939   BLI_snprintf(temp_str, MAX_METADATA_STR, "%s: %s", field, value);
2940   BLF_position(ctx->fontid, ctx->xmin, ctx->ymin + ctx->current_y, 0.0f);
2941   BLF_draw(ctx->fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2942   ctx->current_y += ctx->vertical_offset;
2943 }
2944
2945 static void metadata_draw_imbuf(ImBuf *ibuf, const rctf *rect, int fontid, const bool is_top)
2946 {
2947   char temp_str[MAX_METADATA_STR];
2948   int line_width;
2949   int ofs_y = 0;
2950   short i;
2951   int len;
2952   const float height = BLF_height_max(fontid);
2953   const float margin = height / 8;
2954   const float vertical_offset = (height + margin);
2955
2956   /* values taking margins into account */
2957   const float descender = BLF_descender(fontid);
2958   const float xmin = (rect->xmin + margin);
2959   const float xmax = (rect->xmax - margin);
2960   const float ymin = (rect->ymin + margin) - descender;
2961   const float ymax = (rect->ymax - margin) - descender;
2962
2963   if (is_top) {
2964     for (i = 0; i < 4; i++) {
2965       /* first line */
2966       if (i == 0) {
2967         bool do_newline = false;
2968         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[0]);
2969         if (metadata_is_valid(ibuf, temp_str, 0, len)) {
2970           BLF_position(fontid, xmin, ymax - vertical_offset, 0.0f);
2971           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2972           do_newline = true;
2973         }
2974
2975         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[1]);
2976         if (metadata_is_valid(ibuf, temp_str, 1, len)) {
2977           line_width = BLF_width(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2978           BLF_position(fontid, xmax - line_width, ymax - vertical_offset, 0.0f);
2979           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2980           do_newline = true;
2981         }
2982
2983         if (do_newline) {
2984           ofs_y += vertical_offset;
2985         }
2986       } /* Strip */
2987       else if (i == 1 || i == 2) {
2988         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i + 1]);
2989         if (metadata_is_valid(ibuf, temp_str, i + 1, len)) {
2990           BLF_position(fontid, xmin, ymax - vertical_offset - ofs_y, 0.0f);
2991           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2992           ofs_y += vertical_offset;
2993         }
2994       } /* Note (wrapped) */
2995       else if (i == 3) {
2996         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i + 1]);
2997         if (metadata_is_valid(ibuf, temp_str, i + 1, len)) {
2998           struct ResultBLF info;
2999           BLF_enable(fontid, BLF_WORD_WRAP);
3000           BLF_wordwrap(fontid, ibuf->x - (margin * 2));
3001           BLF_position(fontid, xmin, ymax - vertical_offset - ofs_y, 0.0f);
3002           BLF_draw_ex(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX, &info);
3003           BLF_wordwrap(fontid, 0);
3004           BLF_disable(fontid, BLF_WORD_WRAP);
3005           ofs_y += vertical_offset * info.lines;
3006         }
3007       }
3008       else {
3009         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i + 1]);
3010         if (metadata_is_valid(ibuf, temp_str, i + 1, len)) {
3011           line_width = BLF_width(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
3012           BLF_position(fontid, xmax - line_width, ymax - vertical_offset - ofs_y, 0.0f);
3013           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
3014           ofs_y += vertical_offset;
3015         }
3016       }
3017     }
3018   }
3019   else {
3020     MetadataCustomDrawContext ctx;
3021     ctx.fontid = fontid;
3022     ctx.xmin = xmin;
3023     ctx.ymin = ymin;
3024     ctx.vertical_offset = vertical_offset;
3025     ctx.current_y = ofs_y;
3026     ctx.vertical_offset = vertical_offset;
3027     IMB_metadata_foreach(ibuf, metadata_custom_draw_fields, &ctx);
3028     int ofs_x = 0;
3029     ofs_y = ctx.current_y;
3030     for (i = 5; i < 10; i++) {
3031       len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i]);
3032       if (metadata_is_valid(ibuf, temp_str, i, len)) {
3033         BLF_position(fontid, xmin + ofs_x, ymin + ofs_y, 0.0f);
3034         BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
3035
3036         ofs_x += BLF_width(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX) + UI_UNIT_X;
3037       }
3038     }
3039   }
3040 }
3041
3042 typedef struct MetadataCustomCountContext {
3043   int count;
3044 } MetadataCustomCountContext;
3045
3046 static void metadata_custom_count_fields(const char *field, const char *UNUSED(value), void *ctx_v)
3047 {
3048   if (!metadata_is_custom_drawable(field)) {
3049     return;
3050   }
3051   MetadataCustomCountContext *ctx = (MetadataCustomCountContext *)ctx_v;
3052   ctx->count++;
3053 }
3054
3055 static float metadata_box_height_get(ImBuf *ibuf, int fontid, const bool is_top)
3056 {
3057   const float height = BLF_height_max(fontid);
3058   const float margin = (height / 8);
3059   char str[MAX_METADATA_STR] = "";
3060   short i, count = 0;
3061
3062   if (is_top) {
3063     if (metadata_is_valid(ibuf, str, 0, 0) || metadata_is_valid(ibuf, str, 1, 0)) {
3064       count++;
3065     }
3066     for (i = 2; i < 5; i++) {
3067       if (metadata_is_valid(ibuf, str, i, 0)) {
3068         if (i == 4) {
3069           struct {
3070             struct ResultBLF info;
3071             rctf rect;
3072           } wrap;
3073
3074           BLF_enable(fontid, BLF_WORD_WRAP);
3075           BLF_wordwrap(fontid, ibuf->x - (margin * 2));
3076           BLF_boundbox_ex(fontid, str, sizeof(str), &wrap.rect, &wrap.info);
3077           BLF_wordwrap(fontid, 0);
3078           BLF_disable(fontid, BLF_WORD_WRAP);
3079
3080           count += wrap.info.lines;
3081         }
3082         else {
3083           count++;
3084         }
3085       }
3086     }
3087   }
3088   else {
3089     for (i = 5; i < 10; i++) {
3090       if (metadata_is_valid(ibuf, str, i, 0)) {
3091         count = 1;
3092         break;
3093       }
3094     }
3095     MetadataCustomCountContext ctx;
3096     ctx.count = 0;
3097     IMB_metadata_foreach(ibuf, metadata_custom_count_fields, &ctx);
3098     count += ctx.count;
3099   }
3100
3101   if (count) {
3102     return (height + margin) * count;
3103   }
3104
3105   return 0;
3106 }
3107
3108 #undef MAX_METADATA_STR
3109
3110 void ED_region_image_metadata_draw(
3111     int x, int y, ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy)
3112 {
3113   float box_y;
3114   rctf rect;
3115   uiStyle *style = UI_style_get_dpi();
3116
3117   if (!ibuf->metadata) {
3118     return;
3119   }
3120
3121   /* find window pixel coordinates of origin */
3122   GPU_matrix_push();
3123
3124   /* offset and zoom using ogl */
3125   GPU_matrix_translate_2f(x, y);
3126   GPU_matrix_scale_2f(zoomx, zoomy);
3127
3128   BLF_size(blf_mono_font, style->widgetlabel.points * 1.5f * U.pixelsize, U.dpi);
3129
3130   /* *** upper box*** */
3131
3132   /* get needed box height */
3133   box_y = metadata_box_height_get(ibuf, blf_mono_font, true);
3134
3135   if (box_y) {
3136     /* set up rect */
3137     BLI_rctf_init(&rect, frame->xmin, frame->xmax, frame->ymax, frame->ymax + box_y);
3138     /* draw top box */
3139     GPUVertFormat *format = immVertexFormat();
3140     uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3141     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3142     immUniformThemeColor(TH_METADATA_BG);
3143     immRectf(pos, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3144     immUnbindProgram();
3145
3146     BLF_clipping(blf_mono_font, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3147     BLF_enable(blf_mono_font, BLF_CLIPPING);
3148
3149     UI_FontThemeColor(blf_mono_font, TH_METADATA_TEXT);
3150     metadata_draw_imbuf(ibuf, &rect, blf_mono_font, true);
3151
3152     BLF_disable(blf_mono_font, BLF_CLIPPING);
3153   }
3154
3155   /* *** lower box*** */
3156
3157   box_y = metadata_box_height_get(ibuf, blf_mono_font, false);
3158
3159   if (box_y) {
3160     /* set up box rect */
3161     BLI_rctf_init(&rect, frame->xmin, frame->xmax, frame->ymin - box_y, frame->ymin);
3162     /* draw top box */
3163     GPUVertFormat *format = immVertexFormat();
3164     uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3165     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3166     immUniformThemeColor(TH_METADATA_BG);
3167     immRectf(pos, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3168     immUnbindProgram();
3169
3170     BLF_clipping(blf_mono_font, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3171     BLF_enable(blf_mono_font, BLF_CLIPPING);
3172
3173     UI_FontThemeColor(blf_mono_font, TH_METADATA_TEXT);
3174     metadata_draw_imbuf(ibuf, &rect, blf_mono_font, false);
3175
3176     BLF_disable(blf_mono_font, BLF_CLIPPING);
3177   }
3178
3179   GPU_matrix_pop();
3180 }
3181
3182 typedef struct MetadataPanelDrawContext {
3183   uiLayout *layout;
3184 } MetadataPanelDrawContext;
3185
3186 static void metadata_panel_draw_field(const char *field, const char *value, void *ctx_v)
3187 {
3188   MetadataPanelDrawContext *ctx = (MetadataPanelDrawContext *)ctx_v;
3189   uiLayout *row = uiLayoutRow(ctx->layout, false);
3190   uiItemL(row, field, ICON_NONE);
3191   uiItemL(row, value, ICON_NONE);
3192 }
3193
3194 void ED_region_image_metadata_panel_draw(ImBuf *ibuf, uiLayout *layout)
3195 {
3196   MetadataPanelDrawContext ctx;
3197   ctx.layout = layout;
3198   IMB_metadata_foreach(ibuf, metadata_panel_draw_field, &ctx);
3199 }
3200
3201 void ED_region_grid_draw(ARegion *ar, float zoomx, float zoomy)
3202 {
3203   float gridsize, gridstep = 1.0f / 32.0f;
3204   float fac, blendfac;
3205   int x1, y1, x2, y2;
3206
3207   /* the image is located inside (0, 0), (1, 1) as set by view2d */
3208   UI_view2d_view_to_region(&ar->v2d, 0.0f, 0.0f, &x1, &y1);
3209   UI_view2d_view_to_region(&ar->v2d, 1.0f, 1.0f, &x2, &y2);
3210
3211   GPUVertFormat *format = immVertexFormat();
3212   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3213
3214   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3215   immUniformThemeColorShade(TH_BACK, 20);
3216   immRectf(pos, x1, y1, x2, y2);
3217   immUnbindProgram();
3218
3219   /* gridsize adapted to zoom level */
3220   gridsize = 0.5f * (zoomx + zoomy);
3221   if (gridsize <= 0.0f) {
3222     return;
3223   }
3224
3225   if (gridsize < 1.0f) {
3226     while (gridsize < 1.0f) {
3227       gridsize *= 4.0f;
3228       gridstep *= 4.0f;
3229     }
3230   }
3231   else {
3232     while (gridsize >= 4.0f) {
3233       gridsize /= 4.0f;
3234       gridstep /= 4.0f;
3235     }
3236   }
3237
3238   blendfac = 0.25f * gridsize - floorf(0.25f * gridsize);
3239   CLAMP(blendfac, 0.0f, 1.0f);
3240
3241   int count_fine = 1.0f / gridstep;
3242   int count_large = 1.0f / (4.0f * gridstep);
3243
3244   if (count_fine > 0) {
3245     GPU_vertformat_clear(format);
3246     pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3247     unsigned color = GPU_vertformat_attr_add(format, "color", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
3248
3249     immBindBuiltinProgram(GPU_SHADER_2D_FLAT_COLOR);
3250     immBegin(GPU_PRIM_LINES, 4 * count_fine + 4 * count_large);
3251
3252     float theme_color[3];
3253     UI_GetThemeColorShade3fv(TH_BACK, (int)(20.0f * (1.0f - blendfac)), theme_color);
3254     fac = 0.0f;
3255
3256     /* the fine resolution level */
3257     for (int i = 0; i < count_fine; i++) {
3258       immAttr3fv(color, theme_color);
3259       immVertex2f(pos, x1, y1 * (1.0f - fac) + y2 * fac);
3260       immAttr3fv(color, theme_color);
3261       immVertex2f(pos, x2, y1 * (1.0f - fac) + y2 * fac);
3262       immAttr3fv(color, theme_color);
3263       immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y1);
3264       immAttr3fv(color, theme_color);
3265       immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y2);
3266       fac += gridstep;
3267     }
3268
3269     if (count_large > 0) {
3270       UI_GetThemeColor3fv(TH_BACK, theme_color);
3271       fac = 0.0f;
3272
3273       /* the large resolution level */
3274       for (int i = 0; i < count_large; i++) {
3275         immAttr3fv(color, theme_color);
3276         immVertex2f(pos, x1, y1 * (1.0f - fac) + y2 * fac);
3277         immAttr3fv(color, theme_color);
3278         immVertex2f(pos, x2, y1 * (1.0f - fac) + y2 * fac);
3279         immAttr3fv(color, theme_color);
3280         immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y1);
3281         immAttr3fv(color, theme_color);
3282         immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y2);
3283         fac += 4.0f * gridstep;
3284       }
3285     }
3286
3287     immEnd();
3288     immUnbindProgram();
3289   }
3290 }
3291
3292 /* If the area has overlapping regions, it returns visible rect for Region *ar */
3293 /* rect gets returned in local region coordinates */
3294 void ED_region_visible_rect(ARegion *ar, rcti *rect)
3295 {
3296   ARegion *arn = ar;
3297
3298   /* allow function to be called without area */
3299   while (arn->prev) {
3300     arn = arn->prev;
3301   }
3302
3303   *rect = ar->winrct;
3304
3305   /* check if a region overlaps with the current one */
3306   for (; arn; arn = arn->next) {
3307     if (ar != arn && arn->overlap) {
3308       if (BLI_rcti_isect(rect, &arn->winrct, NULL)) {
3309         if (ELEM(arn->alignment, RGN_ALIGN_LEFT, RGN_ALIGN_RIGHT)) {
3310           /* Overlap left, also check 1 pixel offset (2 regions on one side). */
3311           if (ABS(rect->xmin - arn->winrct.xmin) < 2) {
3312             rect->xmin = arn->winrct.xmax;
3313           }
3314
3315           /* Overlap right. */
3316           if (ABS(rect->xmax - arn->winrct.xmax) < 2) {
3317             rect->xmax = arn->winrct.xmin;
3318           }
3319         }
3320         else if (ELEM(arn->alignment, RGN_ALIGN_TOP, RGN_ALIGN_BOTTOM)) {
3321           /* Same logic as above for vertical regions. */
3322           if (ABS(rect->ymin - arn->winrct.ymin) < 2) {
3323             rect->ymin = arn->winrct.ymax;
3324           }
3325           if (ABS(rect->ymax - arn->winrct.ymax) < 2) {
3326             rect->ymax = arn->winrct.ymin;
3327           }
3328         }
3329         else if (arn->alignment == RGN_ALIGN_FLOAT) {
3330           /* Skip floating. */
3331         }
3332         else {
3333           BLI_assert(!"Region overlap with unknown alignment");
3334         }
3335       }
3336     }
3337   }
3338   BLI_rcti_translate(rect, -ar->winrct.xmin, -ar->winrct.ymin);
3339 }
3340
3341 /* Cache display helpers */
3342
3343 void ED_region_cache_draw_background(const ARegion *ar)
3344 {
3345   uint pos = GPU_vertformat_attr_add(
3346       immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
3347   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3348   immUniformColor4ub(128, 128, 255, 64);
3349   immRecti(pos, 0, 0, ar->winx, 8 * UI_DPI_FAC);
3350   immUnbindProgram();
3351 }
3352
3353 void ED_region_cache_draw_curfra_label(const int framenr, const float x, const float y)
3354 {
3355   uiStyle *style = UI_style_get();
3356   int fontid = style->widget.uifont_id;
3357   char numstr[32];
3358   float font_dims[2] = {0.0f, 0.0f};
3359
3360   /* frame number */
3361   BLF_size(fontid, 11.0f * U.pixelsize, U.dpi);
3362   BLI_snprintf(numstr, sizeof(numstr), "%d", framenr);
3363
3364   BLF_width_and_height(fontid, numstr, sizeof(numstr), &font_dims[0], &font_dims[1]);
3365
3366   uint pos = GPU_vertformat_attr_add(
3367       immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
3368   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3369   immUniformThemeColor(TH_CFRAME);
3370   immRecti(pos, x, y, x + font_dims[0] + 6.0f, y + font_dims[1] + 4.0f);
3371   immUnbindProgram();
3372
3373   UI_FontThemeColor(fontid, TH_TEXT);
3374   BLF_position(fontid, x + 2.0f, y + 2.0f, 0.0f);
3375   BLF_draw(fontid, numstr, sizeof(numstr));
3376 }
3377
3378 void ED_region_cache_draw_cached_segments(
3379     const ARegion *ar, const int num_segments, const int *points, const int sfra, const int efra)
3380 {
3381   if (num_segments) {
3382     uint pos = GPU_vertformat_attr_add(
3383         immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
3384     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3385     immUniformColor4ub(128, 128, 255, 128);
3386
3387     for (int a = 0; a < num_segments; a++) {
3388       float x1 = (float)(points[a * 2] - sfra) / (efra - sfra + 1) * ar->winx;
3389       float x2 = (float)(points[a * 2 + 1] - sfra + 1) / (efra - sfra + 1) * ar->winx;
3390
3391       immRecti(pos, x1, 0, x2, 8 * UI_DPI_FAC);
3392       /* TODO(merwin): use primitive restart to draw multiple rects more efficiently */
3393     }
3394
3395     immUnbindProgram();
3396   }
3397 }
3398
3399 /**
3400  * Generate subscriptions for this region.
3401  */
3402 void ED_region_message_subscribe(bContext *C,
3403                                  struct WorkSpace *workspace,
3404                                  struct Scene *scene,
3405                                  struct bScreen *screen,
3406                                  struct ScrArea *sa,
3407                                  struct ARegion *ar,
3408                                  struct wmMsgBus *mbus)
3409 {
3410   if (ar->gizmo_map != NULL) {
3411     WM_gizmomap_message_subscribe(C, ar->gizmo_map, ar, mbus);
3412   }
3413
3414   if (!BLI_listbase_is_empty(&ar->uiblocks)) {
3415     UI_region_message_subscribe(ar, mbus);
3416   }
3417
3418   if (ar->type->message_subscribe != NULL) {
3419     ar->type->message_subscribe(C, workspace, scene, screen, sa, ar, mbus);
3420   }
3421 }
3422
3423 int ED_region_snap_size_test(const ARegion *ar)
3424 {
3425   /* Use a larger value because toggling scrollbars can jump in size. */
3426   const int snap_match_threshold = 16;
3427   if (ar->type->snap_size != NULL) {
3428     return ((((ar->sizex - ar->type->snap_size(ar, ar->sizex, 0)) <= snap_match_threshold) << 0) |
3429             (((ar->sizey - ar->type->snap_size(ar, ar->sizey, 1)) <= snap_match_threshold) << 1));
3430   }
3431   return 0;
3432 }
3433
3434 bool ED_region_snap_size_apply(ARegion *ar, int snap_flag)
3435 {
3436   bool changed = false;
3437   if (ar->type->snap_size != NULL) {
3438     if (snap_flag & (1 << 0)) {
3439       short snap_size = ar->type->snap_size(ar, ar->sizex, 0);
3440       if (snap_size != ar->sizex) {
3441         ar->sizex = snap_size;
3442         changed = true;
3443       }
3444     }
3445     if (snap_flag & (1 << 1)) {
3446       short snap_size = ar->type->snap_size(ar, ar->sizey, 1);
3447       if (snap_size != ar->sizey) {
3448         ar->sizey = snap_size;
3449         changed = true;
3450       }
3451     }
3452   }
3453   return changed;
3454 }