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