/* * line.c * Copyright (C) 2016 Kovid Goyal * * Distributed under terms of the GPL3 license. */ #include "state.h" #include "unicode-data.h" #include "lineops.h" #include "charsets.h" #include "wcwidth-std.h" extern PyTypeObject Cursor_Type; static PyObject * new(PyTypeObject UNUSED *type, PyObject UNUSED *args, PyObject UNUSED *kwds) { PyErr_SetString(PyExc_TypeError, "Line objects cannot be instantiated directly, create them using LineBuf.line()"); return NULL; } static void dealloc(Line* self) { if (self->needs_free) { PyMem_Free(self->cpu_cells); PyMem_Free(self->gpu_cells); } Py_TYPE(self)->tp_free((PyObject*)self); } unsigned int line_length(Line *self) { index_type last = self->xnum - 1; for (index_type i = 0; i < self->xnum; i++) { if ((self->cpu_cells[last - i].ch) != BLANK_CHAR) return self->xnum - i; } return 0; } PyObject* cell_text(CPUCell *cell) { PyObject *ans; unsigned num = 1; static Py_UCS4 buf[arraysz(cell->cc_idx) + 1]; buf[0] = cell->ch; for (unsigned i = 0; i < arraysz(cell->cc_idx) && cell->cc_idx[i]; i++) buf[num++] = codepoint_for_mark(cell->cc_idx[i]); ans = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buf, num); return ans; } // URL detection {{{ static index_type find_colon_slash(Line *self, index_type x, index_type limit) { // Find :// at or before x index_type pos = MIN(x, self->xnum - 1); enum URL_PARSER_STATES {ANY, FIRST_SLASH, SECOND_SLASH}; enum URL_PARSER_STATES state = ANY; limit = MAX(2u, limit); if (pos < limit) return 0; do { char_type ch = self->cpu_cells[pos].ch; if (!is_url_char(ch)) return false; if (pos == x) { if (ch == ':') { if (pos + 2 < self->xnum && self->cpu_cells[pos+1].ch == '/' && self->cpu_cells[pos + 2].ch == '/') state = SECOND_SLASH; } else if (ch == '/') { if (pos + 1 < self->xnum && self->cpu_cells[pos+1].ch == '/') state = FIRST_SLASH; } } switch(state) { case ANY: if (ch == '/') state = FIRST_SLASH; break; case FIRST_SLASH: state = ch == '/' ? SECOND_SLASH : ANY; break; case SECOND_SLASH: if (ch == ':') return pos; state = ch == '/' ? SECOND_SLASH : ANY; break; } pos--; } while(pos >= limit); return 0; } static bool prefix_matches(Line *self, index_type at, const char_type* prefix, index_type prefix_len) { if (prefix_len > at) return false; index_type p, i; for (p = at - prefix_len, i = 0; i < prefix_len && p < self->xnum; i++, p++) { if ((self->cpu_cells[p].ch) != prefix[i]) return false; } return i == prefix_len; } static bool has_url_prefix_at(Line *self, index_type at, index_type min_prefix_len, index_type *ans) { for (size_t i = 0; i < OPT(url_prefixes.num); i++) { index_type prefix_len = OPT(url_prefixes.values[i].len); if (at < prefix_len || prefix_len < min_prefix_len) continue; if (prefix_matches(self, at, OPT(url_prefixes.values[i].string), prefix_len)) { *ans = at - prefix_len; return true; } } return false; } #define MIN_URL_LEN 5 static bool has_url_beyond(Line *self, index_type x) { for (index_type i = x; i < MIN(x + MIN_URL_LEN + 3, self->xnum); i++) { if (!is_url_char(self->cpu_cells[i].ch)) return false; } return true; } index_type line_url_start_at(Line *self, index_type x) { // Find the starting cell for a URL that contains the position x. A URL is defined as // known-prefix://url-chars. If no URL is found self->xnum is returned. if (x >= self->xnum || self->xnum <= MIN_URL_LEN + 3) return self->xnum; index_type ds_pos = 0, t; // First look for :// ahead of x ds_pos = find_colon_slash(self, x + OPT(url_prefixes).max_prefix_len + 3, x < 2 ? 0 : x - 2); if (ds_pos != 0 && has_url_beyond(self, ds_pos)) { if (has_url_prefix_at(self, ds_pos, ds_pos > x ? ds_pos - x: 0, &t)) return t; } ds_pos = find_colon_slash(self, x, 0); if (ds_pos == 0 || self->xnum < ds_pos + MIN_URL_LEN + 3 || !has_url_beyond(self, ds_pos)) return self->xnum; if (has_url_prefix_at(self, ds_pos, 0, &t)) return t; return self->xnum; } index_type line_url_end_at(Line *self, index_type x, bool check_short, char_type sentinel, bool next_line_starts_with_url_chars) { index_type ans = x; if (x >= self->xnum || (check_short && self->xnum <= MIN_URL_LEN + 3)) return 0; if (sentinel) { while (ans < self->xnum && self->cpu_cells[ans].ch != sentinel && is_url_char(self->cpu_cells[ans].ch)) ans++; } else { while (ans < self->xnum && is_url_char(self->cpu_cells[ans].ch)) ans++; } if (ans) ans--; if (ans < self->xnum - 1 || !next_line_starts_with_url_chars) { while (ans > x && can_strip_from_end_of_url(self->cpu_cells[ans].ch)) ans--; } return ans; } bool line_startswith_url_chars(Line *self) { return is_url_char(self->cpu_cells[0].ch); } static PyObject* url_start_at(Line *self, PyObject *x) { #define url_start_at_doc "url_start_at(x) -> Return the start cell number for a URL containing x or self->xnum if not found" return PyLong_FromUnsignedLong((unsigned long)line_url_start_at(self, PyLong_AsUnsignedLong(x))); } static PyObject* url_end_at(Line *self, PyObject *args) { #define url_end_at_doc "url_end_at(x) -> Return the end cell number for a URL containing x or 0 if not found" unsigned int x, sentinel = 0; int next_line_starts_with_url_chars = 0; if (!PyArg_ParseTuple(args, "I|Ip", &x, &sentinel, &next_line_starts_with_url_chars)) return NULL; return PyLong_FromUnsignedLong((unsigned long)line_url_end_at(self, x, true, sentinel, next_line_starts_with_url_chars)); } // }}} static PyObject* text_at(Line* self, Py_ssize_t xval) { #define text_at_doc "[x] -> Return the text in the specified cell" if ((unsigned)xval >= self->xnum) { PyErr_SetString(PyExc_IndexError, "Column number out of bounds"); return NULL; } return cell_text(self->cpu_cells + xval); } size_t cell_as_unicode(CPUCell *cell, bool include_cc, Py_UCS4 *buf, char_type zero_char) { size_t n = 1; buf[0] = cell->ch ? cell->ch : zero_char; if (include_cc) { for (unsigned i = 0; i < arraysz(cell->cc_idx) && cell->cc_idx[i]; i++) buf[n++] = codepoint_for_mark(cell->cc_idx[i]); } return n; } size_t cell_as_unicode_for_fallback(CPUCell *cell, Py_UCS4 *buf) { size_t n = 1; buf[0] = cell->ch ? cell->ch : ' '; if (buf[0] != '\t') { for (unsigned i = 0; i < arraysz(cell->cc_idx) && cell->cc_idx[i]; i++) { if (cell->cc_idx[i] != VS15 && cell->cc_idx[i] != VS16) buf[n++] = codepoint_for_mark(cell->cc_idx[i]); } } else buf[0] = ' '; return n; } size_t cell_as_utf8(CPUCell *cell, bool include_cc, char *buf, char_type zero_char) { char_type ch = cell->ch ? cell->ch : zero_char; if (ch == '\t') { include_cc = false; } size_t n = encode_utf8(ch, buf); if (include_cc) { for (unsigned i = 0; i < arraysz(cell->cc_idx) && cell->cc_idx[i]; i++) n += encode_utf8(codepoint_for_mark(cell->cc_idx[i]), buf + n); } buf[n] = 0; return n; } size_t cell_as_utf8_for_fallback(CPUCell *cell, char *buf) { char_type ch = cell->ch ? cell->ch : ' '; bool include_cc = true; if (ch == '\t') { ch = ' '; include_cc = false; } size_t n = encode_utf8(ch, buf); if (include_cc) { for (unsigned i = 0; i < arraysz(cell->cc_idx) && cell->cc_idx[i]; i++) { if (cell->cc_idx[i] != VS15 && cell->cc_idx[i] != VS16) { n += encode_utf8(codepoint_for_mark(cell->cc_idx[i]), buf + n); } } } buf[n] = 0; return n; } PyObject* unicode_in_range(const Line *self, const index_type start, const index_type limit, const bool include_cc, const char leading_char, const bool skip_zero_cells) { size_t n = 0; static Py_UCS4 buf[4096]; if (leading_char) buf[n++] = leading_char; char_type previous_width = 0; for(index_type i = start; i < limit && n < arraysz(buf) - 2 - arraysz(self->cpu_cells->cc_idx); i++) { char_type ch = self->cpu_cells[i].ch; if (ch == 0) { if (previous_width == 2) { previous_width = 0; continue; }; if (skip_zero_cells) continue; } if (ch == '\t') { buf[n++] = '\t'; unsigned num_cells_to_skip_for_tab = self->cpu_cells[i].cc_idx[0]; while (num_cells_to_skip_for_tab && i + 1 < limit && self->cpu_cells[i+1].ch == ' ') { i++; num_cells_to_skip_for_tab--; } } else { n += cell_as_unicode(self->cpu_cells + i, include_cc, buf + n, ' '); } previous_width = self->gpu_cells[i].attrs.width; } return PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buf, n); } PyObject * line_as_unicode(Line* self, bool skip_zero_cells) { return unicode_in_range(self, 0, xlimit_for_line(self), true, 0, skip_zero_cells); } static PyObject* sprite_at(Line* self, PyObject *x) { #define sprite_at_doc "[x] -> Return the sprite in the specified cell" unsigned long xval = PyLong_AsUnsignedLong(x); if (xval >= self->xnum) { PyErr_SetString(PyExc_IndexError, "Column number out of bounds"); return NULL; } GPUCell *c = self->gpu_cells + xval; return Py_BuildValue("HHH", c->sprite_x, c->sprite_y, c->sprite_z); } static void write_sgr(const char *val, ANSIBuf *output) { #define W(c) output->buf[output->len++] = c W(0x1b); W('['); for (size_t i = 0; val[i] != 0 && i < 122; i++) W(val[i]); W('m'); #undef W } static void write_hyperlink(hyperlink_id_type hid, ANSIBuf *output) { #define W(c) output->buf[output->len++] = c const char *key = hid ? get_hyperlink_for_id(output->hyperlink_pool, hid, false) : NULL; if (!key) hid = 0; output->active_hyperlink_id = hid; W(0x1b); W(']'); W('8'); if (!hid) { W(';'); W(';'); } else { const char* partition = strstr(key, ":"); W(';'); if (partition != key) { W('i'); W('d'); W('='); while (key != partition) W(*(key++)); } W(';'); while(*(++partition)) W(*partition); } W(0x1b); W('\\'); #undef W } static void write_mark(const char *mark, ANSIBuf *output) { #define W(c) output->buf[output->len++] = c W(0x1b); W(']'); W('1'); W('3'); W('3'); W(';'); for (size_t i = 0; mark[i] != 0 && i < 32; i++) W(mark[i]); W(0x1b); W('\\'); #undef W } bool line_as_ansi(Line *self, ANSIBuf *output, const GPUCell** prev_cell, index_type start_at, index_type stop_before, char_type prefix_char) { #define ENSURE_SPACE(extra) ensure_space_for(output, buf, Py_UCS4, output->len + extra, capacity, 2048, false); #define WRITE_SGR(val) { ENSURE_SPACE(128); escape_code_written = true; write_sgr(val, output); } #define WRITE_CH(val) { ENSURE_SPACE(1); output->buf[output->len++] = val; } #define WRITE_HYPERLINK(val) { ENSURE_SPACE(2256); escape_code_written = true; write_hyperlink(val, output); } #define WRITE_MARK(val) { ENSURE_SPACE(64); escape_code_written = true; write_mark(val, output); } bool escape_code_written = false; output->len = 0; index_type limit = MIN(stop_before, xlimit_for_line(self)); char_type previous_width = 0; if (prefix_char) { WRITE_CH(prefix_char); previous_width = wcwidth_std(prefix_char); } switch (self->attrs.prompt_kind) { case UNKNOWN_PROMPT_KIND: break; case PROMPT_START: WRITE_MARK("A"); break; case SECONDARY_PROMPT: WRITE_MARK("A;k=s"); break; case OUTPUT_START: WRITE_MARK("C"); break; } if (limit <= start_at) return escape_code_written; static const GPUCell blank_cell = { 0 }; GPUCell *cell; if (*prev_cell == NULL) *prev_cell = &blank_cell; const CellAttrs mask_for_sgr = {.val=SGR_MASK}; for (index_type pos=start_at; pos < limit; pos++) { char_type ch = self->cpu_cells[pos].ch; if (ch == 0) { if (previous_width == 2) { previous_width = 0; continue; } ch = ' '; } if (output->hyperlink_pool) { hyperlink_id_type hid = self->cpu_cells[pos].hyperlink_id; if (hid != output->active_hyperlink_id) { WRITE_HYPERLINK(hid); } } cell = &self->gpu_cells[pos]; #define CMP_ATTRS (cell->attrs.val & mask_for_sgr.val) != ((*prev_cell)->attrs.val & mask_for_sgr.val) #define CMP(x) cell->x != (*prev_cell)->x if (CMP_ATTRS || CMP(fg) || CMP(bg) || CMP(decoration_fg)) { const char *sgr = cell_as_sgr(cell, *prev_cell); if (*sgr) WRITE_SGR(sgr); } *prev_cell = cell; WRITE_CH(ch); if (ch == '\t') { unsigned num_cells_to_skip_for_tab = self->cpu_cells[pos].cc_idx[0]; while (num_cells_to_skip_for_tab && pos + 1 < limit && self->cpu_cells[pos+1].ch == ' ') { num_cells_to_skip_for_tab--; pos++; } } else { for(unsigned c = 0; c < arraysz(self->cpu_cells[pos].cc_idx) && self->cpu_cells[pos].cc_idx[c]; c++) { WRITE_CH(codepoint_for_mark(self->cpu_cells[pos].cc_idx[c])); } } previous_width = cell->attrs.width; } return escape_code_written; #undef CMP_ATTRS #undef CMP #undef WRITE_SGR #undef WRITE_CH #undef ENSURE_SPACE #undef WRITE_HYPERLINK #undef WRITE_MARK } static PyObject* as_ansi(Line* self, PyObject *a UNUSED) { #define as_ansi_doc "Return the line's contents with ANSI (SGR) escape codes for formatting" const GPUCell *prev_cell = NULL; ANSIBuf output = {0}; line_as_ansi(self, &output, &prev_cell, 0, self->xnum, 0); PyObject *ans = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, output.buf, output.len); free(output.buf); return ans; } static PyObject* is_continued(Line* self, PyObject *a UNUSED) { #define is_continued_doc "Return the line's continued flag" PyObject *ans = self->attrs.continued ? Py_True : Py_False; Py_INCREF(ans); return ans; } static PyObject* __repr__(Line* self) { PyObject *s = line_as_unicode(self, false); if (s == NULL) return NULL; PyObject *ans = PyObject_Repr(s); Py_CLEAR(s); return ans; } static PyObject* __str__(Line* self) { return line_as_unicode(self, false); } static PyObject* width(Line *self, PyObject *val) { #define width_doc "width(x) -> the width of the character at x" unsigned long x = PyLong_AsUnsignedLong(val); if (x >= self->xnum) { PyErr_SetString(PyExc_ValueError, "Out of bounds"); return NULL; } return PyLong_FromUnsignedLong((unsigned long) (self->gpu_cells[x].attrs.width)); } void line_add_combining_char(Line *self, uint32_t ch, unsigned int x) { CPUCell *cell = self->cpu_cells + x; if (!cell->ch) { if (x > 0 && (self->gpu_cells[x-1].attrs.width) == 2 && self->cpu_cells[x-1].ch) cell = self->cpu_cells + x - 1; else return; // don't allow adding combining chars to a null cell } for (unsigned i = 0; i < arraysz(cell->cc_idx); i++) { if (!cell->cc_idx[i]) { cell->cc_idx[i] = mark_for_codepoint(ch); return; } } cell->cc_idx[arraysz(cell->cc_idx) - 1] = mark_for_codepoint(ch); } static PyObject* add_combining_char(Line* self, PyObject *args) { #define add_combining_char_doc "add_combining_char(x, ch) -> Add the specified character as a combining char to the specified cell." int new_char; unsigned int x; if (!PyArg_ParseTuple(args, "IC", &x, &new_char)) return NULL; if (x >= self->xnum) { PyErr_SetString(PyExc_ValueError, "Column index out of bounds"); return NULL; } line_add_combining_char(self, new_char, x); Py_RETURN_NONE; } static PyObject* set_text(Line* self, PyObject *args) { #define set_text_doc "set_text(src, offset, sz, cursor) -> Set the characters and attributes from the specified text and cursor" PyObject *src; Py_ssize_t offset, sz, limit; Cursor *cursor; int kind; void *buf; if (!PyArg_ParseTuple(args, "UnnO!", &src, &offset, &sz, &Cursor_Type, &cursor)) return NULL; if (PyUnicode_READY(src) != 0) { PyErr_NoMemory(); return NULL; } kind = PyUnicode_KIND(src); buf = PyUnicode_DATA(src); limit = offset + sz; if (PyUnicode_GET_LENGTH(src) < limit) { PyErr_SetString(PyExc_ValueError, "Out of bounds offset/sz"); return NULL; } CellAttrs attrs = cursor_to_attrs(cursor, 1); color_type fg = (cursor->fg & COL_MASK), bg = cursor->bg & COL_MASK; color_type dfg = cursor->decoration_fg & COL_MASK; for (index_type i = cursor->x; offset < limit && i < self->xnum; i++, offset++) { self->cpu_cells[i].ch = (PyUnicode_READ(kind, buf, offset)); self->cpu_cells[i].hyperlink_id = 0; self->gpu_cells[i].attrs = attrs; self->gpu_cells[i].fg = fg; self->gpu_cells[i].bg = bg; self->gpu_cells[i].decoration_fg = dfg; memset(self->cpu_cells[i].cc_idx, 0, sizeof(self->cpu_cells[i].cc_idx)); } Py_RETURN_NONE; } static PyObject* cursor_from(Line* self, PyObject *args) { #define cursor_from_doc "cursor_from(x, y=0) -> Create a cursor object based on the formatting attributes at the specified x position. The y value of the cursor is set as specified." unsigned int x, y = 0; Cursor* ans; if (!PyArg_ParseTuple(args, "I|I", &x, &y)) return NULL; if (x >= self->xnum) { PyErr_SetString(PyExc_ValueError, "Out of bounds x"); return NULL; } ans = alloc_cursor(); if (ans == NULL) { PyErr_NoMemory(); return NULL; } ans->x = x; ans->y = y; attrs_to_cursor(self->gpu_cells[x].attrs, ans); ans->fg = self->gpu_cells[x].fg; ans->bg = self->gpu_cells[x].bg; ans->decoration_fg = self->gpu_cells[x].decoration_fg & COL_MASK; return (PyObject*)ans; } void line_clear_text(Line *self, unsigned int at, unsigned int num, char_type ch) { const uint16_t width = ch ? 1 : 0; for (index_type i = at; i < MIN(self->xnum, at + num); i++) { self->cpu_cells[i].ch = ch; memset(self->cpu_cells[i].cc_idx, 0, sizeof(self->cpu_cells[i].cc_idx)); self->cpu_cells[i].hyperlink_id = 0; self->gpu_cells[i].attrs.width = width; } } static PyObject* clear_text(Line* self, PyObject *args) { #define clear_text_doc "clear_text(at, num, ch=BLANK_CHAR) -> Clear characters in the specified range, preserving formatting." unsigned int at, num; int ch = BLANK_CHAR; if (!PyArg_ParseTuple(args, "II|C", &at, &num, &ch)) return NULL; line_clear_text(self, at, num, ch); Py_RETURN_NONE; } void line_apply_cursor(Line *self, Cursor *cursor, unsigned int at, unsigned int num, bool clear_char) { CellAttrs attrs = cursor_to_attrs(cursor, 0); color_type fg = (cursor->fg & COL_MASK), bg = (cursor->bg & COL_MASK); color_type dfg = cursor->decoration_fg & COL_MASK; for (index_type i = at; i < self->xnum && i < at + num; i++) { if (clear_char) { self->cpu_cells[i].ch = BLANK_CHAR; self->cpu_cells[i].hyperlink_id = 0; memset(self->cpu_cells[i].cc_idx, 0, sizeof(self->cpu_cells[i].cc_idx)); self->gpu_cells[i].attrs = attrs; clear_sprite_position(self->gpu_cells[i]); } else { attrs.width = self->gpu_cells[i].attrs.width; attrs.mark = self->gpu_cells[i].attrs.mark; self->gpu_cells[i].attrs = attrs; } self->gpu_cells[i].fg = fg; self->gpu_cells[i].bg = bg; self->gpu_cells[i].decoration_fg = dfg; } } static PyObject* apply_cursor(Line* self, PyObject *args) { #define apply_cursor_doc "apply_cursor(cursor, at=0, num=1, clear_char=False) -> Apply the formatting attributes from cursor to the specified characters in this line." Cursor* cursor; unsigned int at=0, num=1; int clear_char = 0; if (!PyArg_ParseTuple(args, "O!|IIp", &Cursor_Type, &cursor, &at, &num, &clear_char)) return NULL; line_apply_cursor(self, cursor, at, num, clear_char & 1); Py_RETURN_NONE; } void line_right_shift(Line *self, unsigned int at, unsigned int num) { for(index_type i = self->xnum - 1; i >= at + num; i--) { COPY_SELF_CELL(i - num, i) } // Check if a wide character was split at the right edge if (self->gpu_cells[self->xnum - 1].attrs.width != 1) { self->cpu_cells[self->xnum - 1].ch = BLANK_CHAR; self->cpu_cells[self->xnum - 1].hyperlink_id = 0; self->gpu_cells[self->xnum - 1].attrs = (CellAttrs){.width=BLANK_CHAR ? 1 : 0}; clear_sprite_position(self->gpu_cells[self->xnum - 1]); } } static PyObject* right_shift(Line *self, PyObject *args) { #define right_shift_doc "right_shift(at, num) -> ..." unsigned int at, num; if (!PyArg_ParseTuple(args, "II", &at, &num)) return NULL; if (at >= self->xnum || at + num > self->xnum) { PyErr_SetString(PyExc_ValueError, "Out of bounds"); return NULL; } if (num > 0) { line_right_shift(self, at, num); } Py_RETURN_NONE; } static PyObject* left_shift(Line *self, PyObject *args) { #define left_shift_doc "left_shift(at, num) -> ..." unsigned int at, num; if (!PyArg_ParseTuple(args, "II", &at, &num)) return NULL; if (at >= self->xnum || at + num > self->xnum) { PyErr_SetString(PyExc_ValueError, "Out of bounds"); return NULL; } if (num > 0) left_shift_line(self, at, num); Py_RETURN_NONE; } static color_type resolve_color(ColorProfile *cp, color_type val, color_type defval) { switch(val & 0xff) { case 1: return cp->color_table[(val >> 8) & 0xff]; case 2: return val >> 8; default: return defval; } } bool colors_for_cell(Line *self, ColorProfile *cp, index_type *x, color_type *fg, color_type *bg) { if (*x >= self->xnum) return false; if (*x > 0 && !self->gpu_cells[*x].attrs.width && self->gpu_cells[*x-1].attrs.width == 2) (*x)--; *fg = resolve_color(cp, self->gpu_cells[*x].fg, *fg); *bg = resolve_color(cp, self->gpu_cells[*x].bg, *bg); return true; } char_type line_get_char(Line *self, index_type at) { char_type ch = self->cpu_cells[at].ch; if (!ch && at > 0 && (self->gpu_cells[at-1].attrs.width) > 1) ch = self->cpu_cells[at-1].ch; return ch; } void line_set_char(Line *self, unsigned int at, uint32_t ch, unsigned int width, Cursor *cursor, hyperlink_id_type hyperlink_id) { GPUCell *g = self->gpu_cells + at; if (cursor == NULL) { g->attrs.width = width; } else { g->attrs = cursor_to_attrs(cursor, width); g->fg = cursor->fg & COL_MASK; g->bg = cursor->bg & COL_MASK; g->decoration_fg = cursor->decoration_fg & COL_MASK; } self->cpu_cells[at].ch = ch; self->cpu_cells[at].hyperlink_id = hyperlink_id; memset(self->cpu_cells[at].cc_idx, 0, sizeof(self->cpu_cells[at].cc_idx)); } static PyObject* set_char(Line *self, PyObject *args) { #define set_char_doc "set_char(at, ch, width=1, cursor=None, hyperlink_id=0) -> Set the character at the specified cell. If cursor is not None, also set attributes from that cursor." unsigned int at, width=1; int ch; Cursor *cursor = NULL; unsigned int hyperlink_id = 0; if (!PyArg_ParseTuple(args, "IC|IO!I", &at, &ch, &width, &Cursor_Type, &cursor, &hyperlink_id)) return NULL; if (at >= self->xnum) { PyErr_SetString(PyExc_ValueError, "Out of bounds"); return NULL; } line_set_char(self, at, ch, width, cursor, hyperlink_id); Py_RETURN_NONE; } static PyObject* set_attribute(Line *self, PyObject *args) { #define set_attribute_doc "set_attribute(which, val) -> Set the attribute on all cells in the line." unsigned int val; char *which; if (!PyArg_ParseTuple(args, "sI", &which, &val)) return NULL; if (!set_named_attribute_on_line(self->gpu_cells, which, val, self->xnum)) { PyErr_SetString(PyExc_KeyError, "Unknown cell attribute"); return NULL; } Py_RETURN_NONE; } static int color_as_sgr(char *buf, size_t sz, unsigned long val, unsigned simple_code, unsigned aix_code, unsigned complex_code) { switch(val & 0xff) { case 1: val >>= 8; if (val < 16 && simple_code) { return snprintf(buf, sz, "%lu;", (val < 8) ? simple_code + val : aix_code + (val - 8)); } return snprintf(buf, sz, "%u:5:%lu;", complex_code, val); case 2: return snprintf(buf, sz, "%u:2:%lu:%lu:%lu;", complex_code, (val >> 24) & 0xff, (val >> 16) & 0xff, (val >> 8) & 0xff); default: return snprintf(buf, sz, "%u;", complex_code + 1); // reset } } static const char* decoration_as_sgr(uint8_t decoration) { switch(decoration) { case 1: return "4;"; case 2: return "4:2;"; case 3: return "4:3;"; default: return "24;"; } } const char* cell_as_sgr(const GPUCell *cell, const GPUCell *prev) { static char buf[128]; #define SZ sizeof(buf) - (p - buf) - 2 #define P(s) { size_t len = strlen(s); if (SZ > len) { memcpy(p, s, len); p += len; } } char *p = buf; #define CA cell->attrs #define PA prev->attrs bool intensity_differs = CA.bold != PA.bold || CA.dim != PA.dim; if (intensity_differs) { if (!CA.bold && !CA.dim) { P("22;"); } else { if (CA.bold) P("1;"); if (CA.dim) P("2;"); } } if (CA.italic != PA.italic) P(CA.italic ? "3;" : "23;"); if (CA.reverse != PA.reverse) P(CA.reverse ? "7;" : "27;"); if (CA.strike != PA.strike) P(CA.strike ? "9;" : "29;"); if (cell->fg != prev->fg) p += color_as_sgr(p, SZ, cell->fg, 30, 90, 38); if (cell->bg != prev->bg) p += color_as_sgr(p, SZ, cell->bg, 40, 100, 48); if (cell->decoration_fg != prev->decoration_fg) p += color_as_sgr(p, SZ, cell->decoration_fg, 0, 0, DECORATION_FG_CODE); if (CA.decoration != PA.decoration) P(decoration_as_sgr(CA.decoration)); #undef PA #undef CA #undef P #undef SZ if (p > buf) *(p - 1) = 0; // remove trailing semi-colon *p = 0; // ensure string is null-terminated return buf; } static Py_ssize_t __len__(PyObject *self) { return (Py_ssize_t)(((Line*)self)->xnum); } static int __eq__(Line *a, Line *b) { return a->xnum == b->xnum && memcmp(a->cpu_cells, b->cpu_cells, sizeof(CPUCell) * a->xnum) == 0 && memcmp(a->gpu_cells, b->gpu_cells, sizeof(GPUCell) * a->xnum) == 0; } bool line_has_mark(Line *line, uint16_t mark) { for (index_type x = 0; x < line->xnum; x++) { const uint16_t m = line->gpu_cells[x].attrs.mark; if (m && (!mark || mark == m)) return true; } return false; } static void report_marker_error(PyObject *marker) { if (!PyObject_HasAttrString(marker, "error_reported")) { PyErr_Print(); if (PyObject_SetAttrString(marker, "error_reported", Py_True) != 0) PyErr_Clear(); } else PyErr_Clear(); } static void apply_mark(Line *line, const uint16_t mark, index_type *cell_pos, unsigned int *match_pos) { #define MARK { line->gpu_cells[x].attrs.mark = mark; } index_type x = *cell_pos; MARK; (*match_pos)++; if (line->cpu_cells[x].ch) { if (line->cpu_cells[x].ch == '\t') { unsigned num_cells_to_skip_for_tab = line->cpu_cells[x].cc_idx[0]; while (num_cells_to_skip_for_tab && x + 1 < line->xnum && line->cpu_cells[x+1].ch == ' ') { x++; num_cells_to_skip_for_tab--; MARK; } } else if ((line->gpu_cells[x].attrs.width) > 1 && x + 1 < line->xnum && !line->cpu_cells[x+1].ch) { x++; MARK; } else { for (index_type i = 0; i < arraysz(line->cpu_cells[x].cc_idx); i++) { if (line->cpu_cells[x].cc_idx[i]) (*match_pos)++; } } } *cell_pos = x + 1; #undef MARK } static void apply_marker(PyObject *marker, Line *line, const PyObject *text) { unsigned int l=0, r=0, col=0, match_pos=0; PyObject *pl = PyLong_FromVoidPtr(&l), *pr = PyLong_FromVoidPtr(&r), *pcol = PyLong_FromVoidPtr(&col); if (!pl || !pr || !pcol) { PyErr_Clear(); return; } PyObject *iter = PyObject_CallFunctionObjArgs(marker, text, pl, pr, pcol, NULL); Py_DECREF(pl); Py_DECREF(pr); Py_DECREF(pcol); if (iter == NULL) { report_marker_error(marker); return; } PyObject *match; index_type x = 0; while ((match = PyIter_Next(iter)) && x < line->xnum) { Py_DECREF(match); while (match_pos < l && x < line->xnum) { apply_mark(line, 0, &x, &match_pos); } uint16_t am = (col & MARK_MASK); while(x < line->xnum && match_pos <= r) { apply_mark(line, am, &x, &match_pos); } } Py_DECREF(iter); while(x < line->xnum) line->gpu_cells[x++].attrs.mark = 0; if (PyErr_Occurred()) report_marker_error(marker); } void mark_text_in_line(PyObject *marker, Line *line) { if (!marker) { for (index_type i = 0; i < line->xnum; i++) line->gpu_cells[i].attrs.mark = 0; return; } PyObject *text = line_as_unicode(line, false); if (PyUnicode_GET_LENGTH(text) > 0) { apply_marker(marker, line, text); } else { for (index_type i = 0; i < line->xnum; i++) line->gpu_cells[i].attrs.mark = 0; } Py_DECREF(text); } PyObject* as_text_generic(PyObject *args, void *container, get_line_func get_line, index_type lines, ANSIBuf *ansibuf) { #define APPEND(x) { PyObject* retval = PyObject_CallFunctionObjArgs(callback, x, NULL); if (!retval) return NULL; Py_DECREF(retval); } #define APPEND_AND_DECREF(x) { if (x == NULL) { if (PyErr_Occurred()) return NULL; Py_RETURN_NONE; } PyObject* retval = PyObject_CallFunctionObjArgs(callback, x, NULL); Py_CLEAR(x); if (!retval) return NULL; Py_DECREF(retval); } PyObject *callback; int as_ansi = 0, insert_wrap_markers = 0; if (!PyArg_ParseTuple(args, "O|pp", &callback, &as_ansi, &insert_wrap_markers)) return NULL; PyObject *t = NULL; DECREF_AFTER_FUNCTION PyObject *nl = PyUnicode_FromString("\n"); DECREF_AFTER_FUNCTION PyObject *cr = PyUnicode_FromString("\r"); DECREF_AFTER_FUNCTION PyObject *sgr_reset = PyUnicode_FromString("\x1b[m"); if (nl == NULL || cr == NULL || sgr_reset == NULL) return NULL; const GPUCell *prev_cell = NULL; ansibuf->active_hyperlink_id = 0; for (index_type y = 0; y < lines; y++) { Line *line = get_line(container, y); if (!line) { if (PyErr_Occurred()) return NULL; break; } if (!line->attrs.continued && y > 0) APPEND(nl); if (as_ansi) { // less has a bug where it resets colors when it sees a \r, so work // around it by resetting SGR at the start of every line. This is // pretty sad performance wise, but I guess it will remain till I // get around to writing a nice pager kitten. // see https://github.com/kovidgoyal/kitty/issues/2381 prev_cell = NULL; line_as_ansi(line, ansibuf, &prev_cell, 0, line->xnum, 0); t = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, ansibuf->buf, ansibuf->len); if (t && ansibuf->len > 0) APPEND(sgr_reset); } else { t = line_as_unicode(line, false); } APPEND_AND_DECREF(t); if (insert_wrap_markers) APPEND(cr); } if (ansibuf->active_hyperlink_id) { ansibuf->active_hyperlink_id = 0; t = PyUnicode_FromString("\x1b]8;;\x1b\\"); APPEND_AND_DECREF(t); } Py_RETURN_NONE; #undef APPEND #undef APPEND_AND_DECREF } // Boilerplate {{{ static PyObject* copy_char(Line* self, PyObject *args); #define copy_char_doc "copy_char(src, to, dest) -> Copy the character at src to to the character dest in the line `to`" #define hyperlink_ids_doc "hyperlink_ids() -> Tuple of hyper link ids at every cell" static PyObject* hyperlink_ids(Line *self, PyObject *args UNUSED) { PyObject *ans = PyTuple_New(self->xnum); for (index_type x = 0; x < self->xnum; x++) { PyTuple_SET_ITEM(ans, x, PyLong_FromUnsignedLong(self->cpu_cells[x].hyperlink_id)); } return ans; } static PyObject * richcmp(PyObject *obj1, PyObject *obj2, int op); static PySequenceMethods sequence_methods = { .sq_length = __len__, .sq_item = (ssizeargfunc)text_at }; static PyMethodDef methods[] = { METHOD(add_combining_char, METH_VARARGS) METHOD(set_text, METH_VARARGS) METHOD(cursor_from, METH_VARARGS) METHOD(apply_cursor, METH_VARARGS) METHOD(clear_text, METH_VARARGS) METHOD(copy_char, METH_VARARGS) METHOD(right_shift, METH_VARARGS) METHOD(left_shift, METH_VARARGS) METHOD(set_char, METH_VARARGS) METHOD(set_attribute, METH_VARARGS) METHOD(as_ansi, METH_NOARGS) METHOD(is_continued, METH_NOARGS) METHOD(hyperlink_ids, METH_NOARGS) METHOD(width, METH_O) METHOD(url_start_at, METH_O) METHOD(url_end_at, METH_VARARGS) METHOD(sprite_at, METH_O) {NULL} /* Sentinel */ }; PyTypeObject Line_Type = { PyVarObject_HEAD_INIT(NULL, 0) .tp_name = "fast_data_types.Line", .tp_basicsize = sizeof(Line), .tp_dealloc = (destructor)dealloc, .tp_repr = (reprfunc)__repr__, .tp_str = (reprfunc)__str__, .tp_as_sequence = &sequence_methods, .tp_flags = Py_TPFLAGS_DEFAULT, .tp_richcompare = richcmp, .tp_doc = "Lines", .tp_methods = methods, .tp_new = new }; Line *alloc_line() { Line *ans = (Line*)PyType_GenericAlloc(&Line_Type, 0); ans->needs_free = 0; return ans; } RICHCMP(Line) INIT_TYPE(Line) // }}} static PyObject* copy_char(Line* self, PyObject *args) { unsigned int src, dest; Line *to; if (!PyArg_ParseTuple(args, "IO!I", &src, &Line_Type, &to, &dest)) return NULL; if (src >= self->xnum || dest >= to->xnum) { PyErr_SetString(PyExc_ValueError, "Out of bounds"); return NULL; } COPY_CELL(self, src, to, dest); Py_RETURN_NONE; }