Begun working on a hyperlinks framework - supports rules and keypresses

Author: curiousdannii

.editorconfig

@@ -12,12 +12,9 @@ insert_final_newline = false
 [*.{i6t,i7,i7x,neptune,ni,txt,w}]
 indent_style = tab
 
+[*.{i6t,w}]
+insert_final_newline = true
+
 [*.json]
 indent_style = space
-indent_size = 4
-
-[inform7/Tests/Test Cases/*.txt]
-indent_style = tab
-
-[resources/Documentation/**.txt]
-indent_style = tab
+indent_size = 4

inform7/Internal/Extensions/Graham Nelson/Basic Inform.i7xd/Materials/Inter/Architecture32Kit/Sections/Glk.i6t

@@ -740,6 +740,63 @@ requested.
 	return 0;
 ];
 
+@h Hyperlinks.
+A simple framework for handling hyperlinks in an interoperable manner.
+We combine a hyperlink tag with a payload in one 32-bit value. The tag is stored
+in the lowest bits, and the payload above it.
+
+=
+Global hyperlink_payload_mask;
+Global hyperlink_tag_mask;
+Global hyperlink_tag_width;
+Global hyperlink_value;
+
+[ CALCULATE_HYPERLINK_TAG_WIDTH_R;
+	if (ICOUNT_HYPERLINK_TAG < 8) {
+		hyperlink_tag_mask = $07;
+		hyperlink_tag_width = 3;
+	}
+	else if (ICOUNT_HYPERLINK_TAG < 16) {
+		hyperlink_tag_mask = $0F;
+		hyperlink_tag_width = 4;
+	}
+	else {
+		! Enough for 31 tags, which better be enough!
+		hyperlink_tag_mask = $1F;
+		hyperlink_tag_width = 5;
+	}
+	hyperlink_payload_mask = ~hyperlink_tag_mask;
+	rfalse;
+];
+
+[ MakeTaggedHyperlink tag val;
+	if (Cached_Glk_Gestalts-->gestalt_Hyperlinks) {
+		if (val > 0) {
+			@shiftl val hyperlink_tag_width val;
+		}
+		else {
+			val = val & hyperlink_payload_mask;
+		}
+		glk_set_hyperlink(tag | val);
+	}
+];
+
+[ HANDLE_HYPERLINK_R val;
+	if (current_glk_event-->GLK_EVENT_TYPE_SF == evtype_Hyperlink) {
+		val = current_glk_event-->GLK_EVENT_VALUE1_SF;
+		glk_request_hyperlink_event((current_glk_event-->GLK_EVENT_WINDOW_SF).glk_ref);
+		hyperlink_value = val & hyperlink_payload_mask;
+		if (hyperlink_value < 0) {
+			hyperlink_value = hyperlink_value | hyperlink_tag_mask;
+		}
+		else {
+			@ushiftr hyperlink_value hyperlink_tag_width hyperlink_value;
+		}
+		FollowRulebook(HYPERLINK_HANDLING_RB, val & hyperlink_tag_mask, true);
+	}
+	rfalse;
+];
+
 @h Suspending and resuming text input.
 These functions allow the author to suspend and then resume a window's text
 input requests.

inform7/Internal/Extensions/Graham Nelson/Basic Inform.i7xd/Materials/Inter/Architecture32Kit/Sections/Startup.i6t

@@ -113,6 +113,9 @@ Global Pre_Startup_Text_Capture_Stream;
 		if (BasicInformKit`MANUAL_INPUT_ECHOING_CFGF && Cached_Glk_Gestalts-->gestalt_LineInputEcho) {
 			glk_set_echo_line_event(gg_mainwin, 0);
 		}
+		if (Cached_Glk_Gestalts-->gestalt_Hyperlinks) {
+			glk_request_hyperlink_event(gg_mainwin);
+		}
 	} else {
 		! There was already a story window. We should erase it.
 		glk_window_clear(gg_mainwin);
@@ -124,6 +127,9 @@ Global Pre_Startup_Text_Capture_Stream;
 			gg_statuswin =
 				glk_window_open(gg_mainwin, winmethod_Fixed + winmethod_Above,
 					statuswin_cursize, wintype_TextGrid, GG_STATUSWIN_ROCK);
+			if (Cached_Glk_Gestalts-->gestalt_Hyperlinks) {
+				glk_request_hyperlink_event(gg_statuswin);
+			}
 		}
 	}
 	else if (gg_statuswin) {

inform7/Internal/Extensions/Graham Nelson/Basic Inform.i7xd/Source/Sections/Glulx and Glk.w

@@ -195,6 +195,57 @@ To replace current event with (ev - glk event):
 Glk event handling rule for a screen resize event (this is the redraw the status line rule):
 	redraw the status window;
 
+@h Hyperlinks.
+A simple framework for handling hyperlinks in an interoperable manner.
+
+=
+Chapter - Hyperlinks
+
+A hyperlink tag is a kind of value.
+
+The hyperlink value is a number variable.
+The hyperlink value variable is defined by Inter as "hyperlink_value".
+
+The hyperlink handling rules is a hyperlink tag based rulebook.
+The hyperlink handling rules is accessible to Inter as "HYPERLINK_HANDLING_RB".
+
+The handle hyperlinks rule is listed in the glk event handling rules.
+The handle hyperlinks rule is defined by Inter as "HANDLE_HYPERLINK_R".
+
+To say end link:
+	(- if (Cached_Glk_Gestalts-->gestalt_Hyperlinks) { glk_set_hyperlink(0); } -).
+
+@ And some built-in hyperlink tags:
+
+- A rule hyperlink runs a rule when clicked; that in turn allows you to run any other code you like.
+- A keypress hyperlink converts a hyperlink event into a character event, for the specified unicode character.
+
+=
+
+Rule hyperlink is a hyperlink tag.
+
+To say link (R - rule):
+	(- MakeTaggedHyperlink((+ rule hyperlink +), {R}); -).
+
+Hyperlink handling rule for a rule hyperlink (this is the rule hyperlink rule):
+	run rule at address hyperlink value;
+
+Keypress hyperlink is a hyperlink tag.
+
+To say link (C - unicode character):
+	(- MakeTaggedHyperlink((+ keypress hyperlink +), {C}); -).
+
+Hyperlink handling rule for a keypress hyperlink (this is the keypress hyperlink rule):
+	process a character event for (hyperlink value of the current glk event as a unicode character) in (window of the current glk event);
+
+Section - unindexed
+
+To run rule at address (R - number):
+	(- ({R})(); -).
+
+To decide what unicode character is (N - number) as a unicode character:
+	(- ({N}) -).
+
 @h Suspending input.
 These properties and phrases allow the author to suspend and resume input requests.
 

inform7/Internal/Extensions/Graham Nelson/Basic Inform.i7xd/Source/Sections/Miscellaneous Definitions.w

@@ -154,10 +154,13 @@ Section - Startup C (for Glulx only)
 The start capturing startup text rule is listed first in the before starting the virtual machine rules. [1st]
 The start capturing startup text rule translates into Inter as "CAPTURE_STARTUP_TEXT_R".
 
+The calculate hyperlink tag width rule is listed in the before starting the virtual machine rules. [6th]
+The calculate hyperlink tag width rule translates into Inter as "CALCULATE_HYPERLINK_TAG_WIDTH_R".
+
 @ These rules now set up the built in sound channels and windows.
 
 =
-The set default stylehints rule is listed in the before starting the virtual machine rules. [6th]
+The set default stylehints rule is listed in the before starting the virtual machine rules. [7th]
 The set default stylehints rule translates into Inter as "SET_DEFAULT_STYLEHINTS_R".
 
 The sound channel initialisation rule is listed in the for starting the virtual machine rules.

inform7/Internal/Extensions/Graham Nelson/Basic Inform.i7xd/Source/Sections/Phrase Definitions.w

@@ -2046,4 +2046,4 @@ Chapter 11 - Use Options
 Section 1 - Numerical Value
 
 To decide what number is the numerical value of (U - a use option):
-	(- USE_OPTION_VALUES-->({U}) -).
+	(- USE_OPTION_VALUES-->({U}) -).

inform7/Internal/Extensions/Graham Nelson/English Language.i7xd/Materials/Languages/English/Index.txt

@@ -314,6 +314,7 @@
 %Index.Elements.St.IdentifySchannelsRules = Identify glk sound channels rules
 %Index.Elements.St.GlkObjectUpdatingRules = Glk object updating rules
 %Index.Elements.St.GlkEventHandlingRules = Glk event handling rules
+%Index.Elements.St.HyperlinkHandlingRules = Hyperlink handling rules
 
 %Index.Elements.St.CheckRules =
 	Check rules are tied to specific actions, and there are too many to index here.