1 // fgjs.cxx -- assign joystick axes to flightgear properties
3 // Updated to allow xml output & added a few bits & pieces
4 // Laurie Bradshaw, Jun 2005
6 // Written by Tony Peden, started May 2001
8 // Copyright (C) 2001 Tony Peden (apeden@earthlink.net)
9 // Copyright (C) 2006 Stefan Seifert
11 // This program is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU General Public License as
13 // published by the Free Software Foundation; either version 2 of the
14 // License, or (at your option) any later version.
16 // This program is distributed in the hope that it will be useful, but
17 // WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // General Public License for more details.
21 // You should have received a copy of the GNU General Public License
22 // along with this program; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
29 #include <simgear/compiler.h>
41 SG_USING_STD(fstream);
48 #include <simgear/constants.h>
49 #include <simgear/debug/logstream.hxx>
50 #include <simgear/misc/sg_path.hxx>
51 #include <simgear/misc/sgstream.hxx>
52 #include <simgear/structure/exception.hxx>
54 #include <Main/fg_io.hxx>
55 #include <Main/fg_props.hxx>
56 #include <Main/globals.hxx>
61 bool confirmAnswer() {
64 cout << "Is this correct? (y/n) $ ";
66 cin.ignore(256, '\n');
74 string getFGRoot( int argc, char *argv[] );
76 int main( int argc, char *argv[] ) {
78 for (int i = 1; i < argc; i++) {
79 if (strcmp("--help", argv[i]) == 0) {
80 cout << "Usage:" << endl;
81 cout << " --help\t\t\tShow this help" << endl;
84 cout << "Unknown option \"" << argv[i] << "\"" << endl;
91 jsSuper *jss = new jsSuper();
92 jsInput *jsi = new jsInput(jss);
93 jsi->displayValues(false);
95 cout << "Found " << jss->getNumJoysticks() << " joystick(s)" << endl;
97 if(jss->getNumJoysticks() <= 0) {
98 cout << "Can't find any joysticks ..." << endl;
101 cout << endl << "Now measuring the dead band of your joystick. The dead band is the area " << endl
102 << "where the joystick is centered and should not generate any input. Move all " << endl
103 << "axes around in this dead zone during the ten seconds this test will take." << endl;
104 cout << "Press enter to continue." << endl;
105 cin.ignore(1024, '\n');
107 cout << endl << "Dead band calibration finished. Press enter to start control assignment." << endl;
108 cin.ignore(1024, '\n');
110 jss->firstJoystick();
111 fstream *xfs = new fstream[ jss->getNumJoysticks() ];
112 SGPropertyNode_ptr *jstree = new SGPropertyNode_ptr[ jss->getNumJoysticks() ];
114 cout << "Joystick #" << jss->getCurrentJoystickId()
115 << " \"" << jss->getJoystick()->getName() << "\" has "
116 << jss->getJoystick()->getNumAxes() << " axes" << endl;
119 snprintf(filename, 16, "js%i.xml", jss->getCurrentJoystickId());
120 xfs[ jss->getCurrentJoystickId() ].open(filename, ios::out);
121 jstree[ jss->getCurrentJoystickId() ] = new SGPropertyNode();
122 } while ( jss->nextJoystick() );
124 SGPath templatefile( getFGRoot(argc, argv) );
125 templatefile.append("Input");
126 templatefile.append("Joysticks");
127 templatefile.append("template.xml");
129 SGPropertyNode *templatetree = new SGPropertyNode();
131 readProperties(templatefile.str().c_str(), templatetree);
132 } catch (sg_io_exception e) {
133 cout << e.getFormattedMessage ();
136 vector<SGPropertyNode_ptr> axes = templatetree->getChildren("axis");
137 for(vector<SGPropertyNode_ptr>::iterator iter = axes.begin(); iter != axes.end(); iter++) {
138 cout << "Move the control you wish to use for " << (*iter)->getStringValue("desc")
139 << " " << (*iter)->getStringValue("direction") << endl;
140 cout << "Pressing a button skips this axis" << endl;
143 if (jsi->getInputAxis() != -1) {
144 cout << endl << "Assigned axis " << jsi->getInputAxis()
145 << " on joystick " << jsi->getInputJoystick()
146 << " to control " << (*iter)->getStringValue("desc") << endl;
147 if ( confirmAnswer() ) {
148 SGPropertyNode *axis = jstree[ jsi->getInputJoystick() ]->getChild("axis", jsi->getInputAxis(), true);
149 copyProperties(*iter, axis);
150 axis->setDoubleValue("dead-band", jss->getJoystick(jsi->getInputJoystick())
151 ->getDeadBand(jsi->getInputAxis()));
152 axis->setDoubleValue("binding/factor", jsi->getInputAxisPositive() ? 1.0 : -1.0);
157 cout << "Skipping control" << endl;
158 if ( ! confirmAnswer() )
164 vector<SGPropertyNode_ptr> buttons = templatetree->getChildren("button");
165 for(vector<SGPropertyNode_ptr>::iterator iter = buttons.begin(); iter != buttons.end(); iter++) {
166 cout << "Press the button you wish to use for " << (*iter)->getStringValue("desc") << endl;
167 cout << "Moving a joystick axis skips this button" << endl;
170 if (jsi->getInputButton() != -1) {
171 cout << endl << "Assigned button " << jsi->getInputButton()
172 << " on joystick " << jsi->getInputJoystick()
173 << " to control " << (*iter)->getStringValue("desc") << endl;
174 if ( confirmAnswer() ) {
175 SGPropertyNode *button = jstree[ jsi->getInputJoystick() ]->getChild("button", jsi->getInputButton(), true);
176 copyProperties(*iter, button);
181 cout << "Skipping control" << endl;
182 if (! confirmAnswer())
188 cout << "Your joystick settings are in ";
189 for (int i = 0; i < jss->getNumJoysticks(); i++) {
191 cout << "js" << i << ".xml";
192 if (i + 2 < jss->getNumJoysticks())
194 else if (i + 1 < jss->getNumJoysticks())
197 jstree[i]->setStringValue("name", jss->getJoystick(i)->getName());
198 writeProperties(xfs[i], jstree[i], true);
199 } catch (sg_io_exception e) {
200 cout << e.getFormattedMessage ();
204 cout << "." << endl << "Check and edit as desired. Once you are happy," << endl
205 << "move relevant js<n>.xml files to $FG_ROOT/Input/Joysticks/ (if you didn't use" << endl
206 << "an attached controller, you don't need to move the corresponding file)" << endl;
215 char *homedir = ::getenv( "HOME" );
216 char *hostname = ::getenv( "HOSTNAME" );
217 bool free_hostname = false;
219 // Scan the command line options for the specified option and return
221 static string fgScanForOption( const string& option, int argc, char **argv ) {
224 if (hostname == NULL)
227 gethostname(_hostname, 256);
228 hostname = strdup(_hostname);
229 free_hostname = true;
232 SG_LOG(SG_GENERAL, SG_INFO, "Scanning command line for: " << option );
234 int len = option.length();
237 SG_LOG( SG_GENERAL, SG_DEBUG, "argv[" << i << "] = " << argv[i] );
239 string arg = argv[i];
240 if ( arg.find( option ) == 0 ) {
241 return arg.substr( len );
250 // Scan the user config files for the specified option and return
252 static string fgScanForOption( const string& option, const string& path ) {
253 sg_gzifstream in( path );
254 if ( !in.is_open() ) {
258 SG_LOG( SG_GENERAL, SG_INFO, "Scanning " << path << " for: " << option );
260 int len = option.length();
264 while ( ! in.eof() ) {
267 while ( in.get(c) && c != '\0' ) {
272 #if defined( macintosh )
273 getline( in, line, '\r' );
275 getline( in, line, '\n' );
278 // catch extraneous (DOS) line ending character
279 if ( line[line.length() - 1] < 32 ) {
280 line = line.substr( 0, line.length()-1 );
283 if ( line.find( option ) == 0 ) {
284 return line.substr( len );
293 // Scan the user config files for the specified option and return
295 static string fgScanForOption( const string& option ) {
298 #if defined( unix ) || defined( __CYGWIN__ )
299 // Next check home directory for .fgfsrc.hostname file
301 if ( homedir != NULL ) {
302 SGPath config( homedir );
303 config.append( ".fgfsrc" );
304 config.concat( "." );
305 config.concat( hostname );
306 arg = fgScanForOption( option, config.str() );
311 // Next check home directory for .fgfsrc file
313 if ( homedir != NULL ) {
314 SGPath config( homedir );
315 config.append( ".fgfsrc" );
316 arg = fgScanForOption( option, config.str() );
323 // Read in configuration (files and command line options) but only set
325 string getFGRoot ( int argc, char **argv ) {
328 // First parse command line options looking for --fg-root=, this
329 // will override anything specified in a config file
330 root = fgScanForOption( "--fg-root=", argc, argv);
332 // Check in one of the user configuration files.
334 root = fgScanForOption( "--fg-root=" );
336 // Next check if fg-root is set as an env variable
337 if ( root.empty() ) {
338 char *envp = ::getenv( "FG_ROOT" );
339 if ( envp != NULL ) {
344 // Otherwise, default to a random compiled-in location if we can't
345 // find fg-root any other way.
346 if ( root.empty() ) {
347 #if defined( __CYGWIN__ )
348 root = "/FlightGear";
349 #elif defined( WIN32 )
350 root = "\\FlightGear";
351 #elif defined(OSX_BUNDLE)
352 /* the following code looks for the base package directly inside
353 the application bundle. This can be changed fairly easily by
354 fiddling with the code below. And yes, I know it's ugly and verbose.
356 CFBundleRef appBundle = CFBundleGetMainBundle();
357 CFURLRef appUrl = CFBundleCopyBundleURL(appBundle);
358 CFRelease(appBundle);
360 // look for a 'data' subdir directly inside the bundle : is there
361 // a better place? maybe in Resources? I don't know ...
362 CFURLRef dataDir = CFURLCreateCopyAppendingPathComponent(NULL, appUrl, CFSTR("data"), true);
364 // now convert down to a path, and the a c-string
365 CFStringRef path = CFURLCopyFileSystemPath(dataDir, kCFURLPOSIXPathStyle);
366 root = CFStringGetCStringPtr(path, CFStringGetSystemEncoding());
369 CFRelease(appBundle);
377 SG_LOG(SG_INPUT, SG_INFO, "fg_root = " << root );