diff options
author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2021-05-30 02:38:43 +0200 |
---|---|---|
committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2021-05-30 03:12:56 +0200 |
commit | 432ad24e382681f1c13b07e8486e91063dd96e2e (patch) | |
tree | 51838adac822767bd5884b9383cd4c72f29d3840 /src/parser.c | |
parent | 524bc3960e6a6e5645ce904e20f72479e24e0a23 (diff) | |
download | sciteco-432ad24e382681f1c13b07e8486e91063dd96e2e.tar.gz |
THE GREAT CEEIFICATION EVENT
This is a total conversion of SciTECO to plain C (GNU C11).
The chance was taken to improve a lot of internal datastructures,
fix fundamental bugs and lay the foundations of future features.
The GTK user interface is now in an useable state!
All changes have been squashed together.
The language itself has almost not changed at all, except for:
* Detection of string terminators (usually Escape) now takes
the string building characters into account.
A string is only terminated outside of string building characters.
In other words, you can now for instance write
I^EQ[Hello$world]$
This removes one of the last bits of shellisms which is out of
place in SciTECO where no tokenization/lexing is performed.
Consequently, the current termination character can also be
escaped using ^Q/^R.
This is used by auto completions to make sure that strings
are inserted verbatim and without unwanted sideeffects.
* All strings can now safely contain null-characters
(see also: 8-bit cleanliness).
The null-character itself (^@) is not (yet) a valid SciTECO
command, though.
An incomplete list of changes:
* We got rid of the BSD headers for RB trees and lists/queues.
The problem with them was that they used a form of metaprogramming
only to gain a bit of type safety. It also resulted in less
readble code. This was a C++ desease.
The new code avoids metaprogramming only to gain type safety.
The BSD tree.h has been replaced by rb3ptr by Jens Stimpfle
(https://github.com/jstimpfle/rb3ptr).
This implementation is also more memory efficient than BSD's.
The BSD list.h and queue.h has been replaced with a custom
src/list.h.
* Fixed crashes, performance issues and compatibility issues with
the Gtk 3 User Interface.
It is now more or less ready for general use.
The GDK lock is no longer used to avoid using deprecated functions.
On the downside, the new implementation (driving the Gtk event loop
stepwise) is even slower than the old one.
A few glitches remain (see TODO), but it is hoped that they will
be resolved by the Scintilla update which will be performed soon.
* A lot of program units have been split up, so they are shorter
and easier to maintain: core-commands.c, qreg-commands.c,
goto-commands.c, file-utils.h.
* Parser states are simply structs of callbacks now.
They still use a kind of polymorphy using a preprocessor trick.
TECO_DEFINE_STATE() takes an initializer list that will be
merged with the default list of field initializers.
To "subclass" states, you can simply define new macros that add
initializers to existing macros.
* Parsers no longer have a "transitions" table but the input_cb()
may use switch-case statements.
There are also teco_machine_main_transition_t now which can
be used to implement simple transitions. Additionally, you
can specify functions to execute during transitions.
This largely avoids long switch-case-statements.
* Parsers are embeddable/reusable now, at least in parse-only mode.
This does not currently bring any advantages but may later
be used to write a Scintilla lexer for TECO syntax highlighting.
Once parsers are fully embeddable, it will also be possible
to run TECO macros in a kind of coroutine which would allow
them to process string arguments in real time.
* undo.[ch] still uses metaprogramming extensively but via
the C preprocessor of course. On the downside, most undo
token generators must be initiated explicitly (theoretically
we could have used embedded functions / trampolines to
instantiate automatically but this has turned out to be
dangereous).
There is a TECO_DEFINE_UNDO_CALL() to generate closures for
arbitrary functions now (ie. to call an arbitrary function
at undo-time). This simplified a lot of code and is much
shorter than manually pushing undo tokens in many cases.
* Instead of the ridiculous C++ Curiously Recurring Template
Pattern to achieve static polymorphy for user interface
implementations, we now simply declare all functions to
implement in interface.h and link in the implementations.
This is possible since we no longer hace to define
interface subclasses (all state is static variables in
the interface's *.c files).
* Headers are now significantly shorter than in C++ since
we can often hide more of our "class" implementations.
* Memory counting is based on dlmalloc for most platforms now.
Unfortunately, there is no malloc implementation that
provides an efficient constant-time memory counter that
is guaranteed to decrease when freeing memory.
But since we use a defined malloc implementation now,
malloc_usable_size() can be used safely for tracking memory use.
malloc() replacement is very tricky on Windows, so we
use a poll thread on Windows. This can also be enabled
on other supported platforms using --disable-malloc-replacement.
All in all, I'm still not pleased with the state of memory
limiting. It is a mess.
* Error handling uses GError now. This has the advantage that
the GError codes can be reused once we support error catching
in the SciTECO language.
* Added a few more test suite cases.
* Haiku is no longer supported as builds are instable and
I did not manage to debug them - quite possibly Haiku bugs
were responsible.
* Glib v2.44 or later are now required.
The GTK UI requires Gtk+ v3.12 or later now.
The GtkFlowBox fallback and sciteco-wrapper workaround are
no longer required.
* We now extensively use the GCC/Clang-specific g_auto
feature (automatic deallocations when leaving the current
code block).
* Updated copyright to 2021.
SciTECO has been in continuous development, even though there
have been no commits since 2018.
* Since these changes are so significant, the target release has
been set to v2.0.
It is planned that beginning with v3.0, the language will be
kept stable.
Diffstat (limited to 'src/parser.c')
-rw-r--r-- | src/parser.c | 902 |
1 files changed, 902 insertions, 0 deletions
diff --git a/src/parser.c b/src/parser.c new file mode 100644 index 0000000..ff1fd18 --- /dev/null +++ b/src/parser.c @@ -0,0 +1,902 @@ +/* + * Copyright (C) 2012-2021 Robin Haberkorn + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <string.h> + +#include <glib.h> +#include <glib/gprintf.h> +#include <glib/gstdio.h> + +#include "sciteco.h" +#include "memory.h" +#include "string-utils.h" +#include "interface.h" +#include "undo.h" +#include "expressions.h" +#include "qreg.h" +#include "ring.h" +#include "glob.h" +#include "error.h" +#include "core-commands.h" +#include "goto-commands.h" +#include "parser.h" + +//#define DEBUG + +GArray *teco_loop_stack; + +static void __attribute__((constructor)) +teco_loop_stack_init(void) +{ + teco_loop_stack = g_array_sized_new(FALSE, FALSE, sizeof(teco_loop_context_t), 1024); +} + +TECO_DEFINE_ARRAY_UNDO_INSERT_VAL(teco_loop_stack, teco_loop_context_t); +TECO_DEFINE_ARRAY_UNDO_REMOVE_INDEX(teco_loop_stack); + +#ifndef NDEBUG +static void __attribute__((destructor)) +teco_loop_stack_cleanup(void) +{ + g_array_free(teco_loop_stack, TRUE); +} +#endif + +gboolean +teco_machine_input(teco_machine_t *ctx, gchar chr, GError **error) +{ + teco_state_t *next = ctx->current->input_cb(ctx, chr, error); + if (!next) + return FALSE; + + if (next != ctx->current) { + if (ctx->must_undo) + teco_undo_ptr(ctx->current); + ctx->current = next; + + if (ctx->current->initial_cb && !ctx->current->initial_cb(ctx, error)) + return FALSE; + } + + return TRUE; +} + +gboolean +teco_state_end_of_macro(teco_machine_t *ctx, GError **error) +{ + g_set_error_literal(error, TECO_ERROR, TECO_ERROR_FAILED, + "Unterminated command"); + return FALSE; +} + +/** + * Handles all expected exceptions and preparing them for stack frame insertion. + */ +gboolean +teco_machine_main_step(teco_machine_main_t *ctx, const gchar *macro, gint stop_pos, GError **error) +{ + while (ctx->macro_pc < stop_pos) { +#ifdef DEBUG + g_printf("EXEC(%d): input='%c'/%x, state=%p, mode=%d\n", + ctx->macro_pc, macro[ctx->macro_pc], macro[ctx->macro_pc], + ctx->parent.current, ctx->mode); +#endif + + if (teco_interface_is_interrupted()) { + teco_error_interrupted_set(error); + goto error_attach; + } + + if (!teco_memory_check(error)) + goto error_attach; + + if (!teco_machine_input(&ctx->parent, macro[ctx->macro_pc], error)) + goto error_attach; + ctx->macro_pc++; + } + + /* + * Provide interactive feedback when the + * PC is at the end of the command line. + * This will actually be called in other situations, + * like at the end of macros but that does not hurt. + * It should perhaps be in teco_cmdline_insert(), + * but doing it here ensures that exceptions get + * normalized. + */ + if (ctx->parent.current->refresh_cb && + !ctx->parent.current->refresh_cb(&ctx->parent, error)) + goto error_attach; + + return TRUE; + +error_attach: + g_assert(!error || *error != NULL); + /* + * FIXME: Maybe this can be avoided altogether by passing in ctx->macro_pc + * from the callees? + */ + teco_error_set_coord(macro, ctx->macro_pc); + return FALSE; +} + +gboolean +teco_execute_macro(const gchar *macro, gsize macro_len, + teco_qreg_table_t *qreg_table_locals, GError **error) +{ + /* + * This is not auto-cleaned up, so it can be initialized + * on demand. + */ + teco_qreg_table_t macro_locals; + + if (!qreg_table_locals) + teco_qreg_table_init(¯o_locals, FALSE); + + guint parent_brace_level = teco_brace_level; + + g_auto(teco_machine_main_t) macro_machine; + teco_machine_main_init(¯o_machine, qreg_table_locals ? : ¯o_locals, FALSE); + + GError *tmp_error = NULL; + + if (!teco_machine_main_step(¯o_machine, macro, macro_len, &tmp_error)) { + if (!g_error_matches(tmp_error, TECO_ERROR, TECO_ERROR_RETURN)) { + /* passes ownership of tmp_error */ + g_propagate_error(error, tmp_error); + goto error_cleanup; + } + g_error_free(tmp_error); + + /* + * Macro returned - handle like regular + * end of macro, even though some checks + * are unnecessary here. + * macro_pc will still point to the return PC. + */ + g_assert(macro_machine.parent.current == &teco_state_start); + + /* + * Discard all braces, except the current one. + */ + if (!teco_expressions_brace_return(parent_brace_level, teco_error_return_args, error)) + goto error_cleanup; + + /* + * Clean up the loop stack. + * We are allowed to return in loops. + * NOTE: This does not have to be undone. + */ + g_array_remove_range(teco_loop_stack, macro_machine.loop_stack_fp, + teco_loop_stack->len - macro_machine.loop_stack_fp); + } + + if (G_UNLIKELY(teco_loop_stack->len > macro_machine.loop_stack_fp)) { + const teco_loop_context_t *ctx = &g_array_index(teco_loop_stack, teco_loop_context_t, teco_loop_stack->len-1); + teco_error_set_coord(macro, ctx->pc); + + g_set_error_literal(error, TECO_ERROR, TECO_ERROR_FAILED, + "Unterminated loop"); + goto error_cleanup; + } + + if (G_UNLIKELY(teco_goto_skip_label.len > 0)) { + g_autofree gchar *label_printable = teco_string_echo(teco_goto_skip_label.data, teco_goto_skip_label.len); + g_set_error(error, TECO_ERROR, TECO_ERROR_FAILED, + "Label \"%s\" not found", label_printable); + goto error_attach; + } + + /* + * Some states (esp. commands involving a + * "lookahead") are valid at the end of a macro. + */ + if (macro_machine.parent.current->end_of_macro_cb && + !macro_machine.parent.current->end_of_macro_cb(¯o_machine.parent, error)) + goto error_attach; + + /* + * This handles the problem of Q-Registers + * local to the macro invocation being edited + * when the macro terminates without additional + * complexity. + * teco_qreg_table_empty() might leave the table + * half-empty, but it will eventually be completely + * cleared by teco_qreg_table_clear(). + * This does not hurt since an error will rub out the + * macro invocation itself and macro_locals don't have + * to be preserved. + */ + if (!qreg_table_locals && !teco_qreg_table_empty(¯o_locals, error)) + goto error_attach; + + return TRUE; + +error_attach: + teco_error_set_coord(macro, macro_machine.macro_pc); + /* fall through */ +error_cleanup: + if (!qreg_table_locals) + teco_qreg_table_clear(¯o_locals); + /* make sure teco_goto_skip_label will be NULL even in batch mode */ + teco_string_truncate(&teco_goto_skip_label, 0); + return FALSE; +} + +gboolean +teco_execute_file(const gchar *filename, teco_qreg_table_t *qreg_table_locals, GError **error) +{ + g_auto(teco_string_t) macro = {NULL, 0}; + if (!g_file_get_contents(filename, ¯o.data, ¯o.len, error)) + return FALSE; + + gchar *p; + + /* only when executing files, ignore Hash-Bang line */ + if (*macro.data == '#') { + /* + * NOTE: We assume that a file starting with Hash does not contain + * a null-byte in its first line. + */ + p = strpbrk(macro.data, "\r\n"); + if (G_UNLIKELY(!p)) + /* empty script */ + return TRUE; + p++; + } else { + p = macro.data; + } + + if (!teco_execute_macro(p, macro.len - (p - macro.data), + qreg_table_locals, error)) { + /* correct error position for Hash-Bang line */ + teco_error_pos += p - macro.data; + if (*macro.data == '#') + teco_error_line++; + teco_error_add_frame_file(filename); + return FALSE; + } + + return TRUE; +} + +void +teco_machine_main_init(teco_machine_main_t *ctx, teco_qreg_table_t *qreg_table_locals, + gboolean must_undo) +{ + memset(ctx, 0, sizeof(*ctx)); + teco_machine_init(&ctx->parent, &teco_state_start, must_undo); + ctx->loop_stack_fp = teco_loop_stack->len; + teco_goto_table_init(&ctx->goto_table, must_undo); + ctx->qreg_table_locals = qreg_table_locals; + + ctx->expectstring.nesting = 1; + teco_machine_stringbuilding_init(&ctx->expectstring.machine, '\e', qreg_table_locals, must_undo); +} + +gboolean +teco_machine_main_eval_colon(teco_machine_main_t *ctx) +{ + if (!ctx->modifier_colon) + return FALSE; + + if (ctx->parent.must_undo) + teco_undo_guint(ctx->__flags); + ctx->modifier_colon = FALSE; + return TRUE; +} + +teco_state_t * +teco_machine_main_transition_input(teco_machine_main_t *ctx, + teco_machine_main_transition_t *transitions, + guint len, gchar chr, GError **error) +{ + if (chr < 0 || chr >= len || !transitions[(guint)chr].next) { + teco_error_syntax_set(error, chr); + return NULL; + } + + if (ctx->mode == TECO_MODE_NORMAL && transitions[(guint)chr].transition_cb) { + /* + * NOTE: We could also just let transition_cb return a boolean... + */ + GError *tmp_error = NULL; + transitions[(guint)chr].transition_cb(ctx, &tmp_error); + if (tmp_error) { + g_propagate_error(error, tmp_error); + return NULL; + } + } + + return transitions[(guint)chr].next; +} + +void +teco_machine_main_clear(teco_machine_main_t *ctx) +{ + teco_goto_table_clear(&ctx->goto_table); + teco_machine_stringbuilding_clear(&ctx->expectstring.machine); +} + +/* + * FIXME: All teco_state_stringbuilding_* states could be static? + */ +static teco_state_t *teco_state_stringbuilding_ctl_input(teco_machine_stringbuilding_t *ctx, + gchar chr, GError **error); +TECO_DECLARE_STATE(teco_state_stringbuilding_ctl); + +static teco_state_t *teco_state_stringbuilding_escaped_input(teco_machine_stringbuilding_t *ctx, + gchar chr, GError **error); +TECO_DECLARE_STATE(teco_state_stringbuilding_escaped); + +TECO_DECLARE_STATE(teco_state_stringbuilding_lower); +TECO_DECLARE_STATE(teco_state_stringbuilding_upper); + +TECO_DECLARE_STATE(teco_state_stringbuilding_ctle); +TECO_DECLARE_STATE(teco_state_stringbuilding_ctle_num); +TECO_DECLARE_STATE(teco_state_stringbuilding_ctle_u); +TECO_DECLARE_STATE(teco_state_stringbuilding_ctle_q); +TECO_DECLARE_STATE(teco_state_stringbuilding_ctle_quote); +TECO_DECLARE_STATE(teco_state_stringbuilding_ctle_n); + +static teco_state_t * +teco_state_stringbuilding_start_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + if (chr == '^') + return &teco_state_stringbuilding_ctl; + if (TECO_IS_CTL(chr)) + return teco_state_stringbuilding_ctl_input(ctx, TECO_CTL_ECHO(chr), error); + + return teco_state_stringbuilding_escaped_input(ctx, chr, error); +} + +/* in cmdline.c */ +gboolean teco_state_stringbuilding_start_process_edit_cmd(teco_machine_stringbuilding_t *ctx, teco_machine_t *parent_ctx, + gchar key, GError **error); + +TECO_DEFINE_STATE(teco_state_stringbuilding_start, + .is_start = TRUE, + .process_edit_cmd_cb = (teco_state_process_edit_cmd_cb_t) + teco_state_stringbuilding_start_process_edit_cmd +); + +static teco_state_t * +teco_state_stringbuilding_ctl_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + chr = teco_ascii_toupper(chr); + + switch (chr) { + case '^': break; + case 'Q': + case 'R': return &teco_state_stringbuilding_escaped; + case 'V': return &teco_state_stringbuilding_lower; + case 'W': return &teco_state_stringbuilding_upper; + case 'E': return &teco_state_stringbuilding_ctle; + default: + chr = TECO_CTL_KEY(chr); + } + + if (ctx->result) + teco_string_append_c(ctx->result, chr); + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE_CASEINSENSITIVE(teco_state_stringbuilding_ctl); + +static teco_state_t * +teco_state_stringbuilding_escaped_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + switch (ctx->mode) { + case TECO_STRINGBUILDING_MODE_UPPER: + chr = g_ascii_toupper(chr); + break; + case TECO_STRINGBUILDING_MODE_LOWER: + chr = g_ascii_tolower(chr); + break; + default: + break; + } + + teco_string_append_c(ctx->result, chr); + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE(teco_state_stringbuilding_escaped); + +static teco_state_t * +teco_state_stringbuilding_lower_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + /* + * FIXME: This does not handle ^V^V typed with up-carets. + */ + if (chr == TECO_CTL_KEY('V')) { + if (ctx->parent.must_undo) + teco_undo_guint(ctx->mode); + ctx->mode = TECO_STRINGBUILDING_MODE_LOWER; + } else { + teco_string_append_c(ctx->result, g_ascii_tolower(chr)); + } + + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE(teco_state_stringbuilding_lower); + +static teco_state_t * +teco_state_stringbuilding_upper_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + /* + * FIXME: This does not handle ^W^W typed with up-carets. + */ + if (chr == TECO_CTL_KEY('W')) { + if (ctx->parent.must_undo) + teco_undo_guint(ctx->mode); + ctx->mode = TECO_STRINGBUILDING_MODE_UPPER; + } else { + teco_string_append_c(ctx->result, g_ascii_toupper(chr)); + } + + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE(teco_state_stringbuilding_upper); + +static teco_state_t * +teco_state_stringbuilding_ctle_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + teco_state_t *next; + + switch (teco_ascii_toupper(chr)) { + case '\\': next = &teco_state_stringbuilding_ctle_num; break; + case 'U': next = &teco_state_stringbuilding_ctle_u; break; + case 'Q': next = &teco_state_stringbuilding_ctle_q; break; + case '@': next = &teco_state_stringbuilding_ctle_quote; break; + case 'N': next = &teco_state_stringbuilding_ctle_n; break; + default: + if (ctx->result) { + gchar buf[] = {TECO_CTL_KEY('E'), chr}; + teco_string_append(ctx->result, buf, sizeof(buf)); + } + return &teco_state_stringbuilding_start; + } + + if (ctx->machine_qregspec) + teco_machine_qregspec_reset(ctx->machine_qregspec); + else + ctx->machine_qregspec = teco_machine_qregspec_new(TECO_QREG_REQUIRED, + ctx->qreg_table_locals, + ctx->parent.must_undo); + return next; +} + +TECO_DEFINE_STATE_CASEINSENSITIVE(teco_state_stringbuilding_ctle); + +/* in cmdline.c */ +gboolean teco_state_stringbuilding_qreg_process_edit_cmd(teco_machine_stringbuilding_t *ctx, teco_machine_t *parent_ctx, + gchar chr, GError **error); + +/** + * @interface TECO_DEFINE_STATE_STRINGBUILDING_QREG + * @implements TECO_DEFINE_STATE + * @ingroup states + */ +#define TECO_DEFINE_STATE_STRINGBUILDING_QREG(NAME, ...) \ + TECO_DEFINE_STATE(NAME, \ + .process_edit_cmd_cb = (teco_state_process_edit_cmd_cb_t) \ + teco_state_stringbuilding_qreg_process_edit_cmd, \ + ##__VA_ARGS__ \ + ) + +static teco_state_t * +teco_state_stringbuilding_ctle_num_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + teco_qreg_t *qreg; + + switch (teco_machine_qregspec_input(ctx->machine_qregspec, chr, + ctx->result ? &qreg : NULL, NULL, error)) { + case TECO_MACHINE_QREGSPEC_ERROR: + return NULL; + case TECO_MACHINE_QREGSPEC_MORE: + return &teco_state_stringbuilding_ctle_num; + case TECO_MACHINE_QREGSPEC_DONE: + break; + } + + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + teco_int_t value; + if (!qreg->vtable->get_integer(qreg, &value, error)) + return NULL; + + /* + * NOTE: Numbers can always be safely formatted as null-terminated strings. + */ + gchar buffer[TECO_EXPRESSIONS_FORMAT_LEN]; + const gchar *num = teco_expressions_format(buffer, value); + teco_string_append(ctx->result, num, strlen(num)); + + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE_STRINGBUILDING_QREG(teco_state_stringbuilding_ctle_num); + +static teco_state_t * +teco_state_stringbuilding_ctle_u_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + teco_qreg_t *qreg; + + switch (teco_machine_qregspec_input(ctx->machine_qregspec, chr, + ctx->result ? &qreg : NULL, NULL, error)) { + case TECO_MACHINE_QREGSPEC_ERROR: + return NULL; + case TECO_MACHINE_QREGSPEC_MORE: + return &teco_state_stringbuilding_ctle_u; + case TECO_MACHINE_QREGSPEC_DONE: + break; + } + + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + teco_int_t value; + if (!qreg->vtable->get_integer(qreg, &value, error)) + return NULL; + if (value < 0 || value > 0xFF) { + g_autofree gchar *name_printable = teco_string_echo(qreg->head.name.data, qreg->head.name.len); + g_set_error(error, TECO_ERROR, TECO_ERROR_FAILED, + "Q-Register \"%s\" does not contain a valid character", name_printable); + return NULL; + } + + teco_string_append_c(ctx->result, (gchar)value); + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE_STRINGBUILDING_QREG(teco_state_stringbuilding_ctle_u); + +static teco_state_t * +teco_state_stringbuilding_ctle_q_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + teco_qreg_t *qreg; + + switch (teco_machine_qregspec_input(ctx->machine_qregspec, chr, + ctx->result ? &qreg : NULL, NULL, error)) { + case TECO_MACHINE_QREGSPEC_ERROR: + return NULL; + case TECO_MACHINE_QREGSPEC_MORE: + return &teco_state_stringbuilding_ctle_q; + case TECO_MACHINE_QREGSPEC_DONE: + break; + } + + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + /* + * FIXME: Should we have a special teco_qreg_get_string_append() function? + */ + g_auto(teco_string_t) str = {NULL, 0}; + if (!qreg->vtable->get_string(qreg, &str.data, &str.len, error)) + return NULL; + teco_string_append(ctx->result, str.data, str.len); + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE_STRINGBUILDING_QREG(teco_state_stringbuilding_ctle_q); + +static teco_state_t * +teco_state_stringbuilding_ctle_quote_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + teco_qreg_t *qreg; + teco_qreg_table_t *table; + + switch (teco_machine_qregspec_input(ctx->machine_qregspec, chr, + ctx->result ? &qreg : NULL, &table, error)) { + case TECO_MACHINE_QREGSPEC_ERROR: + return NULL; + case TECO_MACHINE_QREGSPEC_MORE: + return &teco_state_stringbuilding_ctle_quote; + case TECO_MACHINE_QREGSPEC_DONE: + break; + } + + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + g_auto(teco_string_t) str = {NULL, 0}; + if (!qreg->vtable->get_string(qreg, &str.data, &str.len, error)) + return NULL; + /* + * NOTE: g_shell_quote() expects a null-terminated string, so it is + * important to check that there are no embedded nulls. + * The restriction itself is probably valid since null-bytes are not allowed + * in command line arguments anyway. + * Otherwise, we'd have to implement our own POSIX shell escape function. + */ + if (teco_string_contains(&str, '\0')) { + teco_error_qregcontainsnull_set(error, qreg->head.name.data, qreg->head.name.len, + table != &teco_qreg_table_globals); + return NULL; + } + g_autofree gchar *str_quoted = g_shell_quote(str.data); + teco_string_append(ctx->result, str_quoted, strlen(str_quoted)); + + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE_STRINGBUILDING_QREG(teco_state_stringbuilding_ctle_quote); + +static teco_state_t * +teco_state_stringbuilding_ctle_n_input(teco_machine_stringbuilding_t *ctx, gchar chr, GError **error) +{ + teco_qreg_t *qreg; + teco_qreg_table_t *table; + + switch (teco_machine_qregspec_input(ctx->machine_qregspec, chr, + ctx->result ? &qreg : NULL, &table, error)) { + case TECO_MACHINE_QREGSPEC_ERROR: + return NULL; + case TECO_MACHINE_QREGSPEC_MORE: + return &teco_state_stringbuilding_ctle_n; + case TECO_MACHINE_QREGSPEC_DONE: + break; + } + + if (!ctx->result) + /* parse-only mode */ + return &teco_state_stringbuilding_start; + + g_auto(teco_string_t) str = {NULL, 0}; + if (!qreg->vtable->get_string(qreg, &str.data, &str.len, error)) + return NULL; + if (teco_string_contains(&str, '\0')) { + teco_error_qregcontainsnull_set(error, qreg->head.name.data, qreg->head.name.len, + table != &teco_qreg_table_globals); + return NULL; + } + + g_autofree gchar *str_escaped = teco_globber_escape_pattern(str.data); + teco_string_append(ctx->result, str_escaped, strlen(str_escaped)); + + return &teco_state_stringbuilding_start; +} + +TECO_DEFINE_STATE_STRINGBUILDING_QREG(teco_state_stringbuilding_ctle_n); + +void +teco_machine_stringbuilding_init(teco_machine_stringbuilding_t *ctx, gchar escape_char, + teco_qreg_table_t *locals, gboolean must_undo) +{ + memset(ctx, 0, sizeof(*ctx)); + teco_machine_init(&ctx->parent, &teco_state_stringbuilding_start, must_undo); + ctx->escape_char = escape_char; + ctx->qreg_table_locals = locals; +} + +void +teco_machine_stringbuilding_reset(teco_machine_stringbuilding_t *ctx) +{ + teco_machine_reset(&ctx->parent, &teco_state_stringbuilding_start); + if (ctx->machine_qregspec) + teco_machine_qregspec_reset(ctx->machine_qregspec); + if (ctx->parent.must_undo) + teco_undo_guint(ctx->mode); + ctx->mode = TECO_STRINGBUILDING_MODE_NORMAL; +} + +void +teco_machine_stringbuilding_escape(teco_machine_stringbuilding_t *ctx, const gchar *str, gsize len, + teco_string_t *target) +{ + target->data = g_malloc(len*2+1); + target->len = 0; + + for (guint i = 0; i < len; i++) { + if (teco_ascii_toupper(str[i]) == ctx->escape_char || + (ctx->escape_char == '[' && str[i] == ']') || + (ctx->escape_char == '{' && str[i] == '}')) + target->data[target->len++] = TECO_CTL_KEY('Q'); + target->data[target->len++] = str[i]; + } + + target->data[target->len] = '\0'; +} + +void +teco_machine_stringbuilding_clear(teco_machine_stringbuilding_t *ctx) +{ + if (ctx->machine_qregspec) + teco_machine_qregspec_free(ctx->machine_qregspec); +} + +teco_state_t * +teco_state_expectstring_input(teco_machine_main_t *ctx, gchar chr, GError **error) +{ + teco_state_t *current = ctx->parent.current; + + /* + * String termination handling + */ + if (ctx->modifier_at) { + if (current->expectstring.last) { + if (ctx->parent.must_undo) + teco_undo_guint(ctx->__flags); + ctx->modifier_at = FALSE; + } + + /* + * FIXME: Exclude setting at least whitespace characters as the + * new string escape character to avoid accidental errors? + */ + switch (ctx->expectstring.machine.escape_char) { + case '\e': + case '{': + if (ctx->parent.must_undo) + teco_undo_gchar(ctx->expectstring.machine.escape_char); + ctx->expectstring.machine.escape_char = teco_ascii_toupper(chr); + return current; + } + } + + /* + * This makes sure that escape characters (or braces) within string-building + * constructs and Q-Register specifications do not have to be escaped. + * This makes also sure that string terminators can be escaped via ^Q/^R. + */ + if (ctx->expectstring.machine.parent.current->is_start) { + if (ctx->expectstring.machine.escape_char == '{') { + switch (chr) { + case '{': + if (ctx->parent.must_undo) + teco_undo_gint(ctx->expectstring.nesting); + ctx->expectstring.nesting++; + break; + case '}': + if (ctx->parent.must_undo) + teco_undo_gint(ctx->expectstring.nesting); + ctx->expectstring.nesting--; + break; + } + } else if (teco_ascii_toupper(chr) == ctx->expectstring.machine.escape_char) { + if (ctx->parent.must_undo) + teco_undo_gint(ctx->expectstring.nesting); + ctx->expectstring.nesting--; + } + } + + if (!ctx->expectstring.nesting) { + /* + * Call process_cb() even if interactive feedback + * has not been requested using refresh_cb(). + * This is necessary since commands are either + * written for interactive execution or not, + * so they may do their main activity in process_cb(). + */ + if (ctx->expectstring.insert_len && current->expectstring.process_cb && + !current->expectstring.process_cb(ctx, &ctx->expectstring.string, + ctx->expectstring.insert_len, error)) + return NULL; + + teco_state_t *next = current->expectstring.done_cb(ctx, &ctx->expectstring.string, error); + + if (ctx->parent.must_undo) + teco_undo_string_own(ctx->expectstring.string); + else + teco_string_clear(&ctx->expectstring.string); + memset(&ctx->expectstring.string, 0, sizeof(ctx->expectstring.string)); + + if (current->expectstring.last) { + if (ctx->parent.must_undo) + teco_undo_gchar(ctx->expectstring.machine.escape_char); + ctx->expectstring.machine.escape_char = '\e'; + } + ctx->expectstring.nesting = 1; + + if (current->expectstring.string_building) + teco_machine_stringbuilding_reset(&ctx->expectstring.machine); + + ctx->expectstring.insert_len = 0; + return next; + } + + /* + * NOTE: Since we only ever append to `string`, this is more efficient + * than teco_undo_string(ctx->expectstring.string). + */ + if (ctx->mode == TECO_MODE_NORMAL && ctx->parent.must_undo) + undo__teco_string_truncate(&ctx->expectstring.string, ctx->expectstring.string.len); + + /* + * String building characters and string argument accumulation. + */ + gsize old_len = ctx->expectstring.string.len; + if (current->expectstring.string_building) { + teco_string_t *str = ctx->mode == TECO_MODE_NORMAL + ? &ctx->expectstring.string : NULL; + if (!teco_machine_stringbuilding_input(&ctx->expectstring.machine, chr, str, error)) + return NULL; + } else if (ctx->mode == TECO_MODE_NORMAL) { + teco_string_append_c(&ctx->expectstring.string, chr); + } + /* + * NOTE: As an optimization insert_len is not + * restored on undo since that is only + * necessary in interactive mode and we get + * called once per character when this is necessary. + */ + ctx->expectstring.insert_len += ctx->expectstring.string.len - old_len; + + return current; +} + +gboolean +teco_state_expectstring_refresh(teco_machine_main_t *ctx, GError **error) +{ + teco_state_t *current = ctx->parent.current; + + /* never calls process_cb() in parse-only mode */ + if (ctx->expectstring.insert_len && current->expectstring.process_cb && + !current->expectstring.process_cb(ctx, &ctx->expectstring.string, + ctx->expectstring.insert_len, error)) + return FALSE; + + ctx->expectstring.insert_len = 0; + return TRUE; +} + +gboolean +teco_state_expectfile_process(teco_machine_main_t *ctx, const teco_string_t *str, + gsize new_chars, GError **error) +{ + g_assert(str->data != NULL); + + /* + * Null-chars must not ocur in filename/path strings and at some point + * teco_string_t has to be converted to a null-terminated C string + * as all the glib filename functions rely on null-terminated strings. + * Doing it here ensures that teco_file_expand_path() can be safely called + * from the done_cb(). + */ + if (memchr(str->data + str->len - new_chars, '\0', new_chars)) { + g_set_error_literal(error, TECO_ERROR, TECO_ERROR_FAILED, + "Null-character not allowed in filenames"); + return FALSE; + } + + return TRUE; +} |