diff options
Diffstat (limited to 'src/help.c')
| -rw-r--r-- | src/help.c | 143 |
1 files changed, 90 insertions, 53 deletions
@@ -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). |