Cleanup: style, use braces for editors
[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
931   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
932 }
933
934 /* region already made zero sized, in shape of edge */
935 static void region_azone_tab_plus(ScrArea *sa, AZone *az, ARegion *ar)
936 {
937   AZone *azt;
938   int tot = 0, add;
939   /* Edge offset multiplied by the  */
940
941   float edge_offset = 1.0f;
942   const float tab_size_x = 0.7f * U.widget_unit;
943   const float tab_size_y = 0.4f * U.widget_unit;
944
945   for (azt = sa->actionzones.first; azt; azt = azt->next) {
946     if (azt->edge == az->edge) {
947       tot++;
948     }
949   }
950
951   switch (az->edge) {
952     case AE_TOP_TO_BOTTOMRIGHT:
953       add = (ar->winrct.ymax == sa->totrct.ymin) ? 1 : 0;
954       az->x1 = ar->winrct.xmax - ((edge_offset + 1.0f) * tab_size_x);
955       az->y1 = ar->winrct.ymax - add;
956       az->x2 = ar->winrct.xmax - (edge_offset * tab_size_x);
957       az->y2 = ar->winrct.ymax - add + tab_size_y;
958       break;
959     case AE_BOTTOM_TO_TOPLEFT:
960       az->x1 = ar->winrct.xmax - ((edge_offset + 1.0f) * tab_size_x);
961       az->y1 = ar->winrct.ymin - tab_size_y;
962       az->x2 = ar->winrct.xmax - (edge_offset * tab_size_x);
963       az->y2 = ar->winrct.ymin;
964       break;
965     case AE_LEFT_TO_TOPRIGHT:
966       az->x1 = ar->winrct.xmin - tab_size_y;
967       az->y1 = ar->winrct.ymax - ((edge_offset + 1.0f) * tab_size_x);
968       az->x2 = ar->winrct.xmin;
969       az->y2 = ar->winrct.ymax - (edge_offset * tab_size_x);
970       break;
971     case AE_RIGHT_TO_TOPLEFT:
972       az->x1 = ar->winrct.xmax;
973       az->y1 = ar->winrct.ymax - ((edge_offset + 1.0f) * tab_size_x);
974       az->x2 = ar->winrct.xmax + tab_size_y;
975       az->y2 = ar->winrct.ymax - (edge_offset * tab_size_x);
976       break;
977   }
978   /* rect needed for mouse pointer test */
979   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
980 }
981
982 static bool region_azone_edge_poll(const ARegion *ar, const bool is_fullscreen)
983 {
984   const bool is_hidden = (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL));
985
986   if (is_hidden && is_fullscreen) {
987     return false;
988   }
989   if (!is_hidden && ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
990     return false;
991   }
992
993   return true;
994 }
995
996 static void region_azone_edge_initialize(ScrArea *sa,
997                                          ARegion *ar,
998                                          AZEdge edge,
999                                          const bool is_fullscreen)
1000 {
1001   AZone *az = NULL;
1002   const bool is_hidden = (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL));
1003
1004   if (!region_azone_edge_poll(ar, is_fullscreen)) {
1005     return;
1006   }
1007
1008   az = (AZone *)MEM_callocN(sizeof(AZone), "actionzone");
1009   BLI_addtail(&(sa->actionzones), az);
1010   az->type = AZONE_REGION;
1011   az->ar = ar;
1012   az->edge = edge;
1013
1014   if (is_hidden) {
1015     region_azone_tab_plus(sa, az, ar);
1016   }
1017   else {
1018     region_azone_edge(az, ar);
1019   }
1020 }
1021
1022 static void region_azone_scrollbar_initialize(ScrArea *sa,
1023                                               ARegion *ar,
1024                                               AZScrollDirection direction)
1025 {
1026   rcti scroller_vert = (direction == AZ_SCROLL_VERT) ? ar->v2d.vert : ar->v2d.hor;
1027   AZone *az = MEM_callocN(sizeof(*az), __func__);
1028
1029   BLI_addtail(&sa->actionzones, az);
1030   az->type = AZONE_REGION_SCROLL;
1031   az->ar = ar;
1032   az->direction = direction;
1033
1034   if (direction == AZ_SCROLL_VERT) {
1035     az->ar->v2d.alpha_vert = 0;
1036   }
1037   else if (direction == AZ_SCROLL_HOR) {
1038     az->ar->v2d.alpha_hor = 0;
1039   }
1040
1041   BLI_rcti_translate(&scroller_vert, ar->winrct.xmin, ar->winrct.ymin);
1042   az->x1 = scroller_vert.xmin - AZONEFADEIN;
1043   az->y1 = scroller_vert.ymin - AZONEFADEIN;
1044   az->x2 = scroller_vert.xmax + AZONEFADEIN;
1045   az->y2 = scroller_vert.ymax + AZONEFADEIN;
1046
1047   BLI_rcti_init(&az->rect, az->x1, az->x2, az->y1, az->y2);
1048 }
1049
1050 static void region_azones_scrollbars_initialize(ScrArea *sa, ARegion *ar)
1051 {
1052   const View2D *v2d = &ar->v2d;
1053
1054   if ((v2d->scroll & V2D_SCROLL_VERTICAL) && ((v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) == 0)) {
1055     region_azone_scrollbar_initialize(sa, ar, AZ_SCROLL_VERT);
1056   }
1057   if ((v2d->scroll & V2D_SCROLL_HORIZONTAL) &&
1058       ((v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) == 0)) {
1059     region_azone_scrollbar_initialize(sa, ar, AZ_SCROLL_HOR);
1060   }
1061 }
1062
1063 /* *************************************************************** */
1064
1065 static void region_azones_add(const bScreen *screen, ScrArea *sa, ARegion *ar, const int alignment)
1066 {
1067   const bool is_fullscreen = screen->state == SCREENFULL;
1068
1069   /* Only display tab or icons when the header region is hidden
1070    * (not the tool header - they overlap). */
1071   if (ar->regiontype == RGN_TYPE_TOOL_HEADER) {
1072     return;
1073   }
1074
1075   /* edge code (t b l r) is along which area edge azone will be drawn */
1076   if (alignment == RGN_ALIGN_TOP) {
1077     region_azone_edge_initialize(sa, ar, AE_BOTTOM_TO_TOPLEFT, is_fullscreen);
1078   }
1079   else if (alignment == RGN_ALIGN_BOTTOM) {
1080     region_azone_edge_initialize(sa, ar, AE_TOP_TO_BOTTOMRIGHT, is_fullscreen);
1081   }
1082   else if (alignment == RGN_ALIGN_RIGHT) {
1083     region_azone_edge_initialize(sa, ar, AE_LEFT_TO_TOPRIGHT, is_fullscreen);
1084   }
1085   else if (alignment == RGN_ALIGN_LEFT) {
1086     region_azone_edge_initialize(sa, ar, AE_RIGHT_TO_TOPLEFT, is_fullscreen);
1087   }
1088
1089   if (is_fullscreen) {
1090     fullscreen_azone_initialize(sa, ar);
1091   }
1092
1093   region_azones_scrollbars_initialize(sa, ar);
1094 }
1095
1096 /* dir is direction to check, not the splitting edge direction! */
1097 static int rct_fits(const rcti *rect, char dir, int size)
1098 {
1099   if (dir == 'h') {
1100     return BLI_rcti_size_x(rect) + 1 - size;
1101   }
1102   else { /* 'v' */
1103     return BLI_rcti_size_y(rect) + 1 - size;
1104   }
1105 }
1106
1107 /* *************************************************************** */
1108
1109 /* ar should be overlapping */
1110 /* function checks if some overlapping region was defined before - on same place */
1111 static void region_overlap_fix(ScrArea *sa, ARegion *ar)
1112 {
1113   ARegion *ar1;
1114   const int align = ar->alignment & ~RGN_SPLIT_PREV;
1115   int align1 = 0;
1116
1117   /* find overlapping previous region on same place */
1118   for (ar1 = ar->prev; ar1; ar1 = ar1->prev) {
1119     if (ar1->flag & (RGN_FLAG_HIDDEN)) {
1120       continue;
1121     }
1122
1123     if (ar1->overlap && ((ar1->alignment & RGN_SPLIT_PREV) == 0)) {
1124       if (ELEM(ar1->alignment, RGN_ALIGN_FLOAT)) {
1125         continue;
1126       }
1127       align1 = ar1->alignment;
1128       if (BLI_rcti_isect(&ar1->winrct, &ar->winrct, NULL)) {
1129         if (align1 != align) {
1130           /* Left overlapping right or vice-versa, forbid this! */
1131           ar->flag |= RGN_FLAG_TOO_SMALL;
1132           return;
1133         }
1134         /* Else, we have our previous region on same side. */
1135         break;
1136       }
1137     }
1138   }
1139
1140   /* translate or close */
1141   if (ar1) {
1142     if (align1 == RGN_ALIGN_LEFT) {
1143       if (ar->winrct.xmax + ar1->winx > sa->winx - U.widget_unit) {
1144         ar->flag |= RGN_FLAG_TOO_SMALL;
1145         return;
1146       }
1147       else {
1148         BLI_rcti_translate(&ar->winrct, ar1->winx, 0);
1149       }
1150     }
1151     else if (align1 == RGN_ALIGN_RIGHT) {
1152       if (ar->winrct.xmin - ar1->winx < U.widget_unit) {
1153         ar->flag |= RGN_FLAG_TOO_SMALL;
1154         return;
1155       }
1156       else {
1157         BLI_rcti_translate(&ar->winrct, -ar1->winx, 0);
1158       }
1159     }
1160   }
1161
1162   /* At this point, 'ar' is in its final position and still open.
1163    * Make a final check it does not overlap any previous 'other side' region. */
1164   for (ar1 = ar->prev; ar1; ar1 = ar1->prev) {
1165     if (ar1->flag & (RGN_FLAG_HIDDEN)) {
1166       continue;
1167     }
1168     if (ELEM(ar1->alignment, RGN_ALIGN_FLOAT)) {
1169       continue;
1170     }
1171
1172     if (ar1->overlap && (ar1->alignment & RGN_SPLIT_PREV) == 0) {
1173       if ((ar1->alignment != align) && BLI_rcti_isect(&ar1->winrct, &ar->winrct, NULL)) {
1174         /* Left overlapping right or vice-versa, forbid this! */
1175         ar->flag |= RGN_FLAG_TOO_SMALL;
1176         return;
1177       }
1178     }
1179   }
1180 }
1181
1182 /* overlapping regions only in the following restricted cases */
1183 bool ED_region_is_overlap(int spacetype, int regiontype)
1184 {
1185   if (regiontype == RGN_TYPE_HUD) {
1186     return true;
1187   }
1188   if (U.uiflag2 & USER_REGION_OVERLAP) {
1189     if (spacetype == SPACE_NODE) {
1190       if (regiontype == RGN_TYPE_TOOLS) {
1191         return true;
1192       }
1193     }
1194     else if (ELEM(spacetype, SPACE_VIEW3D, SPACE_IMAGE)) {
1195       if (ELEM(regiontype,
1196                RGN_TYPE_TOOLS,
1197                RGN_TYPE_UI,
1198                RGN_TYPE_TOOL_PROPS,
1199                RGN_TYPE_HEADER,
1200                RGN_TYPE_FOOTER)) {
1201         return true;
1202       }
1203     }
1204   }
1205
1206   return false;
1207 }
1208
1209 static void region_rect_recursive(
1210     ScrArea *sa, ARegion *ar, rcti *remainder, rcti *overlap_remainder, int quad)
1211 {
1212   rcti *remainder_prev = remainder;
1213
1214   if (ar == NULL) {
1215     return;
1216   }
1217
1218   int prev_winx = ar->winx;
1219   int prev_winy = ar->winy;
1220
1221   /* no returns in function, winrct gets set in the end again */
1222   BLI_rcti_init(&ar->winrct, 0, 0, 0, 0);
1223
1224   /* for test; allow split of previously defined region */
1225   if (ar->alignment & RGN_SPLIT_PREV) {
1226     if (ar->prev) {
1227       remainder = &ar->prev->winrct;
1228     }
1229   }
1230
1231   int alignment = ar->alignment & ~RGN_SPLIT_PREV;
1232
1233   /* set here, assuming userpref switching forces to call this again */
1234   ar->overlap = ED_region_is_overlap(sa->spacetype, ar->regiontype);
1235
1236   /* clear state flags first */
1237   ar->flag &= ~(RGN_FLAG_TOO_SMALL | RGN_FLAG_SIZE_CLAMP_X | RGN_FLAG_SIZE_CLAMP_Y);
1238   /* user errors */
1239   if ((ar->next == NULL) && !ELEM(alignment, RGN_ALIGN_QSPLIT, RGN_ALIGN_FLOAT)) {
1240     alignment = RGN_ALIGN_NONE;
1241   }
1242
1243   /* prefsize, taking into account DPI */
1244   int prefsizex = UI_DPI_FAC * ((ar->sizex > 1) ? ar->sizex + 0.5f : ar->type->prefsizex);
1245   int prefsizey;
1246
1247   if (ar->flag & RGN_FLAG_PREFSIZE_OR_HIDDEN) {
1248     prefsizex = UI_DPI_FAC * ar->type->prefsizex;
1249     prefsizey = UI_DPI_FAC * ar->type->prefsizey;
1250   }
1251   else if (ar->regiontype == RGN_TYPE_HEADER) {
1252     prefsizey = ED_area_headersize();
1253   }
1254   else if (ar->regiontype == RGN_TYPE_TOOL_HEADER) {
1255     prefsizey = ED_area_headersize();
1256   }
1257   else if (ar->regiontype == RGN_TYPE_FOOTER) {
1258     prefsizey = ED_area_footersize();
1259   }
1260   else if (ED_area_is_global(sa)) {
1261     prefsizey = ED_region_global_size_y();
1262   }
1263   else if (ar->regiontype == RGN_TYPE_UI && sa->spacetype == SPACE_FILE) {
1264     prefsizey = UI_UNIT_Y * 2 + (UI_UNIT_Y / 2);
1265   }
1266   else {
1267     prefsizey = UI_DPI_FAC * (ar->sizey > 1 ? ar->sizey + 0.5f : ar->type->prefsizey);
1268   }
1269
1270   if (ar->flag & RGN_FLAG_HIDDEN) {
1271     /* hidden is user flag */
1272   }
1273   else if (alignment == RGN_ALIGN_FLOAT) {
1274     /**
1275      * \note Currently this window type is only used for #RGN_TYPE_HUD,
1276      * We expect the panel to resize it's self to be larger.
1277      *
1278      * This aligns to the lower left of the area.
1279      */
1280     const int size_min[2] = {UI_UNIT_X, UI_UNIT_Y};
1281     rcti overlap_remainder_margin = *overlap_remainder;
1282     BLI_rcti_resize(&overlap_remainder_margin,
1283                     max_ii(0, BLI_rcti_size_x(overlap_remainder) - UI_UNIT_X / 2),
1284                     max_ii(0, BLI_rcti_size_y(overlap_remainder) - UI_UNIT_Y / 2));
1285     ar->winrct.xmin = overlap_remainder_margin.xmin;
1286     ar->winrct.ymin = overlap_remainder_margin.ymin;
1287     ar->winrct.xmax = ar->winrct.xmin + prefsizex - 1;
1288     ar->winrct.ymax = ar->winrct.ymin + prefsizey - 1;
1289
1290     BLI_rcti_isect(&ar->winrct, &overlap_remainder_margin, &ar->winrct);
1291
1292     if (BLI_rcti_size_x(&ar->winrct) != prefsizex - 1) {
1293       ar->flag |= RGN_FLAG_SIZE_CLAMP_X;
1294     }
1295     if (BLI_rcti_size_y(&ar->winrct) != prefsizey - 1) {
1296       ar->flag |= RGN_FLAG_SIZE_CLAMP_Y;
1297     }
1298
1299     /* We need to use a test that wont have been previously clamped. */
1300     rcti winrct_test = {
1301         .xmin = ar->winrct.xmin,
1302         .ymin = ar->winrct.ymin,
1303         .xmax = ar->winrct.xmin + size_min[0],
1304         .ymax = ar->winrct.ymin + size_min[1],
1305     };
1306     BLI_rcti_isect(&winrct_test, &overlap_remainder_margin, &winrct_test);
1307     if (BLI_rcti_size_x(&winrct_test) < size_min[0] ||
1308         BLI_rcti_size_y(&winrct_test) < size_min[1]) {
1309       ar->flag |= RGN_FLAG_TOO_SMALL;
1310     }
1311   }
1312   else if (rct_fits(remainder, 'v', 1) < 0 || rct_fits(remainder, 'h', 1) < 0) {
1313     /* remainder is too small for any usage */
1314     ar->flag |= RGN_FLAG_TOO_SMALL;
1315   }
1316   else if (alignment == RGN_ALIGN_NONE) {
1317     /* typically last region */
1318     ar->winrct = *remainder;
1319     BLI_rcti_init(remainder, 0, 0, 0, 0);
1320   }
1321   else if (alignment == RGN_ALIGN_TOP || alignment == RGN_ALIGN_BOTTOM) {
1322     rcti *winrct = (ar->overlap) ? overlap_remainder : remainder;
1323
1324     if (rct_fits(winrct, 'v', prefsizey) < 0) {
1325       ar->flag |= RGN_FLAG_TOO_SMALL;
1326     }
1327     else {
1328       int fac = rct_fits(winrct, 'v', prefsizey);
1329
1330       if (fac < 0) {
1331         prefsizey += fac;
1332       }
1333
1334       ar->winrct = *winrct;
1335
1336       if (alignment == RGN_ALIGN_TOP) {
1337         ar->winrct.ymin = ar->winrct.ymax - prefsizey + 1;
1338         winrct->ymax = ar->winrct.ymin - 1;
1339       }
1340       else {
1341         ar->winrct.ymax = ar->winrct.ymin + prefsizey - 1;
1342         winrct->ymin = ar->winrct.ymax + 1;
1343       }
1344     }
1345   }
1346   else if (ELEM(alignment, RGN_ALIGN_LEFT, RGN_ALIGN_RIGHT)) {
1347     rcti *winrct = (ar->overlap) ? overlap_remainder : remainder;
1348
1349     if (rct_fits(winrct, 'h', prefsizex) < 0) {
1350       ar->flag |= RGN_FLAG_TOO_SMALL;
1351     }
1352     else {
1353       int fac = rct_fits(winrct, 'h', prefsizex);
1354
1355       if (fac < 0) {
1356         prefsizex += fac;
1357       }
1358
1359       ar->winrct = *winrct;
1360
1361       if (alignment == RGN_ALIGN_RIGHT) {
1362         ar->winrct.xmin = ar->winrct.xmax - prefsizex + 1;
1363         winrct->xmax = ar->winrct.xmin - 1;
1364       }
1365       else {
1366         ar->winrct.xmax = ar->winrct.xmin + prefsizex - 1;
1367         winrct->xmin = ar->winrct.xmax + 1;
1368       }
1369     }
1370   }
1371   else if (alignment == RGN_ALIGN_VSPLIT || alignment == RGN_ALIGN_HSPLIT) {
1372     /* percentage subdiv*/
1373     ar->winrct = *remainder;
1374
1375     if (alignment == RGN_ALIGN_HSPLIT) {
1376       if (rct_fits(remainder, 'h', prefsizex) > 4) {
1377         ar->winrct.xmax = BLI_rcti_cent_x(remainder);
1378         remainder->xmin = ar->winrct.xmax + 1;
1379       }
1380       else {
1381         BLI_rcti_init(remainder, 0, 0, 0, 0);
1382       }
1383     }
1384     else {
1385       if (rct_fits(remainder, 'v', prefsizey) > 4) {
1386         ar->winrct.ymax = BLI_rcti_cent_y(remainder);
1387         remainder->ymin = ar->winrct.ymax + 1;
1388       }
1389       else {
1390         BLI_rcti_init(remainder, 0, 0, 0, 0);
1391       }
1392     }
1393   }
1394   else if (alignment == RGN_ALIGN_QSPLIT) {
1395     ar->winrct = *remainder;
1396
1397     /* test if there's still 4 regions left */
1398     if (quad == 0) {
1399       ARegion *artest = ar->next;
1400       int count = 1;
1401
1402       while (artest) {
1403         artest->alignment = RGN_ALIGN_QSPLIT;
1404         artest = artest->next;
1405         count++;
1406       }
1407
1408       if (count != 4) {
1409         /* let's stop adding regions */
1410         BLI_rcti_init(remainder, 0, 0, 0, 0);
1411         if (G.debug & G_DEBUG) {
1412           printf("region quadsplit failed\n");
1413         }
1414       }
1415       else {
1416         quad = 1;
1417       }
1418     }
1419     if (quad) {
1420       if (quad == 1) { /* left bottom */
1421         ar->winrct.xmax = BLI_rcti_cent_x(remainder);
1422         ar->winrct.ymax = BLI_rcti_cent_y(remainder);
1423       }
1424       else if (quad == 2) { /* left top */
1425         ar->winrct.xmax = BLI_rcti_cent_x(remainder);
1426         ar->winrct.ymin = BLI_rcti_cent_y(remainder) + 1;
1427       }
1428       else if (quad == 3) { /* right bottom */
1429         ar->winrct.xmin = BLI_rcti_cent_x(remainder) + 1;
1430         ar->winrct.ymax = BLI_rcti_cent_y(remainder);
1431       }
1432       else { /* right top */
1433         ar->winrct.xmin = BLI_rcti_cent_x(remainder) + 1;
1434         ar->winrct.ymin = BLI_rcti_cent_y(remainder) + 1;
1435         BLI_rcti_init(remainder, 0, 0, 0, 0);
1436       }
1437
1438       quad++;
1439     }
1440   }
1441
1442   /* for speedup */
1443   ar->winx = BLI_rcti_size_x(&ar->winrct) + 1;
1444   ar->winy = BLI_rcti_size_y(&ar->winrct) + 1;
1445
1446   /* if region opened normally, we store this for hide/reveal usage */
1447   /* prevent rounding errors for UI_DPI_FAC mult and divide */
1448   if (ar->winx > 1) {
1449     ar->sizex = (ar->winx + 0.5f) / UI_DPI_FAC;
1450   }
1451   if (ar->winy > 1) {
1452     ar->sizey = (ar->winy + 0.5f) / UI_DPI_FAC;
1453   }
1454
1455   /* exception for multiple overlapping regions on same spot */
1456   if (ar->overlap && (alignment != RGN_ALIGN_FLOAT)) {
1457     region_overlap_fix(sa, ar);
1458   }
1459
1460   /* set winrect for azones */
1461   if (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL)) {
1462     ar->winrct = (ar->overlap) ? *overlap_remainder : *remainder;
1463
1464     switch (alignment) {
1465       case RGN_ALIGN_TOP:
1466         ar->winrct.ymin = ar->winrct.ymax;
1467         break;
1468       case RGN_ALIGN_BOTTOM:
1469         ar->winrct.ymax = ar->winrct.ymin;
1470         break;
1471       case RGN_ALIGN_RIGHT:
1472         ar->winrct.xmin = ar->winrct.xmax;
1473         break;
1474       case RGN_ALIGN_LEFT:
1475       default:
1476         /* prevent winrct to be valid */
1477         ar->winrct.xmax = ar->winrct.xmin;
1478         break;
1479     }
1480   }
1481
1482   /* restore prev-split exception */
1483   if (ar->alignment & RGN_SPLIT_PREV) {
1484     if (ar->prev) {
1485       remainder = remainder_prev;
1486       ar->prev->winx = BLI_rcti_size_x(&ar->prev->winrct) + 1;
1487       ar->prev->winy = BLI_rcti_size_y(&ar->prev->winrct) + 1;
1488     }
1489   }
1490
1491   /* After non-overlapping region, all following overlapping regions
1492    * fit within the remaining space again. */
1493   if (!ar->overlap) {
1494     *overlap_remainder = *remainder;
1495   }
1496
1497   region_rect_recursive(sa, ar->next, remainder, overlap_remainder, quad);
1498
1499   /* Tag for redraw if size changes. */
1500   if (ar->winx != prev_winx || ar->winy != prev_winy) {
1501     ED_region_tag_redraw(ar);
1502   }
1503 }
1504
1505 static void area_calc_totrct(ScrArea *sa, const rcti *window_rect)
1506 {
1507   short px = (short)U.pixelsize;
1508
1509   sa->totrct.xmin = sa->v1->vec.x;
1510   sa->totrct.xmax = sa->v4->vec.x;
1511   sa->totrct.ymin = sa->v1->vec.y;
1512   sa->totrct.ymax = sa->v2->vec.y;
1513
1514   /* scale down totrct by 1 pixel on all sides not matching window borders */
1515   if (sa->totrct.xmin > window_rect->xmin) {
1516     sa->totrct.xmin += px;
1517   }
1518   if (sa->totrct.xmax < (window_rect->xmax - 1)) {
1519     sa->totrct.xmax -= px;
1520   }
1521   if (sa->totrct.ymin > window_rect->ymin) {
1522     sa->totrct.ymin += px;
1523   }
1524   if (sa->totrct.ymax < (window_rect->ymax - 1)) {
1525     sa->totrct.ymax -= px;
1526   }
1527   /* Although the following asserts are correct they lead to a very unstable Blender.
1528    * And the asserts would fail even in 2.7x (they were added in 2.8x as part of the top-bar commit).
1529    * For more details see T54864. */
1530 #if 0
1531   BLI_assert(sa->totrct.xmin >= 0);
1532   BLI_assert(sa->totrct.xmax >= 0);
1533   BLI_assert(sa->totrct.ymin >= 0);
1534   BLI_assert(sa->totrct.ymax >= 0);
1535 #endif
1536
1537   /* for speedup */
1538   sa->winx = BLI_rcti_size_x(&sa->totrct) + 1;
1539   sa->winy = BLI_rcti_size_y(&sa->totrct) + 1;
1540 }
1541
1542 /* used for area initialize below */
1543 static void region_subwindow(ARegion *ar)
1544 {
1545   bool hidden = (ar->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL)) != 0;
1546
1547   if ((ar->alignment & RGN_SPLIT_PREV) && ar->prev) {
1548     hidden = hidden || (ar->prev->flag & (RGN_FLAG_HIDDEN | RGN_FLAG_TOO_SMALL));
1549   }
1550
1551   ar->visible = !hidden;
1552 }
1553
1554 /**
1555  * \param ar: Region, may be NULL when adding handlers for \a sa.
1556  */
1557 static void ed_default_handlers(
1558     wmWindowManager *wm, ScrArea *sa, ARegion *ar, ListBase *handlers, int flag)
1559 {
1560   BLI_assert(ar ? (&ar->handlers == handlers) : (&sa->handlers == handlers));
1561
1562   /* note, add-handler checks if it already exists */
1563
1564   /* XXX it would be good to have boundbox checks for some of these... */
1565   if (flag & ED_KEYMAP_UI) {
1566     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "User Interface", 0, 0);
1567     WM_event_add_keymap_handler(handlers, keymap);
1568
1569     /* user interface widgets */
1570     UI_region_handlers_add(handlers);
1571   }
1572   if (flag & ED_KEYMAP_GIZMO) {
1573     BLI_assert(ar && ar->type->regionid == RGN_TYPE_WINDOW);
1574     if (ar) {
1575       /* Anything else is confusing, only allow this. */
1576       BLI_assert(&ar->handlers == handlers);
1577       if (ar->gizmo_map == NULL) {
1578         ar->gizmo_map = WM_gizmomap_new_from_type(
1579             &(const struct wmGizmoMapType_Params){sa->spacetype, ar->type->regionid});
1580       }
1581       WM_gizmomap_add_handlers(ar, ar->gizmo_map);
1582     }
1583   }
1584   if (flag & ED_KEYMAP_TOOL) {
1585     WM_event_add_keymap_handler_dynamic(&ar->handlers, WM_event_get_keymap_from_toolsystem, sa);
1586   }
1587   if (flag & ED_KEYMAP_VIEW2D) {
1588     /* 2d-viewport handling+manipulation */
1589     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "View2D", 0, 0);
1590     WM_event_add_keymap_handler(handlers, keymap);
1591   }
1592   if (flag & ED_KEYMAP_MARKERS) {
1593     /* time-markers */
1594     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Markers", 0, 0);
1595
1596     /* use a boundbox restricted map */
1597     /* same local check for all areas */
1598     static rcti rect = {0, 10000, 0, -1};
1599     rect.ymax = UI_MARKER_MARGIN_Y;
1600     BLI_assert(ar->type->regionid == RGN_TYPE_WINDOW);
1601     WM_event_add_keymap_handler_bb(handlers, keymap, &rect, &ar->winrct);
1602   }
1603   if (flag & ED_KEYMAP_ANIMATION) {
1604     /* frame changing and timeline operators (for time spaces) */
1605     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Animation", 0, 0);
1606     WM_event_add_keymap_handler(handlers, keymap);
1607   }
1608   if (flag & ED_KEYMAP_FRAMES) {
1609     /* frame changing/jumping (for all spaces) */
1610     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Frames", 0, 0);
1611     WM_event_add_keymap_handler(handlers, keymap);
1612   }
1613   if (flag & ED_KEYMAP_HEADER) {
1614     /* standard keymap for headers regions */
1615     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Header", 0, 0);
1616     WM_event_add_keymap_handler(handlers, keymap);
1617   }
1618   if (flag & ED_KEYMAP_FOOTER) {
1619     /* standard keymap for footer regions */
1620     wmKeyMap *keymap = WM_keymap_ensure(wm->defaultconf, "Footer", 0, 0);
1621     WM_event_add_keymap_handler(handlers, keymap);
1622   }
1623
1624   /* Keep last because of LMB/RMB handling, see: T57527. */
1625   if (flag & ED_KEYMAP_GPENCIL) {
1626     /* grease pencil */
1627     /* NOTE: This is now 4 keymaps - One for basic functionality,
1628      *       and others for special stroke modes (edit, paint and sculpt).
1629      *
1630      *       For now, it's easier to just include all,
1631      *       since you hardly want one without the others.
1632      */
1633     wmKeyMap *keymap_general = WM_keymap_ensure(wm->defaultconf, "Grease Pencil", 0, 0);
1634     WM_event_add_keymap_handler(handlers, keymap_general);
1635
1636     wmKeyMap *keymap_edit = WM_keymap_ensure(
1637         wm->defaultconf, "Grease Pencil Stroke Edit Mode", 0, 0);
1638     WM_event_add_keymap_handler(handlers, keymap_edit);
1639
1640     wmKeyMap *keymap_paint = WM_keymap_ensure(
1641         wm->defaultconf, "Grease Pencil Stroke Paint Mode", 0, 0);
1642     WM_event_add_keymap_handler(handlers, keymap_paint);
1643
1644     wmKeyMap *keymap_paint_draw = WM_keymap_ensure(
1645         wm->defaultconf, "Grease Pencil Stroke Paint (Draw brush)", 0, 0);
1646     WM_event_add_keymap_handler(handlers, keymap_paint_draw);
1647
1648     wmKeyMap *keymap_paint_erase = WM_keymap_ensure(
1649         wm->defaultconf, "Grease Pencil Stroke Paint (Erase)", 0, 0);
1650     WM_event_add_keymap_handler(handlers, keymap_paint_erase);
1651
1652     wmKeyMap *keymap_paint_fill = WM_keymap_ensure(
1653         wm->defaultconf, "Grease Pencil Stroke Paint (Fill)", 0, 0);
1654     WM_event_add_keymap_handler(handlers, keymap_paint_fill);
1655
1656     wmKeyMap *keymap_sculpt = WM_keymap_ensure(
1657         wm->defaultconf, "Grease Pencil Stroke Sculpt Mode", 0, 0);
1658     WM_event_add_keymap_handler(handlers, keymap_sculpt);
1659   }
1660 }
1661
1662 void ED_area_update_region_sizes(wmWindowManager *wm, wmWindow *win, ScrArea *area)
1663 {
1664   rcti rect, overlap_rect;
1665   rcti window_rect;
1666
1667   if (!(area->flag & AREA_FLAG_REGION_SIZE_UPDATE)) {
1668     return;
1669   }
1670   const bScreen *screen = WM_window_get_active_screen(win);
1671
1672   WM_window_rect_calc(win, &window_rect);
1673   area_calc_totrct(area, &window_rect);
1674
1675   /* region rect sizes */
1676   rect = area->totrct;
1677   overlap_rect = rect;
1678   region_rect_recursive(area, area->regionbase.first, &rect, &overlap_rect, 0);
1679
1680   /* Dynamically sized regions may have changed region sizes, so we have to force azone update. */
1681   area_azone_initialize(win, screen, area);
1682
1683   for (ARegion *ar = area->regionbase.first; ar; ar = ar->next) {
1684     region_subwindow(ar);
1685
1686     /* region size may have changed, init does necessary adjustments */
1687     if (ar->type->init) {
1688       ar->type->init(wm, ar);
1689     }
1690
1691     /* Some AZones use View2D data which is only updated in region init, so call that first! */
1692     region_azones_add(screen, area, ar, ar->alignment & ~RGN_SPLIT_PREV);
1693   }
1694   ED_area_azones_update(area, &win->eventstate->x);
1695
1696   area->flag &= ~AREA_FLAG_REGION_SIZE_UPDATE;
1697 }
1698
1699 /* called in screen_refresh, or screens_init, also area size changes */
1700 void ED_area_initialize(wmWindowManager *wm, wmWindow *win, ScrArea *sa)
1701 {
1702   WorkSpace *workspace = WM_window_get_active_workspace(win);
1703   const bScreen *screen = BKE_workspace_active_screen_get(win->workspace_hook);
1704   ViewLayer *view_layer = WM_window_get_active_view_layer(win);
1705   ARegion *ar;
1706   rcti rect, overlap_rect;
1707   rcti window_rect;
1708
1709   if (ED_area_is_global(sa) && (sa->global->flag & GLOBAL_AREA_IS_HIDDEN)) {
1710     return;
1711   }
1712   WM_window_rect_calc(win, &window_rect);
1713
1714   /* set typedefinitions */
1715   sa->type = BKE_spacetype_from_id(sa->spacetype);
1716
1717   if (sa->type == NULL) {
1718     sa->spacetype = SPACE_VIEW3D;
1719     sa->type = BKE_spacetype_from_id(sa->spacetype);
1720   }
1721
1722   for (ar = sa->regionbase.first; ar; ar = ar->next) {
1723     ar->type = BKE_regiontype_from_id_or_first(sa->type, ar->regiontype);
1724   }
1725
1726   /* area sizes */
1727   area_calc_totrct(sa, &window_rect);
1728
1729   /* region rect sizes */
1730   rect = sa->totrct;
1731   overlap_rect = rect;
1732   region_rect_recursive(sa, sa->regionbase.first, &rect, &overlap_rect, 0);
1733   sa->flag &= ~AREA_FLAG_REGION_SIZE_UPDATE;
1734
1735   /* default area handlers */
1736   ed_default_handlers(wm, sa, NULL, &sa->handlers, sa->type->keymapflag);
1737   /* checks spacedata, adds own handlers */
1738   if (sa->type->init) {
1739     sa->type->init(wm, sa);
1740   }
1741
1742   /* clear all azones, add the area triangle widgets */
1743   area_azone_initialize(win, screen, sa);
1744
1745   /* region windows, default and own handlers */
1746   for (ar = sa->regionbase.first; ar; ar = ar->next) {
1747     region_subwindow(ar);
1748
1749     if (ar->visible) {
1750       /* default region handlers */
1751       ed_default_handlers(wm, sa, ar, &ar->handlers, ar->type->keymapflag);
1752       /* own handlers */
1753       if (ar->type->init) {
1754         ar->type->init(wm, ar);
1755       }
1756     }
1757     else {
1758       /* prevent uiblocks to run */
1759       UI_blocklist_free(NULL, &ar->uiblocks);
1760     }
1761
1762     /* Some AZones use View2D data which is only updated in region init, so call that first! */
1763     region_azones_add(screen, sa, ar, ar->alignment & ~RGN_SPLIT_PREV);
1764   }
1765
1766   /* Avoid re-initializing tools while resizing the window. */
1767   if ((G.moving & G_TRANSFORM_WM) == 0) {
1768     if ((1 << sa->spacetype) & WM_TOOLSYSTEM_SPACE_MASK) {
1769       WM_toolsystem_refresh_screen_area(workspace, view_layer, sa);
1770       sa->flag |= AREA_FLAG_ACTIVE_TOOL_UPDATE;
1771     }
1772     else {
1773       sa->runtime.tool = NULL;
1774       sa->runtime.is_tool_set = true;
1775     }
1776   }
1777 }
1778
1779 static void region_update_rect(ARegion *ar)
1780 {
1781   ar->winx = BLI_rcti_size_x(&ar->winrct) + 1;
1782   ar->winy = BLI_rcti_size_y(&ar->winrct) + 1;
1783
1784   /* v2d mask is used to subtract scrollbars from a 2d view. Needs initialize here. */
1785   BLI_rcti_init(&ar->v2d.mask, 0, ar->winx - 1, 0, ar->winy - 1);
1786 }
1787
1788 /**
1789  * Call to move a popup window (keep OpenGL context free!)
1790  */
1791 void ED_region_update_rect(ARegion *ar)
1792 {
1793   region_update_rect(ar);
1794 }
1795
1796 /* externally called for floating regions like menus */
1797 void ED_region_init(ARegion *ar)
1798 {
1799   /* refresh can be called before window opened */
1800   region_subwindow(ar);
1801
1802   region_update_rect(ar);
1803 }
1804
1805 void ED_region_cursor_set(wmWindow *win, ScrArea *sa, ARegion *ar)
1806 {
1807   if (ar && sa && ar->type && ar->type->cursor) {
1808     ar->type->cursor(win, sa, ar);
1809   }
1810   else {
1811     if (WM_cursor_set_from_tool(win, sa, ar)) {
1812       return;
1813     }
1814     WM_cursor_set(win, CURSOR_STD);
1815   }
1816 }
1817
1818 /* for use after changing visibility of regions */
1819 void ED_region_visibility_change_update(bContext *C, ScrArea *sa, ARegion *ar)
1820 {
1821   if (ar->flag & RGN_FLAG_HIDDEN) {
1822     WM_event_remove_handlers(C, &ar->handlers);
1823   }
1824
1825   ED_area_initialize(CTX_wm_manager(C), CTX_wm_window(C), sa);
1826   ED_area_tag_redraw(sa);
1827 }
1828
1829 /* for quick toggle, can skip fades */
1830 void region_toggle_hidden(bContext *C, ARegion *ar, const bool do_fade)
1831 {
1832   ScrArea *sa = CTX_wm_area(C);
1833
1834   ar->flag ^= RGN_FLAG_HIDDEN;
1835
1836   if (do_fade && ar->overlap) {
1837     /* starts a timer, and in end calls the stuff below itself (region_sblend_invoke()) */
1838     ED_region_visibility_change_update_animated(C, sa, ar);
1839   }
1840   else {
1841     ED_region_visibility_change_update(C, sa, ar);
1842   }
1843 }
1844
1845 /* exported to all editors, uses fading default */
1846 void ED_region_toggle_hidden(bContext *C, ARegion *ar)
1847 {
1848   region_toggle_hidden(C, ar, true);
1849 }
1850
1851 /**
1852  * we swap spaces for fullscreen to keep all allocated data area vertices were set
1853  */
1854 void ED_area_data_copy(ScrArea *sa_dst, ScrArea *sa_src, const bool do_free)
1855 {
1856   SpaceType *st;
1857   ARegion *ar;
1858   const char spacetype = sa_dst->spacetype;
1859   const short flag_copy = HEADER_NO_PULLDOWN;
1860
1861   sa_dst->spacetype = sa_src->spacetype;
1862   sa_dst->type = sa_src->type;
1863
1864   sa_dst->flag = (sa_dst->flag & ~flag_copy) | (sa_src->flag & flag_copy);
1865
1866   /* area */
1867   if (do_free) {
1868     BKE_spacedata_freelist(&sa_dst->spacedata);
1869   }
1870   BKE_spacedata_copylist(&sa_dst->spacedata, &sa_src->spacedata);
1871
1872   /* Note; SPACE_EMPTY is possible on new screens */
1873
1874   /* regions */
1875   if (do_free) {
1876     st = BKE_spacetype_from_id(spacetype);
1877     for (ar = sa_dst->regionbase.first; ar; ar = ar->next) {
1878       BKE_area_region_free(st, ar);
1879     }
1880     BLI_freelistN(&sa_dst->regionbase);
1881   }
1882   st = BKE_spacetype_from_id(sa_src->spacetype);
1883   for (ar = sa_src->regionbase.first; ar; ar = ar->next) {
1884     ARegion *newar = BKE_area_region_copy(st, ar);
1885     BLI_addtail(&sa_dst->regionbase, newar);
1886   }
1887 }
1888
1889 void ED_area_data_swap(ScrArea *sa_dst, ScrArea *sa_src)
1890 {
1891   SWAP(char, sa_dst->spacetype, sa_src->spacetype);
1892   SWAP(SpaceType *, sa_dst->type, sa_src->type);
1893
1894   SWAP(ListBase, sa_dst->spacedata, sa_src->spacedata);
1895   SWAP(ListBase, sa_dst->regionbase, sa_src->regionbase);
1896 }
1897
1898 /* *********** Space switching code *********** */
1899
1900 void ED_area_swapspace(bContext *C, ScrArea *sa1, ScrArea *sa2)
1901 {
1902   ScrArea *tmp = MEM_callocN(sizeof(ScrArea), "addscrarea");
1903
1904   ED_area_exit(C, sa1);
1905   ED_area_exit(C, sa2);
1906
1907   ED_area_data_copy(tmp, sa1, false);
1908   ED_area_data_copy(sa1, sa2, true);
1909   ED_area_data_copy(sa2, tmp, true);
1910   ED_area_initialize(CTX_wm_manager(C), CTX_wm_window(C), sa1);
1911   ED_area_initialize(CTX_wm_manager(C), CTX_wm_window(C), sa2);
1912
1913   BKE_screen_area_free(tmp);
1914   MEM_freeN(tmp);
1915
1916   /* tell WM to refresh, cursor types etc */
1917   WM_event_add_mousemove(C);
1918
1919   ED_area_tag_redraw(sa1);
1920   ED_area_tag_refresh(sa1);
1921   ED_area_tag_redraw(sa2);
1922   ED_area_tag_refresh(sa2);
1923 }
1924
1925 /**
1926  * \param skip_ar_exit: Skip calling area exit callback. Set for opening temp spaces.
1927  */
1928 void ED_area_newspace(bContext *C, ScrArea *sa, int type, const bool skip_ar_exit)
1929 {
1930   wmWindow *win = CTX_wm_window(C);
1931
1932   if (sa->spacetype != type) {
1933     SpaceType *st;
1934     SpaceLink *slold;
1935     SpaceLink *sl;
1936     /* store sa->type->exit callback */
1937     void *sa_exit = sa->type ? sa->type->exit : NULL;
1938     /* When the user switches between space-types from the type-selector,
1939      * changing the header-type is jarring (especially when using Ctrl-MouseWheel).
1940      *
1941      * However, add-on install for example, forces the header to the top which shouldn't
1942      * be applied back to the previous space type when closing - see: T57724
1943      *
1944      * Newly created windows wont have any space data, use the alignment
1945      * the space type defaults to in this case instead
1946      * (needed for preferences to have space-type on bottom).
1947      */
1948     int header_alignment = ED_area_header_alignment_or_fallback(sa, -1);
1949     const bool sync_header_alignment = ((header_alignment != -1) &&
1950                                         (sa->flag & AREA_FLAG_TEMP_TYPE) == 0);
1951
1952     /* in some cases (opening temp space) we don't want to
1953      * call area exit callback, so we temporarily unset it */
1954     if (skip_ar_exit && sa->type) {
1955       sa->type->exit = NULL;
1956     }
1957
1958     ED_area_exit(C, sa);
1959
1960     /* restore old area exit callback */
1961     if (skip_ar_exit && sa->type) {
1962       sa->type->exit = sa_exit;
1963     }
1964
1965     st = BKE_spacetype_from_id(type);
1966     slold = sa->spacedata.first;
1967
1968     sa->spacetype = type;
1969     sa->type = st;
1970
1971     /* If st->new may be called, don't use context until then. The
1972      * sa->type->context() callback has changed but data may be invalid
1973      * (e.g. with properties editor) until space-data is properly created */
1974
1975     /* check previously stored space */
1976     for (sl = sa->spacedata.first; sl; sl = sl->next) {
1977       if (sl->spacetype == type) {
1978         break;
1979       }
1980     }
1981
1982     /* old spacedata... happened during work on 2.50, remove */
1983     if (sl && BLI_listbase_is_empty(&sl->regionbase)) {
1984       st->free(sl);
1985       BLI_freelinkN(&sa->spacedata, sl);
1986       if (slold == sl) {
1987         slold = NULL;
1988       }
1989       sl = NULL;
1990     }
1991
1992     if (sl) {
1993       /* swap regions */
1994       slold->regionbase = sa->regionbase;
1995       sa->regionbase = sl->regionbase;
1996       BLI_listbase_clear(&sl->regionbase);
1997
1998       /* put in front of list */
1999       BLI_remlink(&sa->spacedata, sl);
2000       BLI_addhead(&sa->spacedata, sl);
2001     }
2002     else {
2003       /* new space */
2004       if (st) {
2005         /* Don't get scene from context here which may depend on space-data. */
2006         Scene *scene = WM_window_get_active_scene(win);
2007         sl = st->new (sa, scene);
2008         BLI_addhead(&sa->spacedata, sl);
2009
2010         /* swap regions */
2011         if (slold) {
2012           slold->regionbase = sa->regionbase;
2013         }
2014         sa->regionbase = sl->regionbase;
2015         BLI_listbase_clear(&sl->regionbase);
2016       }
2017     }
2018
2019     /* Sync header alignment. */
2020     if (sync_header_alignment) {
2021       /* Spaces with footer. */
2022       if (st->spaceid == SPACE_TEXT) {
2023         for (ARegion *ar = sa->regionbase.first; ar; ar = ar->next) {
2024           if (ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
2025             ar->alignment = header_alignment;
2026           }
2027           if (ar->regiontype == RGN_TYPE_FOOTER) {
2028             int footer_alignment = (header_alignment == RGN_ALIGN_BOTTOM) ? RGN_ALIGN_TOP :
2029                                                                             RGN_ALIGN_BOTTOM;
2030             ar->alignment = footer_alignment;
2031             break;
2032           }
2033         }
2034       }
2035       else {
2036         for (ARegion *ar = sa->regionbase.first; ar; ar = ar->next) {
2037           if (ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
2038             ar->alignment = header_alignment;
2039             break;
2040           }
2041         }
2042       }
2043     }
2044
2045     ED_area_initialize(CTX_wm_manager(C), win, sa);
2046
2047     /* tell WM to refresh, cursor types etc */
2048     WM_event_add_mousemove(C);
2049
2050     /* send space change notifier */
2051     WM_event_add_notifier(C, NC_SPACE | ND_SPACE_CHANGED, sa);
2052
2053     ED_area_tag_refresh(sa);
2054   }
2055
2056   /* also redraw when re-used */
2057   ED_area_tag_redraw(sa);
2058 }
2059
2060 void ED_area_prevspace(bContext *C, ScrArea *sa)
2061 {
2062   SpaceLink *sl = sa->spacedata.first;
2063
2064   if (sl && sl->next) {
2065     ED_area_newspace(C, sa, sl->next->spacetype, false);
2066
2067     /* keep old spacedata but move it to end, so calling
2068      * ED_area_prevspace once more won't open it again */
2069     BLI_remlink(&sa->spacedata, sl);
2070     BLI_addtail(&sa->spacedata, sl);
2071   }
2072   else {
2073     /* no change */
2074     return;
2075   }
2076   sa->flag &= ~(AREA_FLAG_STACKED_FULLSCREEN | AREA_FLAG_TEMP_TYPE);
2077
2078   ED_area_tag_redraw(sa);
2079
2080   /* send space change notifier */
2081   WM_event_add_notifier(C, NC_SPACE | ND_SPACE_CHANGED, sa);
2082 }
2083
2084 /* returns offset for next button in header */
2085 int ED_area_header_switchbutton(const bContext *C, uiBlock *block, int yco)
2086 {
2087   ScrArea *sa = CTX_wm_area(C);
2088   bScreen *scr = CTX_wm_screen(C);
2089   PointerRNA areaptr;
2090   int xco = 0.4 * U.widget_unit;
2091
2092   RNA_pointer_create(&(scr->id), &RNA_Area, sa, &areaptr);
2093
2094   uiDefButR(block,
2095             UI_BTYPE_MENU,
2096             0,
2097             "",
2098             xco,
2099             yco,
2100             1.6 * U.widget_unit,
2101             U.widget_unit,
2102             &areaptr,
2103             "ui_type",
2104             0,
2105             0.0f,
2106             0.0f,
2107             0.0f,
2108             0.0f,
2109             "");
2110
2111   return xco + 1.7 * U.widget_unit;
2112 }
2113
2114 /************************ standard UI regions ************************/
2115
2116 static ThemeColorID region_background_color_id(const bContext *C, const ARegion *region)
2117 {
2118   ScrArea *area = CTX_wm_area(C);
2119
2120   switch (region->regiontype) {
2121     case RGN_TYPE_HEADER:
2122     case RGN_TYPE_TOOL_HEADER:
2123       if (ED_screen_area_active(C) || ED_area_is_global(area)) {
2124         return TH_HEADER;
2125       }
2126       else {
2127         return TH_HEADERDESEL;
2128       }
2129     case RGN_TYPE_PREVIEW:
2130       return TH_PREVIEW_BACK;
2131     default:
2132       return TH_BACK;
2133   }
2134 }
2135
2136 static void region_clear_color(const bContext *C, const ARegion *ar, ThemeColorID colorid)
2137 {
2138   if (ar->alignment == RGN_ALIGN_FLOAT) {
2139     /* handle our own drawing. */
2140   }
2141   else if (ar->overlap) {
2142     /* view should be in pixelspace */
2143     UI_view2d_view_restore(C);
2144
2145     float back[4];
2146     UI_GetThemeColor4fv(colorid, back);
2147     GPU_clear_color(back[3] * back[0], back[3] * back[1], back[3] * back[2], back[3]);
2148     GPU_clear(GPU_COLOR_BIT);
2149   }
2150   else {
2151     UI_ThemeClearColor(colorid);
2152     GPU_clear(GPU_COLOR_BIT);
2153   }
2154 }
2155
2156 BLI_INLINE bool streq_array_any(const char *s, const char *arr[])
2157 {
2158   for (uint i = 0; arr[i]; i++) {
2159     if (STREQ(arr[i], s)) {
2160       return true;
2161     }
2162   }
2163   return false;
2164 }
2165
2166 static void ed_panel_draw(const bContext *C,
2167                           ScrArea *sa,
2168                           ARegion *ar,
2169                           ListBase *lb,
2170                           PanelType *pt,
2171                           Panel *panel,
2172                           int w,
2173                           int em,
2174                           bool vertical)
2175 {
2176   uiStyle *style = UI_style_get_dpi();
2177
2178   /* draw panel */
2179   uiBlock *block = UI_block_begin(C, ar, pt->idname, UI_EMBOSS);
2180
2181   bool open;
2182   panel = UI_panel_begin(sa, ar, lb, block, pt, panel, &open);
2183
2184   /* bad fixed values */
2185   int xco, yco, h = 0;
2186
2187   if (pt->draw_header_preset && !(pt->flag & PNL_NO_HEADER) && (open || vertical)) {
2188     /* for preset menu */
2189     panel->layout = UI_block_layout(block,
2190                                     UI_LAYOUT_HORIZONTAL,
2191                                     UI_LAYOUT_HEADER,
2192                                     0,
2193                                     (UI_UNIT_Y * 1.1f) + style->panelspace,
2194                                     UI_UNIT_Y,
2195                                     1,
2196                                     0,
2197                                     style);
2198
2199     pt->draw_header_preset(C, panel);
2200
2201     int headerend = w - UI_UNIT_X;
2202
2203     UI_block_layout_resolve(block, &xco, &yco);
2204     UI_block_translate(block, headerend - xco, 0);
2205     panel->layout = NULL;
2206   }
2207
2208   if (pt->draw_header && !(pt->flag & PNL_NO_HEADER) && (open || vertical)) {
2209     int labelx, labely;
2210     UI_panel_label_offset(block, &labelx, &labely);
2211
2212     /* for enabled buttons */
2213     panel->layout = UI_block_layout(
2214         block, UI_LAYOUT_HORIZONTAL, UI_LAYOUT_HEADER, labelx, labely, UI_UNIT_Y, 1, 0, style);
2215
2216     pt->draw_header(C, panel);
2217
2218     UI_block_layout_resolve(block, &xco, &yco);
2219     panel->labelofs = xco - labelx;
2220     panel->layout = NULL;
2221   }
2222   else {
2223     panel->labelofs = 0;
2224   }
2225
2226   if (open) {
2227     short panelContext;
2228
2229     /* panel context can either be toolbar region or normal panels region */
2230     if (pt->flag & PNL_LAYOUT_VERT_BAR) {
2231       panelContext = UI_LAYOUT_VERT_BAR;
2232     }
2233     else if (ar->regiontype == RGN_TYPE_TOOLS) {
2234       panelContext = UI_LAYOUT_TOOLBAR;
2235     }
2236     else {
2237       panelContext = UI_LAYOUT_PANEL;
2238     }
2239
2240     panel->layout = UI_block_layout(block,
2241                                     UI_LAYOUT_VERTICAL,
2242                                     panelContext,
2243                                     (pt->flag & PNL_LAYOUT_VERT_BAR) ? 0 : style->panelspace,
2244                                     0,
2245                                     (pt->flag & PNL_LAYOUT_VERT_BAR) ? 0 :
2246                                                                        w - 2 * style->panelspace,
2247                                     em,
2248                                     0,
2249                                     style);
2250
2251     pt->draw(C, panel);
2252
2253     UI_block_layout_resolve(block, &xco, &yco);
2254     panel->layout = NULL;
2255
2256     if (yco != 0) {
2257       h = -yco + 2 * style->panelspace;
2258     }
2259   }
2260
2261   UI_block_end(C, block);
2262
2263   /* Draw child panels. */
2264   if (open) {
2265     for (LinkData *link = pt->children.first; link; link = link->next) {
2266       PanelType *child_pt = link->data;
2267       Panel *child_panel = UI_panel_find_by_type(&panel->children, child_pt);
2268
2269       if (child_pt->draw && (!child_pt->poll || child_pt->poll(C, child_pt))) {
2270         ed_panel_draw(C, sa, ar, &panel->children, child_pt, child_panel, w, em, vertical);
2271       }
2272     }
2273   }
2274
2275   UI_panel_end(block, w, h);
2276 }
2277
2278 /**
2279  * \param contexts: A NULL terminated array of context strings to match against.
2280  * Matching against any of these strings will draw the panel.
2281  * Can be NULL to skip context checks.
2282  */
2283 void ED_region_panels_layout_ex(
2284     const bContext *C, ARegion *ar, const char *contexts[], int contextnr, const bool vertical)
2285 {
2286   ar->runtime.category = NULL;
2287
2288   const WorkSpace *workspace = CTX_wm_workspace(C);
2289   ScrArea *sa = CTX_wm_area(C);
2290   PanelType *pt;
2291   View2D *v2d = &ar->v2d;
2292   int x, y, w, em;
2293   bool is_context_new = 0;
2294   int scroll;
2295
2296   /* XXX, should use some better check? */
2297   /* For now also has hardcoded check for clip editor until it supports actual toolbar. */
2298   bool use_category_tabs = ((1 << ar->regiontype) & RGN_TYPE_HAS_CATEGORY_MASK) ||
2299                            (ar->regiontype == RGN_TYPE_TOOLS && sa->spacetype == SPACE_CLIP);
2300   /* offset panels for small vertical tab area */
2301   const char *category = NULL;
2302   const int category_tabs_width = UI_PANEL_CATEGORY_MARGIN_WIDTH;
2303   int margin_x = 0;
2304   const bool region_layout_based = ar->flag & RGN_FLAG_DYNAMIC_SIZE;
2305
2306   BLI_SMALLSTACK_DECLARE(pt_stack, PanelType *);
2307
2308   if (contextnr != -1) {
2309     is_context_new = UI_view2d_tab_set(v2d, contextnr);
2310   }
2311
2312   /* before setting the view */
2313   if (vertical) {
2314     /* only allow scrolling in vertical direction */
2315     v2d->keepofs |= V2D_LOCKOFS_X | V2D_KEEPOFS_Y;
2316     v2d->keepofs &= ~(V2D_LOCKOFS_Y | V2D_KEEPOFS_X);
2317     v2d->scroll &= ~(V2D_SCROLL_BOTTOM);
2318     v2d->scroll |= (V2D_SCROLL_RIGHT);
2319   }
2320   else {
2321     /* for now, allow scrolling in both directions (since layouts are optimized for vertical,
2322      * they often don't fit in horizontal layout)
2323      */
2324     v2d->keepofs &= ~(V2D_LOCKOFS_X | V2D_LOCKOFS_Y | V2D_KEEPOFS_X | V2D_KEEPOFS_Y);
2325     v2d->scroll |= (V2D_SCROLL_BOTTOM);
2326     v2d->scroll &= ~(V2D_SCROLL_RIGHT);
2327   }
2328
2329   scroll = v2d->scroll;
2330
2331   /* collect panels to draw */
2332   for (pt = ar->type->paneltypes.last; pt; pt = pt->prev) {
2333     /* Only draw top level panels. */
2334     if (pt->parent) {
2335       continue;
2336     }
2337
2338     /* verify context */
2339     if (contexts && pt->context[0] && !streq_array_any(pt->context, contexts)) {
2340       continue;
2341     }
2342
2343     /* If we're tagged, only use compatible. */
2344     if (pt->owner_id[0] && BKE_workspace_owner_id_check(workspace, pt->owner_id) == false) {
2345       continue;
2346     }
2347
2348     /* draw panel */
2349     if (pt->draw && (!pt->poll || pt->poll(C, pt))) {
2350       BLI_SMALLSTACK_PUSH(pt_stack, pt);
2351     }
2352   }
2353
2354   /* collect categories */
2355   if (use_category_tabs) {
2356     UI_panel_category_clear_all(ar);
2357
2358     /* gather unique categories */
2359     BLI_SMALLSTACK_ITER_BEGIN (pt_stack, pt) {
2360       if (pt->category[0]) {
2361         if (!UI_panel_category_find(ar, pt->category)) {
2362           UI_panel_category_add(ar, pt->category);
2363         }
2364       }
2365     }
2366     BLI_SMALLSTACK_ITER_END;
2367
2368     if (!UI_panel_category_is_visible(ar)) {
2369       use_category_tabs = false;
2370     }
2371     else {
2372       category = UI_panel_category_active_get(ar, true);
2373       margin_x = category_tabs_width;
2374     }
2375   }
2376
2377   if (vertical) {
2378     w = BLI_rctf_size_x(&v2d->cur);
2379     em = (ar->type->prefsizex) ? 10 : 20; /* works out to 10*UI_UNIT_X or 20*UI_UNIT_X */
2380   }
2381   else {
2382     w = UI_PANEL_WIDTH;
2383     em = (ar->type->prefsizex) ? 10 : 20;
2384   }
2385
2386   w -= margin_x;
2387
2388   /* create panels */
2389   UI_panels_begin(C, ar);
2390
2391   /* set view2d view matrix  - UI_block_begin() stores it */
2392   UI_view2d_view_ortho(v2d);
2393
2394   BLI_SMALLSTACK_ITER_BEGIN (pt_stack, pt) {
2395     Panel *panel = UI_panel_find_by_type(&ar->panels, pt);
2396
2397     if (use_category_tabs && pt->category[0] && !STREQ(category, pt->category)) {
2398       if ((panel == NULL) || ((panel->flag & PNL_PIN) == 0)) {
2399         continue;
2400       }
2401     }
2402
2403     ed_panel_draw(C, sa, ar, &ar->panels, pt, panel, w, em, vertical);
2404   }
2405   BLI_SMALLSTACK_ITER_END;
2406
2407   /* align panels and return size */
2408   UI_panels_end(C, ar, &x, &y);
2409
2410   /* before setting the view */
2411   if (region_layout_based) {
2412     /* XXX, only single panel support atm.
2413      * Can't use x/y values calculated above because they're not using the real height of panels,
2414      * instead they calculate offsets for the next panel to start drawing. */
2415     Panel *panel = ar->panels.last;
2416     if (panel != NULL) {
2417       int size_dyn[2] = {
2418           UI_UNIT_X * ((panel->flag & PNL_CLOSED) ? 8 : 14) / UI_DPI_FAC,
2419           UI_panel_size_y(panel) / UI_DPI_FAC,
2420       };
2421       /* region size is layout based and needs to be updated */
2422       if ((ar->sizex != size_dyn[0]) || (ar->sizey != size_dyn[1])) {
2423         ar->sizex = size_dyn[0];
2424         ar->sizey = size_dyn[1];
2425         sa->flag |= AREA_FLAG_REGION_SIZE_UPDATE;
2426       }
2427       y = ABS(ar->sizey * UI_DPI_FAC - 1);
2428     }
2429   }
2430   else if (vertical) {
2431     /* We always keep the scroll offset -
2432      * so the total view gets increased with the scrolled away part. */
2433     if (v2d->cur.ymax < -FLT_EPSILON) {
2434       /* Clamp to lower view boundary */
2435       if (v2d->tot.ymin < -v2d->winy) {
2436         y = min_ii(y, 0);
2437       }
2438       else {
2439         y = min_ii(y, v2d->cur.ymin);
2440       }
2441     }
2442
2443     y = -y;
2444   }
2445   else {
2446     /* don't jump back when panels close or hide */
2447     if (!is_context_new) {
2448       if (v2d->tot.xmax > v2d->winx) {
2449         x = max_ii(x, 0);
2450       }
2451       else {
2452         x = max_ii(x, v2d->cur.xmax);
2453       }
2454     }
2455
2456     y = -y;
2457   }
2458
2459   /* this also changes the 'cur' */
2460   UI_view2d_totRect_set(v2d, x, y);
2461
2462   if (scroll != v2d->scroll) {
2463     /* Note: this code scales fine, but because of rounding differences, positions of elements
2464      * flip +1 or -1 pixel compared to redoing the entire layout again.
2465      * Leaving in commented code for future tests */
2466 #if 0
2467     UI_panels_scale(ar, BLI_rctf_size_x(&v2d->cur));
2468     break;
2469 #endif
2470   }
2471
2472   if (use_category_tabs) {
2473     ar->runtime.category = category;
2474   }
2475 }
2476 void ED_region_panels_layout(const bContext *C, ARegion *ar)
2477 {
2478   ED_region_panels_layout_ex(C, ar, NULL, -1, true);
2479 }
2480
2481 void ED_region_panels_draw(const bContext *C, ARegion *ar)
2482 {
2483   View2D *v2d = &ar->v2d;
2484
2485   if (ar->alignment != RGN_ALIGN_FLOAT) {
2486     region_clear_color(
2487         C, ar, (ar->type->regionid == RGN_TYPE_PREVIEW) ? TH_PREVIEW_BACK : TH_BACK);
2488   }
2489
2490   /* reset line width for drawing tabs */
2491   GPU_line_width(1.0f);
2492
2493   /* set the view */
2494   UI_view2d_view_ortho(v2d);
2495
2496   /* View2D matrix might have changed due to dynamic sized regions. */
2497   UI_blocklist_update_window_matrix(C, &ar->uiblocks);
2498
2499   /* draw panels */
2500   UI_panels_draw(C, ar);
2501
2502   /* restore view matrix */
2503   UI_view2d_view_restore(C);
2504
2505   /* Set in layout. */
2506   if (ar->runtime.category) {
2507     UI_panel_category_draw_all(ar, ar->runtime.category);
2508   }
2509
2510   /* scrollers */
2511   const rcti *mask = NULL;
2512   rcti mask_buf;
2513   if (ar->runtime.category && (ar->alignment == RGN_ALIGN_RIGHT)) {
2514     UI_view2d_mask_from_win(v2d, &mask_buf);
2515     mask_buf.xmax -= UI_PANEL_CATEGORY_MARGIN_WIDTH;
2516     mask = &mask_buf;
2517   }
2518   View2DScrollers *scrollers = UI_view2d_scrollers_calc(
2519       C, v2d, mask, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
2520   UI_view2d_scrollers_draw(C, v2d, scrollers);
2521   UI_view2d_scrollers_free(scrollers);
2522 }
2523
2524 void ED_region_panels_ex(
2525     const bContext *C, ARegion *ar, const char *contexts[], int contextnr, const bool vertical)
2526 {
2527   /* TODO: remove? */
2528   ED_region_panels_layout_ex(C, ar, contexts, contextnr, vertical);
2529   ED_region_panels_draw(C, ar);
2530 }
2531
2532 void ED_region_panels(const bContext *C, ARegion *ar)
2533 {
2534   /* TODO: remove? */
2535   ED_region_panels_layout(C, ar);
2536   ED_region_panels_draw(C, ar);
2537 }
2538
2539 void ED_region_panels_init(wmWindowManager *wm, ARegion *ar)
2540 {
2541   wmKeyMap *keymap;
2542
2543   UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_PANELS_UI, ar->winx, ar->winy);
2544
2545   keymap = WM_keymap_ensure(wm->defaultconf, "View2D Buttons List", 0, 0);
2546   WM_event_add_keymap_handler(&ar->handlers, keymap);
2547 }
2548
2549 void ED_region_header_layout(const bContext *C, ARegion *ar)
2550 {
2551   uiStyle *style = UI_style_get_dpi();
2552   uiBlock *block;
2553   uiLayout *layout;
2554   HeaderType *ht;
2555   Header header = {NULL};
2556   bool region_layout_based = ar->flag & RGN_FLAG_DYNAMIC_SIZE;
2557
2558   /* Height of buttons and scaling needed to achieve it. */
2559   const int buttony = min_ii(UI_UNIT_Y, ar->winy - 2 * UI_DPI_FAC);
2560   const float buttony_scale = buttony / (float)UI_UNIT_Y;
2561
2562   /* Vertically center buttons. */
2563   int xco = UI_HEADER_OFFSET;
2564   int yco = buttony + (ar->winy - buttony) / 2;
2565   int maxco = xco;
2566
2567   /* XXX workaround for 1 px alignment issue. Not sure what causes it...
2568    * Would prefer a proper fix - Julian */
2569   if (!ELEM(CTX_wm_area(C)->spacetype, SPACE_TOPBAR, SPACE_STATUSBAR)) {
2570     yco -= 1;
2571   }
2572
2573   /* set view2d view matrix for scrolling (without scrollers) */
2574   UI_view2d_view_ortho(&ar->v2d);
2575
2576   /* draw all headers types */
2577   for (ht = ar->type->headertypes.first; ht; ht = ht->next) {
2578     if (ht->poll && !ht->poll(C, ht)) {
2579       continue;
2580     }
2581
2582     block = UI_block_begin(C, ar, ht->idname, UI_EMBOSS);
2583     layout = UI_block_layout(
2584         block, UI_LAYOUT_HORIZONTAL, UI_LAYOUT_HEADER, xco, yco, buttony, 1, 0, style);
2585
2586     if (buttony_scale != 1.0f) {
2587       uiLayoutSetScaleY(layout, buttony_scale);
2588     }
2589
2590     if (ht->draw) {
2591       header.type = ht;
2592       header.layout = layout;
2593       ht->draw(C, &header);
2594       if (ht->next) {
2595         uiItemS(layout);
2596       }
2597
2598       /* for view2d */
2599       xco = uiLayoutGetWidth(layout);
2600       if (xco > maxco) {
2601         maxco = xco;
2602       }
2603     }
2604
2605     UI_block_layout_resolve(block, &xco, &yco);
2606
2607     /* for view2d */
2608     if (xco > maxco) {
2609       maxco = xco;
2610     }
2611
2612     int new_sizex = (maxco + UI_HEADER_OFFSET) / UI_DPI_FAC;
2613
2614     if (region_layout_based && (ar->sizex != new_sizex)) {
2615       /* region size is layout based and needs to be updated */
2616       ScrArea *sa = CTX_wm_area(C);
2617
2618       ar->sizex = new_sizex;
2619       sa->flag |= AREA_FLAG_REGION_SIZE_UPDATE;
2620     }
2621
2622     UI_block_end(C, block);
2623   }
2624
2625   if (!region_layout_based) {
2626     maxco += UI_HEADER_OFFSET;
2627   }
2628
2629   /* always as last  */
2630   UI_view2d_totRect_set(&ar->v2d, maxco, ar->winy);
2631
2632   /* restore view matrix */
2633   UI_view2d_view_restore(C);
2634 }
2635
2636 void ED_region_header_draw(const bContext *C, ARegion *ar)
2637 {
2638   /* clear */
2639   region_clear_color(C, ar, region_background_color_id(C, ar));
2640
2641   UI_view2d_view_ortho(&ar->v2d);
2642
2643   /* View2D matrix might have changed due to dynamic sized regions. */
2644   UI_blocklist_update_window_matrix(C, &ar->uiblocks);
2645
2646   /* draw blocks */
2647   UI_blocklist_draw(C, &ar->uiblocks);
2648
2649   /* restore view matrix */
2650   UI_view2d_view_restore(C);
2651 }
2652
2653 void ED_region_header(const bContext *C, ARegion *ar)
2654 {
2655   /* TODO: remove? */
2656   ED_region_header_layout(C, ar);
2657   ED_region_header_draw(C, ar);
2658 }
2659
2660 void ED_region_header_init(ARegion *ar)
2661 {
2662   UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
2663 }
2664
2665 int ED_area_headersize(void)
2666 {
2667   /* Accomodate widget and padding. */
2668   return U.widget_unit + (int)(UI_DPI_FAC * HEADER_PADDING_Y);
2669 }
2670
2671 int ED_area_header_alignment_or_fallback(const ScrArea *area, int fallback)
2672 {
2673   for (ARegion *ar = area->regionbase.first; ar; ar = ar->next) {
2674     if (ar->regiontype == RGN_TYPE_HEADER) {
2675       return ar->alignment;
2676     }
2677   }
2678   return fallback;
2679 }
2680
2681 int ED_area_header_alignment(const ScrArea *area)
2682 {
2683   return ED_area_header_alignment_or_fallback(
2684       area, (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_BOTTOM : RGN_ALIGN_TOP);
2685 }
2686
2687 int ED_area_footersize(void)
2688 {
2689   return ED_area_headersize();
2690 }
2691
2692 int ED_area_footer_alignment_or_fallback(const ScrArea *area, int fallback)
2693 {
2694   for (ARegion *ar = area->regionbase.first; ar; ar = ar->next) {
2695     if (ar->regiontype == RGN_TYPE_FOOTER) {
2696       return ar->alignment;
2697     }
2698   }
2699   return fallback;
2700 }
2701
2702 int ED_area_footer_alignment(const ScrArea *area)
2703 {
2704   return ED_area_footer_alignment_or_fallback(
2705       area, (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_TOP : RGN_ALIGN_BOTTOM);
2706 }
2707
2708 /**
2709  * \return the final height of a global \a area, accounting for DPI.
2710  */
2711 int ED_area_global_size_y(const ScrArea *area)
2712 {
2713   BLI_assert(ED_area_is_global(area));
2714   return round_fl_to_int(area->global->cur_fixed_height * UI_DPI_FAC);
2715 }
2716 int ED_area_global_min_size_y(const ScrArea *area)
2717 {
2718   BLI_assert(ED_area_is_global(area));
2719   return round_fl_to_int(area->global->size_min * UI_DPI_FAC);
2720 }
2721 int ED_area_global_max_size_y(const ScrArea *area)
2722 {
2723   BLI_assert(ED_area_is_global(area));
2724   return round_fl_to_int(area->global->size_max * UI_DPI_FAC);
2725 }
2726
2727 bool ED_area_is_global(const ScrArea *area)
2728 {
2729   return area->global != NULL;
2730 }
2731
2732 ScrArea *ED_screen_areas_iter_first(const wmWindow *win, const bScreen *screen)
2733 {
2734   ScrArea *global_area = win->global_areas.areabase.first;
2735
2736   if (!global_area) {
2737     return screen->areabase.first;
2738   }
2739   else if ((global_area->global->flag & GLOBAL_AREA_IS_HIDDEN) == 0) {
2740     return global_area;
2741   }
2742   /* Find next visible area. */
2743   return ED_screen_areas_iter_next(screen, global_area);
2744 }
2745 ScrArea *ED_screen_areas_iter_next(const bScreen *screen, const ScrArea *area)
2746 {
2747   if (area->global) {
2748     for (ScrArea *area_iter = area->next; area_iter; area_iter = area_iter->next) {
2749       if ((area_iter->global->flag & GLOBAL_AREA_IS_HIDDEN) == 0) {
2750         return area_iter;
2751       }
2752     }
2753     /* No visible next global area found, start iterating over layout areas. */
2754     return screen->areabase.first;
2755   }
2756
2757   return area->next;
2758 }
2759
2760 /**
2761  * For now we just assume all global areas are made up out of horizontal bars
2762  * with the same size. A fixed size could be stored in ARegion instead if needed.
2763  *
2764  * \return the DPI aware height of a single bar/region in global areas.
2765  */
2766 int ED_region_global_size_y(void)
2767 {
2768   return ED_area_headersize(); /* same size as header */
2769 }
2770
2771 void ED_region_info_draw_multiline(ARegion *ar,
2772                                    const char *text_array[],
2773                                    float fill_color[4],
2774                                    const bool full_redraw)
2775 {
2776   const int header_height = UI_UNIT_Y;
2777   uiStyle *style = UI_style_get_dpi();
2778   int fontid = style->widget.uifont_id;
2779   int scissor[4];
2780   rcti rect;
2781   int num_lines = 0;
2782
2783   /* background box */
2784   ED_region_visible_rect(ar, &rect);
2785
2786   /* Box fill entire width or just around text. */
2787   if (!full_redraw) {
2788     const char **text = &text_array[0];
2789     while (*text) {
2790       rect.xmax = min_ii(rect.xmax,
2791                          rect.xmin + BLF_width(fontid, *text, BLF_DRAW_STR_DUMMY_MAX) +
2792                              1.2f * U.widget_unit);
2793       text++;
2794       num_lines++;
2795     }
2796   }
2797   /* Just count the line number. */
2798   else {
2799     const char **text = &text_array[0];
2800     while (*text) {
2801       text++;
2802       num_lines++;
2803     }
2804   }
2805
2806   rect.ymin = rect.ymax - header_height * num_lines;
2807
2808   /* setup scissor */
2809   GPU_scissor_get_i(scissor);
2810   GPU_scissor(rect.xmin, rect.ymin, BLI_rcti_size_x(&rect) + 1, BLI_rcti_size_y(&rect) + 1);
2811
2812   GPU_blend(true);
2813   GPU_blend_set_func_separate(
2814       GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
2815   GPUVertFormat *format = immVertexFormat();
2816   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
2817   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2818   immUniformColor4fv(fill_color);
2819   immRecti(pos, rect.xmin, rect.ymin, rect.xmax + 1, rect.ymax + 1);
2820   immUnbindProgram();
2821   GPU_blend(false);
2822
2823   /* text */
2824   UI_FontThemeColor(fontid, TH_TEXT_HI);
2825   BLF_clipping(fontid, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
2826   BLF_enable(fontid, BLF_CLIPPING);
2827   int offset = num_lines - 1;
2828   {
2829     const char **text = &text_array[0];
2830     while (*text) {
2831       BLF_position(fontid,
2832                    rect.xmin + 0.6f * U.widget_unit,
2833                    rect.ymin + 0.3f * U.widget_unit + offset * header_height,
2834                    0.0f);
2835       BLF_draw(fontid, *text, BLF_DRAW_STR_DUMMY_MAX);
2836       text++;
2837       offset--;
2838     }
2839   }
2840
2841   BLF_disable(fontid, BLF_CLIPPING);
2842
2843   /* restore scissor as it was before */
2844   GPU_scissor(scissor[0], scissor[1], scissor[2], scissor[3]);
2845 }
2846
2847 void ED_region_info_draw(ARegion *ar,
2848                          const char *text,
2849                          float fill_color[4],
2850                          const bool full_redraw)
2851 {
2852   ED_region_info_draw_multiline(ar, (const char * [2]){text, NULL}, fill_color, full_redraw);
2853 }
2854
2855 #define MAX_METADATA_STR 1024
2856
2857 static const char *meta_data_list[] = {
2858     "File",
2859     "Strip",
2860     "Date",
2861     "RenderTime",
2862     "Note",
2863     "Marker",
2864     "Time",
2865     "Frame",
2866     "Camera",
2867     "Scene",
2868 };
2869
2870 BLI_INLINE bool metadata_is_valid(ImBuf *ibuf, char *r_str, short index, int offset)
2871 {
2872   return (IMB_metadata_get_field(
2873               ibuf->metadata, meta_data_list[index], r_str + offset, MAX_METADATA_STR - offset) &&
2874           r_str[0]);
2875 }
2876
2877 BLI_INLINE bool metadata_is_custom_drawable(const char *field)
2878 {
2879   /* Metadata field stored by Blender for multilayer EXR images. Is rather
2880    * useless to be viewed all the time. Can still be seen in the Metadata
2881    * panel. */
2882   if (STREQ(field, "BlenderMultiChannel")) {
2883     return false;
2884   }
2885   /* Is almost always has value "scanlineimage", also useless to be seen
2886    * all the time. */
2887   if (STREQ(field, "type")) {
2888     return false;
2889   }
2890   return !BKE_stamp_is_known_field(field);
2891 }
2892
2893 typedef struct MetadataCustomDrawContext {
2894   int fontid;
2895   int xmin, ymin;
2896   int vertical_offset;
2897   int current_y;
2898 } MetadataCustomDrawContext;
2899
2900 static void metadata_custom_draw_fields(const char *field, const char *value, void *ctx_v)
2901 {
2902   if (!metadata_is_custom_drawable(field)) {
2903     return;
2904   }
2905   MetadataCustomDrawContext *ctx = (MetadataCustomDrawContext *)ctx_v;
2906   char temp_str[MAX_METADATA_STR];
2907   BLI_snprintf(temp_str, MAX_METADATA_STR, "%s: %s", field, value);
2908   BLF_position(ctx->fontid, ctx->xmin, ctx->ymin + ctx->current_y, 0.0f);
2909   BLF_draw(ctx->fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2910   ctx->current_y += ctx->vertical_offset;
2911 }
2912
2913 static void metadata_draw_imbuf(ImBuf *ibuf, const rctf *rect, int fontid, const bool is_top)
2914 {
2915   char temp_str[MAX_METADATA_STR];
2916   int line_width;
2917   int ofs_y = 0;
2918   short i;
2919   int len;
2920   const float height = BLF_height_max(fontid);
2921   const float margin = height / 8;
2922   const float vertical_offset = (height + margin);
2923
2924   /* values taking margins into account */
2925   const float descender = BLF_descender(fontid);
2926   const float xmin = (rect->xmin + margin);
2927   const float xmax = (rect->xmax - margin);
2928   const float ymin = (rect->ymin + margin) - descender;
2929   const float ymax = (rect->ymax - margin) - descender;
2930
2931   if (is_top) {
2932     for (i = 0; i < 4; i++) {
2933       /* first line */
2934       if (i == 0) {
2935         bool do_newline = false;
2936         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[0]);
2937         if (metadata_is_valid(ibuf, temp_str, 0, len)) {
2938           BLF_position(fontid, xmin, ymax - vertical_offset, 0.0f);
2939           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2940           do_newline = true;
2941         }
2942
2943         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[1]);
2944         if (metadata_is_valid(ibuf, temp_str, 1, len)) {
2945           line_width = BLF_width(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2946           BLF_position(fontid, xmax - line_width, ymax - vertical_offset, 0.0f);
2947           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2948           do_newline = true;
2949         }
2950
2951         if (do_newline) {
2952           ofs_y += vertical_offset;
2953         }
2954       } /* Strip */
2955       else if (i == 1 || i == 2) {
2956         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i + 1]);
2957         if (metadata_is_valid(ibuf, temp_str, i + 1, len)) {
2958           BLF_position(fontid, xmin, ymax - vertical_offset - ofs_y, 0.0f);
2959           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2960           ofs_y += vertical_offset;
2961         }
2962       } /* Note (wrapped) */
2963       else if (i == 3) {
2964         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i + 1]);
2965         if (metadata_is_valid(ibuf, temp_str, i + 1, len)) {
2966           struct ResultBLF info;
2967           BLF_enable(fontid, BLF_WORD_WRAP);
2968           BLF_wordwrap(fontid, ibuf->x - (margin * 2));
2969           BLF_position(fontid, xmin, ymax - vertical_offset - ofs_y, 0.0f);
2970           BLF_draw_ex(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX, &info);
2971           BLF_wordwrap(fontid, 0);
2972           BLF_disable(fontid, BLF_WORD_WRAP);
2973           ofs_y += vertical_offset * info.lines;
2974         }
2975       }
2976       else {
2977         len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i + 1]);
2978         if (metadata_is_valid(ibuf, temp_str, i + 1, len)) {
2979           line_width = BLF_width(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2980           BLF_position(fontid, xmax - line_width, ymax - vertical_offset - ofs_y, 0.0f);
2981           BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
2982           ofs_y += vertical_offset;
2983         }
2984       }
2985     }
2986   }
2987   else {
2988     MetadataCustomDrawContext ctx;
2989     ctx.fontid = fontid;
2990     ctx.xmin = xmin;
2991     ctx.ymin = ymin;
2992     ctx.vertical_offset = vertical_offset;
2993     ctx.current_y = ofs_y;
2994     ctx.vertical_offset = vertical_offset;
2995     IMB_metadata_foreach(ibuf, metadata_custom_draw_fields, &ctx);
2996     int ofs_x = 0;
2997     ofs_y = ctx.current_y;
2998     for (i = 5; i < 10; i++) {
2999       len = BLI_snprintf_rlen(temp_str, MAX_METADATA_STR, "%s: ", meta_data_list[i]);
3000       if (metadata_is_valid(ibuf, temp_str, i, len)) {
3001         BLF_position(fontid, xmin + ofs_x, ymin + ofs_y, 0.0f);
3002         BLF_draw(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX);
3003
3004         ofs_x += BLF_width(fontid, temp_str, BLF_DRAW_STR_DUMMY_MAX) + UI_UNIT_X;
3005       }
3006     }
3007   }
3008 }
3009
3010 typedef struct MetadataCustomCountContext {
3011   int count;
3012 } MetadataCustomCountContext;
3013
3014 static void metadata_custom_count_fields(const char *field, const char *UNUSED(value), void *ctx_v)
3015 {
3016   if (!metadata_is_custom_drawable(field)) {
3017     return;
3018   }
3019   MetadataCustomCountContext *ctx = (MetadataCustomCountContext *)ctx_v;
3020   ctx->count++;
3021 }
3022
3023 static float metadata_box_height_get(ImBuf *ibuf, int fontid, const bool is_top)
3024 {
3025   const float height = BLF_height_max(fontid);
3026   const float margin = (height / 8);
3027   char str[MAX_METADATA_STR] = "";
3028   short i, count = 0;
3029
3030   if (is_top) {
3031     if (metadata_is_valid(ibuf, str, 0, 0) || metadata_is_valid(ibuf, str, 1, 0)) {
3032       count++;
3033     }
3034     for (i = 2; i < 5; i++) {
3035       if (metadata_is_valid(ibuf, str, i, 0)) {
3036         if (i == 4) {
3037           struct {
3038             struct ResultBLF info;
3039             rctf rect;
3040           } wrap;
3041
3042           BLF_enable(fontid, BLF_WORD_WRAP);
3043           BLF_wordwrap(fontid, ibuf->x - (margin * 2));
3044           BLF_boundbox_ex(fontid, str, sizeof(str), &wrap.rect, &wrap.info);
3045           BLF_wordwrap(fontid, 0);
3046           BLF_disable(fontid, BLF_WORD_WRAP);
3047
3048           count += wrap.info.lines;
3049         }
3050         else {
3051           count++;
3052         }
3053       }
3054     }
3055   }
3056   else {
3057     for (i = 5; i < 10; i++) {
3058       if (metadata_is_valid(ibuf, str, i, 0)) {
3059         count = 1;
3060         break;
3061       }
3062     }
3063     MetadataCustomCountContext ctx;
3064     ctx.count = 0;
3065     IMB_metadata_foreach(ibuf, metadata_custom_count_fields, &ctx);
3066     count += ctx.count;
3067   }
3068
3069   if (count) {
3070     return (height + margin) * count;
3071   }
3072
3073   return 0;
3074 }
3075
3076 #undef MAX_METADATA_STR
3077
3078 void ED_region_image_metadata_draw(
3079     int x, int y, ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy)
3080 {
3081   float box_y;
3082   rctf rect;
3083   uiStyle *style = UI_style_get_dpi();
3084
3085   if (!ibuf->metadata) {
3086     return;
3087   }
3088
3089   /* find window pixel coordinates of origin */
3090   GPU_matrix_push();
3091
3092   /* offset and zoom using ogl */
3093   GPU_matrix_translate_2f(x, y);
3094   GPU_matrix_scale_2f(zoomx, zoomy);
3095
3096   BLF_size(blf_mono_font, style->widgetlabel.points * 1.5f * U.pixelsize, U.dpi);
3097
3098   /* *** upper box*** */
3099
3100   /* get needed box height */
3101   box_y = metadata_box_height_get(ibuf, blf_mono_font, true);
3102
3103   if (box_y) {
3104     /* set up rect */
3105     BLI_rctf_init(&rect, frame->xmin, frame->xmax, frame->ymax, frame->ymax + box_y);
3106     /* draw top box */
3107     GPUVertFormat *format = immVertexFormat();
3108     uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3109     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3110     immUniformThemeColor(TH_METADATA_BG);
3111     immRectf(pos, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3112     immUnbindProgram();
3113
3114     BLF_clipping(blf_mono_font, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3115     BLF_enable(blf_mono_font, BLF_CLIPPING);
3116
3117     UI_FontThemeColor(blf_mono_font, TH_METADATA_TEXT);
3118     metadata_draw_imbuf(ibuf, &rect, blf_mono_font, true);
3119
3120     BLF_disable(blf_mono_font, BLF_CLIPPING);
3121   }
3122
3123   /* *** lower box*** */
3124
3125   box_y = metadata_box_height_get(ibuf, blf_mono_font, false);
3126
3127   if (box_y) {
3128     /* set up box rect */
3129     BLI_rctf_init(&rect, frame->xmin, frame->xmax, frame->ymin - box_y, frame->ymin);
3130     /* draw top box */
3131     GPUVertFormat *format = immVertexFormat();
3132     uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3133     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3134     immUniformThemeColor(TH_METADATA_BG);
3135     immRectf(pos, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3136     immUnbindProgram();
3137
3138     BLF_clipping(blf_mono_font, rect.xmin, rect.ymin, rect.xmax, rect.ymax);
3139     BLF_enable(blf_mono_font, BLF_CLIPPING);
3140
3141     UI_FontThemeColor(blf_mono_font, TH_METADATA_TEXT);
3142     metadata_draw_imbuf(ibuf, &rect, blf_mono_font, false);
3143
3144     BLF_disable(blf_mono_font, BLF_CLIPPING);
3145   }
3146
3147   GPU_matrix_pop();
3148 }
3149
3150 typedef struct MetadataPanelDrawContext {
3151   uiLayout *layout;
3152 } MetadataPanelDrawContext;
3153
3154 static void metadata_panel_draw_field(const char *field, const char *value, void *ctx_v)
3155 {
3156   MetadataPanelDrawContext *ctx = (MetadataPanelDrawContext *)ctx_v;
3157   uiLayout *row = uiLayoutRow(ctx->layout, false);
3158   uiItemL(row, field, ICON_NONE);
3159   uiItemL(row, value, ICON_NONE);
3160 }
3161
3162 void ED_region_image_metadata_panel_draw(ImBuf *ibuf, uiLayout *layout)
3163 {
3164   MetadataPanelDrawContext ctx;
3165   ctx.layout = layout;
3166   IMB_metadata_foreach(ibuf, metadata_panel_draw_field, &ctx);
3167 }
3168
3169 void ED_region_grid_draw(ARegion *ar, float zoomx, float zoomy)
3170 {
3171   float gridsize, gridstep = 1.0f / 32.0f;
3172   float fac, blendfac;
3173   int x1, y1, x2, y2;
3174
3175   /* the image is located inside (0, 0), (1, 1) as set by view2d */
3176   UI_view2d_view_to_region(&ar->v2d, 0.0f, 0.0f, &x1, &y1);
3177   UI_view2d_view_to_region(&ar->v2d, 1.0f, 1.0f, &x2, &y2);
3178
3179   GPUVertFormat *format = immVertexFormat();
3180   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3181
3182   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3183   immUniformThemeColorShade(TH_BACK, 20);
3184   immRectf(pos, x1, y1, x2, y2);
3185   immUnbindProgram();
3186
3187   /* gridsize adapted to zoom level */
3188   gridsize = 0.5f * (zoomx + zoomy);
3189   if (gridsize <= 0.0f) {
3190     return;
3191   }
3192
3193   if (gridsize < 1.0f) {
3194     while (gridsize < 1.0f) {
3195       gridsize *= 4.0f;
3196       gridstep *= 4.0f;
3197     }
3198   }
3199   else {
3200     while (gridsize >= 4.0f) {
3201       gridsize /= 4.0f;
3202       gridstep /= 4.0f;
3203     }
3204   }
3205
3206   blendfac = 0.25f * gridsize - floorf(0.25f * gridsize);
3207   CLAMP(blendfac, 0.0f, 1.0f);
3208
3209   int count_fine = 1.0f / gridstep;
3210   int count_large = 1.0f / (4.0f * gridstep);
3211
3212   if (count_fine > 0) {
3213     GPU_vertformat_clear(format);
3214     pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
3215     unsigned color = GPU_vertformat_attr_add(format, "color", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
3216
3217     immBindBuiltinProgram(GPU_SHADER_2D_FLAT_COLOR);
3218     immBegin(GPU_PRIM_LINES, 4 * count_fine + 4 * count_large);
3219
3220     float theme_color[3];
3221     UI_GetThemeColorShade3fv(TH_BACK, (int)(20.0f * (1.0f - blendfac)), theme_color);
3222     fac = 0.0f;
3223
3224     /* the fine resolution level */
3225     for (int i = 0; i < count_fine; i++) {
3226       immAttr3fv(color, theme_color);
3227       immVertex2f(pos, x1, y1 * (1.0f - fac) + y2 * fac);
3228       immAttr3fv(color, theme_color);
3229       immVertex2f(pos, x2, y1 * (1.0f - fac) + y2 * fac);
3230       immAttr3fv(color, theme_color);
3231       immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y1);
3232       immAttr3fv(color, theme_color);
3233       immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y2);
3234       fac += gridstep;
3235     }
3236
3237     if (count_large > 0) {
3238       UI_GetThemeColor3fv(TH_BACK, theme_color);
3239       fac = 0.0f;
3240
3241       /* the large resolution level */
3242       for (int i = 0; i < count_large; i++) {
3243         immAttr3fv(color, theme_color);
3244         immVertex2f(pos, x1, y1 * (1.0f - fac) + y2 * fac);
3245         immAttr3fv(color, theme_color);
3246         immVertex2f(pos, x2, y1 * (1.0f - fac) + y2 * fac);
3247         immAttr3fv(color, theme_color);
3248         immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y1);
3249         immAttr3fv(color, theme_color);
3250         immVertex2f(pos, x1 * (1.0f - fac) + x2 * fac, y2);
3251         fac += 4.0f * gridstep;
3252       }
3253     }
3254
3255     immEnd();
3256     immUnbindProgram();
3257   }
3258 }
3259
3260 /* If the area has overlapping regions, it returns visible rect for Region *ar */
3261 /* rect gets returned in local region coordinates */
3262 void ED_region_visible_rect(ARegion *ar, rcti *rect)
3263 {
3264   ARegion *arn = ar;
3265
3266   /* allow function to be called without area */
3267   while (arn->prev) {
3268     arn = arn->prev;
3269   }
3270
3271   *rect = ar->winrct;
3272
3273   /* check if a region overlaps with the current one */
3274   for (; arn; arn = arn->next) {
3275     if (ar != arn && arn->overlap) {
3276       if (BLI_rcti_isect(rect, &arn->winrct, NULL)) {
3277         if (ELEM(arn->alignment, RGN_ALIGN_LEFT, RGN_ALIGN_RIGHT)) {
3278           /* Overlap left, also check 1 pixel offset (2 regions on one side). */
3279           if (ABS(rect->xmin - arn->winrct.xmin) < 2) {
3280             rect->xmin = arn->winrct.xmax;
3281           }
3282
3283           /* Overlap right. */
3284           if (ABS(rect->xmax - arn->winrct.xmax) < 2) {
3285             rect->xmax = arn->winrct.xmin;
3286           }
3287         }
3288         else if (ELEM(arn->alignment, RGN_ALIGN_TOP, RGN_ALIGN_BOTTOM)) {
3289           /* Same logic as above for vertical regions. */
3290           if (ABS(rect->ymin - arn->winrct.ymin) < 2) {
3291             rect->ymin = arn->winrct.ymax;
3292           }
3293           if (ABS(rect->ymax - arn->winrct.ymax) < 2) {
3294             rect->ymax = arn->winrct.ymin;
3295           }
3296         }
3297         else if (arn->alignment == RGN_ALIGN_FLOAT) {
3298           /* Skip floating. */
3299         }
3300         else {
3301           BLI_assert(!"Region overlap with unknown alignment");
3302         }
3303       }
3304     }
3305   }
3306   BLI_rcti_translate(rect, -ar->winrct.xmin, -ar->winrct.ymin);
3307 }
3308
3309 /* Cache display helpers */
3310
3311 void ED_region_cache_draw_background(const ARegion *ar)
3312 {
3313   uint pos = GPU_vertformat_attr_add(
3314       immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
3315   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3316   immUniformColor4ub(128, 128, 255, 64);
3317   immRecti(pos, 0, 0, ar->winx, 8 * UI_DPI_FAC);
3318   immUnbindProgram();
3319 }
3320
3321 void ED_region_cache_draw_curfra_label(const int framenr, const float x, const float y)
3322 {
3323   uiStyle *style = UI_style_get();
3324   int fontid = style->widget.uifont_id;
3325   char numstr[32];
3326   float font_dims[2] = {0.0f, 0.0f};
3327
3328   /* frame number */
3329   BLF_size(fontid, 11.0f * U.pixelsize, U.dpi);
3330   BLI_snprintf(numstr, sizeof(numstr), "%d", framenr);
3331
3332   BLF_width_and_height(fontid, numstr, sizeof(numstr), &font_dims[0], &font_dims[1]);
3333
3334   uint pos = GPU_vertformat_attr_add(
3335       immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
3336   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3337   immUniformThemeColor(TH_CFRAME);
3338   immRecti(pos, x, y, x + font_dims[0] + 6.0f, y + font_dims[1] + 4.0f);
3339   immUnbindProgram();
3340
3341   UI_FontThemeColor(fontid, TH_TEXT);
3342   BLF_position(fontid, x + 2.0f, y + 2.0f, 0.0f);
3343   BLF_draw(fontid, numstr, sizeof(numstr));
3344 }
3345
3346 void ED_region_cache_draw_cached_segments(
3347     const ARegion *ar, const int num_segments, const int *points, const int sfra, const int efra)
3348 {
3349   if (num_segments) {
3350     uint pos = GPU_vertformat_attr_add(
3351         immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
3352     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
3353     immUniformColor4ub(128, 128, 255, 128);
3354
3355     for (int a = 0; a < num_segments; a++) {
3356       float x1 = (float)(points[a * 2] - sfra) / (efra - sfra + 1) * ar->winx;
3357       float x2 = (float)(points[a * 2 + 1] - sfra + 1) / (efra - sfra + 1) * ar->winx;
3358
3359       immRecti(pos, x1, 0, x2, 8 * UI_DPI_FAC);
3360       /* TODO(merwin): use primitive restart to draw multiple rects more efficiently */
3361     }
3362
3363     immUnbindProgram();
3364   }
3365 }
3366
3367 /**
3368  * Generate subscriptions for this region.
3369  */
3370 void ED_region_message_subscribe(bContext *C,
3371                                  struct WorkSpace *workspace,
3372                                  struct Scene *scene,
3373                                  struct bScreen *screen,
3374                                  struct ScrArea *sa,
3375                                  struct ARegion *ar,
3376                                  struct wmMsgBus *mbus)
3377 {
3378   if (ar->gizmo_map != NULL) {
3379     WM_gizmomap_message_subscribe(C, ar->gizmo_map, ar, mbus);
3380   }
3381
3382   if (!BLI_listbase_is_empty(&ar->uiblocks)) {
3383     UI_region_message_subscribe(ar, mbus);
3384   }
3385
3386   if (ar->type->message_subscribe != NULL) {
3387     ar->type->message_subscribe(C, workspace, scene, screen, sa, ar, mbus);
3388   }
3389 }
3390
3391 int ED_region_snap_size_test(const ARegion *ar)
3392 {
3393   /* Use a larger value because toggling scrollbars can jump in size. */
3394   const int snap_match_threshold = 16;
3395   if (ar->type->snap_size != NULL) {
3396     return ((((ar->sizex - ar->type->snap_size(ar, ar->sizex, 0)) <= snap_match_threshold) << 0) |
3397             (((ar->sizey - ar->type->snap_size(ar, ar->sizey, 1)) <= snap_match_threshold) << 1));
3398   }
3399   return 0;
3400 }
3401
3402 bool ED_region_snap_size_apply(ARegion *ar, int snap_flag)
3403 {
3404   bool changed = false;
3405   if (ar->type->snap_size != NULL) {
3406     if (snap_flag & (1 << 0)) {
3407       short snap_size = ar->type->snap_size(ar, ar->sizex, 0);
3408       if (snap_size != ar->sizex) {
3409         ar->sizex = snap_size;
3410         changed = true;
3411       }
3412     }
3413     if (snap_flag & (1 << 1)) {
3414       short snap_size = ar->type->snap_size(ar, ar->sizey, 1);
3415       if (snap_size != ar->sizey) {
3416         ar->sizey = snap_size;
3417         changed = true;
3418       }
3419     }
3420   }
3421   return changed;
3422 }