]> git.mxchange.org Git - flightgear.git/blobdiff - src/Navaids/positioned.cxx
Remove /sim/paths/use-custom-scenery-data.
[flightgear.git] / src / Navaids / positioned.cxx
index 591f52e45f0bf48344e4ef698df67a1217e50ad5..7aa183eba02be4a831f782f39b433c4871b210fc 100644 (file)
 #include <set>
 #include <algorithm> // for sort
 #include <queue>
+#include <memory>
 
 #include <boost/algorithm/string/case_conv.hpp>
 #include <boost/algorithm/string/predicate.hpp>
 
+#include <osg/Math> // for osg::isNaN
+
 #include <simgear/timing/timestamp.hxx>
+#include <simgear/props/props.hxx>
 #include <simgear/debug/logstream.hxx>
 #include <simgear/structure/exception.hxx>
 #include <simgear/math/SGGeometry.hxx>
+#include <simgear/sg_inlines.h>
+#include <simgear/structure/commands.hxx>
 
-
+#include "PositionedBinding.hxx"
+#include "Airports/simple.hxx"
+#include "Main/fg_props.hxx"
 
 typedef std::multimap<std::string, FGPositioned*> NamedPositionedIndex;
 typedef std::pair<NamedPositionedIndex::const_iterator, NamedPositionedIndex::const_iterator> NamedIndexRange;
@@ -357,13 +365,17 @@ addToIndices(FGPositioned* aPos)
 {
   assert(aPos);
   if (!aPos->ident().empty()) {
+    std::string u(boost::to_upper_copy(aPos->ident()));
+    
     global_identIndex.insert(global_identIndex.begin(), 
-      std::make_pair(aPos->ident(), aPos));
+      std::make_pair(u, aPos));
   }
   
   if (!aPos->name().empty()) {
+    std::string u(boost::to_upper_copy(aPos->name()));
+    
     global_nameIndex.insert(global_nameIndex.begin(), 
-                             std::make_pair(aPos->name(), aPos));
+                             std::make_pair(u, aPos));
   }
 
   if (!Octree::global_spatialOctree) {
@@ -380,8 +392,9 @@ removeFromIndices(FGPositioned* aPos)
   assert(aPos);
   
   if (!aPos->ident().empty()) {
-    NamedPositionedIndex::iterator it = global_identIndex.find(aPos->ident());
-    while (it != global_identIndex.end() && (it->first == aPos->ident())) {
+    std::string u(boost::to_upper_copy(aPos->ident()));
+    NamedPositionedIndex::iterator it = global_identIndex.find(u);
+    while (it != global_identIndex.end() && (it->first == u)) {
       if (it->second == aPos) {
         global_identIndex.erase(it);
         break;
@@ -392,8 +405,9 @@ removeFromIndices(FGPositioned* aPos)
   }
   
   if (!aPos->name().empty()) {
-    NamedPositionedIndex::iterator it = global_nameIndex.find(aPos->name());
-    while (it != global_nameIndex.end() && (it->first == aPos->name())) {
+    std::string u(boost::to_upper_copy(aPos->name()));
+    NamedPositionedIndex::iterator it = global_nameIndex.find(u);
+    while (it != global_nameIndex.end() && (it->first == u)) {
       if (it->second == aPos) {
         global_nameIndex.erase(it);
         break;
@@ -415,50 +429,51 @@ public:
   }
 };
 
-/**
- * A special purpose helper (imported by FGAirport::searchNamesAndIdents) to
- * implement the AirportList dialog. It's unfortunate that it needs to reside
- * here, but for now it's least ugly solution.
- */
-char** searchAirportNamesAndIdents(const std::string& aFilter)
+void findInIndex(NamedPositionedIndex& aIndex, const std::string& aFind, std::vector<FGPositioned*>& aResult)
 {
-  const std::ctype<char> &ct = std::use_facet<std::ctype<char> >(std::locale());
-  std::string filter(aFilter);
-  bool hasFilter = !filter.empty();
-  if (hasFilter) {
-    ct.toupper((char *)filter.data(), (char *)filter.data() + filter.size());
-  }
-  
-  NamedPositionedIndex::const_iterator it = global_identIndex.begin();
-  NamedPositionedIndex::const_iterator end = global_identIndex.end();
-  
-  // note this is a vector of raw pointers, not smart pointers, because it
-  // may get very large and smart-pointer-atomicity-locking then becomes a
-  // bottleneck for this case.
-  std::vector<FGPositioned*> matches;
-  std::string upper;
-  
+  NamedPositionedIndex::const_iterator it = aIndex.begin();
+  NamedPositionedIndex::const_iterator end = aIndex.end();
+
+  bool haveFilter = !aFind.empty();
+
   for (; it != end; ++it) {
     FGPositioned::Type ty = it->second->type();
     if ((ty < FGPositioned::AIRPORT) || (ty > FGPositioned::SEAPORT)) {
       continue;
     }
     
-    if (hasFilter && (it->second->ident().find(aFilter) == std::string::npos)) {
-      upper = it->second->name(); // string copy, sadly
-      ct.toupper((char *)upper.data(), (char *)upper.data() + upper.size());
-      if (upper.find(aFilter) == std::string::npos) {
-        continue;
-      }
+    if (haveFilter && it->first.find(aFind) == std::string::npos) {
+      continue;
     }
     
-    matches.push_back(it->second);
+    aResult.push_back(it->second);
+  } // of index iteration
+}
+
+/**
+ * A special purpose helper (imported by FGAirport::searchNamesAndIdents) to
+ * implement the AirportList dialog. It's unfortunate that it needs to reside
+ * here, but for now it's least ugly solution.
+ */
+char** searchAirportNamesAndIdents(const std::string& aFilter)
+{
+// note this is a vector of raw pointers, not smart pointers, because it
+// may get very large and smart-pointer-atomicity-locking then becomes a
+// bottleneck for this case.
+  std::vector<FGPositioned*> matches;
+  if (!aFilter.empty()) {
+    std::string filter = boost::to_upper_copy(aFilter);
+    findInIndex(global_identIndex, filter, matches);
+    findInIndex(global_nameIndex, filter, matches);
+  } else {
+    
+    findInIndex(global_identIndex, std::string(), matches);
   }
   
-  // sort alphabetically on name
+// sort alphabetically on name
   std::sort(matches.begin(), matches.end(), OrderByName());
   
-  // convert results to format comptible with puaList
+// convert results to format comptible with puaList
   unsigned int numMatches = matches.size();
   char** result = new char*[numMatches + 1];
   result[numMatches] = NULL; // end-of-list marker
@@ -493,6 +508,15 @@ char** searchAirportNamesAndIdents(const std::string& aFilter)
   return result;
 }
 
+static void validateSGGeod(const SGGeod& geod)
+{
+  if (osg::isNaN(geod.getLatitudeDeg()) ||
+      osg::isNaN(geod.getLongitudeDeg()))
+  {
+    throw sg_range_exception("position is invalid, NaNs");
+  }
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 
 bool
@@ -511,17 +535,27 @@ FGPositioned::Filter::passType(Type aTy) const
 
 static FGPositioned::List 
 findAll(const NamedPositionedIndex& aIndex, 
-                             const std::string& aName, FGPositioned::Filter* aFilter)
+                             const std::string& aName,
+                             FGPositioned::Filter* aFilter,
+                             bool aExact)
 {
   FGPositioned::List result;
   if (aName.empty()) {
     return result;
   }
   
-  std::string upperBoundId = aName;
-  upperBoundId[upperBoundId.size()-1]++;
-  NamedPositionedIndex::const_iterator upperBound = aIndex.lower_bound(upperBoundId);
-  NamedPositionedIndex::const_iterator it = aIndex.lower_bound(aName);
+  std::string name = boost::to_upper_copy(aName);
+  NamedPositionedIndex::const_iterator upperBound;
+  
+  if (aExact) {
+    upperBound = aIndex.upper_bound(name);
+  } else {
+    std::string upperBoundId = name;
+    upperBoundId[upperBoundId.size()-1]++;
+    upperBound = aIndex.lower_bound(upperBoundId);
+  }
+  
+  NamedPositionedIndex::const_iterator it = aIndex.lower_bound(name);
   
   for (; it != upperBound; ++it) {
     FGPositionedRef candidate = it->second;
@@ -600,7 +634,15 @@ FGPositioned::Type FGPositioned::typeFromName(const std::string& aName)
     {"fix", FIX},
     {"tacan", TACAN},
     {"dme", DME},
+    {"atis", FREQ_ATIS},
+    {"awos", FREQ_AWOS},
+    {"tower", FREQ_TOWER},
+    {"ground", FREQ_GROUND},
+    {"approach", FREQ_APP_DEP},
+    {"departure", FREQ_APP_DEP},
   // aliases
+    {"gnd", FREQ_GROUND},
+    {"twr", FREQ_TOWER},
     {"waypoint", WAYPOINT},
     {"apt", AIRPORT},
     {"arpt", AIRPORT},
@@ -644,18 +686,33 @@ const char* FGPositioned::nameForType(Type aTy)
  case WAYPOINT: return "waypoint";
  case DME: return "dme";
  case TACAN: return "tacan";
+ case FREQ_TOWER: return "tower";
+ case FREQ_ATIS: return "atis";
+ case FREQ_AWOS: return "awos";
+ case FREQ_GROUND: return "ground";
+ case FREQ_CLEARANCE: return "clearance";
+ case FREQ_UNICOM: return "unicom";
+ case FREQ_APP_DEP: return "approach-departure";
  default:
   return "unknown";
  }
 }
 
+flightgear::PositionedBinding*
+FGPositioned::createBinding(SGPropertyNode* node) const
+{
+    return new flightgear::PositionedBinding(this, node);
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // search / query functions
 
 FGPositionedRef
 FGPositioned::findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter)
 {
-  FGPositioned::List r(findAll(global_identIndex, aIdent, aFilter));
+  validateSGGeod(aPos);
+
+  FGPositioned::List r(findAll(global_identIndex, aIdent, aFilter, true));
   if (r.empty()) {
     return FGPositionedRef();
   }
@@ -667,6 +724,8 @@ FGPositioned::findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos
 FGPositioned::List
 FGPositioned::findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter)
 {
+  validateSGGeod(aPos);
+
   List result;
   Octree::findAllWithinRange(SGVec3d::fromGeod(aPos), 
     aRangeNm * SG_NM_TO_METER, aFilter, result);
@@ -674,32 +733,36 @@ FGPositioned::findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilt
 }
 
 FGPositioned::List
-FGPositioned::findAllWithIdent(const std::string& aIdent, Filter* aFilter)
+FGPositioned::findAllWithIdent(const std::string& aIdent, Filter* aFilter, bool aExact)
 {
-  return findAll(global_identIndex, aIdent, aFilter);
+  return findAll(global_identIndex, aIdent, aFilter, aExact);
 }
 
 FGPositioned::List
-FGPositioned::findAllWithName(const std::string& aName, Filter* aFilter)
+FGPositioned::findAllWithName(const std::string& aName, Filter* aFilter, bool aExact)
 {
-  return findAll(global_nameIndex, aName, aFilter);
+  return findAll(global_nameIndex, aName, aFilter, aExact);
 }
 
 FGPositionedRef
 FGPositioned::findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter)
 {
-   List l(findClosestN(aPos, 1, aCutoffNm, aFilter));
-   if (l.empty()) {
-      return NULL;
-   }
-   
-   assert(l.size() == 1);
-   return l.front();
+  validateSGGeod(aPos);
+  
+  List l(findClosestN(aPos, 1, aCutoffNm, aFilter));
+  if (l.empty()) {
+    return NULL;
+  }
+
+  assert(l.size() == 1);
+  return l.front();
 }
 
 FGPositioned::List
 FGPositioned::findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter)
 {
+  validateSGGeod(aPos);
+  
   List result;
   Octree::findNearestN(SGVec3d::fromGeod(aPos), aN, aCutoffNm * SG_NM_TO_METER, aFilter, result);
   return result;
@@ -755,6 +818,8 @@ FGPositioned::findNextWithPartialId(FGPositionedRef aCur, const std::string& aId
 void
 FGPositioned::sortByRange(List& aResult, const SGGeod& aPos)
 {
+  validateSGGeod(aPos);
+  
   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
 // computer ordering values
   Octree::FindNearestResults r;
@@ -773,3 +838,145 @@ FGPositioned::sortByRange(List& aResult, const SGGeod& aPos)
     aResult[i] = r[i].get();
   }
 }
+
+FGPositioned::Filter* createSearchFilter(const SGPropertyNode* arg)
+{
+    string sty(arg->getStringValue("type", "any"));
+    FGPositioned::Type ty = FGPositioned::typeFromName(sty);
+    double minRunwayLenFt = arg->getDoubleValue("min-runway-length-ft", -1.0);
+    
+    if ((ty == FGPositioned::AIRPORT) && (minRunwayLenFt > 0.0)) {
+        return new FGAirport::HardSurfaceFilter(minRunwayLenFt);
+    } else if (ty != FGPositioned::INVALID) {
+        FGPositioned::TypeFilter* tf = new FGPositioned::TypeFilter(ty);
+        
+        for (int t=1; arg->hasChild("type", t); ++t) {
+            sty = arg->getChild("type", t)->getStringValue();
+            tf->addType(FGPositioned::typeFromName(sty));
+        }
+        
+        return tf;
+    }
+    
+    return NULL;
+}
+
+static SGGeod commandSearchPos(const SGPropertyNode* arg)
+{
+    if (arg->hasChild("longitude-deg") && arg->hasChild("latitude-deg")) {
+        return SGGeod::fromDeg(arg->getDoubleValue("longitude-deg"),
+            arg->getDoubleValue("latitude-deg"));
+    }
+    
+    // use current viewer/aircraft position
+    return SGGeod::fromDeg(fgGetDouble("/position/longitude-deg"), 
+            fgGetDouble("/position/latitude-deg"));
+}
+
+void commandClearExisting(const SGPropertyNode* arg)
+{
+    if (arg->getBoolValue("clear", true)) {
+    // delete all existing result children from their parent
+        string resultPath = arg->getStringValue("results");
+        SGPropertyNode* n = fgGetNode(resultPath.c_str(), 0, true);
+        SGPropertyNode* pr = n->getParent();
+        pr->removeChildren(n->getName(), false /* keep=false, i.e delete nodes */);
+    }
+}
+
+bool commandFindClosest(const SGPropertyNode* arg)
+{
+    int n = arg->getIntValue("max-results", 1);
+    if ((n < 1) || (n > 100)) {
+        SG_LOG(SG_GENERAL, SG_WARN, "commandFindClosest: max-results invalid:" << n);
+        return false;
+    }
+    
+    string resultPath = arg->getStringValue("results");
+    if (resultPath.empty()) {
+        SG_LOG(SG_GENERAL, SG_WARN, "commandFindClosest: no results path defined");
+        return false;
+    }
+
+    std::auto_ptr<FGPositioned::Filter> filt(createSearchFilter(arg));    
+// cap search range, since huge ranges will overload everything
+    double cutoff = arg->getDoubleValue("cutoff-nm", 400.0);
+    SG_CLAMP_RANGE(cutoff, 0.0, 1000.0);
+    
+    SGGeod pos = commandSearchPos(arg);
+    commandClearExisting(arg);
+    
+    FGPositioned::List results = FGPositioned::findClosestN(pos, n, cutoff, filt.get());
+    for (unsigned int i=0; i<results.size(); ++i) {
+       SGPropertyNode* resultsNode = fgGetNode(resultPath.c_str(), i, true);
+       flightgear::PositionedBinding::bind(results[i], resultsNode);
+    }
+    
+    return true;
+}
+
+bool commandFindByIdent(const SGPropertyNode* arg)
+{
+    string resultPath = arg->getStringValue("results");
+    if (resultPath.empty()) {
+        SG_LOG(SG_GENERAL, SG_WARN, "commandFindByIdent: no results path defined");
+        return false;
+    }
+    
+    std::auto_ptr<FGPositioned::Filter> filt(createSearchFilter(arg));    
+    SGGeod pos = commandSearchPos(arg);
+    commandClearExisting(arg);
+    
+    FGPositioned::List results;
+    bool exact = arg->getBoolValue("exact", true);
+    if (arg->hasChild("name")) {
+        results = FGPositioned::findAllWithName(arg->getStringValue("name"), filt.get(), exact);
+    } else if (arg->hasChild("ident")) {
+        results = FGPositioned::findAllWithIdent(arg->getStringValue("ident"), filt.get(), exact);
+    } else {
+        SG_LOG(SG_GENERAL, SG_WARN, "commandFindByIdent: no search term defined");
+        return false;
+    }
+    
+    bool orderByRange = arg->getBoolValue("order-by-distance", true);
+    if (orderByRange) {
+        FGPositioned::sortByRange(results, pos);
+    }
+      
+    for (unsigned int i=0; i<results.size(); ++i) {
+       SGPropertyNode* resultsNode = fgGetNode(resultPath.c_str(), i, true);
+       flightgear::PositionedBinding::bind(results[i], resultsNode);
+    }
+      
+    return true;
+}
+
+void
+FGPositioned::installCommands()
+{
+    SGCommandMgr::instance()->addCommand("find-nearest", commandFindClosest);
+    SGCommandMgr::instance()->addCommand("find-by-ident", commandFindByIdent);
+}
+
+FGPositioned::TypeFilter::TypeFilter(Type aTy)
+{
+    types.push_back(aTy);
+}
+
+void FGPositioned::TypeFilter::addType(Type aTy)
+{
+    types.push_back(aTy);
+}
+
+bool
+FGPositioned::TypeFilter::pass(FGPositioned* aPos) const
+{
+    std::vector<Type>::const_iterator it = types.begin(),
+        end = types.end();
+    for (; it != end; ++it) {
+        return aPos->type() == *it;
+    }
+    
+    return false;
+}
+