Change: Add some basic screen reader support for in-game menu

Author: leezer3

Readme.md

@@ -69,8 +69,9 @@ Please also see the following issue for further discussion on the topic: https:/
 - openBVE uses the [**NVorbis**](https://github.com/NVorbis/NVorbis) for decoding Vorbis file. This is licensed under the *Microsoft Public License*, which may be found in [here](licenses/NVorbis.txt).
 - openBVE uses the [**OpenTK**](https://github.com/opentk/opentk) library for windowing and input handling. This is licensed under the _Open Toolkit Library License_, which may be found in [here](licenses/OpenTK.txt).
 - openBVE uses the [**Prism**](https://github.com/PrismLibrary/Prism). This is licensed under the *MIT License*, which may be found in [here](licenses/Prism.txt).
-- openBVE uses the [**ReactiveProperty**](https://github.com/runceel/ReactiveProperty). This is licensed under the *MIT License*, which may be found in [here](licenses/ReactiveProperty.txt).
+- openBVE uses the [**ReactiveProperty**](https://github.com/runceel/ReactiveProperty) This is licensed under the *MIT License*, which may be found in [here](licenses/ReactiveProperty.txt).
 - openBVE uses the [**SharpCompress**](https://github.com/adamhathcock/sharpcompress) for archive handling. This is licensed under the _MIT License_, which may be found in [here](licenses/SharpCompress.txt).
-- openBVE uses the [**Reactive Extensions**](https://github.com/dotnet/reactive). This is licensed under the *Apache License, Version 2.0*, which may be found in [here](licenses/ReactiveExtensions.txt).
+- openBVE uses the [**Reactive Extensions**](https://github.com/dotnet/reactive) This is licensed under the *Apache License, Version 2.0*, which may be found in [here](licenses/ReactiveExtensions.txt).
 - openBVE uses the [**Ude**](https://github.com/yinyue200/ude) for character set detection. This is tri-licensed under the _Mozilla Public License v1.1_, _GPL 2.0_ and _LGPL 2.0_, which may be found in [here](licenses/Ude.txt).
-- openBVE uses the [**XamlBehaviors for WPF**](https://github.com/microsoft/XamlBehaviorsWpf). This is licensed under the *MIT License*, which may be found in [here](licenses/XamlBehaviorsForWPF.txt).
+- openBVE uses the [**XamlBehaviors for WPF**](https://github.com/microsoft/XamlBehaviorsWpf) This is licensed under the *MIT License*, which may be found in [here](licenses/XamlBehaviorsForWPF.txt).
+- openBVE uses the [**TOLK**] (https://github.com/dkager/tolk) library for screen reader API access. This is licenced under the *LGPL V3* which may be found in [here](licences/TOLK.txt)

dependencies/TolkDotNet.dll

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/]
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

dependencies/x64/SAAPI64.dll

@@ -1,9 +1,9 @@
 using OpenBveApi.Colors;
 using OpenBveApi.Graphics;
 using OpenBveApi.Interface;
-using OpenBveApi.Math;
 using System;
 using System.Drawing;
+using DavyKager;
 using LibRender2.Screens;
 using LibRender2.Texts;
 using OpenBve.Input;
@@ -137,7 +137,30 @@ MENU FIELDS
 			public readonly int ItemWidth = 0;
 			public readonly int Width = 0;
 			public readonly int Height = 0;
-			public int Selection;
+
+			private int lastSelection = int.MaxValue;
+			private int currentSelection;
+			
+			public int Selection
+			{
+				get
+				{
+					return currentSelection;
+				}
+				set
+				{
+					lastSelection = currentSelection;
+					currentSelection = value;
+					if (currentSelection != lastSelection && Interface.CurrentOptions.ScreenReaderAvailable)
+					{
+						if (!Tolk.Output(Items[currentSelection].Text))
+						{
+							// failed to output to screen reader, so don't keep trying
+							Interface.CurrentOptions.ScreenReaderAvailable = false;
+						}
+					}
+				}
+			}
 			public int TopItem;         // the top displayed menu item
 
 

dependencies/x64/Tolk.dll

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="12.0">
-<Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
@@ -124,6 +124,9 @@
     <Reference Include="System.Windows.Forms" />
     <Reference Include="System.Xml" />
     <Reference Include="System.Xml.Linq" />
+    <Reference Include="TolkDotNet">
+      <HintPath>..\..\dependencies\TolkDotNet.dll</HintPath>
+    </Reference>
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Game\AI\AI.cs" />

dependencies/x64/Tolk.exp

@@ -2,7 +2,7 @@
 using System.ComponentModel;
 using System.Globalization;
 using System.Linq;
-using LibRender2;
+using DavyKager;
 using LibRender2.Screens;
 using OpenBve.Input;
 using OpenBveApi.Interface;
@@ -30,7 +30,7 @@ internal enum QuitMode
 		internal static bool BlockKeyRepeat;
 		/// <summary>The current simulation time-factor</summary>
 		internal static int TimeFactor = 1;
-
+		
 		internal static double timeSinceLastMouseEvent;
 
 		internal static formMain.MainDialogResult currentResult;
@@ -52,6 +52,21 @@ internal enum QuitMode
 		internal static void StartLoopEx(formMain.MainDialogResult result)
 		{
 			Program.Sounds.Initialize(Program.CurrentHost, Interface.CurrentOptions.SoundRange);
+			Interface.CurrentOptions.Accessibility = true;
+			if (Interface.CurrentOptions.Accessibility)
+			{
+				Tolk.Load();
+				string name = Tolk.DetectScreenReader();
+				if (!string.IsNullOrEmpty(name))
+				{
+					Interface.CurrentOptions.ScreenReaderAvailable = true;
+					Program.FileSystem.AppendToLogFile("Supported screen reader driver " + name + " initialised.");
+				}
+				else
+				{
+					Program.FileSystem.AppendToLogFile("No supported screen reader found.");
+				}
+			}
 			//Process extra command line arguments supplied
 			if (result.InitialStation != null)
 			{
@@ -65,13 +80,13 @@ internal static void StartLoopEx(formMain.MainDialogResult result)
 
 			Game.InitialAIDriver = result.AIDriver;
 			Game.InitialReversedConsist = result.ReverseConsist;
-			if (result.FullScreen == true)
+			if (result.FullScreen)
 			{
 				Interface.CurrentOptions.FullscreenMode = true;
 			}
 			if (result.Width != default(double) && result.Height != default(double))
 			{
-				if (Interface.CurrentOptions.FullscreenMode == true)
+				if (Interface.CurrentOptions.FullscreenMode)
 				{
 					Interface.CurrentOptions.FullscreenWidth = result.Width;
 					Interface.CurrentOptions.FullscreenHeight = result.Height;
@@ -390,7 +405,7 @@ internal static void ProcessKeyboard()
 								}
 								else
 								{
-									Interface.CurrentControls[i].AnalogState = (double)Math.Sign(axisState);
+									Interface.CurrentControls[i].AnalogState = Math.Sign(axisState);
 								}
 							}
 							else

dependencies/x64/Tolk.lib

@@ -84,6 +84,11 @@ internal class Options : BaseOptions
 			/// <remarks>Set to zero to never hide the cursor</remarks>
 			internal double CursorHideDelay;
 			internal string CursorFileName;
+			/// <summary>Whether various accessibility helpers are enabled</summary>
+			internal bool Accessibility;
+			/// <summary>Whether a screen reader is available</summary>
+			/// <remarks>Not saved, detected on game init</remarks>
+			internal bool ScreenReaderAvailable;
 
 			internal TimeTableMode TimeTableStyle;
 
@@ -173,6 +178,8 @@ internal Options()
 				this.CurrentXParser = XParsers.Original; //Set to Michelle's original X parser by default
 				this.CurrentObjParser = ObjParsers.Original; //Set to original Obj parser by default
 				this.CursorHideDelay = 10;
+				this.Accessibility = false;
+				this.ScreenReaderAvailable = false;
 			}
 		}
 		/// <summary>The current game options</summary>
@@ -269,6 +276,9 @@ internal static void LoadOptions()
 											}
 											Interface.CurrentOptions.KioskModeTimer = d;
 											break;
+										case "accessibility":
+											Interface.CurrentOptions.Accessibility = string.Compare(Value, "true", StringComparison.OrdinalIgnoreCase) == 0;
+											break;
 									} break;
 								case "display":
 									switch (Key)
@@ -780,6 +790,7 @@ internal static void SaveOptions()
 			}
 			Builder.AppendLine("kioskMode = " + (CurrentOptions.KioskMode ? "true" : "false"));
 			Builder.AppendLine("kioskModeTimer = " + CurrentOptions.KioskModeTimer);
+			Builder.AppendLine("accessibility = " + (CurrentOptions.Accessibility ? "true" : "false"));
 			Builder.AppendLine();
 			Builder.AppendLine("[display]");
 			Builder.AppendLine("preferNativeBackend = " + (CurrentOptions.PreferNativeBackend ? "true" : "false"));