]> git.saurik.com Git - wxWidgets.git/blobdiff - src/xrc/xh_sizer.cpp
Add more error checks to XRC handler for longs, doubles and fonts.
[wxWidgets.git] / src / xrc / xh_sizer.cpp
index cfb98b21f77dcaaa012aadc1e383c8ab413636cb..6fbe286e9650b6351bbbd83b04a227e52a7065d7 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        xh_sizer.cpp
+// Name:        src/xrc/xh_sizer.cpp
 // Purpose:     XRC resource for wxBoxSizer
 // Author:      Vaclav Slavik
 // Created:     2000/03/21
 #if wxUSE_XRC
 
 #include "wx/xrc/xh_sizer.h"
-#include "wx/sizer.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/panel.h"
+    #include "wx/statbox.h"
+    #include "wx/sizer.h"
+    #include "wx/frame.h"
+    #include "wx/dialog.h"
+    #include "wx/button.h"
+    #include "wx/scrolwin.h"
+#endif
+
 #include "wx/gbsizer.h"
-#include "wx/log.h"
-#include "wx/statbox.h"
+#include "wx/wrapsizer.h"
 #include "wx/notebook.h"
-#include "wx/panel.h"
 #include "wx/tokenzr.h"
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxSizerXmlHandler, wxXmlResourceHandler)
 
 wxSizerXmlHandler::wxSizerXmlHandler()
-    wxXmlResourceHandler(),
-      m_isInside(false),
-      m_isGBS(false),
-      m_parentSizer(NULL)
+                  :wxXmlResourceHandler(),
+                   m_isInside(false),
+                   m_isGBS(false),
+                   m_parentSizer(NULL)
 {
     XRC_ADD_STYLE(wxHORIZONTAL);
     XRC_ADD_STYLE(wxVERTICAL);
@@ -69,8 +78,17 @@ wxSizerXmlHandler::wxSizerXmlHandler()
     XRC_ADD_STYLE(wxALIGN_CENTER_VERTICAL);
     XRC_ADD_STYLE(wxALIGN_CENTRE_VERTICAL);
 
-    XRC_ADD_STYLE(wxADJUST_MINSIZE);
     XRC_ADD_STYLE(wxFIXED_MINSIZE);
+    XRC_ADD_STYLE(wxRESERVE_SPACE_EVEN_IF_HIDDEN);
+
+    // this flag doesn't do anything any more but we can just ignore its
+    // occurrences in the old resource files instead of raising a fuss because
+    // of it
+    AddStyle("wxADJUST_MINSIZE", 0);
+
+    // wxWrapSizer-specific flags
+    XRC_ADD_STYLE(wxEXTEND_LAST_ON_EACH_LINE);
+    XRC_ADD_STYLE(wxREMOVE_LEADING_SPACES);
 }
 
 
@@ -97,15 +115,47 @@ wxObject* wxSizerXmlHandler::DoCreateResource()
 }
 
 
+wxSizer* wxSizerXmlHandler::DoCreateSizer(const wxString& name)
+{
+    if (name == wxT("wxBoxSizer"))
+        return Handle_wxBoxSizer();
+#if wxUSE_STATBOX
+    else if (name == wxT("wxStaticBoxSizer"))
+        return Handle_wxStaticBoxSizer();
+#endif
+    else if (name == wxT("wxGridSizer"))
+    {
+        if ( !ValidateGridSizerChildren() )
+            return NULL;
+        return Handle_wxGridSizer();
+    }
+    else if (name == wxT("wxFlexGridSizer"))
+    {
+        return Handle_wxFlexGridSizer();
+    }
+    else if (name == wxT("wxGridBagSizer"))
+    {
+        return Handle_wxGridBagSizer();
+    }
+    else if (name == wxT("wxWrapSizer"))
+    {
+        return Handle_wxWrapSizer();
+    }
+
+    ReportError(wxString::Format("unknown sizer class \"%s\"", name));
+    return NULL;
+}
+
 
 
-bool wxSizerXmlHandler::IsSizerNode(wxXmlNode *node)
+bool wxSizerXmlHandler::IsSizerNode(wxXmlNode *node) const
 {
     return (IsOfClass(node, wxT("wxBoxSizer"))) ||
            (IsOfClass(node, wxT("wxStaticBoxSizer"))) ||
            (IsOfClass(node, wxT("wxGridSizer"))) ||
            (IsOfClass(node, wxT("wxFlexGridSizer"))) ||
-           (IsOfClass(node, wxT("wxGridBagSizer")));
+           (IsOfClass(node, wxT("wxGridBagSizer"))) ||
+           (IsOfClass(node, wxT("wxWrapSizer")));
 }
 
 
@@ -138,11 +188,11 @@ wxObject* wxSizerXmlHandler::Handle_sizeritem()
         wxWindow *wnd = wxDynamicCast(item, wxWindow);
 
         if (sizer)
-            sitem->SetSizer(sizer);
+            sitem->AssignSizer(sizer);
         else if (wnd)
-            sitem->SetWindow(wnd);
+            sitem->AssignWindow(wnd);
         else
-            wxLogError(wxT("Error in resource."));
+            ReportError(n, "unexpected item in sizer");
 
         // finally, set other wxSizerItem attributes
         SetSizerItemAttributes(sitem);
@@ -152,7 +202,7 @@ wxObject* wxSizerXmlHandler::Handle_sizeritem()
     }
     else /*n == NULL*/
     {
-        wxLogError(wxT("Error in resource: no window/sizer/spacer within sizeritem object."));
+        ReportError("no window/sizer/spacer within sizeritem object");
         return NULL;
     }
 }
@@ -160,11 +210,15 @@ wxObject* wxSizerXmlHandler::Handle_sizeritem()
 
 wxObject* wxSizerXmlHandler::Handle_spacer()
 {
-    wxCHECK_MSG(m_parentSizer, NULL, wxT("Incorrect syntax of XRC resource: spacer not within sizer!"));
+    if ( !m_parentSizer )
+    {
+        ReportError("spacer only allowed inside a sizer");
+        return NULL;
+    }
 
     wxSizerItem* sitem = MakeSizerItem();
     SetSizerItemAttributes(sitem);
-    sitem->SetSpacer(GetSize());
+    sitem->AssignSpacer(GetSize());
     AddSizerItem(sitem);
     return NULL;
 }
@@ -172,34 +226,22 @@ wxObject* wxSizerXmlHandler::Handle_spacer()
 
 wxObject* wxSizerXmlHandler::Handle_sizer()
 {
-    wxSizer *sizer = NULL;
-
     wxXmlNode *parentNode = m_node->GetParent();
 
-    wxCHECK_MSG(m_parentSizer != NULL ||
-                (parentNode && parentNode->GetType() == wxXML_ELEMENT_NODE &&
-                 m_parentAsWindow != NULL &&
-                 (m_parentAsWindow->IsKindOf(CLASSINFO(wxPanel)) ||
-                  m_parentAsWindow->IsKindOf(CLASSINFO(wxFrame)) ||
-                  m_parentAsWindow->IsKindOf(CLASSINFO(wxDialog)))
-                    ), NULL,
-                wxT("Incorrect use of sizer: parent is not 'wxDialog', 'wxFrame' or 'wxPanel'."));
-
-    if (m_class == wxT("wxBoxSizer"))
-        sizer = Handle_wxBoxSizer();
-
-    else if (m_class == wxT("wxStaticBoxSizer"))
-        sizer = Handle_wxStaticBoxSizer();
-
-    else if (m_class == wxT("wxGridSizer"))
-        sizer = Handle_wxGridSizer();
-
-    else if (m_class == wxT("wxFlexGridSizer"))
-        sizer = Handle_wxFlexGridSizer();
+    if ( !m_parentSizer &&
+            (!parentNode || parentNode->GetType() != wxXML_ELEMENT_NODE ||
+             !m_parentAsWindow) )
+    {
+        ReportError("sizer must have a window parent");
+        return NULL;
+    }
 
-    else if (m_class == wxT("wxGridBagSizer"))
-        sizer = Handle_wxGridBagSizer();
+    // Create the sizer of the appropriate class.
+    wxSizer * const sizer = DoCreateSizer(m_class);
 
+    // creation of sizer failed for some (already reported) reason, so exit:
+    if ( !sizer )
+        return NULL;
 
     wxSize minsize = GetSize(wxT("minsize"));
     if (!(minsize == wxDefaultSize))
@@ -214,7 +256,23 @@ wxObject* wxSizerXmlHandler::Handle_sizer()
     m_isInside = true;
     m_isGBS = (m_class == wxT("wxGridBagSizer"));
 
-    CreateChildren(m_parent, true/*only this handler*/);
+    wxObject* parent = m_parent;
+#if wxUSE_STATBOX
+    // wxStaticBoxSizer's child controls should be parented by the box itself,
+    // not its parent.
+    wxStaticBoxSizer* const stsizer = wxDynamicCast(sizer, wxStaticBoxSizer);
+    if ( stsizer )
+        parent = stsizer->GetStaticBox();
+#endif // wxUSE_STATBOX
+
+    CreateChildren(parent, true/*only this handler*/);
+
+    // set growable rows and cols for sizers which support this
+    if ( wxFlexGridSizer *flexsizer = wxDynamicCast(sizer, wxFlexGridSizer) )
+    {
+        SetGrowables(flexsizer, wxT("growablerows"), true);
+        SetGrowables(flexsizer, wxT("growablecols"), false);
+    }
 
     // restore state
     m_isInside = old_ins;
@@ -227,11 +285,22 @@ wxObject* wxSizerXmlHandler::Handle_sizer()
         wxXmlNode *nd = m_node;
         m_node = parentNode;
         if (GetSize() == wxDefaultSize)
-            sizer->Fit(m_parentAsWindow);
+        {
+            if ( wxDynamicCast(m_parentAsWindow, wxScrolledWindow) != NULL )
+            {
+                sizer->FitInside(m_parentAsWindow);
+            }
+            else
+            {
+                sizer->Fit(m_parentAsWindow);
+            }
+        }
         m_node = nd;
 
-        if (m_parentAsWindow->GetWindowStyle() & (wxRESIZE_BOX | wxRESIZE_BORDER))
+        if (m_parentAsWindow->IsTopLevel())
+        {
             sizer->SetSizeHints(m_parentAsWindow);
+        }
     }
 
     return sizer;
@@ -243,6 +312,7 @@ wxSizer*  wxSizerXmlHandler::Handle_wxBoxSizer()
     return new wxBoxSizer(GetStyle(wxT("orient"), wxHORIZONTAL));
 }
 
+#if wxUSE_STATBOX
 wxSizer*  wxSizerXmlHandler::Handle_wxStaticBoxSizer()
 {
     return new wxStaticBoxSizer(
@@ -254,6 +324,7 @@ wxSizer*  wxSizerXmlHandler::Handle_wxStaticBoxSizer()
                             GetName()),
             GetStyle(wxT("orient"), wxHORIZONTAL));
 }
+#endif // wxUSE_STATBOX
 
 wxSizer*  wxSizerXmlHandler::Handle_wxGridSizer()
 {
@@ -262,46 +333,115 @@ wxSizer*  wxSizerXmlHandler::Handle_wxGridSizer()
 }
 
 
-wxSizer*  wxSizerXmlHandler::Handle_wxFlexGridSizer()
+wxFlexGridSizer* wxSizerXmlHandler::Handle_wxFlexGridSizer()
 {
-    wxFlexGridSizer *sizer =
-        new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
-                            GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
-    SetGrowables(sizer, wxT("growablerows"), true);
-    SetGrowables(sizer, wxT("growablecols"), false);
-    return sizer;
+    if ( !ValidateGridSizerChildren() )
+        return NULL;
+    return new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
+                               GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 }
 
 
-wxSizer*  wxSizerXmlHandler::Handle_wxGridBagSizer()
+wxGridBagSizer* wxSizerXmlHandler::Handle_wxGridBagSizer()
 {
-    wxGridBagSizer *sizer =
-        new wxGridBagSizer(GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
-    SetGrowables(sizer, wxT("growablerows"), true);
-    SetGrowables(sizer, wxT("growablecols"), false);
+    if ( !ValidateGridSizerChildren() )
+        return NULL;
+    return new wxGridBagSizer(GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
+}
+
+wxSizer*  wxSizerXmlHandler::Handle_wxWrapSizer()
+{
+    wxWrapSizer *sizer = new wxWrapSizer(GetStyle("orient"), GetStyle("flag"));
     return sizer;
 }
 
 
+bool wxSizerXmlHandler::ValidateGridSizerChildren()
+{
+    int rows = GetLong("rows");
+    int cols = GetLong("cols");
+
+    if  ( rows && cols )
+    {
+        // fixed number of cells, need to verify children count
+        int children = 0;
+        for ( wxXmlNode *n = m_node->GetChildren(); n; n = n->GetNext() )
+        {
+            if ( n->GetType() == wxXML_ELEMENT_NODE &&
+                 (n->GetName() == "object" || n->GetName() == "object_ref") )
+            {
+                children++;
+            }
+        }
+
+        if ( children > rows * cols )
+        {
+            ReportError
+            (
+                wxString::Format
+                (
+                    "too many children in grid sizer: %d > %d x %d"
+                    " (consider omitting the number of rows or columns)",
+                    children,
+                    cols,
+                    rows
+                )
+            );
+            return false;
+        }
+    }
+
+    return true;
+}
 
 
 void wxSizerXmlHandler::SetGrowables(wxFlexGridSizer* sizer,
                                      const wxChar* param,
                                      bool rows)
 {
+    int nrows, ncols;
+    sizer->CalcRowsCols(nrows, ncols);
+    const int nslots = rows ? nrows : ncols;
+
     wxStringTokenizer tkn;
-    unsigned long l;
     tkn.SetString(GetParamValue(param), wxT(","));
+
     while (tkn.HasMoreTokens())
     {
+        unsigned long l;
         if (!tkn.GetNextToken().ToULong(&l))
-            wxLogError(wxT("growable[rows|cols] must be comma-separated list of row numbers"));
-        else {
-            if (rows)
-                sizer->AddGrowableRow(l);
-            else
-                sizer->AddGrowableCol(l);
+        {
+            ReportParamError
+            (
+                param,
+                "value must be comma-separated list of row numbers"
+            );
+            break;
+        }
+
+        const int n = static_cast<int>(l);
+        if ( n >= nslots )
+        {
+            ReportParamError
+            (
+                param,
+                wxString::Format
+                (
+                    "invalid %s index %d: must be less than %d",
+                    rows ? "row" : "column",
+                    n,
+                    nslots
+                )
+            );
+
+            // ignore incorrect value, still try to process the rest
+            continue;
         }
+
+        if (rows)
+            sizer->AddGrowableRow(n);
+        else
+            sizer->AddGrowableCol(n);
     }
 }
 
@@ -350,6 +490,9 @@ void wxSizerXmlHandler::SetSizerItemAttributes(wxSizerItem* sitem)
         gbsitem->SetPos(GetGBPos(wxT("cellpos")));
         gbsitem->SetSpan(GetGBSpan(wxT("cellspan")));
     }
+
+    // record the id of the item, if any, for use by XRCSIZERITEM()
+    sitem->SetId(GetID());
 }
 
 void wxSizerXmlHandler::AddSizerItem(wxSizerItem* sitem)
@@ -365,6 +508,7 @@ void wxSizerXmlHandler::AddSizerItem(wxSizerItem* sitem)
 //-----------------------------------------------------------------------------
 // wxStdDialogButtonSizerXmlHandler
 //-----------------------------------------------------------------------------
+#if wxUSE_BUTTON
 
 IMPLEMENT_DYNAMIC_CLASS(wxStdDialogButtonSizerXmlHandler, wxXmlResourceHandler)
 
@@ -409,13 +553,13 @@ wxObject *wxStdDialogButtonSizerXmlHandler::DoCreateResource()
             if (button)
                 m_parentSizer->AddButton(button);
             else
-                wxLogError(wxT("Error in resource - expected button."));
+                ReportError(n, "expected wxButton");
 
             return item;
         }
         else /*n == NULL*/
         {
-            wxLogError(wxT("Error in resource: no button within wxStdDialogButtonSizer."));
+            ReportError("no button within wxStdDialogButtonSizer");
             return NULL;
         }
     }
@@ -426,5 +570,6 @@ bool wxStdDialogButtonSizerXmlHandler::CanHandle(wxXmlNode *node)
     return (!m_isInside && IsOfClass(node, wxT("wxStdDialogButtonSizer"))) ||
            (m_isInside && IsOfClass(node, wxT("button")));
 }
+#endif // wxUSE_BUTTON
 
 #endif // wxUSE_XRC