Blender V5.3
console_draw.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <algorithm>
10#include <cstring>
11
12#include "BLI_listbase.hh"
13#include "BLI_span.hh"
14#include "BLI_string_ref.hh"
15#include "BLI_string_utf8.hh"
16
17#include "DNA_screen_types.h"
18#include "DNA_space_types.h"
19#include "DNA_userdef_types.h"
20
21#include "MEM_guardedalloc.h"
22
23#include "GPU_immediate.hh"
24
25#include "UI_resources.hh"
26#include "UI_view2d.hh"
27
28#include "console_intern.hh"
29
31
32namespace blender {
33
35 uchar fg[4],
36 uchar /*bg*/[4],
37 int * /*icon*/,
38 uchar /*icon_fg*/[4],
39 uchar /*icon_bg*/[4])
40{
41 const ConsoleLine *cl_iter = static_cast<const ConsoleLine *>(tvc->iter);
42 int fg_id = TH_TEXT;
43
44 switch (cl_iter->type) {
46 fg_id = TH_CONSOLE_OUTPUT;
47 break;
49 fg_id = TH_CONSOLE_INPUT;
50 break;
52 fg_id = TH_CONSOLE_INFO;
53 break;
55 fg_id = TH_CONSOLE_ERROR;
56 break;
57 }
58
60 return TVC_LINE_FG;
61}
62
64{
65 /* fake the edit line being in the scroll buffer */
66 ConsoleLine *cl = sc->history.last();
67 int prompt_len = strlen(sc->prompt);
68
69 cl_dummy->type = CONSOLE_LINE_INPUT;
70 cl_dummy->len = prompt_len + cl->len;
71 cl_dummy->len_alloc = cl_dummy->len + 1;
72 cl_dummy->line = MEM_new_array_uninitialized<char>(cl_dummy->len_alloc, "cl_dummy");
73 memcpy(cl_dummy->line, sc->prompt, prompt_len);
74 memcpy(cl_dummy->line + prompt_len, cl->line, cl->len + 1);
75 BLI_addtail(&sc->scrollback, cl_dummy);
76}
78{
79 MEM_delete(cl_dummy->line);
80 BLI_remlink(&sc->scrollback, cl_dummy);
81}
82
83/* console textview callbacks */
85{
86 SpaceConsole *sc = static_cast<SpaceConsole *>(const_cast<void *>(tvc->arg1));
87 tvc->sel_start = sc->sel_start;
88 tvc->sel_end = sc->sel_end;
89
90 /* iterator */
91 tvc->iter = sc->scrollback.last();
92
93 return (tvc->iter != nullptr);
94}
95
97{
98 SpaceConsole *sc = static_cast<SpaceConsole *>(const_cast<void *>(tvc->arg1));
99 (void)sc;
100}
101
103{
104 return ((tvc->iter = static_cast<void *>(
105 (static_cast<Link *>(const_cast<void *>(tvc->iter)))->prev)) != nullptr);
106}
107
108static void console_textview_line_get(TextViewContext *tvc, const char **r_line, int *r_len)
109{
110 const ConsoleLine *cl = static_cast<const ConsoleLine *>(tvc->iter);
111 *r_line = cl->line;
112 *r_len = cl->len;
113 // printf("'%s' %d\n", *line, cl->len);
114 BLI_assert(cl->line[cl->len] == '\0' && (cl->len == 0 || cl->line[cl->len - 1] != '\0'));
115}
116
119 int row = 0;
120 int column = 0;
121};
122
133
141 const int byte_offset)
142{
143 const Span<int> offsets = line.offsets;
144 int row = 0;
145 while ((row + 1 < offsets.size()) && (offsets[row + 1] <= byte_offset)) {
146 row++;
147 }
148 const int row_start = offsets[row];
149 const int row_end = (row + 1 < offsets.size()) ? offsets[row + 1] : line.str_len;
151 line.str + row_start, row_end - row_start, byte_offset - row_start, TVC_TAB_COLUMNS);
152 return {row, column};
153}
154
160 const ConsoleWrapOffset &wrap_offset)
161{
162 const int end_row = int(line.offsets.size()) - 1;
163 return {
164 line.draw_rect.xmin + (line.char_width * wrap_offset.column),
165 line.draw_rect.ymin + (line.line_height * (end_row - wrap_offset.row)),
166 };
167}
168
170static int2 console_line_byte_to_xy(const ConsoleDrawLine &line, const int byte_offset)
171{
172 return console_line_wrap_offset_to_xy(line, console_line_wrap_offset(line, byte_offset));
173}
174
175static void console_textview_draw_cursor(TextViewContext *tvc, int char_width, int columns)
176{
177 int2 pen;
178 {
179 const SpaceConsole *sc = static_cast<SpaceConsole *>(const_cast<void *>(tvc->arg1));
180 /* Cache the font metrics computed during draw, reused for IME cursor positioning. */
181 sc->runtime->char_width_px = char_width;
183 const ConsoleLine *cl = sc->history.last();
184
185 /* Use the dummy scrollback line built for this draw,
186 * see #console_scrollback_prompt_begin. */
187 const ConsoleLine *cl_drawn = sc->scrollback.last();
188 const int cursor_byte = int(strlen(sc->prompt)) + cl->cursor;
189
190 /* Rebuild the wrap layout #textview_draw just drew this line with. */
191 int tot_rows;
192 int *offsets_buf;
193 textview_wrap_offsets(cl_drawn->line, cl_drawn->len, columns, &tot_rows, &offsets_buf);
194 const ConsoleDrawLine line = {
195 cl_drawn->line,
196 cl_drawn->len,
197 Span<int>(offsets_buf, tot_rows),
198 tvc->draw_rect,
199 char_width,
200 tvc->line_height,
201 };
202
203 pen = console_line_byte_to_xy(line, cursor_byte);
204 MEM_delete(offsets_buf);
205 }
206
207 /* cursor */
208 GPUVertFormat *format = immVertexFormat();
209 uint pos = GPU_vertformat_attr_add(format, "pos", gpu::VertAttrType::SFLOAT_32_32);
212
213 immRectf(pos, pen[0] - U.pixelsize, pen[1], pen[0] + U.pixelsize, pen[1] + tvc->line_height);
214
216}
217
222
223static void console_textview_draw_rect_calc(const ARegion *region,
224 rcti *r_draw_rect,
225 rcti *r_draw_rect_outer)
226{
227 const int margin = 4 * UI_SCALE_FAC;
228 r_draw_rect->xmin = margin;
229 r_draw_rect->xmax = region->winx - V2D_SCROLL_WIDTH;
230 r_draw_rect->ymin = margin;
231 /* No margin at the top (allow text to scroll off the window). */
232 r_draw_rect->ymax = region->winy;
233
234 r_draw_rect_outer->xmin = 0;
235 r_draw_rect_outer->xmax = region->winx;
236 r_draw_rect_outer->ymin = 0;
237 r_draw_rect_outer->ymax = region->winy;
238}
239
241 const ARegion *region,
242 const bool do_draw,
243 const int mval[2],
244 void **r_mval_pick_item,
245 int *r_mval_pick_offset)
246{
247 ConsoleLine cl_dummy = {nullptr};
248 int ret = 0;
249
250 const View2D *v2d = &region->v2d;
251
252 TextViewContext tvc = {0};
253
256
262
263 tvc.arg1 = sc;
264 tvc.arg2 = nullptr;
265
266 /* view */
267 tvc.sel_start = sc->sel_start;
268 tvc.sel_end = sc->sel_end;
270 tvc.scroll_ymin = v2d->cur.ymin;
271 tvc.scroll_ymax = v2d->cur.ymax;
272
274
275 /* Nudge right by half a column to break selection mid-character. */
276 int m_pos[2] = {mval[0], mval[1]};
277 /* Mouse position is initialized with max int. */
278 if (m_pos[0] != INT_MAX) {
279 m_pos[0] += tvc.line_height / 4;
280 }
281
282 console_scrollback_prompt_begin(sc, &cl_dummy);
283 ret = textview_draw(&tvc, do_draw, m_pos, r_mval_pick_item, r_mval_pick_offset);
284 console_scrollback_prompt_end(sc, &cl_dummy);
285
286 return ret;
287}
288
290{
291 const int mval[2] = {INT_MAX, INT_MAX};
292 console_textview_main__internal(sc, region, true, mval, nullptr, nullptr);
293}
294
296{
297 const int mval[2] = {INT_MAX, INT_MAX};
298 return console_textview_main__internal(sc, region, false, mval, nullptr, nullptr);
299}
300
301int console_char_pick(SpaceConsole *sc, const ARegion *region, const int mval[2])
302{
303 int mval_pick_offset = 0;
304 void *mval_pick_item = nullptr;
305
306 console_textview_main__internal(sc, region, false, mval, &mval_pick_item, &mval_pick_offset);
307 return mval_pick_offset;
308}
309
310std::optional<blender::int2> console_cursor_region_xy_get(const SpaceConsole *sc,
311 const ARegion *region,
312 const int offset)
313{
314 const ConsoleLine *cl = sc->history.last();
315 if (cl == nullptr) {
316 return std::nullopt;
317 }
318
319 rcti draw_rect, draw_rect_outer;
320 console_textview_draw_rect_calc(region, &draw_rect, &draw_rect_outer);
321
322 const int char_width = sc->runtime->char_width_px;
323 const int columns = std::max((draw_rect.xmax - draw_rect.xmin) / std::max(char_width, 1), 1);
324
325 /* Build the edit line as drawn: prompt + input. */
326 const std::string str = StringRef(sc->prompt) + StringRef(cl->line, cl->len);
327
328 int tot_rows;
329 int *offsets_buf;
330 textview_wrap_offsets(str.c_str(), int(str.size()), columns, &tot_rows, &offsets_buf);
331 const ConsoleDrawLine line = {
332 str.c_str(),
333 int(str.size()),
334 Span<int>(offsets_buf, tot_rows),
335 draw_rect,
336 char_width,
338 };
339 const int2 xy = console_line_byte_to_xy(line, int(strlen(sc->prompt)) + offset);
340 MEM_delete(offsets_buf);
341
342 return xy;
343}
344
345} // namespace blender
#define UI_SCALE_FAC
Read Blender memory allocation and freeing.
#define V2D_SCROLL_WIDTH
Definition UI_view2d.hh:79
constexpr int64_t size() const
Definition BLI_span.hh:256
constexpr StringRef()
constexpr int64_t size() const
#define str(s)
#define INT_MAX
void get_color_4ubv(int colorid, unsigned char col[4])
BMesh Iterators.
UserDef U
Definition blender.cc:58
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static enum eTextViewContext_LineFlag console_line_data(TextViewContext *tvc, uchar fg[4], uchar[4], int *, uchar[4], uchar[4])
unsigned int uint
Definition BKE_text.h:55
void * MEM_new_array_uninitialized(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
GPUVertFormat * immVertexFormat()
static int2 console_line_byte_to_xy(const ConsoleDrawLine &line, const int byte_offset)
static void console_textview_draw_rect_calc(const ARegion *region, rcti *r_draw_rect, rcti *r_draw_rect_outer)
@ TH_CONSOLE_CURSOR
@ TH_CONSOLE_OUTPUT
@ TH_CONSOLE_SELECT
int textview_wrap_offsets(const char *str, const int str_len, const int width, int *r_lines, int **r_offsets)
Definition textview.cc:98
void immUnbindProgram()
int textview_draw(TextViewContext *tvc, const bool do_draw, const int mval_init[2], void **r_mval_pick_item, int *r_mval_pick_offset)
Definition textview.cc:302
void immBindBuiltinProgram(GPUBuiltinShader shader_id)
static int console_textview_main__internal(SpaceConsole *sc, const ARegion *region, const bool do_draw, const int mval[2], void **r_mval_pick_item, int *r_mval_pick_offset)
static int console_textview_step(TextViewContext *tvc)
void immUniformThemeColor(int color_id)
VecBase< int32_t, 2 > int2
unsigned char uchar
Definition BKE_text.h:58
static void console_textview_draw_cursor(TextViewContext *tvc, int char_width, int columns)
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:138
std::optional< blender::int2 > console_cursor_region_xy_get(const SpaceConsole *sc, const ARegion *region, const int offset)
eTextViewContext_LineFlag
Definition textview.hh:19
@ TVC_LINE_FG
Definition textview.hh:20
int BLI_str_utf8_offset_to_column_with_tabs(const char *str, size_t str_len, int offset_target, int tab_width) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
uint GPU_vertformat_attr_add(GPUVertFormat *format, StringRef name, gpu::VertAttrType type)
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
static int2 console_line_wrap_offset_to_xy(const ConsoleDrawLine &line, const ConsoleWrapOffset &wrap_offset)
static ConsoleWrapOffset console_line_wrap_offset(const ConsoleDrawLine &line, const int byte_offset)
int console_textview_height(SpaceConsole *sc, const ARegion *region)
void console_textview_main(SpaceConsole *sc, const ARegion *region)
static int console_textview_begin(TextViewContext *tvc)
void console_scrollback_prompt_end(SpaceConsole *sc, ConsoleLine *cl_dummy)
void immRectf(uint pos, float x1, float y1, float x2, float y2)
static void console_textview_line_get(TextViewContext *tvc, const char **r_line, int *r_len)
static void console_textview_const_colors(TextViewContext *, uchar bg_sel[4])
void console_scrollback_prompt_begin(SpaceConsole *sc, ConsoleLine *cl_dummy)
static void console_textview_end(TextViewContext *tvc)
int console_char_pick(SpaceConsole *sc, const ARegion *region, const int mval[2])
ListBaseT< ConsoleLine > scrollback
SpaceConsole_Runtime * runtime
ListBaseT< ConsoleLine > history
void(*) const_colors(TextViewContext *tvc, unsigned char bg_sel[4])
Definition textview.hh:61
int(*) begin(TextViewContext *tvc)
Definition textview.hh:45
void(*) line_get(TextViewContext *tvc, const char **r_line, int *r_len)
Definition textview.hh:52
int(*) step(TextViewContext *tvc)
Definition textview.hh:51
void(*) draw_cursor(TextViewContext *tvc, int char_width, int columns)
Definition textview.hh:59
void(*) end(TextViewContext *tvc)
Definition textview.hh:46
enum eTextViewContext_LineFlag(*) line_data(TextViewContext *tvc, uchar fg[4], uchar bg[4], int *r_icon, uchar r_icon_fg[4], uchar r_icon_bg[4])
Definition textview.hh:53
#define TVC_TAB_COLUMNS
Definition textview.hh:17