diff options
| -rw-r--r-- | TODO | 6 | ||||
| -rw-r--r-- | doc/sciteco.1.in | 6 | ||||
| -rw-r--r-- | doc/sciteco.7.template | 15 | ||||
| -rw-r--r-- | src/help.c | 143 | ||||
| -rw-r--r-- | src/lsp.c | 2 | ||||
| -rw-r--r-- | src/rb3str.c | 42 | ||||
| -rw-r--r-- | src/rb3str.h | 2 | ||||
| -rw-r--r-- | tests/testsuite.at | 9 |
8 files changed, 136 insertions, 89 deletions
@@ -1018,11 +1018,7 @@ Optimizations: Documentation: * Doxygen docs could be deployed on Github pages automatically. - * The ? command could be extended to support looking - up help terms at dot in the current document (e.g. if called as .?$ - similar to .FT$). - `?$` could also toggle through all results just like `FT$`. - Furthermore, womanpages could contain "hypertext" links + * Womanpages could contain "hypertext" links to help topics using special Troff markup and grosciteco support. * The command reference should include an overview. * Command reference is poorly formatted. diff --git a/doc/sciteco.1.in b/doc/sciteco.1.in index 1e7fe3b..dc10f11 100644 --- a/doc/sciteco.1.in +++ b/doc/sciteco.1.in @@ -191,7 +191,7 @@ option. .SCITECO_TOPIC "-h" "--help" Display a short help text on the console. .IP "\fB-v\fR, \fB--version\fR" -.SCITECO_TOPIC "-v" "--version" +.SCITECO_TOPIC "-v" "--version" version Display the \*(ST version in an easy to parse way. See also the \fBEO\fP command. .IP "\fB-q\fR, \fB--quiet\fR" @@ -367,7 +367,7 @@ environment before initializing Curses, so these variables can be modified in the profile macro. . .LP -.SCITECO_TOPIC "$SCITECO_CLIPBOARD_SET" "$SCITECO_CLIPBOARD_GET" +.SCITECO_TOPIC "$SCITECO_CLIPBOARD_SET" "$SCITECO_CLIPBOARD_GET" clipboard On ncurses, in addition to the OSC-52 protocol, you can use external processes to drive the built-in clipboard Q-Registers (\(lq~\(rq and so on). For that you can set the \fBSCITECO_CLIPBOARD_SET\fP and \fBSCITECO_CLIPBOARD_GET\fP @@ -391,7 +391,7 @@ for an example of how to integrate the X11 clipboard via Integrating with Wayland and the Mac OS clipboards is of course also possible. . .LP -.SCITECO_TOPIC "$SCITECO_LSP" "$SCITECO_LSP_ROOT" +.SCITECO_TOPIC "$SCITECO_LSP" "$SCITECO_LSP_ROOT" LSP The \fBSCITECO_LSP\fP environment variable must be set to a language server command line if you would like to use the \fBFT\fP command for looking up symbols, definitions or references. diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template index 4b6987a..0ff3f51 100644 --- a/doc/sciteco.7.template +++ b/doc/sciteco.7.template @@ -1604,6 +1604,7 @@ Its integer part is unused. It is initialized automatically on startup. .TP .BI $ variable +.SCITECO_TOPIC environment Global Q-Registers beginning with a dollar sign that do not contain any \(lq=\(rq represent the process environment (the environment variables). @@ -1692,7 +1693,7 @@ the original clipboard contents, though. The numeric parts of the clipboard registers are currently not used by \*(ST. .TP -.SCITECO_TOPIC ^Ax +.SCITECO_TOPIC ^Ax argv arguments .BI ^A x An argument passed on the operating system's command line. \fIx\fP can be an integer beginning with 0. @@ -1858,7 +1859,7 @@ character and their case is insignificant. In the following list of supported expressions, the caret-notation thus refers to the corresponding control code: .TP -.SCITECO_TOPIC ^P +.SCITECO_TOPIC ^P verbatim .B ^P Disable interpretation of all further string building characters, so all following characters will be taken verbatim. @@ -1885,7 +1886,7 @@ When \fB^V\fP is not followed by \fB^V\fP, a single character \fIc\fP is lower-cased. \# Which is pretty pointless nowadays. .TP -.SCITECO_TOPIC ^W^W ^Wc +.SCITECO_TOPIC ^W^W ^Wc upper .B ^W^W .TQ .BI ^W c @@ -2258,7 +2259,7 @@ In addition to labels and unlike most classic TECO dialects, \*(ST also supports true comments. True comments are parsed faster than labels and do not take up memory in goto tables. -.SCITECO_TOPIC "!*" "block comment" +.SCITECO_TOPIC "!*" comment One form of comments is the block comment: .br .BI !* comment *! @@ -2271,7 +2272,7 @@ They are analoguous to C's comments. .LP \# This form of comment was originally in TECO-64. -.SCITECO_TOPIC "!!" "EOL comment" +.SCITECO_TOPIC "!!" comment The second form of real comments are end-of-line comments, which are analogous to C++'s \fB//\fP comments: .br @@ -2322,7 +2323,7 @@ infinite one. Additionally \*(ST supports special colon-modified \(lqpass-through\(rq forms of the loop start and end commands for processing the argument stack dynamically. -.SCITECO_TOPIC :> +.SCITECO_TOPIC :> passthrough loop The \fB:>\fP loop end command will \fInot\fP pop values left on the stack since the beginning of the loop and can be used to aggregate stack values. @@ -2335,7 +2336,7 @@ For instance, the following command will leave the numbers .EE The command can be understood as equivalent to the expressions \(lq(%a)(%a)(%a)(%a)(%a)\(rq or \(lq(%a,%a,%a,%a,%a)\(rq. -.SCITECO_TOPIC :< +.SCITECO_TOPIC :< passthrough loop Consequently, the colon-modified loop start command will \fInot\fP represent an argument barrier and the corresponding loop end command will not discard any values which is useful @@ -40,8 +40,6 @@ static void teco_help_set(const gchar *topic_name, const gchar *filename, gsize pos); -static GStringChunk *teco_help_chunk = NULL; - /** @extends teco_rb3str_head_t */ typedef struct { teco_rb3str_head_t head; @@ -51,6 +49,21 @@ typedef struct { gchar filename[]; } teco_help_topic_t; +static struct { + /** + * Search tree for help topics. + * Several topics with the same name (key) are allowed. + */ + teco_rb3str_tree_t tree; + + /** first entry found for a given topic */ + teco_help_topic_t *first; + /** last entry shown for a given topic */ + teco_help_topic_t *current; + + GStringChunk *chunk; +} teco_help = {0}; + /** @static @memberof teco_help_topic_t */ static teco_help_topic_t * teco_help_topic_new(const gchar *topic_name, const gchar *filename, gsize pos) @@ -63,7 +76,7 @@ teco_help_topic_new(const gchar *topic_name, const gchar *filename, gsize pos) * It could be allocated via a stack allocator. */ teco_help_topic_t *topic = g_malloc0(sizeof(teco_help_topic_t) + strlen(filename) + 1); - teco_string_init_chunk(&topic->head.name, topic_name, strlen(topic_name), teco_help_chunk); + teco_string_init_chunk(&topic->head.name, topic_name, strlen(topic_name), teco_help.chunk); topic->pos = pos; strcpy(topic->filename, filename); return topic; @@ -80,17 +93,15 @@ teco_help_topic_free(teco_help_topic_t *ctx) g_free(ctx); } -static teco_rb3str_tree_t teco_help_tree; - static gboolean teco_help_init(GError **error) { - if (G_LIKELY(teco_help_chunk != NULL)) + if (G_LIKELY(teco_help.chunk != NULL)) /* already loaded */ return TRUE; - teco_help_chunk = g_string_chunk_new(32); - rb3_reset_tree(&teco_help_tree); + teco_help.chunk = g_string_chunk_new(32); + rb3_reset_tree(&teco_help.tree); g_auto(teco_string_t) lib_path = {NULL, 0}; if (!teco_qreg_table_get_string(&teco_qreg_table_globals, "$SCITECOPATH", @@ -180,6 +191,16 @@ teco_help_init(GError **error) return TRUE; } +/* + * Compare only for the key name (search term), but we are lower than + * all of the existing entries. + */ +static gint +teco_help_casecmp_plain(const teco_rb3str_head_t *head, const teco_string_t *data) +{ + return teco_string_casecmp(head->key, data->data, data->len) ? : 1; +} + static inline teco_help_topic_t * teco_help_find(const gchar *topic_name) { @@ -192,60 +213,54 @@ teco_help_find(const gchar *topic_name) * look-up string to their printable forms. */ g_autofree gchar *term = teco_string_echo(topic_name, strlen(topic_name)); - return (teco_help_topic_t *)teco_rb3str_find(&teco_help_tree, FALSE, term, strlen(term)); + teco_string_t data = {(gchar *)term, strlen(term)}; + teco_help_topic_t *topic = (teco_help_topic_t *)rb3_nfind(&teco_help.tree, + (rb3_cmp *)teco_help_casecmp_plain, &data); + return topic && !teco_string_casecmp(topic->head.key, data.data, data.len) ? topic : NULL; } -static void -teco_help_set(const gchar *topic_name, const gchar *filename, gsize pos) +/* + * By turning the filename and position into secondary keys, we can insert + * several topics with the same search term and they will be sorted. + * Alternatively, we'd have to keep lists in each teco_help_topic_t. + */ +static gint +teco_help_casecmp(const teco_help_topic_t *topic, const teco_help_topic_t *data) { - teco_help_topic_t *topic; - teco_help_topic_t *existing = teco_help_find(topic_name); - if (existing) { - if (!strcmp(existing->filename, filename)) { - /* - * A topic with the same name already exists - * in the same file. - * For the time being, we simply overwrite the - * last topic. - * FIXME: Perhaps make it unique again!? - */ - existing->pos = pos; - return; - } - - /* in another file -> make name unique */ - teco_interface_msg(TECO_MSG_WARNING, - "Topic collision: \"%s\" defined in \"%s\" and \"%s\"", - topic_name, existing->filename, filename); - - g_autofree gchar *basename = g_path_get_basename(filename); - g_autofree gchar *unique_name = g_strconcat(topic_name, ":", basename, NULL); - topic = teco_help_topic_new(unique_name, filename, pos); - } else { - topic = teco_help_topic_new(topic_name, filename, pos); - } + return teco_string_casecmp(topic->head.key, data->head.key.data, data->head.key.len) + ? : strcasecmp(topic->filename, data->filename) + ? : (gssize)topic->pos - data->pos; +} - teco_rb3str_insert(&teco_help_tree, FALSE, &topic->head); +/* + * If the topic is already present in the tree, we will still + * insert the given topic. + */ +static inline void +teco_help_set(const gchar *topic_name, const gchar *filename, gsize pos) +{ + teco_help_topic_t *topic = teco_help_topic_new(topic_name, filename, pos); + rb3_insert(&teco_help.tree, &topic->head.head, (rb3_cmp *)teco_help_casecmp, topic); } gboolean teco_help_auto_complete(const gchar *topic_name, teco_string_t *insert) { - return teco_rb3str_auto_complete(&teco_help_tree, FALSE, topic_name, + return teco_rb3str_auto_complete(&teco_help.tree, FALSE, topic_name, topic_name ? strlen(topic_name) : 0, 0, insert); } static void TECO_DEBUG_CLEANUP teco_help_cleanup(void) { - if (!teco_help_chunk) + if (!teco_help.chunk) /* not initialized */ return; - g_string_chunk_free(teco_help_chunk); + g_string_chunk_free(teco_help.chunk); struct rb3_head *cur; - while ((cur = rb3_get_root(&teco_help_tree))) { + while ((cur = rb3_get_root(&teco_help.tree))) { rb3_unlink_and_rebalance(cur); teco_help_topic_free((teco_help_topic_t *)cur); } @@ -282,15 +297,34 @@ teco_state_help_done(teco_machine_main_t *ctx, teco_string_t str, GError **error return NULL; } - /* - * FIXME: Perhaps ?$ could toggle through all topics with the - * same name. - */ - const gchar *topic_name = str.data ? : ""; - teco_help_topic_t *topic = teco_help_find(topic_name); - if (!topic) { + if (str.len) { + teco_help_topic_t *next = teco_help_find(str.data); + if (!next) { + g_set_error(error, TECO_ERROR, TECO_ERROR_FAILED, + "Topic \"%s\" not found", str.data); + return NULL; + } + teco_undo_ptr(teco_help.current) = next; + teco_undo_ptr(teco_help.first) = next; + + guint results = 0; + for (teco_help_topic_t *cur = teco_help.first; + cur && !teco_string_cmp(cur->head.name, teco_help.first->head.name.data, + teco_help.first->head.name.len); + cur = (teco_help_topic_t *)teco_rb3str_get_next(&cur->head)) + results++; + if (results > 1) + teco_interface_msg(TECO_MSG_INFO, "Found %u help entries", results); + } else if (teco_help.current) { + /* toggle through topics with the same name */ + teco_help_topic_t *next = (teco_help_topic_t *)teco_rb3str_get_next(&teco_help.current->head); + if (!next || teco_string_cmp(next->head.name, teco_help.first->head.name.data, + teco_help.first->head.name.len) != 0) + next = teco_help.first; + teco_undo_ptr(teco_help.current) = next; + } else { g_set_error(error, TECO_ERROR, TECO_ERROR_FAILED, - "Topic \"%s\" not found", topic_name); + "No help topic found"); return NULL; } @@ -300,10 +334,10 @@ teco_state_help_done(teco_machine_main_t *ctx, teco_string_t str, GError **error * when editing the buffer for the first time. */ if (!teco_current_doc_undo_edit(error) || - !teco_ring_edit(topic->filename, error)) + !teco_ring_edit(teco_help.current->filename, error)) return NULL; - teco_current_doc_set_dot(teco_interface_bytes2glyphs_absdot(topic->pos)); + teco_current_doc_set_dot(teco_interface_bytes2glyphs_absdot(teco_help.current->pos)); /* * Make sure the topic is visible. @@ -315,7 +349,7 @@ teco_state_help_done(teco_machine_main_t *ctx, teco_string_t str, GError **error */ undo__teco_interface_ssm(SCI_GOTOPOS, teco_interface_ssm(SCI_GETCURRENTPOS, 0, 0), 0); - teco_interface_ssm(SCI_GOTOPOS, topic->pos, 0); + teco_interface_ssm(SCI_GOTOPOS, teco_help.current->pos, 0); return &teco_state_start; } @@ -332,6 +366,9 @@ gboolean teco_state_help_insert_completion(teco_machine_main_t *ctx, teco_string * Look up <topic> in the help index, opening * the corresponding womanpage as a buffer and scrolling * to the topic's position. + * If a <topic> is defined in several places, you can + * call \(lq?\fB$\fP\(rq to toggle through all of them. + * * The help index is built when this command is first * executed, so the help system does not consume resources * when not used (e.g. in a batch-mode script). @@ -1462,7 +1462,7 @@ teco_state_lsp_lookup_done(teco_machine_main_t *ctx, teco_string_t str, GError * return &teco_state_start; } - if (teco_lsp_lookup_symbol(str, !have_colon, error)) + if (!teco_lsp_lookup_symbol(str, !have_colon, error)) return NULL; } else { /* look up definition or references at <n> */ diff --git a/src/rb3str.c b/src/rb3str.c index f4c16fa..367ff83 100644 --- a/src/rb3str.c +++ b/src/rb3str.c @@ -60,32 +60,37 @@ teco_rb3str_find(teco_rb3str_tree_t *tree, gboolean case_sensitive, const gchar return (teco_rb3str_head_t *)rb3_find(tree, cmp, &data); } -/** @memberof teco_rb3str_tree_t */ -teco_rb3str_head_t * -teco_rb3str_nfind(teco_rb3str_tree_t *tree, gboolean case_sensitive, const gchar *str, gsize len) +/* + * This is based on rb3_INLINE_find() in rb3ptr.h. + * FIXME: Should perhaps be in rb3ptr.c. + */ +struct rb3_head * +rb3_nfind(struct rb3_tree *tree, rb3_cmp cmp, void *data) { - rb3_cmp *cmp = case_sensitive ? (rb3_cmp *)teco_rb3str_cmp : (rb3_cmp *)teco_rb3str_casecmp; - teco_string_t data = {(gchar *)str, len}; - - /* - * This is based on rb3_INLINE_find() in rb3ptr.h. - * Alternatively, we might adapt/wrap teco_rb3str_cmp() in order to store - * the last element > data. - */ struct rb3_head *parent = rb3_get_base(tree); struct rb3_head *res = NULL; int dir = RB3_LEFT; + while (rb3_has_child(parent, dir)) { parent = rb3_get_child(parent, dir); - int r = cmp(parent, &data); + int r = cmp(parent, data); if (r == 0) - return (teco_rb3str_head_t *)parent; - dir = (r < 0) ? RB3_RIGHT : RB3_LEFT; + return parent; + dir = r < 0 ? RB3_RIGHT : RB3_LEFT; if (dir == RB3_LEFT) res = parent; } - return (teco_rb3str_head_t *)res; + return res; +} + +/** @memberof teco_rb3str_tree_t */ +teco_rb3str_head_t * +teco_rb3str_nfind(teco_rb3str_tree_t *tree, gboolean case_sensitive, const gchar *str, gsize len) +{ + rb3_cmp *cmp = case_sensitive ? (rb3_cmp *)teco_rb3str_cmp : (rb3_cmp *)teco_rb3str_casecmp; + teco_string_t data = {(gchar *)str, len}; + return (teco_rb3str_head_t *)rb3_nfind(tree, cmp, &data); } /** @@ -133,9 +138,14 @@ teco_rb3str_auto_complete(teco_rb3str_tree_t *tree, gboolean case_sensitive, if (prefix_len > 0) { teco_string_init(insert, first->key.data + str_len, prefix_len); } else if (prefixed_entries > 1) { + teco_rb3str_head_t *next; for (teco_rb3str_head_t *cur = first; cur && cur->key.len >= str_len && diff(cur->key, str, str_len) == str_len; - cur = teco_rb3str_get_next(cur)) { + cur = next) { + next = teco_rb3str_get_next(cur); + if (next && !teco_string_cmp(next->key, cur->key.data, cur->key.len)) + /* filter out duplicates */ + continue; if (restrict_len && g_utf8_strlen(cur->key.data, cur->key.len) != restrict_len) continue; diff --git a/src/rb3str.h b/src/rb3str.h index 00d1791..7fd7007 100644 --- a/src/rb3str.h +++ b/src/rb3str.h @@ -23,6 +23,8 @@ #include "sciteco.h" #include "string-utils.h" +struct rb3_head *rb3_nfind(struct rb3_tree *tree, rb3_cmp cmp, void *data); + /** * A RB-tree with teco_string_t keys. * diff --git a/tests/testsuite.at b/tests/testsuite.at index fef01dc..293bc9b 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -456,15 +456,16 @@ AT_CLEANUP AT_SETUP([Online help]) AT_CHECK([[mkdir -p women]], 0, ignore, ignore) -AT_DATA([women/test.woman], [[ABC +AT_DATA([women/test.woman], [[ABCD ]]) AT_DATA([women/test.woman.tec], [[!*0:A 1:B +3:A *! ]]) -AT_CHECK([[SCITECOPATH=. $SCITECO -e '@?/A/ 0A-^^A"N(0/0)F" @?/B/ 0A-^^B"N(0/0)F"']], 0, ignore, ignore) -# This used to crash: -TE_CHECK([[@?//]], 1, ignore, ignore) +# @?// also used to crash. +# It now toggles through all results for a given topic. +AT_CHECK([[SCITECOPATH=. $SCITECO -e '@?/A/ 0A-^^A"N(0/0)F" @?// 0A-^^D"N(0/0)F" @?/B/ 0A-^^B"N(0/0)F"']], 0, ignore, ignore) AT_CLEANUP # FIXME: Does not work on OBS runners, perhaps because of Xvfb? |