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