os_ui.cpp

//
//    openSAM: open source SAM emulator for X Plane
//
//    Copyright (C) 2025  Holger Teutsch
//
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//
//    This library 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
//    Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
//    USA
//

#include <cstdlib>
#include <cstdio>
#include "openSAM.h"
#include "plane.h"
#include "samjw.h"
#include "jwctrl.h"
#include "widget_ctx.h"

#include "XPLMDisplay.h"
#include "XPStandardWidgets.h"

#include "version.h"

static WidgetCtx ui_widget_ctx;

static XPWidgetID ui_widget, jw_btn[kMaxDoor][kNearJwLimit],
    auto_btn, dock_btn, undock_btn;

static void CloseUI() {
    ui_widget_ctx.Hide();
}

// static
int MyPlane::UIWidgetCb(XPWidgetMessage msg, XPWidgetID widget_id, [[maybe_unused]] intptr_t param1,
                          intptr_t param2) {
    if (msg == xpMessage_CloseButtonPushed) {
        CloseUI();
        return 1;
    }

    unsigned n_door = my_plane->n_door_;

    if (msg == xpMsg_PushButtonPressed && widget_id == dock_btn) {
        LogMsg("Dock pressed");
        if (!my_plane->auto_mode() && my_plane->ui_unlocked_) {
            // we can be called several times in this callback, so we need
            // some effort to maintain the selected flags

            // first clear all selected flags then later set specifically
            for (auto& njw : my_plane->nearest_jws_)
                njw.selected_ = false;

            my_plane->active_jws_.clear();

            for (unsigned i = 0; i < n_door; i++) {
                // check for a selected button
                for (unsigned j = 0; j < my_plane->nearest_jws_.size(); j++) {
                    int state = (uint64_t)XPGetWidgetProperty(jw_btn[i][j], xpProperty_ButtonState, NULL);
                    if (state) {
                        LogMsg("active jw for door %d is %s", i, my_plane->nearest_jws_[j].jw_->name.c_str());
                        my_plane->nearest_jws_[j].selected_ = true;
                        my_plane->nearest_jws_[j].door_ = i;
                        my_plane->active_jws_.push_back(my_plane->nearest_jws_[j]);
                    }
                }
            }
        }

        my_plane->dock_requested_ = true;
        CloseUI();
        return 1;
    }

    if (msg == xpMsg_PushButtonPressed && widget_id == undock_btn) {
        LogMsg("Undock pressed");
        my_plane->undock_requested_ = true;
        CloseUI();
        return 1;
    }

    if (msg == xpMsg_ButtonStateChanged && widget_id == auto_btn) {
        bool auto_mode = (bool)(uint64_t)param2;
        LogMsg("auto_mode now: %d", auto_mode);

        my_plane->AutoModeSet(auto_mode);  // start over with new setting
        return 1;
    }

    // one of the jw select buttons
    if (msg == xpMsg_ButtonStateChanged) {
        // find index of button
        int idoor = -1, ijw = -1;
        for (unsigned i = 0; i < n_door; i++)
            for (unsigned j = 0; j < my_plane->nearest_jws_.size(); j++)
                if (jw_btn[i][j] == widget_id) {
                    idoor = i;
                    ijw = j;
                    break;
                }

        if (idoor < 0 || ijw < 0) {
            LogMsg("invalid button selection???");
            return 1;
        }

        int new_state = (int)(uint64_t)param2;
        LogMsg("button door: %d, jw: %d pressed, name: %s, new_state: %d", idoor, ijw,
               my_plane->nearest_jws_[ijw].jw_->name.c_str(), new_state);

        // unselect all other buttons for the selected door
        for (unsigned j = 0; j < my_plane->nearest_jws_.size(); j++)
            if ((int)j != ijw)
                XPSetWidgetProperty(jw_btn[idoor][j], xpProperty_ButtonState, 0);

        // unselect selected jw for other doors
        for (unsigned i = 0; i < n_door; i++)
            if ((int)i != idoor)
                XPSetWidgetProperty(jw_btn[i][ijw], xpProperty_ButtonState, 0);

        return 1;
    }

    return 0;
}

void MyPlane::UpdateUI(bool only_if_visible) {
    if (ui_widget == NULL || (only_if_visible && !XPIsWidgetVisible(ui_widget))) {
        LogMsg("UpdateUI: widget is not visible");
        return;
    }

    LogMsg("UpdateUI started");
    XPSetWidgetProperty(auto_btn, xpProperty_ButtonState, auto_mode_);

    // hide everything
    for (unsigned i = 0; i < kMaxDoor; i++)
        for (unsigned j = 0; j < kNearJwLimit; j++)
            XPHideWidget(jw_btn[i][j]);

    // if manual selection set label and unhide
    if (ui_unlocked_ && !auto_mode_) {
        for (unsigned i = 0; i < n_door_; i++)
            for (unsigned j = 0; j < nearest_jws_.size(); j++) {
                JwCtrl& njw = nearest_jws_[j];
                XPWidgetID btn = jw_btn[i][j];
                XPSetWidgetDescriptor(btn, njw.jw_->name.c_str());
                XPSetWidgetProperty(btn, xpProperty_ButtonState, 0);
                XPShowWidget(btn);
            }
    }

    LogMsg("UpdateUI finished");
}

static void CreateUI() {
    // Note that (0,0) is the top left while for widgets it's bottom left
    // so we pass the y* arguments that the outcome is in widget coordinates

    int xl, yr;
    XPLMGetScreenBoundsGlobal(&xl, &yr, NULL, NULL);

    static const int margin = 20;
    static const int col_spacing = 60;

    int left = xl + 50;
    int top = yr - 100;
    int width = 2 * margin + kMaxDoor * col_spacing;
    int height = 240;
    int left1;

    ui_widget = XPCreateWidget(left, top, left + width, top - height, 0, "openSAM " VERSION_SHORT, 1, NULL,
                               xpWidgetClass_MainWindow);
    ui_widget_ctx.Set(ui_widget, left, top, width, height);

    XPSetWidgetProperty(ui_widget, xpProperty_MainWindowHasCloseBoxes, 1);
    XPAddWidgetCallback(ui_widget, MyPlane::UIWidgetCb);

    top -= 20;
    left1 = left + 60;
    XPCreateWidget(left1, top, left1 + 50, top - 20, 1, "Jetway selection", 0, ui_widget, xpWidgetClass_Caption);

    top -= 30;
    left1 = left + margin;

    auto_btn =
        XPCreateWidget(left1, top, left1 + 100, top - 20, 1, "Automatic Mode", 0, ui_widget, xpWidgetClass_Button);
    XPSetWidgetProperty(auto_btn, xpProperty_ButtonBehavior, xpButtonBehaviorCheckBox);
    XPAddWidgetCallback(auto_btn, MyPlane::UIWidgetCb);

    top -= 30;
    for (int i = 0; i < kMaxDoor; i++) {
        char label[50];
        sprintf(label, "Door %d", i + 1);
        XPCreateWidget(left1, top, left1 + 50, top - 20, 1, label, 0, ui_widget, xpWidgetClass_Caption);
        left1 += col_spacing;
    }

    top -= 20;
    for (int j = 0; j < kNearJwLimit; j++) {
        left1 = left + margin;
        for (int i = 0; i < kMaxDoor; i++) {
            XPWidgetID btn = jw_btn[i][j] =
                XPCreateWidget(left1, top, left1 + 50, top - 20, 1, "Jw", 0, ui_widget, xpWidgetClass_Button);

            XPSetWidgetProperty(btn, xpProperty_ButtonBehavior, xpButtonBehaviorCheckBox);
            XPAddWidgetCallback(btn, MyPlane::UIWidgetCb);

            left1 += col_spacing;
        }
        top -= 20;
    }

    top -= 20;
    left1 = left + margin;
    dock_btn = XPCreateWidget(left1, top, left1 + 50, top - 20, 1, "Dock", 0, ui_widget, xpWidgetClass_Button);
    XPSetWidgetProperty(dock_btn, xpProperty_ButtonType, xpPushButton);
    XPSetWidgetProperty(dock_btn, xpProperty_ButtonBehavior, xpButtonBehaviorPushButton);
    XPAddWidgetCallback(dock_btn, MyPlane::UIWidgetCb);

    left1 = left + 2 * margin + 50;
    undock_btn = XPCreateWidget(left1, top, left1 + 50, top - 20, 1, "Undock", 0, ui_widget, xpWidgetClass_Button);
    XPSetWidgetProperty(undock_btn, xpProperty_ButtonType, xpPushButton);
    XPSetWidgetProperty(undock_btn, xpProperty_ButtonBehavior, xpButtonBehaviorPushButton);
    XPAddWidgetCallback(undock_btn, MyPlane::UIWidgetCb);
}

void ToggleUI(void) {
    LogMsg("ToggleUI called");

    if (ui_widget == NULL)
        CreateUI();

    if (XPIsWidgetVisible(ui_widget)) {
        CloseUI();
        return;
    }

    if (!my_plane->is_helicopter_) {
        my_plane->UpdateUI(0);
        ui_widget_ctx.Show();
    }
}