]> 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 2420ff04eb59be7184274e98ffa55aa9d576fa43..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
@@ -7,10 +7,6 @@
 // Copyright:   (c) 2000 Vaclav Slavik
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "xh_sizer.h"
-#endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
     #pragma hdrstop
 #endif
 
+#if wxUSE_XRC
+
 #include "wx/xrc/xh_sizer.h"
-#include "wx/sizer.h"
-#include "wx/log.h"
-#include "wx/statbox.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/wrapsizer.h"
 #include "wx/notebook.h"
 #include "wx/tokenzr.h"
 
-bool wxSizerXmlHandler::IsSizerNode(wxXmlNode *node)
-{
-    return (IsOfClass(node, wxT("wxBoxSizer"))) ||
-           (IsOfClass(node, wxT("wxStaticBoxSizer"))) ||
-           (IsOfClass(node, wxT("wxGridSizer"))) ||
-           (IsOfClass(node, wxT("wxFlexGridSizer")));
-}
 
+//-----------------------------------------------------------------------------
+// wxSizerXmlHandler
+//-----------------------------------------------------------------------------
 
+IMPLEMENT_DYNAMIC_CLASS(wxSizerXmlHandler, wxXmlResourceHandler)
 
-wxSizerXmlHandler::wxSizerXmlHandler() 
-: wxXmlResourceHandler(), m_isInside(FALSE), m_parentSizer(NULL)
+wxSizerXmlHandler::wxSizerXmlHandler()
+                  :wxXmlResourceHandler(),
+                   m_isInside(false),
+                   m_isGBS(false),
+                   m_parentSizer(NULL)
 {
     XRC_ADD_STYLE(wxHORIZONTAL);
     XRC_ADD_STYLE(wxVERTICAL);
@@ -68,156 +77,499 @@ wxSizerXmlHandler::wxSizerXmlHandler()
     XRC_ADD_STYLE(wxALIGN_CENTRE_HORIZONTAL);
     XRC_ADD_STYLE(wxALIGN_CENTER_VERTICAL);
     XRC_ADD_STYLE(wxALIGN_CENTRE_VERTICAL);
+
+    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);
 }
 
 
 
-wxObject *wxSizerXmlHandler::DoCreateResource()
-{ 
+bool wxSizerXmlHandler::CanHandle(wxXmlNode *node)
+{
+    return ( (!m_isInside && IsSizerNode(node)) ||
+             (m_isInside && IsOfClass(node, wxT("sizeritem"))) ||
+             (m_isInside && IsOfClass(node, wxT("spacer")))
+        );
+}
+
+
+wxObject* wxSizerXmlHandler::DoCreateResource()
+{
     if (m_class == wxT("sizeritem"))
+        return Handle_sizeritem();
+
+    else if (m_class == wxT("spacer"))
+        return Handle_spacer();
+
+    else
+        return Handle_sizer();
+}
+
+
+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"))
     {
-        wxXmlNode *n = GetParamNode(wxT("object"));
+        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();
+    }
 
-       if ( !n )
-           n = GetParamNode(wxT("object_ref"));
+    ReportError(wxString::Format("unknown sizer class \"%s\"", name));
+    return NULL;
+}
 
-        if (n)
-        {
-            bool old_ins = m_isInside;
-            wxSizer *old_par = m_parentSizer;
-            m_isInside = FALSE;
-            if (!IsSizerNode(n)) m_parentSizer = NULL;
-            wxObject *item = CreateResFromNode(n, m_parent, NULL);
-            m_isInside = old_ins;
-            m_parentSizer = old_par;
-            wxSizer *sizer = wxDynamicCast(item, wxSizer);
-            wxWindow *wnd = wxDynamicCast(item, wxWindow);
-            wxSize minsize = GetSize(wxT("minsize"));
 
-            if (sizer)
+
+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("wxWrapSizer")));
+}
+
+
+wxObject* wxSizerXmlHandler::Handle_sizeritem()
+{
+    // find the item to be managed by this sizeritem
+    wxXmlNode *n = GetParamNode(wxT("object"));
+    if ( !n )
+        n = GetParamNode(wxT("object_ref"));
+
+    // did we find one?
+    if (n)
+    {
+        // create a sizer item for it
+        wxSizerItem* sitem = MakeSizerItem();
+
+        // now fetch the item to be managed
+        bool old_gbs = m_isGBS;
+        bool old_ins = m_isInside;
+        wxSizer *old_par = m_parentSizer;
+        m_isInside = false;
+        if (!IsSizerNode(n)) m_parentSizer = NULL;
+        wxObject *item = CreateResFromNode(n, m_parent, NULL);
+        m_isInside = old_ins;
+        m_parentSizer = old_par;
+        m_isGBS = old_gbs;
+
+        // and figure out what type it is
+        wxSizer *sizer = wxDynamicCast(item, wxSizer);
+        wxWindow *wnd = wxDynamicCast(item, wxWindow);
+
+        if (sizer)
+            sitem->AssignSizer(sizer);
+        else if (wnd)
+            sitem->AssignWindow(wnd);
+        else
+            ReportError(n, "unexpected item in sizer");
+
+        // finally, set other wxSizerItem attributes
+        SetSizerItemAttributes(sitem);
+
+        AddSizerItem(sitem);
+        return item;
+    }
+    else /*n == NULL*/
+    {
+        ReportError("no window/sizer/spacer within sizeritem object");
+        return NULL;
+    }
+}
+
+
+wxObject* wxSizerXmlHandler::Handle_spacer()
+{
+    if ( !m_parentSizer )
+    {
+        ReportError("spacer only allowed inside a sizer");
+        return NULL;
+    }
+
+    wxSizerItem* sitem = MakeSizerItem();
+    SetSizerItemAttributes(sitem);
+    sitem->AssignSpacer(GetSize());
+    AddSizerItem(sitem);
+    return NULL;
+}
+
+
+wxObject* wxSizerXmlHandler::Handle_sizer()
+{
+    wxXmlNode *parentNode = m_node->GetParent();
+
+    if ( !m_parentSizer &&
+            (!parentNode || parentNode->GetType() != wxXML_ELEMENT_NODE ||
+             !m_parentAsWindow) )
+    {
+        ReportError("sizer must have a window parent");
+        return NULL;
+    }
+
+    // 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))
+        sizer->SetMinSize(minsize);
+
+    // save state
+    wxSizer *old_par = m_parentSizer;
+    bool old_ins = m_isInside;
+
+    // set new state
+    m_parentSizer = sizer;
+    m_isInside = true;
+    m_isGBS = (m_class == wxT("wxGridBagSizer"));
+
+    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;
+    m_parentSizer = old_par;
+
+    if (m_parentSizer == NULL) // setup window:
+    {
+        m_parentAsWindow->SetSizer(sizer);
+
+        wxXmlNode *nd = m_node;
+        m_node = parentNode;
+        if (GetSize() == wxDefaultSize)
+        {
+            if ( wxDynamicCast(m_parentAsWindow, wxScrolledWindow) != NULL )
             {
-                m_parentSizer->Add(sizer, GetLong(wxT("option")), 
-                                   GetStyle(wxT("flag")), GetDimension(wxT("border")));
-                if (!(minsize == wxDefaultSize))
-                    m_parentSizer->SetItemMinSize(sizer, minsize.x, minsize.y);
+                sizer->FitInside(m_parentAsWindow);
             }
-            else if (wnd)
+            else
             {
-                m_parentSizer->Add(wnd, GetLong(wxT("option")), 
-                                   GetStyle(wxT("flag")), GetDimension(wxT("border")));
-                if (!(minsize == wxDefaultSize))
-                    m_parentSizer->SetItemMinSize(wnd, minsize.x, minsize.y);
+                sizer->Fit(m_parentAsWindow);
             }
-            else 
-                wxLogError(wxT("Error in resource."));
-
-            return item;
         }
-        else /*n == NULL*/
+        m_node = nd;
+
+        if (m_parentAsWindow->IsTopLevel())
         {
-            wxLogError(wxT("Error in resource: no control/sizer within sizer's <item> tag."));
-            return NULL;
+            sizer->SetSizeHints(m_parentAsWindow);
         }
     }
-    
-    else if (m_class == wxT("spacer"))
-    {
-        wxCHECK_MSG(m_parentSizer, NULL, wxT("Incorrect syntax of XRC resource: spacer not within sizer!"));
-        wxSize sz = GetSize();
-        m_parentSizer->Add(sz.x, sz.y,
-            GetLong(wxT("option")), GetStyle(wxT("flag")), GetDimension(wxT("border")));
+
+    return sizer;
+}
+
+
+wxSizer*  wxSizerXmlHandler::Handle_wxBoxSizer()
+{
+    return new wxBoxSizer(GetStyle(wxT("orient"), wxHORIZONTAL));
+}
+
+#if wxUSE_STATBOX
+wxSizer*  wxSizerXmlHandler::Handle_wxStaticBoxSizer()
+{
+    return new wxStaticBoxSizer(
+            new wxStaticBox(m_parentAsWindow,
+                            GetID(),
+                            GetText(wxT("label")),
+                            wxDefaultPosition, wxDefaultSize,
+                            0/*style*/,
+                            GetName()),
+            GetStyle(wxT("orient"), wxHORIZONTAL));
+}
+#endif // wxUSE_STATBOX
+
+wxSizer*  wxSizerXmlHandler::Handle_wxGridSizer()
+{
+    return new wxGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
+                           GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
+}
+
+
+wxFlexGridSizer* wxSizerXmlHandler::Handle_wxFlexGridSizer()
+{
+    if ( !ValidateGridSizerChildren() )
         return NULL;
-    }
-    
+    return new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
+                               GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
+}
 
-    else {
-        wxSizer *sizer = NULL;
-        
-        wxXmlNode *parentNode = m_node->GetParent();
 
-        wxCHECK_MSG(m_parentSizer != NULL ||
-                ((IsOfClass(parentNode, wxT("wxPanel")) ||
-                  IsOfClass(parentNode, wxT("wxFrame")) ||
-                  IsOfClass(parentNode, wxT("wxDialog"))) &&
-                 parentNode->GetType() == wxXML_ELEMENT_NODE), NULL,
-                wxT("Incorrect use of sizer: parent is not 'wxDialog', 'wxFrame' or 'wxPanel'."));
+wxGridBagSizer* wxSizerXmlHandler::Handle_wxGridBagSizer()
+{
+    if ( !ValidateGridSizerChildren() )
+        return NULL;
+    return new wxGridBagSizer(GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
+}
 
-        if (m_class == wxT("wxBoxSizer"))
-            sizer = new wxBoxSizer(GetStyle(wxT("orient"), wxHORIZONTAL));
+wxSizer*  wxSizerXmlHandler::Handle_wxWrapSizer()
+{
+    wxWrapSizer *sizer = new wxWrapSizer(GetStyle("orient"), GetStyle("flag"));
+    return sizer;
+}
 
-        else if (m_class == wxT("wxStaticBoxSizer"))
-        {
-            sizer = new wxStaticBoxSizer(
-                         new wxStaticBox(m_parentAsWindow, -1, GetText(wxT("label"))),
-                         GetStyle(wxT("orient"), wxHORIZONTAL));
-        }
-        
-        else if (m_class == wxT("wxGridSizer"))
-            sizer = new wxGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
-                                    GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
-                                    
-        else if (m_class == wxT("wxFlexGridSizer"))
+
+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() )
         {
-            wxFlexGridSizer *fsizer = 
-                  new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
-                      GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
-            sizer = fsizer;
-            wxStringTokenizer tkn;
-            unsigned long l;
-            tkn.SetString(GetParamValue(wxT("growablerows")), wxT(","));
-            while (tkn.HasMoreTokens())
-            {
-                if (!tkn.GetNextToken().ToULong(&l))
-                    wxLogError(wxT("growablerows must be comma-separated list of row numbers"));
-                else
-                    fsizer->AddGrowableRow(l);
-            }
-            tkn.SetString(GetParamValue(wxT("growablecols")), wxT(","));
-            while (tkn.HasMoreTokens())
+            if ( n->GetType() == wxXML_ELEMENT_NODE &&
+                 (n->GetName() == "object" || n->GetName() == "object_ref") )
             {
-                if (!tkn.GetNextToken().ToULong(&l))
-                    wxLogError(wxT("growablecols must be comma-separated list of column numbers"));
-                else
-                    fsizer->AddGrowableCol(l);
+                children++;
             }
         }
 
-        wxSize minsize = GetSize(wxT("minsize"));
-        if (!(minsize == wxDefaultSize))
-            sizer->SetMinSize(minsize);
+        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;
+        }
+    }
 
-        wxSizer *old_par = m_parentSizer;
-        m_parentSizer = sizer;
-        bool old_ins = m_isInside;
-        m_isInside = TRUE;
-        CreateChildren(m_parent, TRUE/*only this handler*/);
-        m_isInside = old_ins;
-        m_parentSizer = old_par;
-        
-        if (m_parentSizer == NULL) // setup window:
+    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;
+    tkn.SetString(GetParamValue(param), wxT(","));
+
+    while (tkn.HasMoreTokens())
+    {
+        unsigned long l;
+        if (!tkn.GetNextToken().ToULong(&l))
         {
-            m_parentAsWindow->SetAutoLayout(TRUE);
-            m_parentAsWindow->SetSizer(sizer);
+            ReportParamError
+            (
+                param,
+                "value must be comma-separated list of row numbers"
+            );
+            break;
+        }
 
-            wxXmlNode *nd = m_node;
-            m_node = parentNode;
-            if (GetSize() == wxDefaultSize)
-                sizer->Fit(m_parentAsWindow);
-            m_node = nd;
+        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
+                )
+            );
 
-            if (m_parentAsWindow->GetWindowStyle() & (wxRESIZE_BOX | wxRESIZE_BORDER))
-                sizer->SetSizeHints(m_parentAsWindow);
+            // ignore incorrect value, still try to process the rest
+            continue;
         }
-        
-        return sizer;
+
+        if (rows)
+            sizer->AddGrowableRow(n);
+        else
+            sizer->AddGrowableCol(n);
     }
 }
 
 
+wxGBPosition wxSizerXmlHandler::GetGBPos(const wxString& param)
+{
+    wxSize sz = GetSize(param);
+    if (sz.x < 0) sz.x = 0;
+    if (sz.y < 0) sz.y = 0;
+    return wxGBPosition(sz.x, sz.y);
+}
 
-bool wxSizerXmlHandler::CanHandle(wxXmlNode *node)
+wxGBSpan wxSizerXmlHandler::GetGBSpan(const wxString& param)
 {
-    return ((!m_isInside && IsSizerNode(node)) ||
-            (m_isInside && IsOfClass(node, wxT("sizeritem"))) ||
-            (m_isInside && IsOfClass(node, wxT("spacer"))));
+    wxSize sz = GetSize(param);
+    if (sz.x < 1) sz.x = 1;
+    if (sz.y < 1) sz.y = 1;
+    return wxGBSpan(sz.x, sz.y);
 }
+
+
+
+wxSizerItem* wxSizerXmlHandler::MakeSizerItem()
+{
+    if (m_isGBS)
+        return new wxGBSizerItem();
+    else
+        return new wxSizerItem();
+}
+
+void wxSizerXmlHandler::SetSizerItemAttributes(wxSizerItem* sitem)
+{
+    sitem->SetProportion(GetLong(wxT("option")));  // Should this check for "proportion" too?
+    sitem->SetFlag(GetStyle(wxT("flag")));
+    sitem->SetBorder(GetDimension(wxT("border")));
+    wxSize sz = GetSize(wxT("minsize"));
+    if (!(sz == wxDefaultSize))
+        sitem->SetMinSize(sz);
+    sz = GetSize(wxT("ratio"));
+    if (!(sz == wxDefaultSize))
+        sitem->SetRatio(sz);
+
+    if (m_isGBS)
+    {
+        wxGBSizerItem* gbsitem = (wxGBSizerItem*)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)
+{
+    if (m_isGBS)
+        ((wxGridBagSizer*)m_parentSizer)->Add((wxGBSizerItem*)sitem);
+    else
+        m_parentSizer->Add(sitem);
+}
+
+
+
+//-----------------------------------------------------------------------------
+// wxStdDialogButtonSizerXmlHandler
+//-----------------------------------------------------------------------------
+#if wxUSE_BUTTON
+
+IMPLEMENT_DYNAMIC_CLASS(wxStdDialogButtonSizerXmlHandler, wxXmlResourceHandler)
+
+wxStdDialogButtonSizerXmlHandler::wxStdDialogButtonSizerXmlHandler()
+    : m_isInside(false), m_parentSizer(NULL)
+{
+}
+
+wxObject *wxStdDialogButtonSizerXmlHandler::DoCreateResource()
+{
+    if (m_class == wxT("wxStdDialogButtonSizer"))
+    {
+        wxASSERT( !m_parentSizer );
+
+        wxSizer *s = m_parentSizer = new wxStdDialogButtonSizer;
+        m_isInside = true;
+
+        CreateChildren(m_parent, true/*only this handler*/);
+
+        m_parentSizer->Realize();
+
+        m_isInside = false;
+        m_parentSizer = NULL;
+
+        return s;
+    }
+    else // m_class == "button"
+    {
+        wxASSERT( m_parentSizer );
+
+        // find the item to be managed by this sizeritem
+        wxXmlNode *n = GetParamNode(wxT("object"));
+        if ( !n )
+            n = GetParamNode(wxT("object_ref"));
+
+        // did we find one?
+        if (n)
+        {
+            wxObject *item = CreateResFromNode(n, m_parent, NULL);
+            wxButton *button = wxDynamicCast(item, wxButton);
+
+            if (button)
+                m_parentSizer->AddButton(button);
+            else
+                ReportError(n, "expected wxButton");
+
+            return item;
+        }
+        else /*n == NULL*/
+        {
+            ReportError("no button within wxStdDialogButtonSizer");
+            return NULL;
+        }
+    }
+}
+
+bool wxStdDialogButtonSizerXmlHandler::CanHandle(wxXmlNode *node)
+{
+    return (!m_isInside && IsOfClass(node, wxT("wxStdDialogButtonSizer"))) ||
+           (m_isInside && IsOfClass(node, wxT("button")));
+}
+#endif // wxUSE_BUTTON
+
+#endif // wxUSE_XRC