src/ATC/atcdialog.cxx

   1 // atcdialog.cxx - classes to manage user interactions with AI traffic
   2 // Written by Durk Talsma, started April 3, 2011
   3 // Based on earlier code written by Alexander Kappes and David Luff
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 //
  19 // $Id$
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include "config.h"
  23 #endif
  24
  25 #include "atcdialog.hxx"
  26
  27 #include <boost/foreach.hpp>
  28
  29 #include <simgear/constants.h>
  30 #include <simgear/structure/commands.hxx>
  31 #include <simgear/compiler.h>
  32 #include <simgear/props/props.hxx>
  33 #include <simgear/props/props_io.hxx>
  34 #include <simgear/misc/sgstream.hxx>
  35 #include <simgear/math/sg_geodesy.hxx>
  36 #include <simgear/debug/logstream.hxx>
  37 #include <simgear/structure/SGSharedPtr.hxx>
  38
  39 #include <Main/fg_commands.hxx>
  40 #include <Main/globals.hxx>
  41 #include <Main/fg_props.hxx>
  42 #include <GUI/gui.h>            // mkDialog
  43 #include <GUI/new_gui.hxx>
  44 #include <Airports/airport.hxx>
  45 #include <ATC/CommStation.hxx>
  46
  47 using std::string;
  48
  49 static SGPropertyNode *getNamedNode(SGPropertyNode *prop, const char *name)
  50 {
  51   SGPropertyNode* p;
  52
  53   for (int i = 0; i < prop->nChildren(); i++)
  54     if ((p = getNamedNode(prop->getChild(i), name)))
  55       return p;
  56
  57   if (!strcmp(prop->getStringValue("name"), name))
  58     return prop;
  59   return 0;
  60 }
  61
  62 static void atcUppercase(string &s) {
  63         for(unsigned int i=0; i<s.size(); ++i) {
  64                 s[i] = toupper(s[i]);
  65         }
  66 }
  67
  68 class AirportsWithATC : public FGAirport::AirportFilter
  69 {
  70 public:
  71   virtual FGPositioned::Type maxType() const {
  72     return FGPositioned::SEAPORT;
  73   }
  74
  75   virtual bool passAirport(FGAirport* aApt) const
  76   {
  77     return (!aApt->commStations().empty());
  78   }
  79 };
  80
  81 void FGATCDialogNew::frequencySearch()
  82 {
  83         const char *dialog_name = "atc-freq-search";
  84         SGPropertyNode_ptr dlg = _gui->getDialogProperties(dialog_name);
  85         if (!dlg)
  86                 return;
  87
  88         _gui->closeDialog(dialog_name);
  89
  90         SGPropertyNode_ptr button_group = getNamedNode(dlg, "quick-buttons");
  91         // remove all dynamic airport/ATC buttons
  92         button_group->removeChildren("button", false);
  93
  94   AirportsWithATC filt;
  95   FGPositionedList results = FGPositioned::findWithinRange(globals->get_aircraft_position(), 50.0, &filt);
  96   FGPositioned::sortByRange(results, globals->get_aircraft_position());
  97   for (unsigned int r=0; (r<results.size()) && (r < 6); ++r) {
  98
  99     SGPropertyNode *entry = button_group->getNode("button", r, true);
 100                 copyProperties(button_group->getNode("button-template", true), entry);
 101                 entry->removeChildren("enabled", true);
 102                 entry->setStringValue("legend", results[r]->ident());
 103                 entry->setStringValue("binding[0]/icao", results[r]->ident());
 104   }
 105
 106         // (un)hide message saying no things in range
 107         SGPropertyNode_ptr range_error = getNamedNode(dlg, "no-atc-in-range");
 108         range_error->setBoolValue("visible", !results.empty());
 109
 110         _gui->showDialog(dialog_name);
 111 }
 112
 113 void FGATCDialogNew::frequencyDisplay(const std::string& ident)
 114 {
 115         const char *dialog_name = "atc-freq-display";
 116         SGPropertyNode_ptr dlg = _gui->getDialogProperties(dialog_name);
 117         if (!dlg)
 118                 return;
 119
 120         _gui->closeDialog(dialog_name);
 121
 122         SGPropertyNode_ptr freq_group = getNamedNode(dlg, "frequency-list");
 123         // remove all frequency entries
 124         freq_group->removeChildren("group", false);
 125
 126   std::string uident(ident);
 127         atcUppercase(uident);
 128         string label;
 129
 130         const FGAirport *a = fgFindAirportID(uident);
 131         if (!a) {
 132                 label = "Airport " + ident + " not found in database.";
 133                 mkDialog(label.c_str());
 134                 return;
 135         }
 136
 137         // set title
 138         label = uident + " Frequencies";
 139         dlg->setStringValue("text/label", label.c_str());
 140
 141   const flightgear::CommStationList& comms(a->commStations());
 142   if (comms.empty()) {
 143     label = "No frequencies found for airport " + uident;
 144                 mkDialog(label.c_str());
 145                 return;
 146   }
 147
 148   for (unsigned int c=0; c < comms.size(); ++c) {
 149     flightgear::CommStation* comm = comms[c];
 150
 151     // add frequency line (modified copy of <group-template>)
 152                 SGPropertyNode *entry = freq_group->getNode("group", c, true);
 153                 copyProperties(freq_group->getNode("group-template", true), entry);
 154                 entry->removeChildren("enabled", true);
 155
 156     entry->setStringValue("text[0]/label", comm->ident());
 157
 158                 char buf[8];
 159                 snprintf(buf, 8, "%.2f", comm->freqMHz());
 160                 if(buf[5] == '3') buf[5] = '2';
 161                 if(buf[5] == '8') buf[5] = '7';
 162                 buf[7] = '\0';
 163
 164                 entry->setStringValue("text[1]/label", buf);
 165   }
 166
 167         _gui->showDialog(dialog_name);
 168 }
 169
 170 static bool doFrequencySearch( const SGPropertyNode* )
 171 {
 172   FGATCDialogNew::instance()->frequencySearch();
 173   return true;
 174 }
 175
 176 static bool doFrequencyDisplay( const SGPropertyNode* args )
 177 {
 178   std::string icao = args->getStringValue("icao");
 179   if (icao.empty()) {
 180     icao = fgGetString("/sim/atc/freq-airport");
 181   }
 182
 183   FGATCDialogNew::instance()->frequencyDisplay(icao);
 184   return true;
 185 }
 186
 187 FGATCDialogNew * FGATCDialogNew::_instance = NULL;
 188
 189 FGATCDialogNew::FGATCDialogNew()
 190 : _gui(NULL),
 191    dialogVisible(true)
 192 {
 193 }
 194
 195 FGATCDialogNew::~FGATCDialogNew()
 196 {
 197 }
 198
 199
 200
 201 void FGATCDialogNew::init() {
 202     // Add ATC-dialog to the command list
 203     globals->get_commands()->addCommand("ATC-dialog", FGATCDialogNew::popup );
 204     // Add ATC-freq-search to the command list
 205     globals->get_commands()->addCommand("ATC-freq-search", doFrequencySearch);
 206     globals->get_commands()->addCommand("ATC-freq-display", doFrequencyDisplay);
 207
 208     // initialize properties polled in Update()
 209     //globals->get_props()->setStringValue("/sim/atc/freq-airport", "");
 210     globals->get_props()->setIntValue("/sim/atc/transmission-num", -1);
 211 }
 212
 213
 214
 215 // Display the ATC popup dialog box with options relevant to the users current situation.
 216 //
 217 // So, the first thing we need to do is check the frequency that our pilot's nav radio
 218 // is currently tuned to. The dialog should always contain an option to to tune the
 219 // to a particular frequency,
 220
 221 // Okay, let's see, according to my interpretation of David Luff's original code,
 222 // his ATC subsystem wrote properties to a named node, called "transmission-choice"
 223
 224
 225 void FGATCDialogNew::addEntry(int nr, const std::string& txt) {
 226     commands.clear();
 227     commands.push_back(txt);
 228     commands.push_back(string("Toggle ground network visibility"));
 229 }
 230
 231 void FGATCDialogNew::removeEntry(int nr) {
 232     commands.clear();
 233 }
 234
 235
 236
 237 void FGATCDialogNew::PopupDialog() {
 238     dialogVisible = !dialogVisible;
 239     return;
 240 }
 241
 242 void FGATCDialogNew::update(double dt) {
 243 //  double onBoardRadioFreq0 =
 244 //      fgGetDouble("/instrumentation/comm[0]/frequencies/selected-mhz");
 245 //  double onBoardRadioFreq1 =
 246 //      fgGetDouble("/instrumentation/comm[1]/frequencies/selected-mhz");
 247
 248     const char *dialog_name = "atc-dialog";
 249     _gui = (NewGUI *)globals->get_subsystem("gui");
 250     if (!_gui) {
 251       return;
 252     }
 253
 254     SGPropertyNode_ptr dlg = _gui->getDialogProperties(dialog_name);
 255     if (!dlg)
 256         return;
 257
 258     _gui->closeDialog(dialog_name);
 259     SGPropertyNode_ptr button_group = getNamedNode(dlg, "transmission-choice");
 260     button_group->removeChildren("button", false);
 261
 262     const int bufsize = 32;
 263     char buf[bufsize];
 264     int commandNr = 0;
 265     // loop over all entries that should fill up the dialog; use 10 items for now...
 266     BOOST_FOREACH(const std::string& i, commands) {
 267         snprintf(buf, bufsize, "/sim/atc/opt[%d]", commandNr);
 268             fgSetBool(buf, false);
 269         SGPropertyNode *entry = button_group->getNode("button", commandNr, true);
 270         copyProperties(button_group->getNode("button-template", true), entry);
 271         entry->removeChildren("enabled", true);
 272         entry->setStringValue("property", buf);
 273         entry->setIntValue("keynum", '1' + commandNr);
 274         if (commandNr == 0)
 275             entry->setBoolValue("default", true);
 276
 277         snprintf(buf, bufsize, "%d", 1 + commandNr);
 278         string legend = string(buf) + i; //"; // + current->menuentry;
 279         entry->setStringValue("legend", legend.c_str());
 280         entry->setIntValue("binding/value", commandNr);
 281         commandNr++;
 282         //current++;
 283     }
 284
 285     if (dialogVisible) {
 286         _gui->closeDialog(dialog_name);
 287     } else {
 288         _gui->showDialog(dialog_name);
 289     }
 290 }