Changeset 122

Timestamp:

08/19/10 19:21:08 (18 months ago)

Author:

Carsten

Message:

CaWE GUI editor:

• Lua errors on loading a GUI are now presented to the user.
• Window names are checked for unique-ness now (and silently repaired, if necessary) when the GUI is saved.

Fixes #37.

Location:

cafu/trunk

Files:

• CaWE/GuiEditor/Commands/Paste.cpp (modified) (5 diffs)
• CaWE/GuiEditor/EditorData/Window.cpp (modified) (3 diffs)
• CaWE/GuiEditor/EditorData/Window.hpp (modified) (2 diffs)
• CaWE/GuiEditor/GuiDocument.cpp (modified) (4 diffs)
• Libs/GuiSys/GuiImpl.cpp (modified) (2 diffs)
• Libs/GuiSys/GuiImpl.hpp (modified) (2 diffs)

cafu/trunk/CaWE/GuiEditor/Commands/Paste.cpp

@@ -23 +23 @@
 
 #include "Paste.hpp"
-
 #include "../GuiDocument.hpp"
-
 #include "../EditorData/Window.hpp"
-
 #include "GuiSys/Window.hpp"
 
@@ -78 +75 @@
 {
     wxASSERT(!m_Done);
-
     if (m_Done) return false;
 
@@ -84 +80 @@
     {
         m_Windows[WinNr]->Parent=m_NewParent;
-
         m_NewParent->Children.PushBack(m_Windows[WinNr]);
 
-        // If current window name is not unique within the window structure it was pasted into,
-        // create a new unique name.
-        wxString CurrentWindowName=m_Windows[WinNr]->Name;
-        unsigned long Counter=1;
-
-        while (!(((EditorDataWindowT*)m_Windows[WinNr]->EditorData)->CheckNameUniqueness(m_Windows[WinNr]->Name)))
-        {
-            std::ostringstream NameStream;
-            NameStream << CurrentWindowName << "_" << Counter;
-            Counter++;
-
-            m_Windows[WinNr]->Name=NameStream.str();
-        }
+        // If the name of the window is not unique among its siblings, find a new unique name.
+        ((EditorDataWindowT*)m_Windows[WinNr]->EditorData)->RepairNameUniqueness();
     }
 
@@ -105 +89 @@
 
     m_Done=true;
-
     return true;
 }
@@ -113 +96 @@
 {
     wxASSERT(m_Done);
-
     if (!m_Done) return;
 

cafu/trunk/CaWE/GuiEditor/EditorData/Window.cpp

@@ -34 +34 @@
 
 
-static unsigned int Counter=1;
-
-
 EditorDataWindowT::EditorDataWindowT(cf::GuiSys::WindowT* Window, GuiDocumentT* GuiDocument)
     : cf::GuiSys::EditorDataT(Window),
       Selected(false),
-      m_GuiDocument(GuiDocument)
+      m_GuiDocument(GuiDocument),
+      m_Counter(1)
 {
     // If window has no name, create default name.
-    if (Window->Name=="")
-    {
-        std::ostringstream NameStream;
-        NameStream << "Window" << "_" << Counter;
-        Counter++;
-        Window->Name=NameStream.str();
-    }
+    if (Window->Name=="") Window->Name="Window";
 
     // Check window name uniqueness and repair it.
@@ -80 +72 @@
 
 
-void EditorDataWindowT::RepairNameUniqueness()
-{
-    // Check if windows current name is unique.
-    std::string CurrentName=m_GuiWindow->Name;
-    std::string NewName    =CurrentName;
-
-    // While current window name is not unique.
-    while (!CheckNameUniqueness(NewName))
-    {
-        // Append continous number to name until the name is unique.
-        std::ostringstream NameStream;
-        NameStream << CurrentName << "_" << Counter;
-        NewName=NameStream.str();
-        Counter++;
-    }
-
-    m_GuiWindow->Name=NewName;
-}
-
-
-bool EditorDataWindowT::CheckNameUniqueness(wxString Name)
+bool EditorDataWindowT::CheckNameUniqueness(const wxString& Name) const
 {
     if (m_GuiWindow->GetRoot()==m_GuiWindow) return true; // Root window can have any name.
@@ -118 +90 @@
     return true;
 }
+
+
+static wxString StripSuffix(const wxString& Str)
+{
+    const size_t Pos=Str.rfind("_");
+
+    if (Pos==std::string::npos) return Str;
+
+    for (size_t i=Pos+1; i<Str.length(); i++)
+        if (!wxIsdigit(Str[i])) return Str;
+
+    if (Pos==0) return "Window";
+
+    return Str.Left(Pos);
+}
+
+
+void EditorDataWindowT::RepairNameUniqueness()
+{
+    const wxString BaseName=StripSuffix(m_GuiWindow->Name);
+    wxString       NewName =m_GuiWindow->Name;
+
+    while (!CheckNameUniqueness(NewName))
+    {
+        NewName=BaseName+"_"+wxString::Format("%u", m_Counter);
+        m_Counter++;
+    }
+
+    m_GuiWindow->Name=NewName;
+}

cafu/trunk/CaWE/GuiEditor/EditorData/Window.hpp

@@ -50 +50 @@
 
         /// Checks the name uniqueness of a new name string within the windows siblings.
-        /// @param Name Name to check for uniqueness.
+        /// @param Name    Name to check for uniqueness.
         /// @return Whether this name is unique.
-        bool CheckNameUniqueness(wxString Name);
+        bool CheckNameUniqueness(const wxString& Name) const;
+
+        /// Helper method to check and auto-repair the uniqueness of the name of this window.
+        void RepairNameUniqueness();
 
         GuiDocumentT* GetGuiDoc() { return m_GuiDocument; }
@@ -62 +65 @@
 
         GuiDocumentT* m_GuiDocument;
-
-        /// Helper method to check and repair the uniqueness of the name of this window.
-        void RepairNameUniqueness();
+        unsigned int  m_Counter;
     };
 }

cafu/trunk/CaWE/GuiEditor/GuiDocument.cpp

@@ -61 +61 @@
         cf::GuiSys::GuiImplT Gui(gifn);
 
+        if (Gui.GetScriptInitResult()!="")
+        {
+            // GuiImplT::InitErrorT excecptions are caught in the caller code.
+            // Here we handle the case that initializing the GUI succeeded "halfway".
+            wxMessageBox("GUI file "+GuiInitFileName+" was loaded, but errors occurred:\n\n"+
+                         Gui.GetScriptInitResult()+"\n\n"+
+                         "You may choose to ignore this error and proceed,\n"+
+                         "but it is probably better to edit the file and manually fix the problem first.",
+                         "GUI initialization warning", wxOK | wxICON_EXCLAMATION);
+        }
+
         m_GuiProperties=GuiPropertiesT(Gui);
 
@@ -159 +170 @@
 
 
+// Recursively makes sure that the children of each window have unique names.
+// Normally the other GUI editor code should make sure that that is always true, but right now it
+// is possible to create violations of this constraint via drag-and-drop in the window hierarchy tree
+// (can drop a window as a child of another window that already has a child with the same name).
+static void CheckWindowNames(cf::GuiSys::WindowT* Window)
+{
+    const std::string OldName=Window->Name;
+
+    ((EditorDataWindowT*)Window->EditorData)->RepairNameUniqueness();
+
+    if (Window->Name!=OldName)
+        ((EditorDataWindowT*)Window->EditorData)->GetGuiDoc()->UpdateAllObservers_Modified(Window, WMD_PROPERTY_CHANGED, "Name");
+
+    for (unsigned long ChildNr=0; ChildNr<Window->Children.Size(); ChildNr++)
+        CheckWindowNames(Window->Children[ChildNr]);
+}
+
+
 // Recursively saves the window instantiation of the passed window and all of its children.
 static void SaveWindowInstantiation(std::ostream& OutFile, cf::GuiSys::WindowT* Window, const wxString& ParentName)
@@ -239 +268 @@
 bool GuiDocumentT::SaveInit_cgui(std::ostream& OutFile)
 {
+    CheckWindowNames(m_RootWindow);
+
     OutFile << "-- This is a Cafu engine GUI script file, written by CaWE, the Cafu World Editor.\n";
     OutFile << "-- You CAN edit this file manually, but note that CaWE may overwrite your changes.\n";
@@ -262 +293 @@
     OutFile << "\n";
 
-    SaveWindowHierarchy   (OutFile, m_RootWindow, "");
+    SaveWindowHierarchy(OutFile, m_RootWindow, "");
 
     OutFile << "\n";

cafu/trunk/Libs/GuiSys/GuiImpl.cpp

@@ -54 +54 @@
 
 using namespace cf::GuiSys;
+
+
+GuiImplT::InitErrorT::InitErrorT(const std::string& Message)
+    : std::runtime_error(Message)
+{
+}
 
 
@@ -219 +225 @@
         // problem. That is, there might still be a case left where we might want to throw.
         lua_close(LuaState);
-        throw InitErrorT(/*"No root window set. Probable cause:\n"+ScriptInitResult*/);
+        throw InitErrorT("No root window set. Probable cause:\n"+ScriptInitResult);
     }
 

cafu/trunk/Libs/GuiSys/GuiImpl.hpp

@@ -49 +49 @@
             public:
 
-            /// GUI initialization error.
-            class InitErrorT { };
+            class InitErrorT;
 
 
@@ -158 +157 @@
 }
 
+
+/// A class that is thrown on GUI initialization errors.
+class cf::GuiSys::GuiImplT::InitErrorT : public std::runtime_error
+{
+    public:
+
+    InitErrorT(const std::string& Message);
+};
+
 #endif