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