]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scripting/NasalPositioned.cxx
Checkpoint - ground-net skips the cache
[flightgear.git] / src / Scripting / NasalPositioned.cxx
index eb572973e015316121a883eff935ee3a0ae49017..275929de2cf38b62204906126312eb08f861a062 100644 (file)
@@ -124,6 +124,17 @@ static naRef stringToNasal(naContext c, const std::string& s)
                    s.length());
 }
 
+static bool convertToNum(naRef v, double& result)
+{
+    naRef n = naNumValue(v);
+    if (naIsNil(n)) {
+        return false; // couldn't convert
+    }
+    
+    result = n.num;
+    return true;
+}
+
 static WayptFlag wayptFlagFromString(const char* s)
 {
   if (!strcmp(s, "sid")) return WPT_DEPARTURE;
@@ -415,11 +426,11 @@ static const char* airportGhostGetMember(naContext c, void* g, naRef field, naRe
 
 static const char* waypointCommonGetMember(naContext c, Waypt* wpt, const char* fieldName, naRef* out)
 {
-  if (!strcmp(fieldName, "wp_name")) *out = stringToNasal(c, wpt->ident());
+  if (!strcmp(fieldName, "wp_name") || !strcmp(fieldName, "id")) *out = stringToNasal(c, wpt->ident());
   else if (!strcmp(fieldName, "wp_type")) *out = stringToNasal(c, wpt->type());
   else if (!strcmp(fieldName, "wp_role")) *out = wayptFlagToNasal(c, wpt->flags());
-  else if (!strcmp(fieldName, "wp_lat")) *out = naNum(wpt->position().getLatitudeDeg());
-  else if (!strcmp(fieldName, "wp_lon")) *out = naNum(wpt->position().getLongitudeDeg());
+  else if (!strcmp(fieldName, "wp_lat") || !strcmp(fieldName, "lat")) *out = naNum(wpt->position().getLatitudeDeg());
+  else if (!strcmp(fieldName, "wp_lon") || !strcmp(fieldName, "lon")) *out = naNum(wpt->position().getLongitudeDeg());
   else if (!strcmp(fieldName, "wp_parent_name")) {
     Procedure* proc = dynamic_cast<Procedure*>(wpt->owner());
     *out = proc ? stringToNasal(c, proc->ident()) : naNil();
@@ -432,6 +443,8 @@ static const char* waypointCommonGetMember(naContext c, Waypt* wpt, const char*
     } else {
       *out = stringToNasal(c, wpt->flag(WPT_OVERFLIGHT) ? "flyOver" : "flyBy");
     }
+  } else if (!strcmp(fieldName, "heading_course")) {
+      *out = naNum(wpt->headingRadialDeg());
   } else {
     return NULL; // member not found
   }
@@ -450,6 +463,10 @@ static void waypointCommonSetMember(naContext c, Waypt* wpt, const char* fieldNa
     }
     
     wpt->setFlag(f, true);
+  } else if (!strcmp(fieldName, "fly_type")) {
+      if (!naIsString(value)) naRuntimeError(c, "fly_type must be a string");
+      bool flyOver = (strcmp(naStr_data(value), "flyOver") == 0);
+      wpt->setFlag(WPT_OVERFLIGHT, flyOver);
   }
 }
 
@@ -497,6 +514,7 @@ static const char* legGhostGetMember(naContext c, void* g, naRef field, naRef* o
   if (!strcmp(fieldName, "parents")) {
     *out = naNewVector(c);
     naVec_append(*out, fpLegPrototype);
+    naVec_append(*out, waypointPrototype);
   } else if (!strcmp(fieldName, "index")) {
     *out = naNum(leg->index());
   } else if (!strcmp(fieldName, "alt_cstr")) {
@@ -555,6 +573,8 @@ static const char* flightplanGhostGetMember(naContext c, void* g, naRef field, n
   else if (!strcmp(fieldName, "star_trans")) *out = ghostForProcedure(c, fp->starTransition());
   else if (!strcmp(fieldName, "approach")) *out = ghostForProcedure(c, fp->approach());
   else if (!strcmp(fieldName, "current")) *out = naNum(fp->currentIndex());
+    else if (!strcmp(fieldName, "aircraftCategory")) *out = stringToNasal(c, fp->icaoAircraftCategory());
+    else if (!strcmp(fieldName, "followLegTrackToFix")) *out = naNum(fp->followLegTrackToFixes());
   else {
     return 0;
   }
@@ -589,6 +609,11 @@ static void flightplanGhostSetMember(naContext c, void* g, naRef field, naRef va
       return;
     }
     
+    if (naIsNil(value)) {
+      fp->setDeparture(static_cast<FGAirport*>(NULL));
+      return;
+    }
+      
     naRuntimeError(c, "bad argument type setting departure");
   } else if (!strcmp(fieldName, "destination")) {
     FGAirport* apt = airportGhost(value);
@@ -611,7 +636,7 @@ static void flightplanGhostSetMember(naContext c, void* g, naRef field, naRef va
       return;
     }
     
-    naRuntimeError(c, "bad argument type setting departure");
+    naRuntimeError(c, "bad argument type setting departure runway");
   } else if (!strcmp(fieldName, "destination_runway")) {
     FGRunway* rwy = runwayGhost(value);
     if (rwy){
@@ -619,7 +644,7 @@ static void flightplanGhostSetMember(naContext c, void* g, naRef field, naRef va
       return;
     }
     
-    naRuntimeError(c, "bad argument type setting departure");
+    naRuntimeError(c, "bad argument type setting destination runway");
   } else if (!strcmp(fieldName, "sid")) {
     Procedure* proc = procedureGhost(value);
     if (proc && (proc->type() == PROCEDURE_SID)) {
@@ -672,6 +697,12 @@ static void flightplanGhostSetMember(naContext c, void* g, naRef field, naRef va
     }
     
     naRuntimeError(c, "bad argument type setting approach");
+  } else if (!strcmp(fieldName, "aircraftCategory")) {
+      if (!naIsString(value)) naRuntimeError(c, "aircraftCategory must be a string");
+      fp->setIcaoAircraftCategory(naStr_data(value));
+  } else if (!strcmp(fieldName, "followLegTrackToFix")) {
+      int b = (int) value.num;
+      fp->setFollowLegTrackToFixes(b);
   }
 }
 
@@ -1051,7 +1082,7 @@ static naRef f_findAirportsWithinRange(naContext c, naRef me, int argc, naRef* a
   
   naRef r = naNewVector(c);
   
-  FGPositioned::List apts = FGPositioned::findWithinRange(pos, rangeNm, &filter);
+  FGPositionedList apts = FGPositioned::findWithinRange(pos, rangeNm, &filter);
   FGPositioned::sortByRange(apts, pos);
   
   BOOST_FOREACH(FGPositionedRef a, apts) {
@@ -1077,7 +1108,7 @@ static naRef f_findAirportsByICAO(naContext c, naRef me, int argc, naRef* args)
   
   naRef r = naNewVector(c);
   
-  FGPositioned::List apts = FGPositioned::findAllWithIdent(prefix, &filter, false);
+  FGPositionedList apts = FGPositioned::findAllWithIdent(prefix, &filter, false);
   
   BOOST_FOREACH(FGPositionedRef a, apts) {
     FGAirport* apt = (FGAirport*) a.get();
@@ -1112,7 +1143,11 @@ static naRef f_airport_comms(naContext c, naRef me, int argc, naRef* args)
     naRef comms = naNewVector(c);
     
 // if we have an explicit type, return a simple vector of frequencies
-    if (argc > 0 && naIsScalar(args[0])) {
+    if (argc > 0 && !naIsString(args[0])) {
+        naRuntimeError(c, "airport.comms argument must be a frequency type name");
+    }
+    
+    if (argc > 0) {
         std::string commName = naStr_data(args[0]);
         FGPositioned::Type commType = FGPositioned::typeFromName(commName);
         
@@ -1317,20 +1352,10 @@ static naRef f_airport_parking(naContext c, naRef me, int argc, naRef* args)
   }
   
   FGAirportDynamics* dynamics = apt->getDynamics();
-  PositionedIDVec parkings = flightgear::NavDataCache::instance()->airportItemsOfType(apt->guid(),
-                                                                                      FGPositioned::PARKING);
-  
-  BOOST_FOREACH(PositionedID parking, parkings) {
-    // filter out based on availability and type
-    if (onlyAvailable && !dynamics->isParkingAvailable(parking)) {
-      continue;
-    }
-    
-    FGParking* park = dynamics->getParking(parking);
-    if (!type.empty() && (park->getType() != type)) {
-      continue;
-    }
-    
+  FGParkingList parkings = dynamics->getParkings(onlyAvailable, type);
+  FGParkingList::const_iterator it;
+  for (it = parkings.begin(); it != parkings.end(); ++it) {
+    FGParkingRef park = *it;
     const SGGeod& parkLoc = park->geod();
     naRef ph = naNewHash(c);
     hashset(c, ph, "name", stringToNasal(c, park->getName()));
@@ -1388,6 +1413,21 @@ static naRef f_airport_getApproach(naContext c, naRef me, int argc, naRef* args)
   return ghostForProcedure(c, apt->findApproachWithIdent(ident));
 }
 
+static naRef f_airport_findBestRunway(naContext c, naRef me, int argc, naRef* args)
+{
+    FGAirport* apt = airportGhost(me);
+    if (!apt) {
+        naRuntimeError(c, "findBestRunway called on non-airport object");
+    }
+    
+    SGGeod pos;
+    if (!geodFromArgs(args, 0, argc, pos)) {
+        naRuntimeError(c, "findBestRunway must be passed a position");
+    }
+    
+    return ghostForRunway(c,  apt->findBestRunwayForPos(pos));
+}
+
 static naRef f_airport_toString(naContext c, naRef me, int argc, naRef* args)
 {
   FGAirport* apt = airportGhost(me);
@@ -1483,7 +1523,7 @@ static naRef f_findNavaidsWithinRange(naContext c, naRef me, int argc, naRef* ar
   
   naRef r = naNewVector(c);
   FGNavList::TypeFilter filter(type);
-  FGPositioned::List navs = FGPositioned::findWithinRange(pos, rangeNm, &filter);
+  FGPositionedList navs = FGPositioned::findWithinRange(pos, rangeNm, &filter);
   FGPositioned::sortByRange(navs, pos);
   
   BOOST_FOREACH(FGPositionedRef a, navs) {
@@ -1588,7 +1628,7 @@ static naRef f_findFixesByIdent(naContext c, naRef me, int argc, naRef* args)
   naRef r = naNewVector(c);
   
   FGPositioned::TypeFilter filter(FGPositioned::FIX);
-  FGPositioned::List fixes = FGPositioned::findAllWithIdent(ident, &filter);
+  FGPositionedList fixes = FGPositioned::findAllWithIdent(ident, &filter);
   FGPositioned::sortByRange(fixes, pos);
   
   BOOST_FOREACH(FGPositionedRef f, fixes) {
@@ -1720,13 +1760,11 @@ public:
     _plan(fp),
     _instance(ins)
   {
-    SG_LOG(SG_NASAL, SG_INFO, "created Nasal delegate for " << fp);
     _gcSaveKey = _nasal->gcSave(ins);
   }
   
   virtual ~NasalFPDelegate()
   {
-    SG_LOG(SG_NASAL, SG_INFO, "destroying Nasal delegate for " << _plan);
     _nasal->gcRelease(_gcSaveKey);
   }
   
@@ -1754,19 +1792,30 @@ public:
   {
     callDelegateMethod("cleared");
   }
+    
+  virtual void endOfFlightPlan()
+  {
+    callDelegateMethod("endOfFlightPlan");
+  }
+
+  virtual void activated()
+  {
+    callDelegateMethod("activated");
+  }
 private:
   
   void callDelegateMethod(const char* method)
   {
     naRef f;
-    naMember_cget(_nasal->context(), _instance, method, &f);
-    if (naIsNil(f)) {
-      return; // no method on the delegate
+    naContext ctx = naNewContext();
+      
+    if (naMember_cget(ctx, _instance, method, &f) != 0) {
+        naRef arg[1];
+        arg[0] = ghostForFlightPlan(ctx, _plan);
+        _nasal->callMethod(f, _instance, 1, arg, naNil());
     }
     
-    naRef arg[1];
-    arg[0] = ghostForFlightPlan(_nasal->context(), _plan);
-    _nasal->callMethod(f, _instance, 1, arg, naNil());
+    naFreeContext(ctx);
   }
   
   FGNasalSys* _nasal;
@@ -1775,6 +1824,7 @@ private:
   int _gcSaveKey;
 };
 
+
 class NasalFPDelegateFactory : public FlightPlan::DelegateFactory
 {
 public:
@@ -1785,7 +1835,7 @@ public:
     _gcSaveKey = _nasal->gcSave(_func);
   }
   
-  ~NasalFPDelegateFactory()
+  virtual ~NasalFPDelegateFactory()
   {
     _nasal->gcRelease(_gcSaveKey);
   }
@@ -1793,13 +1843,18 @@ public:
   virtual FlightPlan::Delegate* createFlightPlanDelegate(FlightPlan* fp)
   {
     naRef args[1];
-    args[0] = ghostForFlightPlan(_nasal->context(), fp);
+    naContext ctx = naNewContext();
+    args[0] = ghostForFlightPlan(ctx, fp);
     naRef instance = _nasal->call(_func, 1, args, naNil());
-    if (naIsNil(instance)) {
-      return NULL;
-    }
     
-    return new NasalFPDelegate(fp, _nasal, instance);
+      FlightPlan::Delegate* result = NULL;
+      if (!naIsNil(instance)) {
+          // will GC-save instance
+          result = new NasalFPDelegate(fp, _nasal, instance);
+      }
+      
+      naFreeContext(ctx);
+      return result;
   }
 private:
   FGNasalSys* _nasal;
@@ -1807,6 +1862,20 @@ private:
   int _gcSaveKey;
 };
 
+static std::vector<NasalFPDelegateFactory*> static_nasalDelegateFactories;
+
+void shutdownNasalPositioned()
+{
+    std::vector<NasalFPDelegateFactory*>::iterator it;
+    for (it = static_nasalDelegateFactories.begin();
+         it != static_nasalDelegateFactories.end(); ++it)
+    {
+        FlightPlan::unregisterDelegateFactory(*it);
+        delete (*it);
+    }
+    static_nasalDelegateFactories.clear();
+}
+
 static naRef f_registerFPDelegate(naContext c, naRef me, int argc, naRef* args)
 {
   if ((argc < 1) || !naIsFunc(args[0])) {
@@ -1815,7 +1884,7 @@ static naRef f_registerFPDelegate(naContext c, naRef me, int argc, naRef* args)
   
   NasalFPDelegateFactory* factory = new NasalFPDelegateFactory(args[0]);
   FlightPlan::registerDelegateFactory(factory);
-  
+    static_nasalDelegateFactories.push_back(factory);
   return naNil();
 }
 
@@ -1897,6 +1966,10 @@ static naRef f_createWP(naContext c, naRef me, int argc, naRef* args)
 // set waypt flags - approach, departure, pseudo, etc
   if (argc > argOffset) {
     WayptFlag f = wayptFlagFromString(naStr_data(args[argOffset++]));
+    if (f == 0) {
+      naRuntimeError(c, "createWP: bad waypoint role");
+    }
+      
     wpt->setFlag(f);
   }
   
@@ -1924,6 +1997,9 @@ static naRef f_createWPFrom(naContext c, naRef me, int argc, naRef* args)
   // set waypt flags - approach, departure, pseudo, etc
   if (argc > 1) {
     WayptFlag f = wayptFlagFromString(naStr_data(args[1]));
+    if (f == 0) {
+      naRuntimeError(c, "createWPFrom: bad waypoint role");
+    }
     wpt->setFlag(f);
   }
   
@@ -2093,6 +2169,10 @@ static naRef f_flightplan_clearWPType(naContext c, naRef me, int argc, naRef* ar
   }
   
   WayptFlag flag = wayptFlagFromString(naStr_data(args[0]));
+  if (flag == 0) {
+    naRuntimeError(c, "clearWPType: bad waypoint role");
+  }
+    
   fp->clearWayptsWithFlag(flag);
   return naNil();
 }
@@ -2131,6 +2211,37 @@ static naRef f_flightplan_pathGeod(naContext c, naRef me, int argc, naRef* args)
   return result;
 }
 
+static naRef f_flightplan_finish(naContext c, naRef me, int argc, naRef* args)
+{
+    FlightPlan* fp = flightplanGhost(me);
+    if (!fp) {
+        naRuntimeError(c, "flightplan.finish called on non-flightplan object");
+    }
+    
+    fp->finish();
+    return naNil();
+}
+
+static naRef f_flightplan_indexOfWp(naContext c, naRef me, int argc, naRef* args)
+{
+  FlightPlan* fp = flightplanGhost(me);
+  if (!fp) {
+    naRuntimeError(c, "flightplan.indexOfWP called on non-flightplan object");
+  }
+  
+  FGPositioned* positioned = positionedGhost(args[0]);
+  if (positioned) {
+    return naNum(fp->findWayptIndex(positioned));
+  }
+  
+  SGGeod pos;
+  int argOffset = geodFromArgs(args, 0, argc, pos);
+  if (argOffset > 0) {
+    return naNum(fp->findWayptIndex(pos));
+  }
+
+  return naNum(-1);
+}
 
 static naRef f_leg_setSpeed(naContext c, naRef me, int argc, naRef* args)
 {
@@ -2138,13 +2249,14 @@ static naRef f_leg_setSpeed(naContext c, naRef me, int argc, naRef* args)
   if (!leg) {
     naRuntimeError(c, "leg.setSpeed called on non-flightplan-leg object");
   }
-  
-  if (argc < 2) {
-    naRuntimeError(c, "bad arguments to leg.setSpeed");
-  }
-  
+
+    double speed = 0.0;
+    if ((argc < 2) || !convertToNum(args[0], speed))
+        naRuntimeError(c, "bad arguments to setSpeed");
+    
   RouteRestriction rr = routeRestrictionFromString(naStr_data(args[1]));
-  leg->setSpeed(rr, args[0].num);
+  leg->setSpeed(rr, speed);
+  
   return naNil();
 }
 
@@ -2155,12 +2267,13 @@ static naRef f_leg_setAltitude(naContext c, naRef me, int argc, naRef* args)
     naRuntimeError(c, "leg.setAltitude called on non-flightplan-leg object");
   }
   
-  if (argc < 2) {
-    naRuntimeError(c, "bad arguments to leg.setAltitude");
-  }
-  
+    double alt = 0.0;
+    if ((argc < 2) || !convertToNum(args[0], alt))
+        naRuntimeError(c, "bad arguments to leg.setAltitude");
+    
   RouteRestriction rr = routeRestrictionFromString(naStr_data(args[1]));
-  leg->setAltitude(rr, args[0].num);
+    leg->setAltitude(rr, alt);
+
   return naNil();
 }
 
@@ -2195,11 +2308,12 @@ static naRef f_leg_courseAndDistanceFrom(naContext c, naRef me, int argc, naRef*
     
     SGGeod pos;
     geodFromArgs(args, 0, argc, pos);
-    
-    double courseDeg;
-    double distanceM;
-    boost::tie(courseDeg, distanceM) = leg->waypoint()->courseAndDistanceFrom(pos);
-    
+  
+    RoutePath path(leg->owner());
+    SGGeod wpPos = path.positionForIndex(leg->index());
+    double courseDeg, az2, distanceM;
+    SGGeodesy::inverse(pos, wpPos, courseDeg, az2, distanceM);
+  
     naRef result = naNewVector(c);
     naVec_append(result, naNum(courseDeg));
     naVec_append(result, naNum(distanceM * SG_METER_TO_NM));
@@ -2301,7 +2415,6 @@ static naRef f_procedure_route(naContext c, naRef me, int argc, naRef* args)
     WayptVec r;
     Approach* app = (Approach*) proc;
     if (!app->route(iaf, r)) {
-      SG_LOG(SG_NASAL, SG_WARN, "procedure.route failed for Approach somehow");
       return naNil();
     }
     
@@ -2359,10 +2472,10 @@ static struct { const char* name; naCFunction func; } funcs[] = {
 };
 
 
-naRef initNasalPositioned(naRef globals, naContext c, naRef gcSave)
+naRef initNasalPositioned(naRef globals, naContext c)
 {
     airportPrototype = naNewHash(c);
-    hashset(c, gcSave, "airportProto", airportPrototype);
+    naSave(c, airportPrototype);
   
     hashset(c, airportPrototype, "runway", naNewFunc(c, naNewCCode(c, f_airport_runway)));
     hashset(c, airportPrototype, "runwaysWithoutReciprocals", naNewFunc(c, naNewCCode(c, f_airport_runwaysWithoutReciprocals)));
@@ -2376,10 +2489,11 @@ naRef initNasalPositioned(naRef globals, naContext c, naRef gcSave)
     hashset(c, airportPrototype, "getSid", naNewFunc(c, naNewCCode(c, f_airport_getSid)));
     hashset(c, airportPrototype, "getStar", naNewFunc(c, naNewCCode(c, f_airport_getStar)));
     hashset(c, airportPrototype, "getIAP", naNewFunc(c, naNewCCode(c, f_airport_getApproach)));
+    hashset(c, airportPrototype, "findBestRunwayForPos", naNewFunc(c, naNewCCode(c, f_airport_findBestRunway)));
     hashset(c, airportPrototype, "tostring", naNewFunc(c, naNewCCode(c, f_airport_toString)));
   
     flightplanPrototype = naNewHash(c);
-    hashset(c, gcSave, "flightplanProto", flightplanPrototype);
+    naSave(c, flightplanPrototype);
       
     hashset(c, flightplanPrototype, "getWP", naNewFunc(c, naNewCCode(c, f_flightplan_getWP)));
     hashset(c, flightplanPrototype, "currentWP", naNewFunc(c, naNewCCode(c, f_flightplan_currentWP))); 
@@ -2394,21 +2508,23 @@ naRef initNasalPositioned(naRef globals, naContext c, naRef gcSave)
     hashset(c, flightplanPrototype, "clearWPType", naNewFunc(c, naNewCCode(c, f_flightplan_clearWPType))); 
     hashset(c, flightplanPrototype, "clone", naNewFunc(c, naNewCCode(c, f_flightplan_clone))); 
     hashset(c, flightplanPrototype, "pathGeod", naNewFunc(c, naNewCCode(c, f_flightplan_pathGeod)));
+    hashset(c, flightplanPrototype, "finish", naNewFunc(c, naNewCCode(c, f_flightplan_finish)));
+    hashset(c, flightplanPrototype, "indexOfWP", naNewFunc(c, naNewCCode(c, f_flightplan_indexOfWp)));
     
     waypointPrototype = naNewHash(c);
-    hashset(c, gcSave, "wayptProto", waypointPrototype);
+    naSave(c, waypointPrototype);
     
     hashset(c, waypointPrototype, "navaid", naNewFunc(c, naNewCCode(c, f_waypoint_navaid)));
     hashset(c, waypointPrototype, "runway", naNewFunc(c, naNewCCode(c, f_waypoint_runway)));
     hashset(c, waypointPrototype, "airport", naNewFunc(c, naNewCCode(c, f_waypoint_airport)));
   
     procedurePrototype = naNewHash(c);
-    hashset(c, gcSave, "procedureProto", procedurePrototype);
+    naSave(c, procedurePrototype);
     hashset(c, procedurePrototype, "transition", naNewFunc(c, naNewCCode(c, f_procedure_transition)));
     hashset(c, procedurePrototype, "route", naNewFunc(c, naNewCCode(c, f_procedure_route)));
   
     fpLegPrototype = naNewHash(c);
-    hashset(c, gcSave, "fpLegProto", fpLegPrototype);
+    naSave(c, fpLegPrototype);
     hashset(c, fpLegPrototype, "setSpeed", naNewFunc(c, naNewCCode(c, f_leg_setSpeed)));
     hashset(c, fpLegPrototype, "setAltitude", naNewFunc(c, naNewCCode(c, f_leg_setAltitude)));
     hashset(c, fpLegPrototype, "path", naNewFunc(c, naNewCCode(c, f_leg_path)));