From e7867fb0d9979c550e6e3d7597ece73b680c4af6 Mon Sep 17 00:00:00 2001
From: Robin Haberkorn <robin.haberkorn@googlemail.com>
Date: Fri, 26 Feb 2016 02:02:50 +0100
Subject: implemented self-documenting (online) help system

 * the new "?" (help) command can be used to look up
   help topics.
 * help topics are index from $SCITECOPATH/women/*.woman.tec
   files.
 * looking up a help topic opens the corresponding "womanpage"
   and jumps to the position of the topic (it acts like an anchor
   into the document).
 * styling is performed by *.woman.tec files.
 * Setting up the Scintilla view and munging the *.tec file
   is performed by the new "woman.tes" lexer.
   On supporting UIs (Gtk), womanpages are shown in a variable-width
   font.
 * Woman pages are usually not hand-written, but generated from manpages.
   A special Groff post-processor grosciteco has been introduced for this
   purpose. It is much like grotty, but can output SciTECO macros for styling
   the document (ie. the *.woman.tec files).
   It is documented in its own man-page.
 * grosciteco also introduces sciteco.tmac - special Troff macros
   for controlling the formatting of the document in SciTECO.
   It also defines .SCITECO_TOPIC which can be used to mark up
   help topics/terms in Troff markup.
 * Woman pages are generated/formatted by grosciteco at compile-time, so
   they will work on platforms without Groff (ie. as on windows).
 * Groff has been added as a hard compile-time requirement.
 * The sciteco(1) and sciteco(7) man pages have been augmented with
   help topic anchors.
---
 src/help.h | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 src/help.h

(limited to 'src/help.h')

diff --git a/src/help.h b/src/help.h
new file mode 100644
index 0000000..db78979
--- /dev/null
+++ b/src/help.h
@@ -0,0 +1,87 @@
+/*
+ * Copyright (C) 2012-2016 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/>.
+ */
+
+#ifndef __HELP_H
+#define __HELP_H
+
+#include <string.h>
+
+#include <glib.h>
+#include <glib/gprintf.h>
+
+#include "sciteco.h"
+#include "parser.h"
+#include "undo.h"
+#include "rbtree.h"
+
+namespace SciTECO {
+
+class HelpIndex : public RBTree {
+public:
+	class Topic : public RBTree::RBEntry {
+	public:
+		gchar	*name;
+		gchar	*filename;
+		tecoInt	pos;
+
+		Topic(const gchar *_name, const gchar *_filename = NULL, tecoInt _pos = 0)
+		     : name(g_strdup(_name)),
+		       filename(_filename ? g_strdup(_filename) : NULL),
+		       pos(_pos) {}
+		~Topic()
+		{
+			g_free(name);
+			g_free(filename);
+		}
+
+		int
+		operator <(RBEntry &l2)
+		{
+			return g_ascii_strcasecmp(name, ((Topic &)l2).name);
+		}
+	};
+
+	void load(void);
+
+	Topic *find(const gchar *name);
+
+	void set(const gchar *name, const gchar *filename,
+	         tecoInt pos = 0);
+};
+
+extern HelpIndex help_index;
+
+/*
+ * Command states
+ */
+
+class StateGetHelp : public StateExpectString {
+public:
+	StateGetHelp() : StateExpectString(false) {}
+
+private:
+	void initial(void);
+	State *done(const gchar *str);
+};
+
+namespace States {
+	extern StateGetHelp gethelp;
+}
+
+} /* namespace SciTECO */
+
+#endif
-- 
cgit v1.2.3