flightgear/src/GUI/new_gui.cxx

// new_gui.cxx: implementation of XML-configurable GUI support.

#include "new_gui.hxx"

#include <plib/pu.h>
#include <plib/ul.h>

#include <vector>
SG_USING_STD(vector);

#include <simgear/misc/exception.hxx>
#include <Main/fg_props.hxx>



////////////////////////////////////////////////////////////////////////
// Callbacks.
////////////////////////////////////////////////////////////////////////


/**
 * Callback to update all property values.
 */
static void
update_callback (puObject * object)
{
    ((GUIWidget *)object->getUserData())->updateProperties();
}


/**
 * Callback to close the dialog.
 */
static void
close_callback (puObject * object)
{
    delete ((GUIWidget *)object->getUserData());
}


/**
 * Callback to apply the property value for every field.
 */
static void
apply_callback (puObject * object)
{
    ((GUIWidget *)object->getUserData())->applyProperties();
    update_callback(object);
}


/**
 * Callback to apply the property values and close the dialog.
 */
static void
close_apply_callback (puObject * object)
{
    apply_callback(object);
    close_callback(object);
}



////////////////////////////////////////////////////////////////////////
// Implementation of GUIWidget.
////////////////////////////////////////////////////////////////////////

GUIWidget::GUIWidget (SGPropertyNode_ptr props)
    : _object(0)
{
    display(props);
}

GUIWidget::~GUIWidget ()
{
    delete _object;
}

void
GUIWidget::display (SGPropertyNode_ptr props)
{
    if (_object != 0) {
        SG_LOG(SG_GENERAL, SG_ALERT, "This widget is already active");
        return;
    }

    _object = makeObject(props, 1024, 768);

    if (_object != 0) {
        _object->reveal();
    } else {
        SG_LOG(SG_GENERAL, SG_ALERT, "Widget "
               << props->getStringValue("name", "[unnamed]")
               << " does not contain a proper GUI definition");
    }
}


void
GUIWidget::applyProperties ()
{
    for (int i = 0; i < _propertyObjects.size(); i++) {
        puObject * object = _propertyObjects[i].object;
        SGPropertyNode_ptr node = _propertyObjects[i].node;
        node->setStringValue(object->getStringValue());
    }
}

void
GUIWidget::updateProperties ()
{
    for (int i = 0; i < _propertyObjects.size(); i++) {
        puObject * object = _propertyObjects[i].object;
        SGPropertyNode_ptr node = _propertyObjects[i].node;
        object->setValue(node->getStringValue());
    }
}

puObject *
GUIWidget::makeObject (SGPropertyNode * props, int parentWidth, int parentHeight)
{
    int width = props->getIntValue("width", parentWidth);
    int height = props->getIntValue("height", parentHeight);

    int x = props->getIntValue("x", (parentWidth - width) / 2);
    int y = props->getIntValue("y", (parentHeight - height) / 2);

    string type = props->getName();
    if (type == "")
        type = props->getStringValue("type");
    if (type == "") {
        SG_LOG(SG_GENERAL, SG_ALERT, "No type specified for GUI object");
        return 0;
    }

    if (type == "dialog") {
        puPopup * dialog;
        if (props->getBoolValue("modal", false))
            dialog = new puDialogBox(x, y);
        else
            dialog = new puPopup(x, y);
        setupGroup(dialog, props, width, height, true);
        return dialog;
    } else if (type == "group") {
        puGroup * group = new puGroup(x, y);
        setupGroup(group, props, width, height, false);
        return group;
    } else if (type == "input") {
        puInput * input = new puInput(x, y, x + width, y + height);
        setupObject(input, props);
        return input;
    } else if (type == "text") {
        puText * text = new puText(x, y);
        setupObject(text, props);
        return text;
    } else if (type == "button") {
        puButton * b;
        const char * legend = props->getStringValue("legend", "[none]");
        if (props->getBoolValue("one-shot", true))
            b = new puOneShot(x, y, legend);
        else
            b = new puButton(x, y, legend);
        setupObject(b, props);
        return b;
    } else {
        return 0;
    }
}

void
GUIWidget::setupObject (puObject * object, SGPropertyNode * props)
{
    object->setUserData(this);

    if (props->hasValue("legend"))
        object->setLegend(props->getStringValue("legend"));

    if (props->hasValue("label"))
        object->setLabel(props->getStringValue("label"));

    if (props->hasValue("default-value-prop")) {
        const char * name = props->getStringValue("default-value-prop");
        SGPropertyNode_ptr node = fgGetNode(name, true);
        object->setValue(node->getStringValue());
        _propertyObjects.push_back(PropertyObject(object, node));
    }

    if (props->hasValue("action")) {
        string action = props->getStringValue("action");
        if (action == "update")
            object->setCallback(update_callback);
        else if (action == "close")
            object->setCallback(close_callback);
        else if (action == "apply")
            object->setCallback(apply_callback);
        else if (action == "close-apply")
            object->setCallback(close_apply_callback);
        else
            SG_LOG(SG_GENERAL, SG_ALERT, "Unknown GUI action " + action);
    }

    object->makeReturnDefault(props->getBoolValue("default"));
}

void
GUIWidget::setupGroup (puGroup * group, SGPropertyNode * props,
                    int width, int height, bool makeFrame)
{
    setupObject(group, props);

    if (makeFrame)
        new puFrame(0, 0, width, height);

    int nChildren = props->nChildren();
    for (int i = 0; i < nChildren; i++)
        makeObject(props->getChild(i), width, height);
    group->close();
}

GUIWidget::PropertyObject::PropertyObject (puObject * o, SGPropertyNode_ptr n)
    : object(o),
      node(n)
{
}



////////////////////////////////////////////////////////////////////////
// Implementation of NewGUI.
////////////////////////////////////////////////////////////////////////


NewGUI::NewGUI ()
{
}

NewGUI::~NewGUI ()
{
}

void
NewGUI::init ()
{
    char path[1024];
    ulMakePath(path, getenv("FG_ROOT"), "gui");
    readDir(path);
}

void
NewGUI::update (double delta_time_sec)
{
    // NO OP
}

void
NewGUI::display (const string &name)
{
    if (_widgets.find(name) == _widgets.end())
        SG_LOG(SG_GENERAL, SG_ALERT, "Dialog " << name << " not defined");
    else
        new GUIWidget(_widgets[name]); // PUI will delete it
}

void
NewGUI::readDir (const char * path)
{
    ulDir * dir = ulOpenDir(path);

    if (dir == 0) {
        SG_LOG(SG_GENERAL, SG_ALERT, "Failed to read GUI files from "
               << path);
        return;
    }

    ulDirEnt * dirEnt = ulReadDir(dir);
    while (dirEnt != 0) {
        char subpath[1024];

        ulMakePath(subpath, path, dirEnt->d_name);

        if (dirEnt->d_isdir && dirEnt->d_name[0] != '.') {
            readDir(subpath);
        } else {
            SGPropertyNode_ptr props = new SGPropertyNode;
            try {
                readProperties(subpath, props);
            } catch (const sg_exception &ex) {
                SG_LOG(SG_INPUT, SG_ALERT, "Error parsing GUI file "
                       << subpath);
            }
            if (!props->hasValue("name")) {
                SG_LOG(SG_INPUT, SG_WARN, "GUI file " << subpath
                   << " has no name; skipping.");
            } else {
                string name = props->getStringValue("name");
                SG_LOG(SG_INPUT, SG_BULK, "Saving GUI node " << name);
                _widgets[name] = props;
            }
        }
        dirEnt = ulReadDir(dir);
    }
    ulCloseDir(dir);
}

// end of new_gui.cxx