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.

1 files changed, 115 insertions, 0 deletions

diff --git a/src/doc.h b/src/doc.h
new file mode 100644
index 0000000..471d16a
--- /dev/null
+++ b/src/doc.h
@@ -0,0 +1,115 @@
+/*
+ * 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/>.
+ */
+#pragma once
+
+#include <string.h>
+
+#include <glib.h>
+
+#include <Scintilla.h>
+
+#include "sciteco.h"
+#include "view.h"
+#include "undo.h"
+
+/**
+ * Scintilla document type.
+ * The struct is never defined and only exists for improved
+ * type safety.
+ */
+typedef struct teco_doc_scintilla_t teco_doc_scintilla_t;
+
+/**
+ * A Scintilla document.
+ *
+ * Also contains other attributes required to restore
+ * the overall editor state when loading it into a Scintilla view.
+ */
+typedef struct {
+	/**
+	 * Underlying Scintilla document.
+	 * It is created on demand in teco_doc_maybe_create_document(),
+	 * so that we don't waste memory on integer-only Q-Registers.
+	 */
+	teco_doc_scintilla_t *doc;
+
+	/*
+	 * The so called "parameters".
+	 * Updated/restored only when required
+	 */
+	gint anchor, dot;
+	gint first_line, xoffset;
+} teco_doc_t;
+
+/** @memberof teco_doc_t */
+static inline void
+teco_doc_init(teco_doc_t *ctx)
+{
+	memset(ctx, 0, sizeof(*ctx));
+}
+
+void teco_doc_edit(teco_doc_t *ctx);
+void teco_doc_undo_edit(teco_doc_t *ctx);
+
+void teco_doc_set_string(teco_doc_t *ctx, const gchar *str, gsize len);
+void teco_doc_undo_set_string(teco_doc_t *ctx);
+
+void teco_doc_get_string(teco_doc_t *ctx, gchar **str, gsize *len);
+
+void teco_doc_update_from_view(teco_doc_t *ctx, teco_view_t *from);
+void teco_doc_update_from_doc(teco_doc_t *ctx, const teco_doc_t *from);
+
+/** @memberof teco_doc_t */
+#define teco_doc_update(CTX, FROM) \
+	(_Generic((FROM), teco_view_t *      : teco_doc_update_from_view, \
+	                  teco_doc_t *       : teco_doc_update_from_doc, \
+	                  const teco_doc_t * : teco_doc_update_from_doc)((CTX), (FROM)))
+
+/** @memberof teco_doc_t */
+static inline void
+teco_doc_reset(teco_doc_t *ctx)
+{
+	ctx->anchor = ctx->dot = 0;
+	ctx->first_line = ctx->xoffset = 0;
+}
+
+/** @memberof teco_doc_t */
+static inline void
+teco_doc_undo_reset(teco_doc_t *ctx)
+{
+	/*
+	 * NOTE: Could be rolled into one function
+	 * and called with teco_undo_call() if we really
+	 * wanted to save more memory.
+	 */
+	teco_undo_gint(ctx->anchor);
+	teco_undo_gint(ctx->dot);
+	teco_undo_gint(ctx->first_line);
+	teco_undo_gint(ctx->xoffset);
+}
+
+void teco_doc_exchange(teco_doc_t *ctx, teco_doc_t *other);
+
+/** @memberof teco_doc_t */
+static inline void
+teco_doc_undo_exchange(teco_doc_t *ctx)
+{
+	teco_undo_ptr(ctx->doc);
+	teco_doc_undo_reset(ctx);
+}
+
+void teco_doc_clear(teco_doc_t *ctx);