projects/mde: mde/gui/WidgetManager.d comparison

comparison mde/gui/WidgetManager.d @ 80:ea58f277f487

Gui reorganization and changes; partial implementation of floating widgets. Moved contents of mde/gui/WidgetData.d elsewhere; new gui/WidgetDataSet.d and gui/types.d modules. Changes to widget/createWidget.d Partially implemented FloatingAreaWidget to provide an area for floating "window" widgets. New DebugWidget and some uses of it (e.g. bad widget data). Decoupled OptionChanges from Options.

author	Diggory Hardy <diggory.hardy@gmail.com>
date	Thu, 07 Aug 2008 11:25:27 +0100
parents	65780e0e48e6
children	d8fccaa45d5f

comparison

equal deleted inserted replaced

-:61ea26abe4dd
+:ea58f277f487
 * This is the module to use externally to create a graphical user interface (likely also with
 * content modules).
 *************************************************************************************************/
 module mde.gui.WidgetManager;
-public import mde.gui.WidgetData;
+import mde.gui.WidgetDataSet;
 import mde.gui.widget.Ifaces;
 import mde.gui.renderer.createRenderer;
 // For adding the input event callbacks and requesting redraws:
 import imde = mde.imde;
 bool delegate(wdabs cx, wdabs cy, ubyte b, bool state) [void*] clickCallbacks;
 void delegate(wdabs cx, wdabs cy) [void*] motionCallbacks;
 IRenderer rend;
 wdim w,h;       // area available to the widgets
 }
+import mde.gui.exception;
+import mde.gui.widget.Ifaces;
+import mde.gui.widget.createWidget;
+import mde.mergetag.Reader;
+import mde.mergetag.Writer;
+import mde.setup.paths;
+/*************************************************************************************************
+* Contains the code for loading and saving the gui, but not the code for drawing it or handling
+* user input.
+*
+* This abstract class exists solely for separating out some of the functionality.
+*************************************************************************************************/
+abstract scope class WidgetLoader : IWidgetManager
+{
+/** Construct a new widget loader.
+*
+* params:
+*  fileName = Name of file specifying the gui, excluding path and extension.
+*/
+protected this (char[] file) {
+mutex = new Mutex;  // Used on functions intended to be called from outside the gui package.
+fileName = file;
+}
+~this () {
+save;
+}
+/* Load the widgets' data from the file specified to the CTOR.
+*
+* params:
+*  allDesigns = Load all sections
+*/
+private void loadData (bool allDesigns = false) {
+if (allLoaded || (defaultDesign !is null && allDesigns == false))
+return; // test if already loaded
+if (!confDir.exists (fileName)) {
+logger.error ("Unable to load GUI: no config file!");
+return; // not a fatal error (so long as the game can run without a GUI!)
+}
+// Set up a reader
+scope IReader reader;
+try {
+reader = confDir.makeMTReader (fileName, PRIORITY.HIGH_LOW, null, true);
+// Read from the HEADER:
+// Get the renderer
+char[]* p = "Renderer" in reader.dataset.header._charA;
+if (p is null || *p is null) {
+logger.warn ("No renderer specified: using \"Simple\"");
+rendName = "Simple";
+}
+else
+rendName = *p;
+// Get which section to use
+p = "Design" in reader.dataset.header._charA;
+if (p is null || *p is null) {
+logger.warn ("No gui design specified: trying \"Default\"");
+defaultDesign = "Default";
+}
+else
+defaultDesign = *p;
+// Read the body:
+// Load the chosen design
+reader.dataSecCreator = delegate mt.IDataSection(mt.ID id) {
+WidgetDataSet* p = id in data;
+if (p is null) {
+data[id] = new WidgetDataSet;
+return *(id in data);
+}
+return *p;
+};
+if (allDesigns) {
+reader.read;
+allLoaded = true;
+} else
+reader.read([defaultDesign]);
+} catch (Exception e) {
+logger.error ("Unable to load GUI: errors parsing config file ("~confDir.getFileName(fileName,PRIORITY.HIGH_LOW)~"):");
+logger.error (e.msg);
+throw new GuiException ("Failure parsing config file");
+}
+}
+/** Load the gui from some design.
+*
+* If a design was previously loaded, its changes are saved first.
+*
+* Params:
+*  name = Design to load. If null, the default will be loaded.
+*/
+void loadDesign (char[] name = null) {
+if (changes !is null)
+save;       // own lock
+mutex.lock;
+scope(exit) mutex.unlock;
+// Load data (loadData tests if it's already loaded first):
+if (name is null) {
+loadData (false);
+name = defaultDesign;
+} else
+loadData (true);
+// Get data:
+auto p = name in data;
+while (p is null) {
+if (name == defaultDesign)
+throw new GuiException ("Unable to load [specified or] default design");
+name = defaultDesign;       // try again with the default
+p = name in data;
+}
+curData = *p;
+// Get/create a changes section:
+if (changesDS is null)
+changesDS = new mt.DataSet;
+mt.IDataSection* q = name in changesDS.sec;
+if (q && ((changes = cast(WidgetDataChanges) *q) !is null)) {}
+else {
+changes = new WidgetDataChanges (curData);
+changesDS.sec[name] = changes;
+}
+// Create the widgets:
+createRootWidget;
+}
+/** Save changes, if any exist.
+*
+* Is run when the manager is destroyed, but could be run at other times too. */
+void save () {
+mutex.lock;
+scope(exit) mutex.unlock;
+// Make all widgets save any changed data; return if no changes:
+if (!child.saveChanges ("root"))
+return;
+if (loadUserFile) { // merge entries from user file into current changes
+try {
+scope IReader reader = confDir.makeMTReader (
+fileName, PRIORITY.HIGH_ONLY, changesDS, true);
+// Create if necessary, only corresponding to existing designs read:
+reader.dataSecCreator = delegate mt.IDataSection(mt.ID id) {
+WidgetDataSet* p = id in data;
+if (p is null)
+throw new Exception ("File has changed since it was loaded!");
+return new WidgetDataChanges (*p);
+};
+reader.read;
+} catch (NoFileException) {
+// No user file exists; not an error.
+} catch (Exception e) {
+logger.error ("Error reading "~confDir.getFileName(fileName,PRIORITY.HIGH_ONLY)~" prior to saving:");
+logger.error (e.msg);
+logger.error ("Overwriting the file.");
+// Continue...
+}
+loadUserFile = false;   // don't need to do it again
+}
+try {   // Save
+IWriter writer;
+writer = confDir.makeMTWriter (fileName, changesDS);
+writer.write;
+} catch (Exception e) {
+logger.error ("Saving to "~confDir.getFileName(fileName,PRIORITY.HIGH_ONLY)~" failed:");
+logger.error (e.msg);
+// No point in throwing since it doesn't affect anything else.
+}
+}
+/** Get the names of all designs available. */
+char[][] designs() {
+synchronized(mutex) {
+loadData (true);
+return data.keys;
+}
+}
+/** Create a widget by ID. */
+IChildWidget makeWidget (widgetID id, IParentWidget parent = null) {
+debug logger.trace ("Creating widget \""~id~'"');
+return createWidget (this, curData[id], parent);
+}
+/** For making changes. */
+void setData (widgetID id, WidgetData d) {
+changes[id] = d;        // also updates WidgetDataSet in data.
+}
+/** Second stage of loading the widgets.
+*
+* loadDesign handles the data; this method needs to:
+* ---
+* // 1. Create the root widget:
+* child = makeWidget ("root");
+* // 2. Set the setSize, e.g.:
+* child.setWidth  (child.minWidth,  1);
+* child.setHeight (child.minHeight, 1);
+* ---
+*/
+void createRootWidget();
+protected:
+final char[] fileName;
+char[] defaultDesign;       // The design specified in the file header.
+char[] rendName;    // Name of renderer; for saving and creating renderers
+// Loaded data, indexed by design name. May not be loaded for all gui designs:
+scope WidgetDataSet[char[]] data;
+private bool allLoaded = false;  // applies to data
+WidgetDataSet curData;      // Current data
+WidgetDataChanges changes;  // Changes for the current design.
+scope mt.DataSet changesDS; // changes and sections from user file (used for saving)
+bool loadUserFile = true;   // still need to load user file for saving?
+scope IChildWidget child;   // The primary widget.
+Mutex mutex;    // lock on methods for use outside the package.
+}

Mercurial > projects > mde

comparison mde/gui/WidgetManager.d @ 80:ea58f277f487