src/xrc/xmlres.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        xmlres.cpp
   3 // Purpose:     XRC resources
   4 // Author:      Vaclav Slavik
   5 // Created:     2000/03/05
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2000 Vaclav Slavik
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifdef __GNUG__
  12 #pragma implementation "xmlres.h"
  13 #endif
  14
  15 // For compilers that support precompilation, includes "wx.h".
  16 #include "wx/wxprec.h"
  17
  18 #ifdef __BORLANDC__
  19     #pragma hdrstop
  20 #endif
  21
  22 #include "wx/dialog.h"
  23 #include "wx/panel.h"
  24 #include "wx/frame.h"
  25 #include "wx/wfstream.h"
  26 #include "wx/filesys.h"
  27 #include "wx/filename.h"
  28 #include "wx/log.h"
  29 #include "wx/intl.h"
  30 #include "wx/tokenzr.h"
  31 #include "wx/fontenum.h"
  32 #include "wx/module.h"
  33 #include "wx/bitmap.h"
  34 #include "wx/image.h"
  35 #include "wx/fontmap.h"
  36 #include "wx/artprov.h"
  37
  38 #include "wx/xml/xml.h"
  39 #include "wx/xrc/xmlres.h"
  40
  41 #include "wx/arrimpl.cpp"
  42 WX_DEFINE_OBJARRAY(wxXmlResourceDataRecords);
  43
  44
  45 wxXmlResource *wxXmlResource::ms_instance = NULL;
  46
  47 /*static*/ wxXmlResource *wxXmlResource::Get()
  48 {
  49     if ( !ms_instance )
  50         ms_instance = new wxXmlResource;
  51     return ms_instance;
  52 }
  53
  54 /*static*/ wxXmlResource *wxXmlResource::Set(wxXmlResource *res)
  55 {
  56     wxXmlResource *old = ms_instance;
  57     ms_instance = res;
  58     return old;
  59 }
  60
  61 wxXmlResource::wxXmlResource(int flags)
  62 {
  63     m_flags = flags;
  64     m_version = -1;
  65 }
  66
  67 wxXmlResource::wxXmlResource(const wxString& filemask, int flags)
  68 {
  69     m_flags = flags;
  70     m_version = -1;
  71     Load(filemask);
  72 }
  73
  74 wxXmlResource::~wxXmlResource()
  75 {
  76     ClearHandlers();
  77 }
  78
  79
  80 bool wxXmlResource::Load(const wxString& filemask)
  81 {
  82     wxString fnd;
  83     wxXmlResourceDataRecord *drec;
  84     bool iswild = wxIsWild(filemask);
  85     bool rt = TRUE;
  86
  87 #if wxUSE_FILESYSTEM
  88     wxFileSystem fsys;
  89 #   define wxXmlFindFirst  fsys.FindFirst(filemask, wxFILE)
  90 #   define wxXmlFindNext   fsys.FindNext()
  91 #else
  92 #   define wxXmlFindFirst  wxFindFirstFile(filemask, wxFILE)
  93 #   define wxXmlFindNext   wxFindNextFile()
  94 #endif
  95     if (iswild)
  96         fnd = wxXmlFindFirst;
  97     else
  98         fnd = filemask;
  99     while (!!fnd)
 100     {
 101         // NB: Load() accepts both filenames and URLs (should probably be
 102         //     changed to filenames only, but embedded resources currently
 103         //     rely on its ability to handle URLs - FIXME). This check
 104         //     serves as a quick way to determine whether found name is
 105         //     filename and not URL:
 106         if (wxFileName::FileExists(fnd))
 107         {
 108             // Make the name absolute filename, because the app may
 109             // change working directory later:
 110             wxFileName fn(fnd);
 111             if (fn.IsRelative())
 112             {
 113                 fn.MakeAbsolute();
 114                 fnd = fn.GetFullPath();
 115             }
 116 #if wxUSE_FILESYSTEM
 117             fnd = wxFileSystem::FileNameToURL(fnd);
 118 #endif
 119         }
 120
 121 #if wxUSE_FILESYSTEM
 122         if (fnd.Lower().Matches(wxT("*.zip")) ||
 123             fnd.Lower().Matches(wxT("*.xrs")))
 124         {
 125             rt = rt && Load(fnd + wxT("#zip:*.xrc"));
 126         }
 127         else
 128 #endif
 129         {
 130             drec = new wxXmlResourceDataRecord;
 131             drec->File = fnd;
 132             m_data.Add(drec);
 133         }
 134
 135         if (iswild)
 136             fnd = wxXmlFindNext;
 137         else
 138             fnd = wxEmptyString;
 139     }
 140 #   undef wxXmlFindFirst
 141 #   undef wxXmlFindNext
 142     return rt && UpdateResources();
 143 }
 144
 145
 146 IMPLEMENT_ABSTRACT_CLASS(wxXmlResourceHandler, wxObject)
 147
 148 void wxXmlResource::AddHandler(wxXmlResourceHandler *handler)
 149 {
 150     m_handlers.Append(handler);
 151     handler->SetParentResource(this);
 152 }
 153
 154 void wxXmlResource::InsertHandler(wxXmlResourceHandler *handler)
 155 {
 156     m_handlers.Insert(handler);
 157     handler->SetParentResource(this);
 158 }
 159
 160
 161
 162 void wxXmlResource::ClearHandlers()
 163 {
 164     WX_CLEAR_LIST(wxList, m_handlers);
 165 }
 166
 167
 168 wxMenu *wxXmlResource::LoadMenu(const wxString& name)
 169 {
 170     return (wxMenu*)CreateResFromNode(FindResource(name, wxT("wxMenu")), NULL, NULL);
 171 }
 172
 173
 174
 175 wxMenuBar *wxXmlResource::LoadMenuBar(wxWindow *parent, const wxString& name)
 176 {
 177     return (wxMenuBar*)CreateResFromNode(FindResource(name, wxT("wxMenuBar")), parent, NULL);
 178 }
 179
 180
 181
 182 #if wxUSE_TOOLBAR
 183 wxToolBar *wxXmlResource::LoadToolBar(wxWindow *parent, const wxString& name)
 184 {
 185     return (wxToolBar*)CreateResFromNode(FindResource(name, wxT("wxToolBar")), parent, NULL);
 186 }
 187 #endif
 188
 189
 190 wxDialog *wxXmlResource::LoadDialog(wxWindow *parent, const wxString& name)
 191 {
 192     return (wxDialog*)CreateResFromNode(FindResource(name, wxT("wxDialog")), parent, NULL);
 193 }
 194
 195 bool wxXmlResource::LoadDialog(wxDialog *dlg, wxWindow *parent, const wxString& name)
 196 {
 197     return CreateResFromNode(FindResource(name, wxT("wxDialog")), parent, dlg) != NULL;
 198 }
 199
 200
 201
 202 wxPanel *wxXmlResource::LoadPanel(wxWindow *parent, const wxString& name)
 203 {
 204     return (wxPanel*)CreateResFromNode(FindResource(name, wxT("wxPanel")), parent, NULL);
 205 }
 206
 207 bool wxXmlResource::LoadPanel(wxPanel *panel, wxWindow *parent, const wxString& name)
 208 {
 209     return CreateResFromNode(FindResource(name, wxT("wxPanel")), parent, panel) != NULL;
 210 }
 211
 212 wxFrame *wxXmlResource::LoadFrame(wxWindow* parent, const wxString& name)
 213 {
 214     return (wxFrame*)CreateResFromNode(FindResource(name, wxT("wxFrame")), parent, NULL);
 215 }
 216
 217 bool wxXmlResource::LoadFrame(wxFrame* frame, wxWindow *parent, const wxString& name)
 218 {
 219     return CreateResFromNode(FindResource(name, wxT("wxFrame")), parent, frame) != NULL;
 220 }
 221
 222 wxBitmap wxXmlResource::LoadBitmap(const wxString& name)
 223 {
 224     wxBitmap *bmp = (wxBitmap*)CreateResFromNode(
 225                                FindResource(name, wxT("wxBitmap")), NULL, NULL);
 226     wxBitmap rt;
 227
 228     if (bmp) { rt = *bmp; delete bmp; }
 229     return rt;
 230 }
 231
 232 wxIcon wxXmlResource::LoadIcon(const wxString& name)
 233 {
 234     wxIcon *icon = (wxIcon*)CreateResFromNode(
 235                             FindResource(name, wxT("wxIcon")), NULL, NULL);
 236     wxIcon rt;
 237
 238     if (icon) { rt = *icon; delete icon; }
 239     return rt;
 240 }
 241
 242
 243 wxObject *wxXmlResource::LoadObject(wxWindow *parent, const wxString& name, const wxString& classname)
 244 {
 245     return CreateResFromNode(FindResource(name, classname), parent, NULL);
 246 }
 247
 248 bool wxXmlResource::LoadObject(wxObject *instance, wxWindow *parent, const wxString& name, const wxString& classname)
 249 {
 250     return CreateResFromNode(FindResource(name, classname), parent, instance) != NULL;
 251 }
 252
 253
 254 bool wxXmlResource::AttachUnknownControl(const wxString& name,
 255                                          wxWindow *control, wxWindow *parent)
 256 {
 257     if (parent == NULL)
 258         parent = control->GetParent();
 259     wxWindow *container = parent->FindWindow(name + wxT("_container"));
 260     if (!container)
 261     {
 262         wxLogError(_("Cannot find container for unknown control '%s'."), name.c_str());
 263         return FALSE;
 264     }
 265     return control->Reparent(container);
 266 }
 267
 268
 269 static void ProcessPlatformProperty(wxXmlNode *node)
 270 {
 271     wxString s;
 272     bool isok;
 273
 274     wxXmlNode *c = node->GetChildren();
 275     while (c)
 276     {
 277         isok = FALSE;
 278         if (!c->GetPropVal(wxT("platform"), &s))
 279             isok = TRUE;
 280         else
 281         {
 282             wxStringTokenizer tkn(s, wxT(" |"));
 283
 284             while (tkn.HasMoreTokens())
 285             {
 286                 s = tkn.GetNextToken();
 287 #ifdef __WINDOWS__
 288                 if (s == wxT("win")) isok = true;
 289 #endif
 290 #if defined(__MAC__) || defined(__APPLE__)
 291                 if (s == wxT("mac")) isok = true;
 292 #elif defined(__UNIX__)
 293                 if (s == wxT("unix")) isok = true;
 294 #endif
 295 #ifdef __OS2__
 296                 if (s == wxT("os2")) isok = true;
 297 #endif
 298
 299                 if (isok)
 300                     break;
 301             }
 302         }
 303
 304         if (isok)
 305         {
 306             ProcessPlatformProperty(c);
 307             c = c->GetNext();
 308         }
 309         else
 310         {
 311             wxXmlNode *c2 = c->GetNext();
 312             node->RemoveChild(c);
 313             delete c;
 314             c = c2;
 315         }
 316     }
 317 }
 318
 319
 320
 321 bool wxXmlResource::UpdateResources()
 322 {
 323     bool rt = true;
 324     bool modif;
 325 #   if wxUSE_FILESYSTEM
 326     wxFSFile *file = NULL;
 327     wxUnusedVar(file);
 328     wxFileSystem fsys;
 329 #   endif
 330
 331     wxString encoding(wxT("UTF-8"));
 332 #if !wxUSE_UNICODE && wxUSE_INTL
 333     if ( (GetFlags() & wxXRC_USE_LOCALE) == 0 )
 334     {
 335         // In case we are not using wxLocale to translate strings, convert the
 336         // strings GUI's charset. This must not be done when wxXRC_USE_LOCALE
 337         // is on, because it could break wxGetTranslation lookup.
 338         encoding = wxLocale::GetSystemEncodingName();
 339     }
 340 #endif
 341
 342     for (size_t i = 0; i < m_data.GetCount(); i++)
 343     {
 344         modif = (m_data[i].Doc == NULL);
 345
 346         if (!modif)
 347         {
 348 #           if wxUSE_FILESYSTEM
 349             file = fsys.OpenFile(m_data[i].File);
 350             modif = file && file->GetModificationTime() > m_data[i].Time;
 351             if (!file)
 352             {
 353                 wxLogError(_("Cannot open file '%s'."), m_data[i].File.c_str());
 354                 rt = false;
 355             }
 356             wxDELETE(file);
 357             wxUnusedVar(file);
 358 #           else
 359             modif = wxDateTime(wxFileModificationTime(m_data[i].File)) > m_data[i].Time;
 360 #           endif
 361         }
 362
 363         if (modif)
 364         {
 365             wxInputStream *stream = NULL;
 366
 367 #           if wxUSE_FILESYSTEM
 368             file = fsys.OpenFile(m_data[i].File);
 369                         if (file)
 370                                 stream = file->GetStream();
 371 #           else
 372             stream = new wxFileInputStream(m_data[i].File);
 373 #           endif
 374
 375             if (stream)
 376             {
 377                 delete m_data[i].Doc;
 378                 m_data[i].Doc = new wxXmlDocument;
 379             }
 380             if (!stream || !m_data[i].Doc->Load(*stream, encoding))
 381             {
 382                 wxLogError(_("Cannot load resources from file '%s'."),
 383                            m_data[i].File.c_str());
 384                 wxDELETE(m_data[i].Doc);
 385                 rt = false;
 386             }
 387             else if (m_data[i].Doc->GetRoot()->GetName() != wxT("resource"))
 388             {
 389                 wxLogError(_("Invalid XRC resource '%s': doesn't have root node 'resource'."), m_data[i].File.c_str());
 390                 wxDELETE(m_data[i].Doc);
 391                 rt = false;
 392             }
 393             else
 394                         {
 395                 long version;
 396                 int v1, v2, v3, v4;
 397                 wxString verstr = m_data[i].Doc->GetRoot()->GetPropVal(
 398                                       wxT("version"), wxT("0.0.0.0"));
 399                 if (wxSscanf(verstr.c_str(), wxT("%i.%i.%i.%i"),
 400                     &v1, &v2, &v3, &v4) == 4)
 401                     version = v1*256*256*256+v2*256*256+v3*256+v4;
 402                 else
 403                     version = 0;
 404                 if (m_version == -1)
 405                     m_version = version;
 406                 if (m_version != version)
 407                 {
 408                     wxLogError(_("Resource files must have same version number!"));
 409                     rt = false;
 410                 }
 411
 412                 ProcessPlatformProperty(m_data[i].Doc->GetRoot());
 413                                 m_data[i].Time = file->GetModificationTime();
 414                         }
 415
 416 #           if wxUSE_FILESYSTEM
 417                                 wxDELETE(file);
 418                                 wxUnusedVar(file);
 419 #           else
 420                                 wxDELETE(stream);
 421 #           endif
 422         }
 423     }
 424
 425     return rt;
 426 }
 427
 428
 429 wxXmlNode *wxXmlResource::DoFindResource(wxXmlNode *parent,
 430                                          const wxString& name,
 431                                          const wxString& classname,
 432                                          bool recursive)
 433 {
 434     wxString dummy;
 435     wxXmlNode *node;
 436
 437     // first search for match at the top-level nodes (as this is
 438     // where the resource is most commonly looked for):
 439     for (node = parent->GetChildren(); node; node = node->GetNext())
 440     {
 441         if ( node->GetType() == wxXML_ELEMENT_NODE &&
 442                  (node->GetName() == wxT("object") ||
 443                   node->GetName() == wxT("object_ref")) &&
 444              node->GetPropVal(wxT("name"), &dummy) && dummy == name )
 445         {
 446             wxString cls(node->GetPropVal(wxT("class"), wxEmptyString));
 447             if (!classname || cls == classname)
 448                 return node;
 449             // object_ref may not have 'class' property:
 450             if (cls.empty() && node->GetName() == wxT("object_ref"))
 451             {
 452                 wxString refName = node->GetPropVal(wxT("ref"), wxEmptyString);
 453                 if (refName.empty())
 454                     continue;
 455                 wxXmlNode* refNode = FindResource(refName, wxEmptyString, TRUE);
 456                 if (refNode &&
 457                     refNode->GetPropVal(wxT("class"), wxEmptyString) == classname)
 458                 {
 459                     return node;
 460                 }
 461             }
 462         }
 463     }
 464
 465     if ( recursive )
 466         for (node = parent->GetChildren(); node; node = node->GetNext())
 467         {
 468             if ( node->GetType() == wxXML_ELEMENT_NODE &&
 469                  (node->GetName() == wxT("object") ||
 470                   node->GetName() == wxT("object_ref")) )
 471             {
 472                 wxXmlNode* found = DoFindResource(node, name, classname, TRUE);
 473                 if ( found )
 474                     return found;
 475             }
 476         }
 477
 478    return NULL;
 479 }
 480
 481 wxXmlNode *wxXmlResource::FindResource(const wxString& name,
 482                                        const wxString& classname,
 483                                        bool recursive)
 484 {
 485     UpdateResources(); //ensure everything is up-to-date
 486
 487     wxString dummy;
 488     for (size_t f = 0; f < m_data.GetCount(); f++)
 489     {
 490         if ( m_data[f].Doc == NULL || m_data[f].Doc->GetRoot() == NULL )
 491             continue;
 492
 493         wxXmlNode* found = DoFindResource(m_data[f].Doc->GetRoot(),
 494                                           name, classname, recursive);
 495         if ( found )
 496         {
 497 #if wxUSE_FILESYSTEM
 498             m_curFileSystem.ChangePathTo(m_data[f].File);
 499 #endif
 500             return found;
 501         }
 502     }
 503
 504     wxLogError(_("XRC resource '%s' (class '%s') not found!"),
 505                name.c_str(), classname.c_str());
 506     return NULL;
 507 }
 508
 509 static void MergeNodes(wxXmlNode& dest, wxXmlNode& with)
 510 {
 511     // Merge properties:
 512     for (wxXmlProperty *prop = with.GetProperties(); prop; prop = prop->GetNext())
 513     {
 514         wxXmlProperty *dprop;
 515         for (dprop = dest.GetProperties(); dprop; dprop = dprop->GetNext())
 516         {
 517
 518             if ( dprop->GetName() == prop->GetName() )
 519             {
 520                 dprop->SetValue(prop->GetValue());
 521                 break;
 522             }
 523         }
 524
 525         if ( !dprop )
 526             dest.AddProperty(prop->GetName(), prop->GetValue());
 527    }
 528
 529     // Merge child nodes:
 530     for (wxXmlNode* node = with.GetChildren(); node; node = node->GetNext())
 531     {
 532         wxString name = node->GetPropVal(wxT("name"), wxEmptyString);
 533         wxXmlNode *dnode;
 534
 535         for (dnode = dest.GetChildren(); dnode; dnode = dnode->GetNext() )
 536         {
 537             if ( dnode->GetName() == node->GetName() &&
 538                  dnode->GetPropVal(wxT("name"), wxEmptyString) == name &&
 539                  dnode->GetType() == node->GetType() )
 540             {
 541                 MergeNodes(*dnode, *node);
 542                 break;
 543             }
 544         }
 545
 546         if ( !dnode )
 547             dest.AddChild(new wxXmlNode(*node));
 548     }
 549
 550     if ( dest.GetType() == wxXML_TEXT_NODE && with.GetContent().Length() )
 551          dest.SetContent(with.GetContent());
 552 }
 553
 554 wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent,
 555                                            wxObject *instance,
 556                                            wxXmlResourceHandler *handlerToUse)
 557 {
 558     if (node == NULL) return NULL;
 559
 560     // handling of referenced resource
 561     if ( node->GetName() == wxT("object_ref") )
 562     {
 563         wxString refName = node->GetPropVal(wxT("ref"), wxEmptyString);
 564         wxXmlNode* refNode = FindResource(refName, wxEmptyString, TRUE);
 565
 566         if ( !refNode )
 567         {
 568             wxLogError(_("Referenced object node with ref=\"%s\" not found!"),
 569                        refName.c_str());
 570             return NULL;
 571         }
 572
 573         wxXmlNode copy(*refNode);
 574         MergeNodes(copy, *node);
 575
 576         return CreateResFromNode(&copy, parent, instance);
 577     }
 578
 579     wxXmlResourceHandler *handler;
 580
 581     if (handlerToUse)
 582     {
 583         if (handlerToUse->CanHandle(node))
 584         {
 585             return handlerToUse->CreateResource(node, parent, instance);
 586         }
 587     }
 588     else if (node->GetName() == wxT("object"))
 589     {
 590         wxList::compatibility_iterator ND = m_handlers.GetFirst();
 591         while (ND)
 592         {
 593             handler = (wxXmlResourceHandler*)ND->GetData();
 594             if (handler->CanHandle(node))
 595             {
 596                 return handler->CreateResource(node, parent, instance);
 597             }
 598             ND = ND->GetNext();
 599         }
 600     }
 601
 602     wxLogError(_("No handler found for XML node '%s', class '%s'!"),
 603                node->GetName().c_str(),
 604                node->GetPropVal(wxT("class"), wxEmptyString).c_str());
 605     return NULL;
 606 }
 607
 608
 609 #include "wx/listimpl.cpp"
 610 WX_DECLARE_LIST(wxXmlSubclassFactory, wxXmlSubclassFactoriesList);
 611 WX_DEFINE_LIST(wxXmlSubclassFactoriesList);
 612
 613 wxXmlSubclassFactoriesList *wxXmlResource::ms_subclassFactories = NULL;
 614
 615 /*static*/ void wxXmlResource::AddSubclassFactory(wxXmlSubclassFactory *factory)
 616 {
 617     if (!ms_subclassFactories)
 618     {
 619         ms_subclassFactories = new wxXmlSubclassFactoriesList;
 620     }
 621     ms_subclassFactories->Append(factory);
 622 }
 623
 624 class wxXmlSubclassFactoryCXX : public wxXmlSubclassFactory
 625 {
 626 public:
 627     ~wxXmlSubclassFactoryCXX() {}
 628
 629     wxObject *Create(const wxString& className)
 630     {
 631         wxClassInfo* classInfo = wxClassInfo::FindClass(className);
 632
 633         if (classInfo)
 634             return classInfo->CreateObject();
 635         else
 636             return NULL;
 637     }
 638 };
 639
 640
 641
 642
 643
 644 wxXmlResourceHandler::wxXmlResourceHandler()
 645         : m_node(NULL), m_parent(NULL), m_instance(NULL),
 646           m_parentAsWindow(NULL), m_instanceAsWindow(NULL)
 647 {}
 648
 649
 650
 651 wxObject *wxXmlResourceHandler::CreateResource(wxXmlNode *node, wxObject *parent, wxObject *instance)
 652 {
 653     wxXmlNode *myNode = m_node;
 654     wxString myClass = m_class;
 655     wxObject *myParent = m_parent, *myInstance = m_instance;
 656     wxWindow *myParentAW = m_parentAsWindow, *myInstanceAW = m_instanceAsWindow;
 657
 658     m_instance = instance;
 659     if (!m_instance && node->HasProp(wxT("subclass")) &&
 660         !(m_resource->GetFlags() & wxXRC_NO_SUBCLASSING))
 661     {
 662         wxString subclass = node->GetPropVal(wxT("subclass"), wxEmptyString);
 663         if (!subclass.empty())
 664         {
 665             for (wxXmlSubclassFactoriesList::compatibility_iterator i = wxXmlResource::ms_subclassFactories->GetFirst();
 666                  i; i = i->GetNext())
 667             {
 668                 m_instance = i->GetData()->Create(subclass);
 669                 if (m_instance)
 670                     break;
 671             }
 672
 673             if (!m_instance)
 674             {
 675                 wxString name = node->GetPropVal(wxT("name"), wxEmptyString);
 676                 wxLogError(_("Subclass '%s' not found for resource '%s', not subclassing!"),
 677                            subclass.c_str(), name.c_str());
 678             }
 679         }
 680     }
 681
 682     m_node = node;
 683     m_class = node->GetPropVal(wxT("class"), wxEmptyString);
 684     m_parent = parent;
 685     m_parentAsWindow = wxDynamicCast(m_parent, wxWindow);
 686     m_instanceAsWindow = wxDynamicCast(m_instance, wxWindow);
 687
 688     wxObject *returned = DoCreateResource();
 689
 690     m_node = myNode;
 691     m_class = myClass;
 692     m_parent = myParent; m_parentAsWindow = myParentAW;
 693     m_instance = myInstance; m_instanceAsWindow = myInstanceAW;
 694
 695     return returned;
 696 }
 697
 698
 699 void wxXmlResourceHandler::AddStyle(const wxString& name, int value)
 700 {
 701     m_styleNames.Add(name);
 702     m_styleValues.Add(value);
 703 }
 704
 705
 706
 707 void wxXmlResourceHandler::AddWindowStyles()
 708 {
 709     XRC_ADD_STYLE(wxSIMPLE_BORDER);
 710     XRC_ADD_STYLE(wxSUNKEN_BORDER);
 711     XRC_ADD_STYLE(wxDOUBLE_BORDER);
 712     XRC_ADD_STYLE(wxRAISED_BORDER);
 713     XRC_ADD_STYLE(wxSTATIC_BORDER);
 714     XRC_ADD_STYLE(wxNO_BORDER);
 715     XRC_ADD_STYLE(wxTRANSPARENT_WINDOW);
 716     XRC_ADD_STYLE(wxWANTS_CHARS);
 717     XRC_ADD_STYLE(wxNO_FULL_REPAINT_ON_RESIZE);
 718 }
 719
 720
 721
 722 bool wxXmlResourceHandler::HasParam(const wxString& param)
 723 {
 724     return (GetParamNode(param) != NULL);
 725 }
 726
 727
 728 int wxXmlResourceHandler::GetStyle(const wxString& param, int defaults)
 729 {
 730     wxString s = GetParamValue(param);
 731
 732     if (!s) return defaults;
 733
 734     wxStringTokenizer tkn(s, wxT("| \t\n"), wxTOKEN_STRTOK);
 735     int style = 0;
 736     int index;
 737     wxString fl;
 738     while (tkn.HasMoreTokens())
 739     {
 740         fl = tkn.GetNextToken();
 741         index = m_styleNames.Index(fl);
 742         if (index != wxNOT_FOUND)
 743             style |= m_styleValues[index];
 744         else
 745             wxLogError(_("Unknown style flag ") + fl);
 746     }
 747     return style;
 748 }
 749
 750
 751
 752 wxString wxXmlResourceHandler::GetText(const wxString& param, bool translate)
 753 {
 754     wxString str1(GetParamValue(param));
 755     wxString str2;
 756     const wxChar *dt;
 757     wxChar amp_char;
 758
 759     // VS: First version of XRC resources used $ instead of & (which is
 760     //     illegal in XML), but later I realized that '_' fits this purpose
 761     //     much better (because &File means "File with F underlined").
 762     if (m_resource->CompareVersion(2,3,0,1) < 0)
 763         amp_char = wxT('$');
 764     else
 765         amp_char = wxT('_');
 766
 767     for (dt = str1.c_str(); *dt; dt++)
 768     {
 769         // Remap amp_char to &, map double amp_char to amp_char (for things
 770         // like "&File..." -- this is illegal in XML, so we use "_File..."):
 771         if (*dt == amp_char)
 772         {
 773             if ( *(++dt) == amp_char )
 774                 str2 << amp_char;
 775             else
 776                 str2 << wxT('&') << *dt;
 777         }
 778         // Remap \n to CR, \r to LF, \t to TAB:
 779         else if (*dt == wxT('\\'))
 780             switch (*(++dt))
 781             {
 782                 case wxT('n') : str2 << wxT('\n'); break;
 783                 case wxT('t') : str2 << wxT('\t'); break;
 784                 case wxT('r') : str2 << wxT('\r'); break;
 785                 default       : str2 << wxT('\\') << *dt; break;
 786             }
 787         else str2 << *dt;
 788     }
 789
 790     if (translate && m_resource->GetFlags() & wxXRC_USE_LOCALE)
 791         return wxGetTranslation(str2);
 792     else
 793         return str2;
 794
 795 }
 796
 797
 798
 799 long wxXmlResourceHandler::GetLong(const wxString& param, long defaultv)
 800 {
 801     long value;
 802     wxString str1 = GetParamValue(param);
 803
 804     if (!str1.ToLong(&value))
 805         value = defaultv;
 806
 807     return value;
 808 }
 809
 810
 811
 812 int wxXmlResourceHandler::GetID()
 813 {
 814     return wxXmlResource::GetXRCID(GetName());
 815 }
 816
 817
 818
 819 wxString wxXmlResourceHandler::GetName()
 820 {
 821     return m_node->GetPropVal(wxT("name"), wxT("-1"));
 822 }
 823
 824
 825
 826 bool wxXmlResourceHandler::GetBool(const wxString& param, bool defaultv)
 827 {
 828     wxString v = GetParamValue(param);
 829     v.MakeLower();
 830     if (!v) return defaultv;
 831     else return (v == wxT("1"));
 832 }
 833
 834
 835
 836 wxColour wxXmlResourceHandler::GetColour(const wxString& param)
 837 {
 838     wxString v = GetParamValue(param);
 839     unsigned long tmp = 0;
 840
 841     if (v.Length() != 7 || v[0u] != wxT('#') ||
 842         wxSscanf(v.c_str(), wxT("#%lX"), &tmp) != 1)
 843     {
 844         wxLogError(_("XRC resource: Incorrect colour specification '%s' for property '%s'."),
 845                    v.c_str(), param.c_str());
 846         return wxNullColour;
 847     }
 848
 849     return wxColour((unsigned char) ((tmp & 0xFF0000) >> 16) ,
 850                     (unsigned char) ((tmp & 0x00FF00) >> 8),
 851                     (unsigned char) ((tmp & 0x0000FF)));
 852 }
 853
 854
 855
 856 wxBitmap wxXmlResourceHandler::GetBitmap(const wxString& param,
 857                                          const wxArtClient& defaultArtClient,
 858                                          wxSize size)
 859 {
 860     /* If the bitmap is specified as stock item, query wxArtProvider for it: */
 861     wxXmlNode *bmpNode = GetParamNode(param);
 862     if ( bmpNode )
 863     {
 864         wxString sid = bmpNode->GetPropVal(wxT("stock_id"), wxEmptyString);
 865         if ( !sid.empty() )
 866         {
 867             wxString scl = bmpNode->GetPropVal(wxT("stock_client"), defaultArtClient);
 868             wxBitmap stockArt =
 869                 wxArtProvider::GetBitmap(wxART_MAKE_ART_ID_FROM_STR(sid),
 870                                          wxART_MAKE_CLIENT_ID_FROM_STR(scl),
 871                                          size);
 872             if ( stockArt.Ok() )
 873                 return stockArt;
 874         }
 875     }
 876
 877     /* ...or load the bitmap from file: */
 878     wxString name = GetParamValue(param);
 879     if (name.IsEmpty()) return wxNullBitmap;
 880 #if wxUSE_FILESYSTEM
 881     wxFSFile *fsfile = GetCurFileSystem().OpenFile(name);
 882     if (fsfile == NULL)
 883     {
 884         wxLogError(_("XRC resource: Cannot create bitmap from '%s'."),
 885                    name.c_str());
 886         return wxNullBitmap;
 887     }
 888     wxImage img(*(fsfile->GetStream()));
 889     delete fsfile;
 890 #else
 891     wxImage img(GetParamValue(wxT("bitmap")));
 892 #endif
 893
 894     if (!img.Ok())
 895     {
 896         wxLogError(_("XRC resource: Cannot create bitmap from '%s'."), param.c_str());
 897         return wxNullBitmap;
 898     }
 899     if (!(size == wxDefaultSize)) img.Rescale(size.x, size.y);
 900     return wxBitmap(img);
 901
 902 }
 903
 904
 905
 906 wxIcon wxXmlResourceHandler::GetIcon(const wxString& param,
 907                                      const wxArtClient& defaultArtClient,
 908                                      wxSize size)
 909 {
 910     wxIcon icon;
 911     icon.CopyFromBitmap(GetBitmap(param, defaultArtClient, size));
 912     return icon;
 913 }
 914
 915
 916
 917 wxXmlNode *wxXmlResourceHandler::GetParamNode(const wxString& param)
 918 {
 919     wxCHECK_MSG(m_node, NULL, wxT("You can't access handler data before it was initialized!"));
 920
 921     wxXmlNode *n = m_node->GetChildren();
 922
 923     while (n)
 924     {
 925         if (n->GetType() == wxXML_ELEMENT_NODE && n->GetName() == param)
 926             return n;
 927         n = n->GetNext();
 928     }
 929     return NULL;
 930 }
 931
 932
 933 wxString wxXmlResourceHandler::GetNodeContent(wxXmlNode *node)
 934 {
 935     wxXmlNode *n = node;
 936     if (n == NULL) return wxEmptyString;
 937     n = n->GetChildren();
 938
 939     while (n)
 940     {
 941         if (n->GetType() == wxXML_TEXT_NODE ||
 942             n->GetType() == wxXML_CDATA_SECTION_NODE)
 943             return n->GetContent();
 944         n = n->GetNext();
 945     }
 946     return wxEmptyString;
 947 }
 948
 949
 950
 951 wxString wxXmlResourceHandler::GetParamValue(const wxString& param)
 952 {
 953     if (param.IsEmpty())
 954         return GetNodeContent(m_node);
 955     else
 956         return GetNodeContent(GetParamNode(param));
 957 }
 958
 959
 960
 961 wxSize wxXmlResourceHandler::GetSize(const wxString& param)
 962 {
 963     wxString s = GetParamValue(param);
 964     if (s.IsEmpty()) s = wxT("-1,-1");
 965     bool is_dlg;
 966     long sx, sy;
 967
 968     is_dlg = s[s.Length()-1] == wxT('d');
 969     if (is_dlg) s.RemoveLast();
 970
 971     if (!s.BeforeFirst(wxT(',')).ToLong(&sx) ||
 972         !s.AfterLast(wxT(',')).ToLong(&sy))
 973     {
 974         wxLogError(_("Cannot parse coordinates from '%s'."), s.c_str());
 975         return wxDefaultSize;
 976     }
 977
 978     if (is_dlg)
 979     {
 980         if (m_instanceAsWindow)
 981             return wxDLG_UNIT(m_instanceAsWindow, wxSize(sx, sy));
 982         else if (m_parentAsWindow)
 983             return wxDLG_UNIT(m_parentAsWindow, wxSize(sx, sy));
 984         else
 985         {
 986             wxLogError(_("Cannot convert dialog units: dialog unknown."));
 987             return wxDefaultSize;
 988         }
 989     }
 990     else return wxSize(sx, sy);
 991 }
 992
 993
 994
 995 wxPoint wxXmlResourceHandler::GetPosition(const wxString& param)
 996 {
 997     wxSize sz = GetSize(param);
 998     return wxPoint(sz.x, sz.y);
 999 }
1000
1001
1002
1003 wxCoord wxXmlResourceHandler::GetDimension(const wxString& param, wxCoord defaultv)
1004 {
1005     wxString s = GetParamValue(param);
1006     if (s.IsEmpty()) return defaultv;
1007     bool is_dlg;
1008     long sx;
1009
1010     is_dlg = s[s.Length()-1] == wxT('d');
1011     if (is_dlg) s.RemoveLast();
1012
1013     if (!s.ToLong(&sx))
1014     {
1015         wxLogError(_("Cannot parse dimension from '%s'."), s.c_str());
1016         return defaultv;
1017     }
1018
1019     if (is_dlg)
1020     {
1021         if (m_instanceAsWindow)
1022             return wxDLG_UNIT(m_instanceAsWindow, wxSize(sx, 0)).x;
1023         else if (m_parentAsWindow)
1024             return wxDLG_UNIT(m_parentAsWindow, wxSize(sx, 0)).x;
1025         else
1026         {
1027             wxLogError(_("Cannot convert dialog units: dialog unknown."));
1028             return defaultv;
1029         }
1030     }
1031     else return sx;
1032 }
1033
1034
1035
1036 wxFont wxXmlResourceHandler::GetFont(const wxString& param)
1037 {
1038     wxXmlNode *font_node = GetParamNode(param);
1039     if (font_node == NULL)
1040     {
1041         wxLogError(_("Cannot find font node '%s'."), param.c_str());
1042         return wxNullFont;
1043     }
1044
1045     wxXmlNode *oldnode = m_node;
1046     m_node = font_node;
1047
1048     long size = GetLong(wxT("size"), 12);
1049
1050     wxString style = GetParamValue(wxT("style"));
1051     wxString weight = GetParamValue(wxT("weight"));
1052     int istyle = wxNORMAL, iweight = wxNORMAL;
1053     if (style == wxT("italic")) istyle = wxITALIC;
1054     else if (style == wxT("slant")) istyle = wxSLANT;
1055     if (weight == wxT("bold")) iweight = wxBOLD;
1056     else if (weight == wxT("light")) iweight = wxLIGHT;
1057
1058     wxString family = GetParamValue(wxT("family"));
1059     int ifamily = wxDEFAULT;
1060          if (family == wxT("decorative")) ifamily = wxDECORATIVE;
1061     else if (family == wxT("roman")) ifamily = wxROMAN;
1062     else if (family == wxT("script")) ifamily = wxSCRIPT;
1063     else if (family == wxT("swiss")) ifamily = wxSWISS;
1064     else if (family == wxT("modern")) ifamily = wxMODERN;
1065
1066     bool underlined = GetBool(wxT("underlined"), FALSE);
1067
1068     wxString encoding = GetParamValue(wxT("encoding"));
1069     wxFontMapper mapper;
1070     wxFontEncoding enc = wxFONTENCODING_DEFAULT;
1071     if (!encoding.IsEmpty())
1072         enc = mapper.CharsetToEncoding(encoding);
1073     if (enc == wxFONTENCODING_SYSTEM)
1074         enc = wxFONTENCODING_DEFAULT;
1075
1076     wxString faces = GetParamValue(wxT("face"));
1077     wxString facename = wxEmptyString;
1078     wxFontEnumerator enu;
1079     enu.EnumerateFacenames();
1080     wxStringTokenizer tk(faces, wxT(","));
1081     while (tk.HasMoreTokens())
1082     {
1083         int index = enu.GetFacenames()->Index(tk.GetNextToken(), FALSE);
1084         if (index != wxNOT_FOUND)
1085         {
1086             facename = (*enu.GetFacenames())[index];
1087             break;
1088         }
1089     }
1090
1091     m_node = oldnode;
1092
1093     wxFont font(size, ifamily, istyle, iweight, underlined, facename, enc);
1094     return font;
1095 }
1096
1097
1098 void wxXmlResourceHandler::SetupWindow(wxWindow *wnd)
1099 {
1100     //FIXME : add cursor
1101
1102     if (HasParam(wxT("exstyle")))
1103         wnd->SetExtraStyle(GetStyle(wxT("exstyle")));
1104     if (HasParam(wxT("bg")))
1105         wnd->SetBackgroundColour(GetColour(wxT("bg")));
1106     if (HasParam(wxT("fg")))
1107         wnd->SetForegroundColour(GetColour(wxT("fg")));
1108     if (GetBool(wxT("enabled"), 1) == 0)
1109         wnd->Enable(FALSE);
1110     if (GetBool(wxT("focused"), 0) == 1)
1111         wnd->SetFocus();
1112     if (GetBool(wxT("hidden"), 0) == 1)
1113         wnd->Show(FALSE);
1114 #if wxUSE_TOOLTIPS
1115     if (HasParam(wxT("tooltip")))
1116         wnd->SetToolTip(GetText(wxT("tooltip")));
1117 #endif
1118     if (HasParam(wxT("font")))
1119         wnd->SetFont(GetFont());
1120 }
1121
1122
1123 void wxXmlResourceHandler::CreateChildren(wxObject *parent, bool this_hnd_only)
1124 {
1125     wxXmlNode *n = m_node->GetChildren();
1126
1127     while (n)
1128     {
1129         if (n->GetType() == wxXML_ELEMENT_NODE &&
1130            (n->GetName() == wxT("object") || n->GetName() == wxT("object_ref")))
1131         {
1132             m_resource->CreateResFromNode(n, parent, NULL,
1133                                           this_hnd_only ? this : NULL);
1134         }
1135         n = n->GetNext();
1136     }
1137 }
1138
1139
1140 void wxXmlResourceHandler::CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode)
1141 {
1142     wxXmlNode *root;
1143     if (rootnode == NULL) root = m_node; else root = rootnode;
1144     wxXmlNode *n = root->GetChildren();
1145
1146     while (n)
1147     {
1148         if (n->GetType() == wxXML_ELEMENT_NODE && CanHandle(n))
1149         {
1150             CreateResource(n, parent, NULL);
1151         }
1152         n = n->GetNext();
1153     }
1154 }
1155
1156
1157
1158
1159
1160
1161
1162 // --------------- XRCID implementation -----------------------------
1163
1164 #define XRCID_TABLE_SIZE     1024
1165
1166
1167 struct XRCID_record
1168 {
1169     int id;
1170     wxChar *key;
1171     XRCID_record *next;
1172 };
1173
1174 static XRCID_record *XRCID_Records[XRCID_TABLE_SIZE] = {NULL};
1175
1176 static int XRCID_Lookup(const wxChar *str_id, int value_if_not_found = -2)
1177 {
1178     static int XRCID_LastID = wxID_HIGHEST;
1179
1180     int index = 0;
1181
1182     for (const wxChar *c = str_id; *c != wxT('\0'); c++) index += (int)*c;
1183     index %= XRCID_TABLE_SIZE;
1184
1185     XRCID_record *oldrec = NULL;
1186     for (XRCID_record *rec = XRCID_Records[index]; rec; rec = rec->next)
1187     {
1188         if (wxStrcmp(rec->key, str_id) == 0)
1189         {
1190             return rec->id;
1191         }
1192         oldrec = rec;
1193     }
1194
1195     XRCID_record **rec_var = (oldrec == NULL) ?
1196                               &XRCID_Records[index] : &oldrec->next;
1197     *rec_var = new XRCID_record;
1198     (*rec_var)->key = wxStrdup(str_id);
1199     (*rec_var)->next = NULL;
1200
1201     wxChar *end;
1202     if (value_if_not_found != -2)
1203         (*rec_var)->id = value_if_not_found;
1204     else
1205     {
1206         int asint = wxStrtol(str_id, &end, 10);
1207         if (*str_id && *end == 0)
1208         {
1209             // if str_id was integer, keep it verbosely:
1210             (*rec_var)->id = asint;
1211         }
1212         else
1213         {
1214             (*rec_var)->id = ++XRCID_LastID;
1215         }
1216     }
1217
1218     return (*rec_var)->id;
1219 }
1220
1221 /*static*/ int wxXmlResource::GetXRCID(const wxChar *str_id)
1222 {
1223     return XRCID_Lookup(str_id);
1224 }
1225
1226
1227 static void CleanXRCID_Record(XRCID_record *rec)
1228 {
1229     if (rec)
1230     {
1231         CleanXRCID_Record(rec->next);
1232         free(rec->key);
1233         delete rec;
1234     }
1235 }
1236
1237 static void CleanXRCID_Records()
1238 {
1239     for (int i = 0; i < XRCID_TABLE_SIZE; i++)
1240     {
1241         CleanXRCID_Record(XRCID_Records[i]);
1242         XRCID_Records[i] = NULL;
1243     }
1244 }
1245
1246 static void AddStdXRCID_Records()
1247 {
1248 #define stdID(id) XRCID_Lookup(wxT(#id), id)
1249     stdID(-1);
1250     stdID(wxID_OPEN); stdID(wxID_CLOSE); stdID(wxID_NEW);
1251     stdID(wxID_SAVE); stdID(wxID_SAVEAS); stdID(wxID_REVERT);
1252     stdID(wxID_EXIT); stdID(wxID_UNDO); stdID(wxID_REDO);
1253     stdID(wxID_HELP); stdID(wxID_PRINT); stdID(wxID_PRINT_SETUP);
1254     stdID(wxID_PREVIEW); stdID(wxID_ABOUT); stdID(wxID_HELP_CONTENTS);
1255     stdID(wxID_HELP_COMMANDS); stdID(wxID_HELP_PROCEDURES);
1256     stdID(wxID_CUT); stdID(wxID_COPY); stdID(wxID_PASTE);
1257     stdID(wxID_CLEAR); stdID(wxID_FIND); stdID(wxID_DUPLICATE);
1258     stdID(wxID_SELECTALL); stdID(wxID_OK); stdID(wxID_CANCEL);
1259     stdID(wxID_APPLY); stdID(wxID_YES); stdID(wxID_NO);
1260     stdID(wxID_STATIC); stdID(wxID_FORWARD); stdID(wxID_BACKWARD);
1261     stdID(wxID_DEFAULT); stdID(wxID_MORE); stdID(wxID_SETUP);
1262     stdID(wxID_RESET); stdID(wxID_HELP_CONTEXT);
1263     stdID(wxID_CLOSE_ALL);
1264 #undef stdID
1265 }
1266
1267
1268
1269
1270
1271 // --------------- module and globals -----------------------------
1272
1273 class wxXmlResourceModule: public wxModule
1274 {
1275 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule)
1276 public:
1277     wxXmlResourceModule() {}
1278     bool OnInit()
1279     {
1280         AddStdXRCID_Records();
1281         wxXmlResource::AddSubclassFactory(new wxXmlSubclassFactoryCXX);
1282         return TRUE;
1283     }
1284     void OnExit()
1285     {
1286         delete wxXmlResource::Set(NULL);
1287         if(wxXmlResource::ms_subclassFactories)
1288             WX_CLEAR_LIST(wxXmlSubclassFactoriesList, *wxXmlResource::ms_subclassFactories);
1289         wxDELETE(wxXmlResource::ms_subclassFactories);
1290         CleanXRCID_Records();
1291     }
1292 };
1293
1294 IMPLEMENT_DYNAMIC_CLASS(wxXmlResourceModule, wxModule)
1295
1296
1297 // When wxXml is loaded dynamically after the application is already running
1298 // then the built-in module system won't pick this one up.  Add it manually.
1299 void wxXmlInitResourceModule()
1300 {
1301     wxModule* module = new wxXmlResourceModule;
1302     module->Init();
1303     wxModule::RegisterModule(module);
1304 }