flightgear/src/GUI/LocationWidget.cxx

// LocationWidget.cxx - GUI launcher dialog using Qt5
//
// Written by James Turner, started October 2015.
//
// Copyright (C) 2015 James Turner <zakalawe@mac.com>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

#include "LocationWidget.hxx"
#include "ui_LocationWidget.h"

#include <QSettings>
#include <QAbstractListModel>
#include <QTimer>
#include <QDebug>
#include <QToolButton>
#include <QMovie>
#include <QPainter>

#include "AirportDiagram.hxx"
#include "NavaidDiagram.hxx"
#include "LaunchConfig.hxx"
#include "DefaultAircraftLocator.hxx"

#include <Airports/airport.hxx>
#include <Airports/groundnetwork.hxx>

#include <Main/globals.hxx>
#include <Navaids/NavDataCache.hxx>
#include <Navaids/navrecord.hxx>
#include <Main/options.hxx>
#include <Main/fg_init.hxx>
#include <Main/fg_props.hxx> // for fgSetDouble

using namespace flightgear;

const unsigned int MAX_RECENT_LOCATIONS = 64;

QString fixNavaidName(QString s)
{
    // split into words
    QStringList words = s.split(QChar(' '));
    QStringList changedWords;
    Q_FOREACH(QString w, words) {
        QString up = w.toUpper();

        // expand common abbreviations
        // note these are not translated, since they are abbreivations
        // for English-langauge airports, mostly in the US/Canada
        if (up == "FLD") {
            changedWords.append("Field");
            continue;
        }

        if (up == "CO") {
            changedWords.append("County");
            continue;
        }

        if ((up == "MUNI") || (up == "MUN")) {
            changedWords.append("Municipal");
            continue;
        }

        if (up == "MEM") {
            changedWords.append("Memorial");
            continue;
        }

        if (up == "RGNL") {
            changedWords.append("Regional");
            continue;
        }

        if (up == "CTR") {
            changedWords.append("Center");
            continue;
        }

        if (up == "INTL") {
            changedWords.append("International");
            continue;
        }

        // occurs in many Australian airport names in our DB
        if (up == "(NSW)") {
            changedWords.append("(New South Wales)");
            continue;
        }

        if ((up == "VOR") || (up == "NDB")
                || (up == "VOR-DME") || (up == "VORTAC")
                || (up == "NDB-DME")
                || (up == "AFB") || (up == "RAF"))
        {
            changedWords.append(w);
            continue;
        }

        if ((up =="[X]") || (up == "[H]") || (up == "[S]")) {
            continue; // consume
        }

        QChar firstChar = w.at(0).toUpper();
        w = w.mid(1).toLower();
        w.prepend(firstChar);

        changedWords.append(w);
    }

    return changedWords.join(QChar(' '));
}

QString formatGeodAsString(const SGGeod& geod)
{
    QChar ns = (geod.getLatitudeDeg() > 0.0) ? 'N' : 'S';
    QChar ew = (geod.getLongitudeDeg() > 0.0) ? 'E' : 'W';

    return QString::number(fabs(geod.getLongitudeDeg()), 'f',2 ) + ew + " " +
            QString::number(fabs(geod.getLatitudeDeg()), 'f',2 ) + ns;
}

bool parseStringAsGeod(const QString& s, SGGeod& result)
{
    int commaPos = s.indexOf(QChar(','));
    if (commaPos < 0)
        return false;

    bool ok;
    double lon = s.leftRef(commaPos).toDouble(&ok);
    if (!ok)
        return false;

    double lat = s.midRef(commaPos+1).toDouble(&ok);
    if (!ok)
        return false;

    result = SGGeod::fromDeg(lon, lat);
    return true;
}

QVariant savePositionList(const FGPositionedList& posList)
{
    QVariantList vl;
    FGPositionedList::const_iterator it;
    for (it = posList.begin(); it != posList.end(); ++it) {
        QVariantMap vm;
        FGPositionedRef pos = *it;
        vm.insert("ident", QString::fromStdString(pos->ident()));
        vm.insert("type", pos->type());
        vm.insert("lat", pos->geod().getLatitudeDeg());
        vm.insert("lon", pos->geod().getLongitudeDeg());
        vl.append(vm);
    }
    return vl;
}

FGPositionedList loadPositionedList(QVariant v)
{
    QVariantList vl = v.toList();
    FGPositionedList result;
    result.reserve(vl.size());
    NavDataCache* cache = NavDataCache::instance();

    Q_FOREACH(QVariant v, vl) {
        QVariantMap vm = v.toMap();
        std::string ident(vm.value("ident").toString().toStdString());
        double lat = vm.value("lat").toDouble();
        double lon = vm.value("lon").toDouble();
        FGPositioned::Type ty(static_cast<FGPositioned::Type>(vm.value("type").toInt()));
        FGPositioned::TypeFilter filter(ty);
        FGPositionedRef pos = cache->findClosestWithIdent(ident,
                                                          SGGeod::fromDeg(lon, lat),
                                                          &filter);
        if (pos)
            result.push_back(pos);
    }

    return result;
}

class IdentSearchFilter : public FGPositioned::TypeFilter
{
public:
    IdentSearchFilter(LauncherAircraftType aircraft)
    {
        addType(FGPositioned::VOR);
        addType(FGPositioned::FIX);
        addType(FGPositioned::NDB);

        if (aircraft == Helicopter) {
            addType(FGPositioned::HELIPAD);
        }

        if (aircraft == Seaplane) {
            addType(FGPositioned::SEAPORT);
        } else {
            addType(FGPositioned::AIRPORT);
        }
    }
};

class NavSearchModel : public QAbstractListModel
{
    Q_OBJECT
public:
    NavSearchModel() :
        m_searchActive(false)
    {
    }

    void setSearch(QString t, LauncherAircraftType aircraft)
    {
        beginResetModel();

        m_items.clear();
        m_ids.clear();

        std::string term(t.toUpper().toStdString());

        IdentSearchFilter filter(aircraft);
        FGPositionedList exactMatches = NavDataCache::instance()->findAllWithIdent(term, &filter, true);
        m_ids.reserve(exactMatches.size());
        m_items.reserve(exactMatches.size());
        for (auto match : exactMatches) {
            m_ids.push_back(match->guid());
            m_items.push_back(match);
        }
        endResetModel();

        m_search.reset(new NavDataCache::ThreadedGUISearch(term));
        QTimer::singleShot(100, this, SLOT(onSearchResultsPoll()));
        m_searchActive = true;
    }

    bool isSearchActive() const
    {
        return m_searchActive;
    }

    virtual int rowCount(const QModelIndex&) const
    {
        // if empty, return 1 for special 'no matches'?
        return m_ids.size();
    }

    virtual QVariant data(const QModelIndex& index, int role) const
    {
        if (!index.isValid())
            return QVariant();

        FGPositionedRef pos = itemAtRow(index.row());
        if (role == Qt::DisplayRole) {
            if (pos->type() == FGPositioned::FIX) {
                // fixes don't have a name, show position instead
                return QString("Fix %1 (%2)").arg(QString::fromStdString(pos->ident()))
                        .arg(formatGeodAsString(pos->geod()));
            } else {
                QString name = fixNavaidName(QString::fromStdString(pos->name()));
                return QString("%1: %2").arg(QString::fromStdString(pos->ident())).arg(name);
            }
        }

        if (role == Qt::DecorationRole) {
            return AirportDiagram::iconForPositioned(pos,
                                                     AirportDiagram::SmallIcons | AirportDiagram::LargeAirportPlans);
        }

        if (role == Qt::EditRole) {
            return QString::fromStdString(pos->ident());
        }

        if (role == Qt::UserRole) {
            return static_cast<qlonglong>(m_ids[index.row()]);
        }

        return QVariant();
    }

    FGPositionedRef itemAtRow(unsigned int row) const
    {
        FGPositionedRef pos = m_items[row];
        if (!pos.valid()) {
            pos = NavDataCache::instance()->loadById(m_ids[row]);
            m_items[row] = pos;
        }

        return pos;
    }

    void setItems(const FGPositionedList& items)
    {
        beginResetModel();
        m_searchActive = false;
        m_items = items;

        m_ids.clear();
        for (unsigned int i=0; i < items.size(); ++i) {
            m_ids.push_back(m_items[i]->guid());
        }

        endResetModel();
    }

Q_SIGNALS:
    void searchComplete();

private slots:

    void onSearchResultsPoll()
    {
        if (m_search.isNull()) {
            return;
        }
        
        PositionedIDVec newIds = m_search->results();
        m_ids.reserve(newIds.size());
        beginInsertRows(QModelIndex(), m_ids.size(), newIds.size() - 1);
        for (auto id : newIds) {
            m_ids.push_back(id);
            m_items.push_back({}); // null ref
        }
        endInsertRows();

        if (m_search->isComplete()) {
            m_searchActive = false;
            m_search.reset();
            emit searchComplete();
        } else {
            QTimer::singleShot(100, this, SLOT(onSearchResultsPoll()));
        }
    }

private:
    PositionedIDVec m_ids;
    mutable FGPositionedList m_items;
    bool m_searchActive;
    QScopedPointer<NavDataCache::ThreadedGUISearch> m_search;
};


LocationWidget::LocationWidget(QWidget *parent) :
    QWidget(parent),
    m_ui(new Ui::LocationWidget),
    m_locationIsLatLon(false),
    m_aircraftType(Airplane)
{
    m_ui->setupUi(this);

    QIcon historyIcon(":/history-icon");
    m_ui->searchHistory->setIcon(historyIcon);

    QByteArray format;
    m_ui->searchIcon->setMovie(new QMovie(":/spinner", format, this));

    m_searchModel = new NavSearchModel;
    m_ui->searchResultsList->setModel(m_searchModel);
    connect(m_ui->searchResultsList, &QListView::clicked,
            this, &LocationWidget::onSearchResultSelected);
    connect(m_searchModel, &NavSearchModel::searchComplete,
            this, &LocationWidget::onSearchComplete);

    connect(m_ui->runwayCombo, SIGNAL(currentIndexChanged(int)),
            this, SLOT(updateDescription()));
    connect(m_ui->parkingCombo, SIGNAL(currentIndexChanged(int)),
            this, SLOT(updateDescription()));
    connect(m_ui->runwayRadio, SIGNAL(toggled(bool)),
            this, SLOT(updateDescription()));
    connect(m_ui->parkingRadio, SIGNAL(toggled(bool)),
            this, SLOT(updateDescription()));
    connect(m_ui->onFinalCheckbox, SIGNAL(toggled(bool)),
            this, SLOT(updateDescription()));
    connect(m_ui->approachDistanceSpin, SIGNAL(valueChanged(int)),
            this, SLOT(updateDescription()));

    connect(m_ui->airportDiagram, &AirportDiagram::clickedRunway,
            this, &LocationWidget::onAirportRunwayClicked);
    connect(m_ui->airportDiagram, &AirportDiagram::clickedParking,
            this, &LocationWidget::onAirportParkingClicked);

    connect(m_ui->locationSearchEdit, &QLineEdit::returnPressed,
            this, &LocationWidget::onSearch);

    connect(m_ui->searchHistory, &QPushButton::clicked,
            this, &LocationWidget::onShowHistory);

    connect(m_ui->trueBearing, &QCheckBox::toggled,
            this, &LocationWidget::onOffsetBearingTrueChanged);
    connect(m_ui->offsetGroup, &QGroupBox::toggled,
            this, &LocationWidget::onOffsetEnabledToggled);
    connect(m_ui->trueBearing, &QCheckBox::toggled, this,
            &LocationWidget::onOffsetDataChanged);
    connect(m_ui->offsetBearingSpinbox, SIGNAL(valueChanged(int)),
            this, SLOT(onOffsetDataChanged()));
    connect(m_ui->offsetNmSpinbox, SIGNAL(valueChanged(double)),
            this, SLOT(onOffsetDataChanged()));
    connect(m_ui->headingSpinbox, SIGNAL(valueChanged(int)),
            this, SLOT(onHeadingChanged()));

    m_backButton = new QToolButton(this);
    m_backButton->setGeometry(0, 0, 64, 32);
    m_backButton->setText(tr("<< Back"));
    m_backButton->raise();

    connect(m_backButton, &QAbstractButton::clicked,
            this, &LocationWidget::onBackToSearch);

// force various pieces of UI into sync
    onOffsetEnabledToggled(m_ui->offsetGroup->isChecked());
    onOffsetBearingTrueChanged(m_ui->trueBearing->isChecked());
    onBackToSearch();
}

LocationWidget::~LocationWidget()
{
    delete m_ui;
}

void LocationWidget::setLaunchConfig(LaunchConfig *config)
{
    m_config = config;
    connect(m_config, &LaunchConfig::collect, this, &LocationWidget::onCollectConfig);
}

void LocationWidget::restoreSettings()
{
    QSettings settings;
    m_recentLocations = loadPositionedList(settings.value("recent-locations"));
    onShowHistory();
}

void LocationWidget::restoreLocation(QVariantMap l)
{
    if (l.contains("location-lat")) {
        m_locationIsLatLon = true;
        m_geodLocation = SGGeod::fromDeg(l.value("location-lon").toDouble(),
                                         l.value("location-lat").toDouble());
    } else if (l.contains("location-id")) {
        m_location = NavDataCache::instance()->loadById(l.value("location-id").toULongLong());
        m_locationIsLatLon = false;
    }

    m_ui->altitudeSpinbox->setValue(l.value("altitude", 6000).toInt());
    m_ui->airspeedSpinbox->setValue(l.value("speed", 120).toInt());
    m_ui->headingSpinbox->setValue(l.value("heading").toInt());
    m_ui->offsetGroup->setChecked(l.value("offset-enabled").toBool());
    m_ui->offsetBearingSpinbox->setValue(l.value("offset-bearing").toInt());
    m_ui->offsetNmSpinbox->setValue(l.value("offset-distance", 10).toInt());

    onLocationChanged();

    // now we've loaded airport location data (potentially), we can apply
    // more settings
    if (FGAirport::isAirportType(m_location.ptr())) {
        if (l.contains("location-apt-runway")) {
            QString runway = l.value("location-apt-runway").toString();
            int index = m_ui->runwayCombo->findText(runway);
            if (index < 0) {
                index = 0; // revert to 'active' option
            }
            m_ui->runwayRadio->setChecked(true);
            m_ui->runwayCombo->setCurrentIndex(index);
        } else if (l.contains("location-apt-parking")) {
            QString parking = l.value("location-apt-parking").toString();
            int index = m_ui->parkingCombo->findText(parking);
            if (index >= 0) {
                m_ui->parkingRadio->setChecked(true);
                m_ui->parkingCombo->setCurrentIndex(index);
            }
        }

        m_ui->onFinalCheckbox->setChecked(l.value("location-on-final").toBool());
        m_ui->approachDistanceSpin->setValue(l.value("location-apt-final-distance").toInt());
    } // of location is an airport

    updateDescription();
}

bool LocationWidget::shouldStartPaused() const
{
    if (!m_location) {
        return false; // defaults to on-ground at KSFO
    }

    if (FGAirport::isAirportType(m_location.ptr())) {
        return m_ui->onFinalCheckbox->isChecked();
    } else {
        // navaid, start paused
        return true;
    }
}

QVariantMap LocationWidget::saveLocation() const
{
    QVariantMap locationSet;
    if (m_locationIsLatLon) {
        locationSet.insert("location-lat", m_geodLocation.getLatitudeDeg());
        locationSet.insert("location-lon", m_geodLocation.getLongitudeDeg());
    } else if (m_location) {
        locationSet.insert("location-id", static_cast<qlonglong>(m_location->guid()));

        if (FGAirport::isAirportType(m_location.ptr())) {
            locationSet.insert("location-on-final", m_ui->onFinalCheckbox->isChecked());
            locationSet.insert("location-apt-final-distance", m_ui->approachDistanceSpin->value());
            if (m_ui->runwayRadio->isChecked()) {
                if (m_ui->runwayCombo->currentIndex() > 0) {
                    locationSet.insert("location-apt-runway", m_ui->runwayCombo->currentText());
                } else {
                    locationSet.insert("location-apt-runway", "active");
                }
            } else if (m_ui->parkingRadio->isChecked()) {
                locationSet.insert("location-apt-parking", m_ui->parkingCombo->currentText());
            }
        } // of location is an airport
    } // of m_location is valid


    locationSet.insert("altitude", m_ui->altitudeSpinbox->value());
    locationSet.insert("speed", m_ui->airspeedSpinbox->value());
    locationSet.insert("offset-enabled", m_ui->offsetGroup->isChecked());
    locationSet.insert("offset-bearing", m_ui->offsetBearingSpinbox->value());
    locationSet.insert("offset-distance", m_ui->offsetNmSpinbox->value());

    locationSet.insert("text", locationDescription());

    return locationSet;
}

void LocationWidget::setLocationProperties()
{
    SGPropertyNode_ptr presets = fgGetNode("/sim/presets", true);

    QStringList props = QStringList() << "vor-id" << "fix" << "ndb-id" <<
        "runway-requested" << "navaid-id" << "offset-azimuth-deg" <<
        "offset-distance-nm" << "glideslope-deg" <<
        "speed-set" << "on-ground" << "airspeed-kt" <<
        "airport-id" << "runway" << "parkpos";

    Q_FOREACH(QString s, props) {
        SGPropertyNode* c = presets->getChild(s.toStdString());
        if (c) {
            c->clearValue();
        }
    }

    if (m_locationIsLatLon) {
        fgSetDouble("/sim/presets/latitude-deg", m_geodLocation.getLatitudeDeg());
        fgSetDouble("/position/latitude-deg", m_geodLocation.getLatitudeDeg());
        fgSetDouble("/sim/presets/longitude-deg", m_geodLocation.getLongitudeDeg());
        fgSetDouble("/position/longitude-deg", m_geodLocation.getLongitudeDeg());

        applyPositionOffset();
        return;
    }

    fgSetDouble("/sim/presets/latitude-deg", 9999.0);
    fgSetDouble("/sim/presets/longitude-deg", 9999.0);
    fgSetDouble("/sim/presets/altitude-ft", -9999.0);
    fgSetDouble("/sim/presets/heading-deg", 9999.0);

    if (!m_location) {
        return;
    }

    if (FGAirport::isAirportType(m_location.ptr())) {
        FGAirport* apt = static_cast<FGAirport*>(m_location.ptr());
        fgSetString("/sim/presets/airport-id", apt->ident());
        fgSetBool("/sim/presets/on-ground", true);
        fgSetBool("/sim/presets/airport-requested", true);

        if (m_ui->runwayRadio->isChecked()) {
            if (apt->type() == FGPositioned::AIRPORT) {
                int index = m_ui->runwayCombo->itemData(m_ui->runwayCombo->currentIndex()).toInt();
                if (index >= 0) {
                    // explicit runway choice
                    FGRunwayRef runway = apt->getRunwayByIndex(index);
                    fgSetString("/sim/presets/runway", runway->ident() );
                    fgSetBool("/sim/presets/runway-requested", true );

                    // set nav-radio 1 based on selected runway
                    if (runway->ILS()) {
                        double mhz = runway->ILS()->get_freq() / 100.0;
                        fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", runway->headingDeg());
                        fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", mhz);
                    }
                }

                if (m_ui->onFinalCheckbox->isChecked()) {
                    fgSetDouble("/sim/presets/glideslope-deg", 3.0);
                    fgSetDouble("/sim/presets/offset-distance-nm", m_ui->approachDistanceSpin->value());
                    fgSetBool("/sim/presets/on-ground", false);
                }
            } else if (apt->type() == FGPositioned::HELIPORT) {
                int index = m_ui->runwayCombo->itemData(m_ui->runwayCombo->currentIndex()).toInt();
                if (index >= 0)  {
                    // explicit pad choice
                    FGHelipadRef pad = apt->getHelipadByIndex(index);
                    fgSetString("/sim/presets/runway", pad->ident() );
                    fgSetBool("/sim/presets/runway-requested", true );
                }
            } else {
                qWarning() << Q_FUNC_INFO << "implement me";
            }

        } else if (m_ui->parkingRadio->isChecked()) {
            // parking selection
            fgSetString("/sim/presets/parkpos", m_ui->parkingCombo->currentText().toStdString());
        }
        // of location is an airport
    } else {
        fgSetString("/sim/presets/airport-id", "");

        // location is a navaid
        // note setting the ident here is ambigious, we really only need and
        // want the 'navaid-id' property. However setting the 'real' option
        // gives a better UI experience (eg existing Position in Air dialog)
        FGPositioned::Type ty = m_location->type();
        switch (ty) {
            case FGPositioned::VOR:
                fgSetString("/sim/presets/vor-id", m_location->ident());
                setNavRadioOption();
                break;

            case FGPositioned::NDB:
                fgSetString("/sim/presets/ndb-id", m_location->ident());
                setNavRadioOption();
                break;

            case FGPositioned::FIX:
                fgSetString("/sim/presets/fix", m_location->ident());
                break;
            default:
                break;
        };
        
        // set disambiguation property
        globals->get_props()->setIntValue("/sim/presets/navaid-id",
                                          static_cast<int>(m_location->guid()));
        
        applyPositionOffset();
    } // of navaid location
}

void LocationWidget::applyPositionOffset()
{
    if (m_ui->altitudeSpinbox->value() > 0) {
        m_config->setArg("altitude", QString::number(m_ui->altitudeSpinbox->value()));
    }

    m_config->setArg("vc", QString::number(m_ui->airspeedSpinbox->value()));
    m_config->setArg("heading", QString::number(m_ui->headingSpinbox->value()));
    
    if (m_ui->offsetGroup->isChecked()) {
        // flip direction of azimuth to balance the flip done in fgApplyStartOffset
        // I don't know why that flip exists but changing it there will break
        // command-line compatability so compensating here instead
        int offsetAzimuth = m_ui->offsetBearingSpinbox->value() - 180;
        m_config->setArg("offset-azimuth", QString::number(offsetAzimuth));
        m_config->setArg("offset-distance", QString::number(m_ui->offsetNmSpinbox->value()));
    }
}

void LocationWidget::onCollectConfig()
{
    if (m_locationIsLatLon) {
        m_config->setArg("lat", QString::number(m_geodLocation.getLatitudeDeg()));
        m_config->setArg("lon", QString::number(m_geodLocation.getLongitudeDeg()));
        applyPositionOffset();
        return;
    }

    if (!m_location) {
        return;
    }

    if (FGAirport::isAirportType(m_location.ptr())) {
        FGAirport* apt = static_cast<FGAirport*>(m_location.ptr());
        m_config->setArg("airport", QString::fromStdString(apt->ident()));

        if (m_ui->runwayRadio->isChecked()) {
            if (apt->type() == FGPositioned::AIRPORT) {
                int index = m_ui->runwayCombo->itemData(m_ui->runwayCombo->currentIndex()).toInt();
                if (index >= 0) {
                    // explicit runway choice
                    FGRunwayRef runway = apt->getRunwayByIndex(index);
                    m_config->setArg("runway", QString::fromStdString(runway->ident()));

                    // set nav-radio 1 based on selected runway
                    if (runway->ILS()) {
                        double mhz = runway->ILS()->get_freq() / 100.0;
                        m_config->setArg("nav1", QString("%1:%2").arg(runway->headingDeg()).arg(mhz));
                    }
                }

                if (m_ui->onFinalCheckbox->isChecked()) {
                    m_config->setArg("glideslope", std::string("3.0"));
                    m_config->setArg("offset-distance", QString::number(m_ui->approachDistanceSpin->value()));
                    m_config->setArg("on-ground", std::string("false"));
                }
            } else if (apt->type() == FGPositioned::HELIPORT) {
                int index = m_ui->runwayCombo->itemData(m_ui->runwayCombo->currentIndex()).toInt();
                if (index >= 0)  {
                    // explicit pad choice
                    FGHelipadRef pad = apt->getHelipadByIndex(index);
                    m_config->setArg("runway", pad->ident());
                }
            } else {
                qWarning() << Q_FUNC_INFO << "implement me";
            }

        } else if (m_ui->parkingRadio->isChecked()) {
            // parking selection
            m_config->setArg("parkpos", m_ui->parkingCombo->currentText());
        }
        // of location is an airport
    } else {
        // location is a navaid
        // note setting the ident here is ambigious, we really only need and
        // want the 'navaid-id' property. However setting the 'real' option
        // gives a better UI experience (eg existing Position in Air dialog)
        FGPositioned::Type ty = m_location->type();
        switch (ty) {
            case FGPositioned::VOR:
                m_config->setArg("vor", m_location->ident());
                setNavRadioOption();
                break;

            case FGPositioned::NDB:
                m_config->setArg("ndb", m_location->ident());
                setNavRadioOption();
                break;

            case FGPositioned::FIX:
                 m_config->setArg("fix", m_location->ident());
                break;
            default:
                break;
        };

        // set disambiguation property
        m_config->setProperty("/sim/presets/navaid-id", QString::number(m_location->guid()));
        applyPositionOffset();
    } // of navaid location
}

void LocationWidget::setNavRadioOption()
{
    if (m_location->type() == FGPositioned::VOR) {
        FGNavRecordRef nav(static_cast<FGNavRecord*>(m_location.ptr()));
        double mhz = nav->get_freq() / 100.0;
        int heading = 0; // add heading support
        QString navOpt = QString("%1:%2").arg(heading).arg(mhz);
        m_config->setArg("nav1", navOpt);
    } else {
        FGNavRecordRef nav(static_cast<FGNavRecord*>(m_location.ptr()));
        int khz = nav->get_freq() / 100;
        int heading = 0;
        QString adfOpt = QString("%1:%2").arg(heading).arg(khz);
        m_config->setArg("adf1", adfOpt);
    }
}

void LocationWidget::onSearch()
{
    QString search = m_ui->locationSearchEdit->text();

    m_locationIsLatLon = parseStringAsGeod(search, m_geodLocation);
    if (m_locationIsLatLon) {
        m_ui->searchIcon->setVisible(false);
        m_ui->searchStatusText->setText(QString("Position '%1'").arg(formatGeodAsString(m_geodLocation)));
        m_location.clear();
        onLocationChanged();
        updateDescription();
        return;
    }

    m_searchModel->setSearch(search, m_aircraftType);

    if (m_searchModel->isSearchActive()) {
        m_ui->searchStatusText->setText(tr("Searching for '%1'").arg(search));
        m_ui->searchIcon->setVisible(true);
        m_ui->searchIcon->movie()->start();
    } else if (m_searchModel->rowCount(QModelIndex()) == 1) {
        setBaseLocation(m_searchModel->itemAtRow(0));
    }
}

void LocationWidget::onSearchComplete()
{
    QString search = m_ui->locationSearchEdit->text();
    m_ui->searchIcon->setVisible(false);
    m_ui->searchStatusText->setText(tr("Results for '%1'").arg(search));

    int numResults = m_searchModel->rowCount(QModelIndex());
    if (numResults == 0) {
        m_ui->searchStatusText->setText(tr("No matches for '%1'").arg(search));
    } else if (numResults == 1) {
        addToRecent(m_searchModel->itemAtRow(0));
        setBaseLocation(m_searchModel->itemAtRow(0));
    }
}

void LocationWidget::onLocationChanged()
{
    bool locIsAirport = FGAirport::isAirportType(m_location.ptr());
    if (!m_location) {
        onBackToSearch();
        return;
    }

    m_backButton->show();

    if (locIsAirport) {
        m_ui->stack->setCurrentIndex(0);
        FGAirport* apt = static_cast<FGAirport*>(m_location.ptr());
        m_ui->airportDiagram->setAirport(apt);

        m_ui->runwayRadio->setChecked(true); // default back to runway mode
        // unless multiplayer is enabled ?
        m_ui->airportDiagram->setEnabled(true);

        m_ui->runwayCombo->clear();
        m_ui->runwayCombo->addItem("Automatic", -1);

        if (apt->type() == FGPositioned::HELIPORT) {
            for (unsigned int r=0; r<apt->numHelipads(); ++r) {
                FGHelipadRef pad = apt->getHelipadByIndex(r);
                // add pad with index as data role
                m_ui->runwayCombo->addItem(QString::fromStdString(pad->ident()), r);

                m_ui->airportDiagram->addHelipad(pad);
            }
        } else {
            for (unsigned int r=0; r<apt->numRunways(); ++r) {
                FGRunwayRef rwy = apt->getRunwayByIndex(r);
                // add runway with index as data role
                m_ui->runwayCombo->addItem(QString::fromStdString(rwy->ident()), r);

                m_ui->airportDiagram->addRunway(rwy);
            }
        }

        m_ui->parkingCombo->clear();
        FGGroundNetwork* ground = apt->groundNetwork();
        if (ground && ground->exists()) {
            FGParkingList parkings = ground->allParkings();
            if (parkings.empty()) {
                m_ui->parkingCombo->setEnabled(false);
                m_ui->parkingRadio->setEnabled(false);
            } else {
                m_ui->parkingCombo->setEnabled(true);
                m_ui->parkingRadio->setEnabled(true);

                FGParkingList::const_iterator it;
                for (it = parkings.begin(); it != parkings.end(); ++it) {
                    m_ui->parkingCombo->addItem(QString::fromStdString((*it)->getName()),
                                                (*it)->getIndex());

                    m_ui->airportDiagram->addParking(*it);
                }
            } // of have parkings
        } // of was able to create dynamics

        const QString airportName = QString::fromStdString(apt->name());
        const QString icao = QString::fromStdString(apt->ident());

        m_ui->titleLabel->setText(tr("%1 (%2)").arg(airportName).arg(icao));
    } else if (m_locationIsLatLon) {
        m_ui->stack->setCurrentIndex(1);
        m_ui->navaidDiagram->setGeod(m_geodLocation);
    } else if (m_location) {
        // navaid
        m_ui->stack->setCurrentIndex(1);
        m_ui->navaidDiagram->setNavaid(m_location);

        const QString name = QString::fromStdString(m_location->name());
        const QString ident = QString::fromStdString(m_location->ident());
        m_ui->navTitleLabel->setText(tr("%1 (%2)").arg(name).arg(ident));
    }
}

void LocationWidget::onOffsetEnabledToggled(bool on)
{
    m_ui->navaidDiagram->setOffsetEnabled(on);
    updateDescription();
}

void LocationWidget::onAirportRunwayClicked(FGRunwayRef rwy)
{
    if (rwy) {
        m_ui->runwayRadio->setChecked(true);
        int rwyIndex = m_ui->runwayCombo->findText(QString::fromStdString(rwy->ident()));
        m_ui->runwayCombo->setCurrentIndex(rwyIndex);
        m_ui->airportDiagram->setSelectedRunway(rwy);
    }

    updateDescription();
}

void LocationWidget::onAirportParkingClicked(FGParkingRef park)
{
    if (park) {
        m_ui->parkingRadio->setChecked(true);
        int parkingIndex = m_ui->parkingCombo->findData(park->getIndex());
        m_ui->parkingCombo->setCurrentIndex(parkingIndex);
        m_ui->airportDiagram->setSelectedParking(park);
    }

    updateDescription();
}

QString compassPointFromHeading(int heading)
{
    const int labelArc = 360 / 8;
    heading += (labelArc >> 1);
    SG_NORMALIZE_RANGE(heading, 0, 359);

    switch (heading / labelArc) {
    case 0: return "N";
    case 1: return "NE";
    case 2: return "E";
    case 3: return "SE";
    case 4: return "S";
    case 5: return "SW";
    case 6: return "W";
    case 7: return "NW";
    }

    return QString();
}

QString LocationWidget::locationDescription() const
{
    if (!m_location) {
        if (m_locationIsLatLon) {
            return tr("at position %1").arg(formatGeodAsString(m_geodLocation));
        }

        return tr("No location selected");
    }

    bool locIsAirport = FGAirport::isAirportType(m_location.ptr());
    QString ident = QString::fromStdString(m_location->ident()),
        name = QString::fromStdString(m_location->name());

    name = fixNavaidName(name);

    if (locIsAirport) {
        //FGAirport* apt = static_cast<FGAirport*>(m_location.ptr());
        QString locationOnAirport;

        if (m_ui->runwayRadio->isChecked()) {
            bool onFinal = m_ui->onFinalCheckbox->isChecked();
            int comboIndex = m_ui->runwayCombo->currentIndex();
            QString runwayName = (comboIndex == 0) ?
                "active runway" :
                QString("runway %1").arg(m_ui->runwayCombo->currentText());

            if (onFinal) {
                int finalDistance = m_ui->approachDistanceSpin->value();
                locationOnAirport = tr("on %2-mile final to %1").arg(runwayName).arg(finalDistance);
            } else {
                locationOnAirport = tr("on %1").arg(runwayName);
            }
        } else if (m_ui->parkingRadio->isChecked()) {
            locationOnAirport = tr("at parking position %1").arg(m_ui->parkingCombo->currentText());
        }

        return tr("%2 (%1): %3").arg(ident).arg(name).arg(locationOnAirport);
    } else {
        QString offsetDesc = tr("at");
        if (m_ui->offsetGroup->isChecked()) {
            offsetDesc = tr("%1nm %2 of").
                    arg(m_ui->offsetNmSpinbox->value(), 0, 'f', 1).
                    arg(compassPointFromHeading(m_ui->offsetBearingSpinbox->value()));
        }

        QString navaidType;
        switch (m_location->type()) {
        case FGPositioned::VOR:
            navaidType = QString("VOR"); break;
        case FGPositioned::NDB:
            navaidType = QString("NDB"); break;
        case FGPositioned::FIX:
            return tr("%2 waypoint %1").arg(ident).arg(offsetDesc);
        default:
            // unsupported type
            break;
        }

        return tr("%4 %1 %2 (%3)").arg(navaidType).arg(ident).arg(name).arg(offsetDesc);
    }

    return tr("No location selected");
}


void LocationWidget::updateDescription()
{
    bool locIsAirport = FGAirport::isAirportType(m_location.ptr());
    if (locIsAirport) {
        FGAirport* apt = static_cast<FGAirport*>(m_location.ptr());

        if (m_ui->runwayRadio->isChecked()) {
            int comboIndex = m_ui->runwayCombo->currentIndex();
            int runwayIndex = m_ui->runwayCombo->itemData(comboIndex).toInt();
            if (apt->type() == FGPositioned::HELIPORT) {
                FGHelipadRef pad = (runwayIndex >= 0) ?
                            apt->getHelipadByIndex(runwayIndex) : FGHelipadRef();
                m_ui->airportDiagram->setSelectedHelipad(pad);
            } else {
                // we can't figure out the active runway in the launcher (yet)
                FGRunwayRef rwy = (runwayIndex >= 0) ?
                    apt->getRunwayByIndex(runwayIndex) : FGRunwayRef();
                m_ui->airportDiagram->setSelectedRunway(rwy);
            }
        } else if (m_ui->parkingRadio->isChecked()) {
            int groundNetIndex = m_ui->parkingCombo->currentData().toInt();
            FGParkingRef park = apt->groundNetwork()->getParkingByIndex(groundNetIndex);
            m_ui->airportDiagram->setSelectedParking(park);
        }

        if (m_ui->onFinalCheckbox->isChecked()) {
            m_ui->airportDiagram->setApproachExtensionDistance(m_ui->approachDistanceSpin->value());
        } else {
            m_ui->airportDiagram->setApproachExtensionDistance(0.0);
        }
    }

    emit descriptionChanged(locationDescription());
}

void LocationWidget::onSearchResultSelected(const QModelIndex& index)
{
    FGPositionedRef pos = m_searchModel->itemAtRow(index.row());
    addToRecent(pos);
    setBaseLocation(pos);
}

void LocationWidget::onOffsetBearingTrueChanged(bool on)
{
    m_ui->offsetBearingLabel->setText(on ? tr("True bearing:") :
                                           tr("Magnetic bearing:"));
}

void LocationWidget::addToRecent(FGPositionedRef pos)
{
    FGPositionedList::iterator it = std::find(m_recentLocations.begin(),
                                              m_recentLocations.end(),
                                              pos);
    if (it != m_recentLocations.end()) {
        m_recentLocations.erase(it);
    }

    if (m_recentLocations.size() >= MAX_RECENT_LOCATIONS) {
        m_recentLocations.pop_back();
    }

    m_recentLocations.insert(m_recentLocations.begin(), pos);
    QSettings settings;
    settings.setValue("recent-locations", savePositionList(m_recentLocations));
}


void LocationWidget::onShowHistory()
{
    // prepend the default location
    FGPositionedList locs = m_recentLocations;
    const std::string defaultICAO = flightgear::defaultAirportICAO();

    auto it = std::find_if(locs.begin(), locs.end(), [defaultICAO](FGPositionedRef pos) {
        return pos->ident() == defaultICAO;
    });

    if (it == locs.end()) {
        FGAirportRef apt = FGAirport::findByIdent(defaultICAO);
        locs.insert(locs.begin(), apt);
    }

    m_searchModel->setItems(locs);
}

void LocationWidget::setBaseLocation(FGPositionedRef ref)
{
    m_locationIsLatLon = false;
// don't change location if we're on the same location. We must check
// the current stack index, otherwise there's no way back into the same
// location after using the back button.
    if ((m_location == ref) && (m_ui->stack->currentIndex() != 2)) {
        return;
    }

    m_location = ref;
    onLocationChanged();

    updateDescription();
}

void LocationWidget::setAircraftType(LauncherAircraftType ty)
{
    m_aircraftType = ty;
    // nothing happens until next search
    m_ui->navaidDiagram->setAircraftType(ty);
    m_ui->airportDiagram->setAircraftType(ty);
}

void LocationWidget::onOffsetDataChanged()
{
    m_ui->navaidDiagram->setOffsetEnabled(m_ui->offsetGroup->isChecked());
    m_ui->navaidDiagram->setOffsetBearingDeg(m_ui->offsetBearingSpinbox->value());
    m_ui->navaidDiagram->setOffsetDistanceNm(m_ui->offsetNmSpinbox->value());

    updateDescription();
}

void LocationWidget::onHeadingChanged()
{
    m_ui->navaidDiagram->setHeadingDeg(m_ui->headingSpinbox->value());
}

void LocationWidget::onBackToSearch()
{
    m_ui->stack->setCurrentIndex(2);
    m_backButton->hide();
}

#include "LocationWidget.moc"