From 76b1d549a522eac959c32059df9ee1857e100135 Mon Sep 17 00:00:00 2001
From: Melchior FRANZ <mfranz@aon.at>
Date: Mon, 12 Sep 2011 18:58:44 +0200
Subject: [PATCH 1/2] warthog: move js config files into Warthog dir; add more
 overlays

---
 .../Warthog/Throttle/helicopter.xml           | 13 ++++
 .../{ => Warthog}/Warthog-Stick.xml           | 67 ++++++++++---------
 .../{ => Warthog}/Warthog-Throttle.xml        | 21 ++++--
 3 files changed, 61 insertions(+), 40 deletions(-)
 create mode 100644 Input/Joysticks/ThrustMaster/Warthog/Throttle/helicopter.xml
 rename Input/Joysticks/ThrustMaster/{ => Warthog}/Warthog-Stick.xml (85%)
 rename Input/Joysticks/ThrustMaster/{ => Warthog}/Warthog-Throttle.xml (95%)

diff --git a/Input/Joysticks/ThrustMaster/Warthog/Throttle/helicopter.xml b/Input/Joysticks/ThrustMaster/Warthog/Throttle/helicopter.xml
new file mode 100644
index 000000000..51cf49390
--- /dev/null
+++ b/Input/Joysticks/ThrustMaster/Warthog/Throttle/helicopter.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+
+<PropertyList>
+	<axis n="5">
+		<name>Hat Switch Horizontal</name>
+		<desc>adjust engine balance</desc>
+	</axis>
+
+	<axis n="6">
+		<name>Hat Switch Vertical</name>
+		<desc>adjust engine power</desc>
+	</axis>
+</PropertyList>
diff --git a/Input/Joysticks/ThrustMaster/Warthog-Stick.xml b/Input/Joysticks/ThrustMaster/Warthog/Warthog-Stick.xml
similarity index 85%
rename from Input/Joysticks/ThrustMaster/Warthog-Stick.xml
rename to Input/Joysticks/ThrustMaster/Warthog/Warthog-Stick.xml
index 4b47100ff..614cb4d44 100644
--- a/Input/Joysticks/ThrustMaster/Warthog-Stick.xml
+++ b/Input/Joysticks/ThrustMaster/Warthog/Warthog-Stick.xml
@@ -1,7 +1,12 @@
 <?xml version="1.0"?>
 <!--
 	Copyright (c) 2011   Melchior FRANZ   mfranz # aon : at
-	Work In Progress
+
+	This driver supports joystick overlay files (see ./Warthog/README).
+
+	TMS ... Target Management Switch (black, rippled cursor switch, left side)
+	DMS ... Data Management Switch (black cursor switch with flat cross on top, right side)
+	CMS ... Countermeasures Management Switch  (grey)
 -->
 
 <PropertyList>
@@ -13,10 +18,12 @@
 			var this = cmdarg().getParent();
 			var popup = func gui.popupTip(call(sprintf, arg));
 			var is_helicopter = (var _ = props.globals.getNode("rotors", 0)) != nil and _.getAttribute("children");
+			var aircraft_type = getprop("/sim/type");
+			var overlay = getprop("/input/joysticks/overlay");
 
 			var load_overlay = func(name) {
 				foreach (var dir; [getprop("/sim/fg-home"), getprop("/sim/fg-root")]) {
-					var file = dir ~ "/Input/Joysticks/ThrustMaster/Warthog/Joystick/" ~ name;
+					var file = dir ~ "/Input/Joysticks/ThrustMaster/Warthog/Joystick/" ~ name ~ ".xml";
 					if (io.stat(file) != nil) {
 						printlog("info", "WARTHOG: loading overlay " ~ file);
 						cmdarg().getNode("script").setValue("");
@@ -48,10 +55,14 @@
 				viewdir[i] = t != nil and t.getValue() == "lookat" ? 1 : -1;
 			}
 
-			load_overlay("generic.xml");
+			load_overlay("generic");
 			if (is_helicopter)
-				load_overlay("helicopter.xml");
-			load_overlay(getprop("/sim/aircraft") ~ ".xml");
+				load_overlay("helicopter");
+			if (aircraft_type)
+				load_overlay(aircraft_type);
+			if (overlay)
+				load_overlay(overlay);
+			load_overlay(getprop("/sim/aircraft"));
 		</script>
 	</nasal>
 
@@ -77,7 +88,7 @@
 	</axis>
 
 	<axis n="2">
-		<name>Trim Coolie Left/Right</name>
+		<name>Trim Hat Switch Left/Right</name>
 		<desc>adjust aileron trim,  +mod: reset aileron trim</desc>
 		<low>
 			<repeatable>true</repeatable>
@@ -106,7 +117,7 @@
 	</axis>
 
 	<axis n="3">
-		<name>Trim Coolie Down/Up</name>
+		<name>Trim Hat Switch Down/Up</name>
 		<desc>adjust elevator trim,  +mod: reset elevator trim</desc>
 		<low>
 			<repeatable>true</repeatable>
@@ -136,17 +147,7 @@
 
 	<button n="0">
 		<name>Trigger Button/Half Pushed</name>
-		<desc>gun trigger stage 1</desc>
-		<binding>
-			<command>nasal</command>
-			<script>controls.trigger(1)</script>
-		</binding>
-		<mod-up>
-			<binding>
-				<command>nasal</command>
-				<script>controls.trigger(0)</script>
-			</binding>
-		</mod-up>
+		<desc>camera oper</desc>
 	</button>
 
 	<button n="1">
@@ -180,10 +181,10 @@
 
 	<button n="5">
 		<name>Trigger Button/Fully Pushed</name>
-		<desc>gun trigger stage 2</desc>
+		<desc>gun trigger</desc>
 		<binding>
 			<command>nasal</command>
-			<script>controls.trigger(2)</script>
+			<script>controls.trigger(1)</script>
 		</binding>
 		<mod-up>
 			<binding>
@@ -194,7 +195,7 @@
 	</button>
 
 	<button n="6">
-		<name>Target Management Switch (TMS) up</name>
+		<name>left black curosr (TMS) up</name>
 		<desc>zoom in,  +mod: reset zoom</desc>
 		<repeatable>true</repeatable>
 		<binding>
@@ -209,7 +210,7 @@
 	</button>
 
 	<button n="7">
-		<name>Target Management Switch (TMS) right</name>
+		<name>left black cursor (TMS) right</name>
 		<desc>next active view,  +mod: next view</desc>
 		<binding>
 			<command>nasal</command>
@@ -218,7 +219,7 @@
 	</button>
 
 	<button n="8">
-		<name>Target Management Switch (TMS) down</name>
+		<name>left black cursor (TMS) down</name>
 		<desc>zoom out,  +mod: reset zoom</desc>
 		<repeatable>true</repeatable>
 		<binding>
@@ -233,7 +234,7 @@
 	</button>
 
 	<button n="9">
-		<name>Target Management Switch (TMS) left</name>
+		<name>left black cursor (TMS) left</name>
 		<desc>previous active view,  +mod: previous view</desc>
 		<binding>
 			<command>nasal</command>
@@ -242,7 +243,7 @@
 	</button>
 
 	<button n="10">
-		<name>Data Management Switch (DMS) up</name>
+		<name>right black cursor (DMS) up</name>
 		<desc>brakes</desc>
 		<binding>
 			<command>nasal</command>
@@ -257,7 +258,7 @@
 	</button>
 
 	<button n="11">
-		<name>Data Management Switch (DMS) right</name>
+		<name>right black cursor (DMS) right</name>
 		<desc>brakes right</desc>
 		<binding>
 			<command>nasal</command>
@@ -272,7 +273,7 @@
 	</button>
 
 	<button n="12">
-		<name>Data Management Switch (DMS) down</name>
+		<name>right black cursor (DMS) down</name>
 		<desc>toggle parking brake</desc>
 		<binding>
 			<command>nasal</command>
@@ -291,7 +292,7 @@
 	</button>
 
 	<button n="13">
-		<name>Data Management Switch (DMS) left</name>
+		<name>right black cursor (DMS) left</name>
 		<desc>brakes left</desc>
 		<binding>
 			<command>nasal</command>
@@ -306,7 +307,7 @@
 	</button>
 
 	<button n="14">
-		<name>Countermeasures Management Switch (CMS) up</name>
+		<name>grey cursor (CMS) up</name>
 		<desc>view up</desc>
 		<repeatable>true</repeatable>
 		<binding>
@@ -316,7 +317,7 @@
 	</button>
 
 	<button n="15">
-		<name>Countermeasures Management Switch (CMS) right</name>
+		<name>grey cursor (CMS) right</name>
 		<desc>view right</desc>
 		<repeatable>true</repeatable>
 		<binding>
@@ -326,7 +327,7 @@
 	</button>
 
 	<button n="16">
-		<name>Countermeasures Management Switch (CMS) down</name>
+		<name>grey cursor (CMS) down</name>
 		<desc>view down</desc>
 		<repeatable>true</repeatable>
 		<binding>
@@ -336,7 +337,7 @@
 	</button>
 
 	<button n="17">
-		<name>Countermeasures Management Switch (CMS) left</name>
+		<name>grey cursor (CMS) left</name>
 		<desc>view left</desc>
 		<repeatable>true</repeatable>
 		<binding>
@@ -346,7 +347,7 @@
 	</button>
 
 	<button n="18">
-		<name>Countermeasures Management Switch (CMS) push</name>
+		<name>grey cursor (CMS) push</name>
 		<desc>center view,  +mod: centered cockpit view</desc>
 		<binding>
 			<command>nasal</command>
diff --git a/Input/Joysticks/ThrustMaster/Warthog-Throttle.xml b/Input/Joysticks/ThrustMaster/Warthog/Warthog-Throttle.xml
similarity index 95%
rename from Input/Joysticks/ThrustMaster/Warthog-Throttle.xml
rename to Input/Joysticks/ThrustMaster/Warthog/Warthog-Throttle.xml
index 8b5dbc672..3a81acb99 100644
--- a/Input/Joysticks/ThrustMaster/Warthog-Throttle.xml
+++ b/Input/Joysticks/ThrustMaster/Warthog/Warthog-Throttle.xml
@@ -1,7 +1,8 @@
 <?xml version="1.0"?>
 <!--
 	Copyright (c) 2011   Melchior FRANZ   mfranz # aon : at
-	Work In Progress
+
+	This driver supports joystick overlay files (see ./Warthog/README).
 -->
 
 <PropertyList>
@@ -13,10 +14,12 @@
 			var this = cmdarg().getParent();
 			var popup = func gui.popupTip(call(sprintf, arg));
 			var is_helicopter = (var _ = props.globals.getNode("rotors", 0)) != nil and _.getAttribute("children");
+			var aircraft_type = getprop("/sim/type");
+			var overlay = getprop("/input/joysticks/overlay");
 
 			var load_overlay = func(name) {
 				foreach (var dir; [getprop("/sim/fg-home"), getprop("/sim/fg-root")]) {
-					var file = dir ~ "/Input/Joysticks/ThrustMaster/Warthog/Throttle/" ~ name;
+					var file = dir ~ "/Input/Joysticks/ThrustMaster/Warthog/Throttle/" ~ name ~ ".xml";
 					if (io.stat(file) != nil) {
 						printlog("info", "WARTHOG: loading overlay " ~ file);
 						cmdarg().getNode("script").setValue("");
@@ -41,10 +44,14 @@
 			var left_engines = [0, 2, 4, 6, 8, 10];
 			var right_engines = [1, 3, 5, 7, 9, 11];
 
-			load_overlay("generic.xml");
+			load_overlay("generic");
 			if (is_helicopter)
-				load_overlay("helicopter.xml");
-			load_overlay(getprop("/sim/aircraft") ~ ".xml");
+				load_overlay("helicopter");
+			if (aircraft_type)
+				load_overlay(aircraft_type);
+			if (overlay)
+				load_overlay(overlay);
+			load_overlay(getprop("/sim/aircraft"));
 		</script>
 	</nasal>
 
@@ -98,7 +105,7 @@
 	</axis>
 
 	<axis n="5">
-		<name>Coolie Switch Horizontal</name>
+		<name>Hat Switch Horizontal</name>
 		<desc>adjust mixture: left = leaner, right = fatter</desc>
 		<number>
 			<unix>5</unix>
@@ -122,7 +129,7 @@
 	</axis>
 
 	<axis n="6">
-		<name>Coolie Switch Vertical</name>
+		<name>Hat Switch Vertical</name>
 		<desc>adjust propeller pitch: forward = increase, backward = decrease</desc>
 		<number>
 			<unix>6</unix>

From 8fd08c7e030adb6bbe4f371fc463d20bd21e31e2 Mon Sep 17 00:00:00 2001
From: Melchior FRANZ <mfranz@aon.at>
Date: Thu, 15 Sep 2011 21:38:14 +0200
Subject: [PATCH 2/2] warthog: add missing file

---
 Input/Joysticks/ThrustMaster/Warthog/README | 35 +++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Input/Joysticks/ThrustMaster/Warthog/README

diff --git a/Input/Joysticks/ThrustMaster/Warthog/README b/Input/Joysticks/ThrustMaster/Warthog/README
new file mode 100644
index 000000000..fc0e4d898
--- /dev/null
+++ b/Input/Joysticks/ThrustMaster/Warthog/README
@@ -0,0 +1,35 @@
+("Master files") Warthog-Stick.xml and Warthog-Throttle.xml support
+configuration overlay files. These are optional and can be used to
+modify the default configuration. Warthog-Stick.xml searches for
+overlay files in
+
+  {$FG_HOME,$FG_ROOT}/Input/Joysticks/ThrustMaster/Warthog/Stick/
+
+and Warthog-Throttle.xml in
+
+  {$FG_HOME,$FG_ROOT}/Input/Joysticks/ThrustMaster/Warthog/Throttle/
+
+
+Available files are loaded in the following order, where <x> is replaced
+by the contents of property "x":
+
+  - generic.xml
+  - helicopter.xml  (only helicopters)
+  - </sim/type>.xml  (some aircraft set this property to "seaplane")
+  - </input/joysticks/overlay>.xml  (not used by the system; meant to
+               be set on the command line or in wrapper scripts,
+               for example: --prop:input/joysticks/overlay=modern_jet)
+  - </sim/aircraft>.xml  (aircraft name, for example "harrier.xml")
+
+
+If a file is found under $FG_HOME, then an equally named file under
+$FG_ROOT will be ignored.
+
+Overlay files are like stripped down joystick driver files, but shall
+not have a <name> entry. They only need to define what should differ
+from the already loaded joystick configuration. Make sure that an
+axis definition uses the same index as the master file. The n-th
+<axis> in an XML config file usually has index n, even if the axis
+uses <number><unix> etc. Nasal blocks are properly executed in the
+namespace of the master file, so you can access all its functions
+and variables.