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