Make FGDialog an interface, moving existing code to FGPUIDialog implementation. (no functionality change, yet)

src/GUI/AirportList.hxx

@@ -5,7 +5,7 @@
 
 #include <simgear/compiler.h>
 #include <plib/puAux.h>
-#include "dialog.hxx"
+#include "FGPUIDialog.hxx"
 
 class FGAirportList;
 

src/GUI/CMakeLists.txt

@@ -6,6 +6,7 @@ set(SOURCES
 	SafeTexFont.cxx
 	WaypointList.cxx
 	dialog.cxx
+	FGPUIDialog.cxx
 	fonts.cxx
 	gui.cxx
 	gui_funcs.cxx
@@ -24,6 +25,7 @@ set(HEADERS
 	SafeTexFont.hxx
 	WaypointList.hxx
 	dialog.hxx
+	FGPUIDialog.hxx
 	gui.h
 	layout.hxx
 	menubar.hxx

src/GUI/FGPUIDialog.hxx

@@ -0,0 +1,277 @@
+// FGPUIDialog.hxx - XML-configured dialog box.
+
+#ifndef FG_PUI_DIALOG_HXX
+#define FG_PUI_DIALOG_HXX 1
+
+#include "dialog.hxx"
+
+#include <plib/puAux.h>
+
+#include <simgear/props/props.hxx>
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/props/condition.hxx>
+
+#include <vector>
+
+
+// ugly temporary workaround for plib's lack of user defined class ids  FIXME
+#define FGCLASS_LIST          0x00000001
+#define FGCLASS_AIRPORTLIST   0x00000002
+#define FGCLASS_PROPERTYLIST  0x00000004
+#define FGCLASS_WAYPOINTLIST  0x00000008
+
+class GUI_ID { public: GUI_ID(int id) : id(id) {} virtual ~GUI_ID() {} int id; };
+
+
+
+class NewGUI;
+class FGColor;
+class puObject;
+class puFont;
+
+/**
+ * An XML-configured dialog box.
+ *
+ * The GUI manager stores only the property tree for the dialog
+ * boxes.  This class creates a PUI dialog box on demand from
+ * the properties in that tree.  The manager recreates the dialog
+ * every time it needs to show it.
+ */
+class FGPUIDialog : public FGDialog
+{
+public:
+
+    /**
+     * Construct a new GUI widget configured by a property tree.
+     *
+     * The configuration properties are not part of the main
+     * FlightGear property tree; the GUI manager reads them
+     * from individual configuration files.
+     *
+     * @param props A property tree describing the dialog.
+     */
+    FGPUIDialog (SGPropertyNode * props);
+
+
+    /**
+     * Destructor.
+     */
+    virtual ~FGPUIDialog ();
+
+
+    /**
+     * Update the values of all GUI objects with a specific name,
+     * or all if name is 0 (default).
+     *
+     * This method copies values from the FlightGear property tree to
+     * the GUI object(s).
+     *
+     * @param objectName The name of the GUI object(s) to update.
+     *        Use the empty name for all unnamed objects.
+     */
+    virtual void updateValues (const char * objectName = 0);
+
+
+    /**
+     * Apply the values of all GUI objects with a specific name,
+     * or all if name is 0 (default)
+     *
+     * This method copies values from the GUI object(s) to the
+     * FlightGear property tree.
+     *
+     * @param objectName The name of the GUI object(s) to update.
+     *        Use the empty name for all unnamed objects.
+     */
+    virtual void applyValues (const char * objectName = 0);
+
+
+    /**
+     * Update state.  Called on active dialogs before rendering.
+     */
+    virtual void update ();
+
+    /**
+     * Recompute the dialog's layout
+     */
+    void relayout();
+    
+    
+    void setNeedsLayout() {
+      _needsRelayout = true;
+    }
+private:
+
+    enum {
+        BACKGROUND = 0x01,
+        FOREGROUND = 0x02,
+        HIGHLIGHT = 0x04,
+        LABEL = 0x08,
+        LEGEND = 0x10,
+        MISC = 0x20,
+        EDITFIELD = 0x40
+    };
+
+    // Show the dialog.
+    void display (SGPropertyNode * props);
+
+    // Build the dialog or a subobject of it.
+    puObject * makeObject (SGPropertyNode * props,
+                           int parentWidth, int parentHeight);
+
+    // Common configuration for all GUI objects.
+    void setupObject (puObject * object, SGPropertyNode * props);
+
+    // Common configuration for all GUI group objects.
+    void setupGroup (puGroup * group, SGPropertyNode * props,
+                     int width, int height, bool makeFrame = false);
+
+    // Set object colors: the "which" argument defines which color qualities
+    // (PUCOL_LABEL, etc.) should pick up the <color> property.
+    void setColor(puObject * object, SGPropertyNode * props, int which = 0);
+
+    // return key code number for keystring
+    int getKeyCode(const char *keystring);
+
+    /**
+     * Apply layout sizes to a tree of puObjects
+     */
+    void applySize(puObject *object);
+
+    // The top-level PUI object.
+    puObject * _object;
+
+    // The GUI subsystem.
+    NewGUI * _gui;
+
+    // The dialog font. Defaults to the global gui font, but can get
+    // overridden by a top level font definition.
+    puFont * _font;
+
+    // The source xml tree, so that we can pass data back, such as the
+    // last position.
+    SGPropertyNode_ptr _props;
+
+    bool _needsRelayout;
+
+    // Nasal module.
+    std::string _module;
+    SGPropertyNode_ptr _nasal_close;
+
+    // PUI provides no way for userdata to be deleted automatically
+    // with a GUI object, so we have to keep track of all the special
+    // data we allocated and then free it manually when the dialog
+    // closes.
+    std::vector<void *> _info;
+    struct PropertyObject {
+        PropertyObject (const char * name,
+                        puObject * object,
+                        SGPropertyNode_ptr node);
+        std::string name;
+        puObject * object;
+        SGPropertyNode_ptr node;
+    };
+    std::vector<PropertyObject *> _propertyObjects;
+    std::vector<PropertyObject *> _liveObjects;
+    
+    class ConditionalObject : public SGConditional
+    {
+    public:
+      ConditionalObject(const std::string& aName, puObject* aPu) :
+        _name(aName),
+        _pu(aPu)
+      { ; }
+    
+      void update(FGPUIDialog* aDlg);
+    
+    private:
+      const std::string _name;
+      puObject* _pu;      
+    };
+    
+    typedef SGSharedPtr<ConditionalObject> ConditionalObjectRef;
+    std::vector<ConditionalObjectRef> _conditionalObjects;
+};
+
+//
+// Custom subclass of puPopup to implement "draggable" windows in the
+// interface.  Note that this is a subclass of puPopup, not
+// puDialogBox.  Sadly, PUI (mis)uses subclassing to implement a
+// boolean property: modality.  That means that we can't implement
+// dragging of both puPopup windows and puDialogBoxes with the same
+// code.  Rather than duplicate code, I've chosen to implement only
+// "non-modal dragability" here.  Modal dialog boxes (like the exit
+// confirmation) are not draggable.
+//
+class fgPopup : public puPopup {
+public:
+    fgPopup(int x, int y, bool r = true, bool d = true) :
+            puPopup(x, y), _draggable(d), _resizable(r), _dragging(false)
+    {}
+    int checkHit(int b, int up, int x, int y);
+    int checkKey(int key, int updown);
+    int getHitObjects(puObject *, int x, int y);
+    puObject *getKeyObject(puObject *, int key);
+    puObject *getActiveInputField(puObject *);
+    void applySize(puObject *);
+private:
+    enum { LEFT = 1, RIGHT = 2, TOP = 4, BOTTOM = 8 };
+    bool _draggable;
+    bool _resizable;
+    bool _dragging;
+    int _resizing;
+    int _start_cursor;
+    int _cursor;
+    int _dlgX, _dlgY, _dlgW, _dlgH;
+    int _startX, _startY;
+};
+
+
+class fgValueList {
+public:
+    fgValueList(SGPropertyNode *p);
+    virtual ~fgValueList();
+    virtual void update();
+
+protected:
+    char **_list;
+
+private:
+    void make_list();
+    void destroy_list();
+    SGPropertyNode_ptr _props;
+};
+
+
+class fgList : public fgValueList, public puaList, public GUI_ID {
+public:
+    fgList(int x1, int y1, int x2, int y2, SGPropertyNode *p, int sw) :
+            fgValueList(p), puaList(x1, y1, x2, y2, _list, sw), GUI_ID(FGCLASS_LIST) {}
+    void update();
+};
+
+class fgComboBox : public fgValueList, public puaComboBox {
+public:
+    fgComboBox(int x1, int y1, int x2, int y2, SGPropertyNode *p, bool editable) :
+        fgValueList(p), 
+        puaComboBox(x1, y1, x2, y2, _list, editable),
+        _inHit(false)
+      {}
+        
+    void update();
+    
+    virtual void setSize(int w, int h);
+    
+    virtual int checkHit(int b, int up, int x, int y);
+    
+    virtual void recalc_bbox();
+private:
+    bool _inHit;
+};
+
+class fgSelectBox : public fgValueList, public puaSelectBox {
+public:
+    fgSelectBox(int x1, int y1, int x2, int y2, SGPropertyNode *p) :
+        fgValueList(p), puaSelectBox(x1, y1, x2, y2, _list) {}
+};
+
+#endif // __DIALOG_HXX

src/GUI/WaypointList.hxx

@@ -10,7 +10,7 @@
 
 #include <plib/pu.h>
 
-#include "dialog.hxx" // for GUI_ID
+#include "FGPUIDialog.hxx" // for GUI_ID
 
 // forward decls
 class puaScrollBar;

src/GUI/dialog.hxx

@@ -7,31 +7,8 @@
 # error This library requires C++
 #endif
 
-#include <plib/puAux.h>
+// forward decls
-
+class SGPropertyNode;
-#include <simgear/compiler.h>	// for SG_USING_STD
-#include <simgear/props/props.hxx>
-#include <simgear/misc/sg_path.hxx>
-#include <simgear/props/condition.hxx>
-
-#include <vector>
-using std::vector;
-
-
-// ugly temporary workaround for plib's lack of user defined class ids  FIXME
-#define FGCLASS_LIST          0x00000001
-#define FGCLASS_AIRPORTLIST   0x00000002
-#define FGCLASS_PROPERTYLIST  0x00000004
-#define FGCLASS_WAYPOINTLIST  0x00000008
-
-class GUI_ID { public: GUI_ID(int id) : id(id) {} virtual ~GUI_ID() {} int id; };
-
-
-
-class FGDialog;
-class NewGUI;
-class FGColor;
-
 
 /**
  * An XML-configured dialog box.
@@ -45,16 +22,6 @@ class FGDialog
 {
 public:
 
-    /**
-     * Construct a new GUI widget configured by a property tree.
-     *
-     * The configuration properties are not part of the main
-     * FlightGear property tree; the GUI manager reads them
-     * from individual configuration files.
-     *
-     * @param props A property tree describing the dialog.
-     */
-    FGDialog (SGPropertyNode * props);
 
 
     /**
@@ -73,7 +40,7 @@ public:
      * @param objectName The name of the GUI object(s) to update.
      *        Use the empty name for all unnamed objects.
      */
-    virtual void updateValues (const char * objectName = 0);
+    virtual void updateValues (const char * objectName = 0) = 0;
 
 
     /**
@@ -86,199 +53,28 @@ public:
      * @param objectName The name of the GUI object(s) to update.
      *        Use the empty name for all unnamed objects.
      */
-    virtual void applyValues (const char * objectName = 0);
+    virtual void applyValues (const char * objectName = 0) = 0;
 
 
     /**
      * Update state.  Called on active dialogs before rendering.
      */
-    virtual void update ();
+    virtual void update () = 0;
-
-    /**
-     * Recompute the dialog's layout
-     */
-    void relayout();
-    
-    
-    void setNeedsLayout() {
-      _needsRelayout = true;
-    }
-private:
-
-    enum {
-        BACKGROUND = 0x01,
-        FOREGROUND = 0x02,
-        HIGHLIGHT = 0x04,
-        LABEL = 0x08,
-        LEGEND = 0x10,
-        MISC = 0x20,
-        EDITFIELD = 0x40
-    };
-
-    // Private copy constructor to avoid unpleasant surprises.
-    FGDialog (const FGDialog &);
-
-    // Show the dialog.
-    void display (SGPropertyNode * props);
-
-    // Build the dialog or a subobject of it.
-    puObject * makeObject (SGPropertyNode * props,
-                           int parentWidth, int parentHeight);
-
-    // Common configuration for all GUI objects.
-    void setupObject (puObject * object, SGPropertyNode * props);
-
-    // Common configuration for all GUI group objects.
-    void setupGroup (puGroup * group, SGPropertyNode * props,
-                     int width, int height, bool makeFrame = false);
-
-    // Set object colors: the "which" argument defines which color qualities
-    // (PUCOL_LABEL, etc.) should pick up the <color> property.
-    void setColor(puObject * object, SGPropertyNode * props, int which = 0);
-
-    // return key code number for keystring
-    int getKeyCode(const char *keystring);
-
-    /**
-     * Apply layout sizes to a tree of puObjects
-     */
-    void applySize(puObject *object);
-
-    // The top-level PUI object.
-    puObject * _object;
-
-    // The GUI subsystem.
-    NewGUI * _gui;
-
-    // The dialog font. Defaults to the global gui font, but can get
-    // overridden by a top level font definition.
-    puFont * _font;
-
-    // The source xml tree, so that we can pass data back, such as the
-    // last position.
-    SGPropertyNode_ptr _props;
-
-    bool _needsRelayout;
-
-    // Nasal module.
-    std::string _module;
-    SGPropertyNode_ptr _nasal_close;
-
-    // PUI provides no way for userdata to be deleted automatically
-    // with a GUI object, so we have to keep track of all the special
-    // data we allocated and then free it manually when the dialog
-    // closes.
-    vector<void *> _info;
-    struct PropertyObject {
-        PropertyObject (const char * name,
-                        puObject * object,
-                        SGPropertyNode_ptr node);
-        std::string name;
-        puObject * object;
-        SGPropertyNode_ptr node;
-    };
-    vector<PropertyObject *> _propertyObjects;
-    vector<PropertyObject *> _liveObjects;
-    
-    class ConditionalObject : public SGConditional
-    {
-    public:
-      ConditionalObject(const std::string& aName, puObject* aPu) :
-        _name(aName),
-        _pu(aPu)
-      { ; }
-    
-      void update(FGDialog* aDlg);
-    
-    private:
-      const std::string _name;
-      puObject* _pu;      
-    };
-    
-    typedef SGSharedPtr<ConditionalObject> ConditionalObjectRef;
-    vector<ConditionalObjectRef> _conditionalObjects;
-};
-
-//
-// Custom subclass of puPopup to implement "draggable" windows in the
-// interface.  Note that this is a subclass of puPopup, not
-// puDialogBox.  Sadly, PUI (mis)uses subclassing to implement a
-// boolean property: modality.  That means that we can't implement
-// dragging of both puPopup windows and puDialogBoxes with the same
-// code.  Rather than duplicate code, I've chosen to implement only
-// "non-modal dragability" here.  Modal dialog boxes (like the exit
-// confirmation) are not draggable.
-//
-class fgPopup : public puPopup {
-public:
-    fgPopup(int x, int y, bool r = true, bool d = true) :
-            puPopup(x, y), _draggable(d), _resizable(r), _dragging(false)
-    {}
-    int checkHit(int b, int up, int x, int y);
-    int checkKey(int key, int updown);
-    int getHitObjects(puObject *, int x, int y);
-    puObject *getKeyObject(puObject *, int key);
-    puObject *getActiveInputField(puObject *);
-    void applySize(puObject *);
-private:
-    enum { LEFT = 1, RIGHT = 2, TOP = 4, BOTTOM = 8 };
-    bool _draggable;
-    bool _resizable;
-    bool _dragging;
-    int _resizing;
-    int _start_cursor;
-    int _cursor;
-    int _dlgX, _dlgY, _dlgW, _dlgH;
-    int _startX, _startY;
-};
-
-
-class fgValueList {
-public:
-    fgValueList(SGPropertyNode *p);
-    virtual ~fgValueList();
-    virtual void update();
 
 protected:
-    char **_list;
+    /**
+     * Construct a new GUI widget configured by a property tree.
+     *
+     * The configuration properties are not part of the main
+     * FlightGear property tree; the GUI manager reads them
+     * from individual configuration files.
+     *
+     * @param props A property tree describing the dialog.
+     */
+    FGDialog (SGPropertyNode * props);
 
 private:
-    void make_list();
-    void destroy_list();
-    SGPropertyNode_ptr _props;
-};
 
-
-class fgList : public fgValueList, public puaList, public GUI_ID {
-public:
-    fgList(int x1, int y1, int x2, int y2, SGPropertyNode *p, int sw) :
-            fgValueList(p), puaList(x1, y1, x2, y2, _list, sw), GUI_ID(FGCLASS_LIST) {}
-    void update();
-};
-
-class fgComboBox : public fgValueList, public puaComboBox {
-public:
-    fgComboBox(int x1, int y1, int x2, int y2, SGPropertyNode *p, bool editable) :
-        fgValueList(p), 
-        puaComboBox(x1, y1, x2, y2, _list, editable),
-        _inHit(false)
-      {}
-        
-    void update();
-    
-    virtual void setSize(int w, int h);
-    
-    virtual int checkHit(int b, int up, int x, int y);
-    
-    virtual void recalc_bbox();
-private:
-    bool _inHit;
-};
-
-class fgSelectBox : public fgValueList, public puaSelectBox {
-public:
-    fgSelectBox(int x1, int y1, int x2, int y2, SGPropertyNode *p) :
-        fgValueList(p), puaSelectBox(x1, y1, x2, y2, _list) {}
 };
 
 #endif // __DIALOG_HXX

src/GUI/new_gui.cxx

@@ -27,7 +27,7 @@
 #endif
 
 #include "menubar.hxx"
-#include "dialog.hxx"
+#include "FGPUIDialog.hxx"
 #include "FGFontCache.hxx"
 #include "FGColor.hxx"
 
@@ -80,7 +80,7 @@ void
 NewGUI::reset (bool reload)
 {
     map<string,FGDialog *>::iterator iter;
-    vector<string> dlg;
+    std::vector<string> dlg;
     // close all open dialogs and remember them ...
     for (iter = _active_dialogs.begin(); iter != _active_dialogs.end(); ++iter)
         dlg.push_back(iter->first);
@@ -138,7 +138,7 @@ NewGUI::showDialog (const string &name)
         return false;
     } else {
         if(!_active_dialogs[name])
-            _active_dialogs[name] = new FGDialog(_dialog_props[name]);
+            _active_dialogs[name] = new FGPUIDialog(_dialog_props[name]);
         return true;
     }
 }

src/GUI/property_list.hxx

@@ -27,7 +27,7 @@
 
 #include <plib/puAux.h>
 #include <simgear/props/props.hxx>
-#include "dialog.hxx"
+#include "FGPUIDialog.hxx"
 
 
 class PropertyList : public puaList, public SGPropertyChangeListener, public GUI_ID {