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.

4 files changed, 40 insertions, 46 deletions

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index c348346..d4c466f 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -177,7 +177,7 @@ SHORT_NAMES            = NO
 # description.)
 # The default value is: NO.
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 
 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
 # line (until the first dot) of a Qt-style comment as the brief description. If
@@ -228,7 +228,7 @@ TAB_SIZE               = 8
 # "Side Effects:". You can put \n's in the value part of an alias to insert
 # newlines.
 
-ALIASES                =
+ALIASES                = "fixme=@bug"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
@@ -242,7 +242,7 @@ TCL_SUBST              =
 # members will be omitted, etc.
 # The default value is: NO.
 
-OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
 
 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
 # Python sources only. Doxygen will then generate output that is more tailored
@@ -398,7 +398,7 @@ INLINE_SIMPLE_STRUCTS  = NO
 # types are typedef'ed and only the typedef is referenced, never the tag name.
 # The default value is: NO.
 
-TYPEDEF_HIDES_STRUCT   = NO
+TYPEDEF_HIDES_STRUCT   = YES
 
 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
 # cache is used to resolve symbols given their name and scope. Since this can be
@@ -560,7 +560,7 @@ INLINE_INFO            = YES
 # name. If set to NO, the members will appear in declaration order.
 # The default value is: YES.
 
-SORT_MEMBER_DOCS       = YES
+SORT_MEMBER_DOCS       = NO
 
 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
 # descriptions of file, namespace and class members alphabetically by member
@@ -670,7 +670,7 @@ SHOW_FILES             = YES
 # Folder Tree View (if specified).
 # The default value is: YES.
 
-SHOW_NAMESPACES        = YES
+SHOW_NAMESPACES        = NO
 
 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
 # doxygen should invoke to get the current version for each file (typically from
@@ -806,9 +806,7 @@ INPUT_ENCODING         = UTF-8
 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
 
-FILE_PATTERNS          = *.cpp \
-                         *.c \
-                         *.h
+FILE_PATTERNS          = *.c *.h
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -839,8 +837,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = "*/symbols-*.cpp" \
-                         "*/gtkflowbox.[ch]"
+EXCLUDE_PATTERNS       = "*/symbols-*.c"
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -1991,7 +1988,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -2031,7 +2028,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             =
+PREDEFINED             = "__attribute__(X)="
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2050,7 +2047,7 @@ EXPAND_AS_DEFINED      =
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-SKIP_FUNCTION_MACROS   = YES
+SKIP_FUNCTION_MACROS   = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to external references
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ad60d7c..1afe7ee 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -3,15 +3,15 @@
 include $(top_srcdir)/bootstrap.am
 
 # tedoc is a code documentation tool for SciTECO commands
-# and macros, extracting comments from SciTECO and C/C++
+# and macros, extracting comments from SciTECO and C
 # code.
 # It generates Troff manpage markup and acts as a Troff
 # preprocessor to manpage templates.
 dist_bin_SCRIPTS = tedoc.tes
 
-%.in : %.template tedoc.tes @top_srcdir@/src/*.cpp
+%.in : %.template tedoc.tes @top_srcdir@/src/*.c
 	$(SCITECO_FULL) -m -- @srcdir@/tedoc.tes \
-	                -C $@ $< @top_srcdir@/src/*.cpp
+	                -C $@ $< @top_srcdir@/src/*.c
 
 # grosciteco is a troff postprocessor similar to grotty
 # which can be used to produce SciTECO-friendly output
@@ -28,12 +28,13 @@ dist_bin_SCRIPTS += grosciteco.tes
 dist_pkgdata_DATA = sciteco.tmac
 
 # Fix up the hash-bang line of installed SciTECO scripts upon
-# installation to refer to the installed sciteco binary,
-# or rather to the sciteco-wrapper script.
+# installation to refer to the installed sciteco binary.
 # This takes --program-prefix into account.
+#
+# FIXME: This will patch the hash-bang line repeatedly.
 install-exec-hook:
 	$(SCITECO_FULL) -e "@EB'$(DESTDIR)$(bindir)/*.tes' 1U* \
-	                    EJ-1<%*^[ 0,L.@FR'#!^EM^Xsciteco'#!$(SCITECO_WRAPPER_INSTALLED)'> \
+	                    EJ-1<%*^[ 0,L.@FR'#!^EM^Xsciteco'#!$(SCITECO_INSTALLED)'> \
 	                    :EX"
 
 womendir = $(scitecolibdir)/women
@@ -97,9 +98,7 @@ SUFFIXES += .htbl .html
 #
 # Doxygen processing (do not install or distribute)
 #
-if BUILD_DEVDOC
-noinst_DATA = doxygen/
-endif
+devdoc : doxygen/
 
 .PHONY: doxygen/
 doxygen/ : Doxyfile
diff --git a/doc/sciteco.1.in b/doc/sciteco.1.in
index ead8337..5441621 100644
--- a/doc/sciteco.1.in
+++ b/doc/sciteco.1.in
@@ -69,19 +69,8 @@ interpreter before the script's file name, so all required \*(ST options must
 be mangled into a single argument with their single-letter names.
 Passing option-like arguments (beginning with a dash) to scripts may cause
 problems because \*(ST might try to interpret these options.
-Beginning with Glib 2.44, \*(ST thus stops parsing at the first non-option
+\*(ST thus stops parsing at the first non-option
 argument (which will always be the munged file name in a script invocation).
-For binaries linked against older versions of Glib, \*(ST works around this
-issue by providing a wrapper script that can be used in place of the main
-executable.
-A portable Hash-Bang line should thus look like:
-.RS
-.EX
-.SCITECO_TT
-#!@libexecdir@/sciteco-wrapper -m
-.SCITECO_TT_END
-.EE
-.RE
 .
 .LP
 .SCITECO_TOPIC argv arguments
@@ -144,7 +133,7 @@ The interactive mode enables character rub-out and thus undoing
 of command side-effects.
 Therefore code runs significantly slower in interactive mode
 and all algorithms have non-constant memory requirements
-as they will constantly accumulate \(lqundo tokens\(rqP.
+as they will constantly accumulate \(lqundo tokens\(rq.
 Batch mode does not have these restrictions.
 .IP \(bu
 A few commands that modify the command line are only available
@@ -175,7 +164,7 @@ option.
 .
 .IP "\fB-h\fR, \fB--help\fR"
 .SCITECO_TOPIC "-h" "--help"
-Display a short help text on the console. 
+Display a short help text on the console.
 .IP "\fB-e\fR, \fB--eval\fR \fImacro"
 .SCITECO_TOPIC "-e" "--eval"
 Evaluate (execute)
@@ -253,11 +242,11 @@ Initialization of this variable ensures that the
 \(lq$HOME\(rq Q-Register is available even on Windows
 and the home directory can always be re-configured.
 .TP
-.SCITECO_TOPIC "$SHELL" "SHELL" "$COMSPEC" "COMSPEC"
-.BR SHELL " or " COMSPEC
+.SCITECO_TOPIC "$SHELL" "SHELL" "$ComSpec" "ComSpec"
+.BR SHELL " or " ComSpec
 Path of the command interpreter used by \fBEG\fP and \fBEC\fP
 commands if UNIX98 shell emulation is \fIdisabled\fP.
-\fBSHELL\fP is used on UNIX-like systems, while \fBCOMSPEC\fP
+\fBSHELL\fP is used on UNIX-like systems, while \fBComSpec\fP
 is used on DOS-like systems (like Windows).
 Both variables are usually already set in the process environment
 but are initialized to \(lq/bin/sh\(rq or \(lqcmd.exe\(rq
diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template
index 47100e9..dbd9392 100644
--- a/doc/sciteco.7.template
+++ b/doc/sciteco.7.template
@@ -734,8 +734,11 @@ This is useful for writing cross-platform \*(ST macros (see
 .LP
 Note that completions take place after string building and
 tilde-expansion is also performed by file name completions,
-so for instance \(lq~/foo\(rq will complete a file
-in the user's home directory.
+so for instance both \(lq~/foo\(rq and \(lq^EQ[$HOME]/foo\(rq
+will complete a file in the user's home directory.
+Auto-completion also takes care of \fIquoting\fP string termination
+and string building characters, which might be relevant especially
+when autocompleting Q-Register names.
 .
 .
 .SH USER INTERFACE
@@ -1249,8 +1252,10 @@ A command identifier (and Q-Register specification) may be followed
 by one or more string arguments.
 String arguments are terminated by Escape characters (27) by default,
 but this may be changed using modifiers.
-All string arguments may contain special string building characters
-for instance to embed other strings.
+If enabled, string arguments may contain special string building characters
+for instance to embed other strings or to quote the argument terminator.
+The detection of the end of a string is aware of string building characters,
+ie. string building constructs may contain the current terminator.
 String building may be enabled or disabled by default for a command.
 In interactive mode the command is often executed as soon as it
 has been completely specified and updates to the string arguments
@@ -1302,6 +1307,10 @@ string arguments, as in:
 }
 .SCITECO_TT_END
 .EE
+The termination character can be \fIquoted\fP if you want to handle
+it like any regular character.
+For instance, you could write \(lqS^Q\fB$$\fP\(rq to search for the
+escape character itself.
 .
 .SH Q-REGISTERS
 .SCITECO_TOPIC Q-Register
@@ -1605,8 +1614,8 @@ thus refers to the corresponding control code:
 .TQ
 .BI ^R c
 Escape character \fIc\fP.
-The character is not handled as a string building character,
-so for instance \(lq^Q^Q\(rq translates to \(lq^Q\(rq.
+The character is not handled as a string building or string termination
+character, so for instance \(lq^Q^Q\(rq translates to \(lq^Q\(rq.
 .TP
 .SCITECO_TOPIC ^V^V ^Vc lower
 .B ^V^V