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