src/xrc/xmlres.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/xrc/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 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 #if wxUSE_XRC
  19
  20 #include "wx/xrc/xmlres.h"
  21
  22 #ifndef WX_PRECOMP
  23     #include "wx/intl.h"
  24     #include "wx/log.h"
  25     #include "wx/panel.h"
  26     #include "wx/frame.h"
  27     #include "wx/dialog.h"
  28     #include "wx/settings.h"
  29     #include "wx/bitmap.h"
  30     #include "wx/image.h"
  31     #include "wx/module.h"
  32     #include "wx/wxcrtvararg.h"
  33 #endif
  34
  35 #ifndef __WXWINCE__
  36     #include <locale.h>
  37 #endif
  38
  39 #include "wx/vector.h"
  40 #include "wx/wfstream.h"
  41 #include "wx/filesys.h"
  42 #include "wx/filename.h"
  43 #include "wx/tokenzr.h"
  44 #include "wx/fontenum.h"
  45 #include "wx/fontmap.h"
  46 #include "wx/artprov.h"
  47 #include "wx/dir.h"
  48 #include "wx/xml/xml.h"
  49
  50
  51 class wxXmlResourceDataRecord
  52 {
  53 public:
  54     wxXmlResourceDataRecord() : Doc(NULL) {
  55 #if wxUSE_DATETIME
  56         Time = wxDateTime::Now();
  57 #endif
  58     }
  59     ~wxXmlResourceDataRecord() {delete Doc;}
  60
  61     wxString File;
  62     wxXmlDocument *Doc;
  63 #if wxUSE_DATETIME
  64     wxDateTime Time;
  65 #endif
  66 };
  67
  68 class wxXmlResourceDataRecords : public wxVector<wxXmlResourceDataRecord*>
  69 {
  70     // this is a class so that it can be forward-declared
  71 };
  72
  73 namespace
  74 {
  75
  76 // helper used by DoFindResource() and elsewhere: returns true if this is an
  77 // object or object_ref node
  78 //
  79 // node must be non-NULL
  80 inline bool IsObjectNode(wxXmlNode *node)
  81 {
  82     return node->GetType() == wxXML_ELEMENT_NODE &&
  83              (node->GetName() == wxS("object") ||
  84                 node->GetName() == wxS("object_ref"));
  85 }
  86
  87 } // anonymous namespace
  88
  89
  90 wxXmlResource *wxXmlResource::ms_instance = NULL;
  91
  92 /*static*/ wxXmlResource *wxXmlResource::Get()
  93 {
  94     if ( !ms_instance )
  95         ms_instance = new wxXmlResource;
  96     return ms_instance;
  97 }
  98
  99 /*static*/ wxXmlResource *wxXmlResource::Set(wxXmlResource *res)
 100 {
 101     wxXmlResource *old = ms_instance;
 102     ms_instance = res;
 103     return old;
 104 }
 105
 106 wxXmlResource::wxXmlResource(int flags, const wxString& domain)
 107 {
 108     m_flags = flags;
 109     m_version = -1;
 110     m_data = new wxXmlResourceDataRecords;
 111     SetDomain(domain);
 112 }
 113
 114 wxXmlResource::wxXmlResource(const wxString& filemask, int flags, const wxString& domain)
 115 {
 116     m_flags = flags;
 117     m_version = -1;
 118     m_data = new wxXmlResourceDataRecords;
 119     SetDomain(domain);
 120     Load(filemask);
 121 }
 122
 123 wxXmlResource::~wxXmlResource()
 124 {
 125     ClearHandlers();
 126
 127     for ( wxXmlResourceDataRecords::iterator i = m_data->begin();
 128           i != m_data->end(); ++i )
 129     {
 130         delete *i;
 131     }
 132     delete m_data;
 133 }
 134
 135 void wxXmlResource::SetDomain(const wxString& domain)
 136 {
 137     m_domain = domain;
 138 }
 139
 140
 141 /* static */
 142 wxString wxXmlResource::ConvertFileNameToURL(const wxString& filename)
 143 {
 144     wxString fnd(filename);
 145
 146     // NB: as Load() and Unload() accept both filenames and URLs (should
 147     //     probably be changed to filenames only, but embedded resources
 148     //     currently rely on its ability to handle URLs - FIXME) we need to
 149     //     determine whether found name is filename and not URL and this is the
 150     //     fastest/simplest way to do it
 151     if (wxFileName::FileExists(fnd))
 152     {
 153         // Make the name absolute filename, because the app may
 154         // change working directory later:
 155         wxFileName fn(fnd);
 156         if (fn.IsRelative())
 157         {
 158             fn.MakeAbsolute();
 159             fnd = fn.GetFullPath();
 160         }
 161 #if wxUSE_FILESYSTEM
 162         fnd = wxFileSystem::FileNameToURL(fnd);
 163 #endif
 164     }
 165
 166     return fnd;
 167 }
 168
 169 #if wxUSE_FILESYSTEM
 170
 171 /* static */
 172 bool wxXmlResource::IsArchive(const wxString& filename)
 173 {
 174     const wxString fnd = filename.Lower();
 175
 176     return fnd.Matches(wxT("*.zip")) || fnd.Matches(wxT("*.xrs"));
 177 }
 178
 179 #endif // wxUSE_FILESYSTEM
 180
 181 bool wxXmlResource::LoadFile(const wxFileName& file)
 182 {
 183     return Load(wxFileSystem::FileNameToURL(file));
 184 }
 185
 186 bool wxXmlResource::LoadAllFiles(const wxString& dirname)
 187 {
 188     bool ok = true;
 189     wxArrayString files;
 190
 191     wxDir::GetAllFiles(dirname, &files, "*.xrc");
 192
 193     for ( wxArrayString::const_iterator i = files.begin(); i != files.end(); ++i )
 194     {
 195         if ( !LoadFile(*i) )
 196             ok = false;
 197     }
 198
 199     return ok;
 200 }
 201
 202 bool wxXmlResource::Load(const wxString& filemask_)
 203 {
 204     wxString filemask = ConvertFileNameToURL(filemask_);
 205
 206 #if wxUSE_FILESYSTEM
 207     wxFileSystem fsys;
 208 #   define wxXmlFindFirst  fsys.FindFirst(filemask, wxFILE)
 209 #   define wxXmlFindNext   fsys.FindNext()
 210 #else
 211 #   define wxXmlFindFirst  wxFindFirstFile(filemask, wxFILE)
 212 #   define wxXmlFindNext   wxFindNextFile()
 213 #endif
 214     wxString fnd = wxXmlFindFirst;
 215     if ( fnd.empty() )
 216     {
 217         wxLogError(_("Cannot load resources from '%s'."), filemask);
 218         return false;
 219     }
 220
 221     while (!fnd.empty())
 222     {
 223 #if wxUSE_FILESYSTEM
 224         if ( IsArchive(fnd) )
 225         {
 226             if ( !Load(fnd + wxT("#zip:*.xrc")) )
 227                 return false;
 228         }
 229         else // a single resource URL
 230 #endif // wxUSE_FILESYSTEM
 231         {
 232             wxXmlResourceDataRecord *drec = new wxXmlResourceDataRecord;
 233             drec->File = fnd;
 234             Data().push_back(drec);
 235         }
 236
 237         fnd = wxXmlFindNext;
 238     }
 239 #   undef wxXmlFindFirst
 240 #   undef wxXmlFindNext
 241
 242     return UpdateResources();
 243 }
 244
 245 bool wxXmlResource::Unload(const wxString& filename)
 246 {
 247     wxASSERT_MSG( !wxIsWild(filename),
 248                     _T("wildcards not supported by wxXmlResource::Unload()") );
 249
 250     wxString fnd = ConvertFileNameToURL(filename);
 251 #if wxUSE_FILESYSTEM
 252     const bool isArchive = IsArchive(fnd);
 253     if ( isArchive )
 254         fnd += _T("#zip:");
 255 #endif // wxUSE_FILESYSTEM
 256
 257     bool unloaded = false;
 258     for ( wxXmlResourceDataRecords::iterator i = Data().begin();
 259           i != Data().end(); ++i )
 260     {
 261 #if wxUSE_FILESYSTEM
 262         if ( isArchive )
 263         {
 264             if ( (*i)->File.StartsWith(fnd) )
 265                 unloaded = true;
 266             // don't break from the loop, we can have other matching files
 267         }
 268         else // a single resource URL
 269 #endif // wxUSE_FILESYSTEM
 270         {
 271             if ( (*i)->File == fnd )
 272             {
 273                 delete *i;
 274                 Data().erase(i);
 275                 unloaded = true;
 276
 277                 // no sense in continuing, there is only one file with this URL
 278                 break;
 279             }
 280         }
 281     }
 282
 283     return unloaded;
 284 }
 285
 286
 287 IMPLEMENT_ABSTRACT_CLASS(wxXmlResourceHandler, wxObject)
 288
 289 void wxXmlResource::AddHandler(wxXmlResourceHandler *handler)
 290 {
 291     m_handlers.push_back(handler);
 292     handler->SetParentResource(this);
 293 }
 294
 295 void wxXmlResource::InsertHandler(wxXmlResourceHandler *handler)
 296 {
 297     m_handlers.insert(m_handlers.begin(), handler);
 298     handler->SetParentResource(this);
 299 }
 300
 301
 302
 303 void wxXmlResource::ClearHandlers()
 304 {
 305     for ( wxVector<wxXmlResourceHandler*>::iterator i = m_handlers.begin();
 306           i != m_handlers.end(); ++i )
 307         delete *i;
 308     m_handlers.clear();
 309 }
 310
 311
 312 wxMenu *wxXmlResource::LoadMenu(const wxString& name)
 313 {
 314     return (wxMenu*)CreateResFromNode(FindResource(name, wxT("wxMenu")), NULL, NULL);
 315 }
 316
 317
 318
 319 wxMenuBar *wxXmlResource::LoadMenuBar(wxWindow *parent, const wxString& name)
 320 {
 321     return (wxMenuBar*)CreateResFromNode(FindResource(name, wxT("wxMenuBar")), parent, NULL);
 322 }
 323
 324
 325
 326 #if wxUSE_TOOLBAR
 327 wxToolBar *wxXmlResource::LoadToolBar(wxWindow *parent, const wxString& name)
 328 {
 329     return (wxToolBar*)CreateResFromNode(FindResource(name, wxT("wxToolBar")), parent, NULL);
 330 }
 331 #endif
 332
 333
 334 wxDialog *wxXmlResource::LoadDialog(wxWindow *parent, const wxString& name)
 335 {
 336     return (wxDialog*)CreateResFromNode(FindResource(name, wxT("wxDialog")), parent, NULL);
 337 }
 338
 339 bool wxXmlResource::LoadDialog(wxDialog *dlg, wxWindow *parent, const wxString& name)
 340 {
 341     return CreateResFromNode(FindResource(name, wxT("wxDialog")), parent, dlg) != NULL;
 342 }
 343
 344
 345
 346 wxPanel *wxXmlResource::LoadPanel(wxWindow *parent, const wxString& name)
 347 {
 348     return (wxPanel*)CreateResFromNode(FindResource(name, wxT("wxPanel")), parent, NULL);
 349 }
 350
 351 bool wxXmlResource::LoadPanel(wxPanel *panel, wxWindow *parent, const wxString& name)
 352 {
 353     return CreateResFromNode(FindResource(name, wxT("wxPanel")), parent, panel) != NULL;
 354 }
 355
 356 wxFrame *wxXmlResource::LoadFrame(wxWindow* parent, const wxString& name)
 357 {
 358     return (wxFrame*)CreateResFromNode(FindResource(name, wxT("wxFrame")), parent, NULL);
 359 }
 360
 361 bool wxXmlResource::LoadFrame(wxFrame* frame, wxWindow *parent, const wxString& name)
 362 {
 363     return CreateResFromNode(FindResource(name, wxT("wxFrame")), parent, frame) != NULL;
 364 }
 365
 366 wxBitmap wxXmlResource::LoadBitmap(const wxString& name)
 367 {
 368     wxBitmap *bmp = (wxBitmap*)CreateResFromNode(
 369                                FindResource(name, wxT("wxBitmap")), NULL, NULL);
 370     wxBitmap rt;
 371
 372     if (bmp) { rt = *bmp; delete bmp; }
 373     return rt;
 374 }
 375
 376 wxIcon wxXmlResource::LoadIcon(const wxString& name)
 377 {
 378     wxIcon *icon = (wxIcon*)CreateResFromNode(
 379                             FindResource(name, wxT("wxIcon")), NULL, NULL);
 380     wxIcon rt;
 381
 382     if (icon) { rt = *icon; delete icon; }
 383     return rt;
 384 }
 385
 386
 387 wxObject *wxXmlResource::LoadObject(wxWindow *parent, const wxString& name, const wxString& classname)
 388 {
 389     return CreateResFromNode(FindResource(name, classname), parent, NULL);
 390 }
 391
 392 bool wxXmlResource::LoadObject(wxObject *instance, wxWindow *parent, const wxString& name, const wxString& classname)
 393 {
 394     return CreateResFromNode(FindResource(name, classname), parent, instance) != NULL;
 395 }
 396
 397
 398 bool wxXmlResource::AttachUnknownControl(const wxString& name,
 399                                          wxWindow *control, wxWindow *parent)
 400 {
 401     if (parent == NULL)
 402         parent = control->GetParent();
 403     wxWindow *container = parent->FindWindow(name + wxT("_container"));
 404     if (!container)
 405     {
 406         wxLogError(_("Cannot find container for unknown control '%s'."), name.c_str());
 407         return false;
 408     }
 409     return control->Reparent(container);
 410 }
 411
 412
 413 static void ProcessPlatformProperty(wxXmlNode *node)
 414 {
 415     wxString s;
 416     bool isok;
 417
 418     wxXmlNode *c = node->GetChildren();
 419     while (c)
 420     {
 421         isok = false;
 422         if (!c->GetAttribute(wxT("platform"), &s))
 423             isok = true;
 424         else
 425         {
 426             wxStringTokenizer tkn(s, wxT(" |"));
 427
 428             while (tkn.HasMoreTokens())
 429             {
 430                 s = tkn.GetNextToken();
 431 #ifdef __WINDOWS__
 432                 if (s == wxT("win")) isok = true;
 433 #endif
 434 #if defined(__MAC__) || defined(__APPLE__)
 435                 if (s == wxT("mac")) isok = true;
 436 #elif defined(__UNIX__)
 437                 if (s == wxT("unix")) isok = true;
 438 #endif
 439 #ifdef __OS2__
 440                 if (s == wxT("os2")) isok = true;
 441 #endif
 442
 443                 if (isok)
 444                     break;
 445             }
 446         }
 447
 448         if (isok)
 449         {
 450             ProcessPlatformProperty(c);
 451             c = c->GetNext();
 452         }
 453         else
 454         {
 455             wxXmlNode *c2 = c->GetNext();
 456             node->RemoveChild(c);
 457             delete c;
 458             c = c2;
 459         }
 460     }
 461 }
 462
 463
 464
 465 bool wxXmlResource::UpdateResources()
 466 {
 467     bool rt = true;
 468     bool modif;
 469 #   if wxUSE_FILESYSTEM
 470     wxFSFile *file = NULL;
 471     wxUnusedVar(file);
 472     wxFileSystem fsys;
 473 #   endif
 474
 475     wxString encoding(wxT("UTF-8"));
 476 #if !wxUSE_UNICODE && wxUSE_INTL
 477     if ( (GetFlags() & wxXRC_USE_LOCALE) == 0 )
 478     {
 479         // In case we are not using wxLocale to translate strings, convert the
 480         // strings GUI's charset. This must not be done when wxXRC_USE_LOCALE
 481         // is on, because it could break wxGetTranslation lookup.
 482         encoding = wxLocale::GetSystemEncodingName();
 483     }
 484 #endif
 485
 486     for ( wxXmlResourceDataRecords::iterator i = Data().begin();
 487           i != Data().end(); ++i )
 488     {
 489         wxXmlResourceDataRecord* const rec = *i;
 490
 491         modif = (rec->Doc == NULL);
 492
 493         if (!modif && !(m_flags & wxXRC_NO_RELOADING))
 494         {
 495 #           if wxUSE_FILESYSTEM
 496             file = fsys.OpenFile(rec->File);
 497 #           if wxUSE_DATETIME
 498             modif = file && file->GetModificationTime() > rec->Time;
 499 #           else // wxUSE_DATETIME
 500             modif = true;
 501 #           endif // wxUSE_DATETIME
 502             if (!file)
 503             {
 504                 wxLogError(_("Cannot open file '%s'."), rec->File);
 505                 rt = false;
 506             }
 507             wxDELETE(file);
 508             wxUnusedVar(file);
 509 #           else // wxUSE_FILESYSTEM
 510 #           if wxUSE_DATETIME
 511             modif = wxDateTime(wxFileModificationTime(rec->File)) > rec->Time;
 512 #           else // wxUSE_DATETIME
 513             modif = true;
 514 #           endif // wxUSE_DATETIME
 515 #           endif // wxUSE_FILESYSTEM
 516         }
 517
 518         if (modif)
 519         {
 520             wxLogTrace(_T("xrc"), _T("opening file '%s'"), rec->File);
 521
 522             wxInputStream *stream = NULL;
 523
 524 #           if wxUSE_FILESYSTEM
 525             file = fsys.OpenFile(rec->File);
 526             if (file)
 527                 stream = file->GetStream();
 528 #           else
 529             stream = new wxFileInputStream(rec->File);
 530 #           endif
 531
 532             if (stream)
 533             {
 534                 delete rec->Doc;
 535                 rec->Doc = new wxXmlDocument;
 536             }
 537             if (!stream || !stream->IsOk() || !rec->Doc->Load(*stream, encoding))
 538             {
 539                 wxLogError(_("Cannot load resources from file '%s'."),
 540                            rec->File);
 541                 wxDELETE(rec->Doc);
 542                 rt = false;
 543             }
 544             else if (rec->Doc->GetRoot()->GetName() != wxT("resource"))
 545             {
 546                 wxLogError(_("Invalid XRC resource '%s': doesn't have root node 'resource'."), rec->File);
 547                 wxDELETE(rec->Doc);
 548                 rt = false;
 549             }
 550             else
 551             {
 552                 long version;
 553                 int v1, v2, v3, v4;
 554                 wxString verstr = rec->Doc->GetRoot()->GetAttribute(
 555                                       wxT("version"), wxT("0.0.0.0"));
 556                 if (wxSscanf(verstr.c_str(), wxT("%i.%i.%i.%i"),
 557                     &v1, &v2, &v3, &v4) == 4)
 558                     version = v1*256*256*256+v2*256*256+v3*256+v4;
 559                 else
 560                     version = 0;
 561                 if (m_version == -1)
 562                     m_version = version;
 563                 if (m_version != version)
 564                 {
 565                     wxLogError(_("Resource files must have same version number!"));
 566                     rt = false;
 567                 }
 568
 569                 ProcessPlatformProperty(rec->Doc->GetRoot());
 570 #if wxUSE_DATETIME
 571 #if wxUSE_FILESYSTEM
 572                 rec->Time = file->GetModificationTime();
 573 #else // wxUSE_FILESYSTEM
 574                 rec->Time = wxDateTime(wxFileModificationTime(rec->File));
 575 #endif // wxUSE_FILESYSTEM
 576 #endif // wxUSE_DATETIME
 577             }
 578
 579 #           if wxUSE_FILESYSTEM
 580                 wxDELETE(file);
 581                 wxUnusedVar(file);
 582 #           else
 583                 wxDELETE(stream);
 584 #           endif
 585         }
 586     }
 587
 588     return rt;
 589 }
 590
 591 wxXmlNode *wxXmlResource::DoFindResource(wxXmlNode *parent,
 592                                          const wxString& name,
 593                                          const wxString& classname,
 594                                          bool recursive) const
 595 {
 596     wxXmlNode *node;
 597
 598     // first search for match at the top-level nodes (as this is
 599     // where the resource is most commonly looked for):
 600     for (node = parent->GetChildren(); node; node = node->GetNext())
 601     {
 602         if ( IsObjectNode(node) && node->GetAttribute(wxS("name")) == name )
 603         {
 604             // empty class name matches everything
 605             if ( classname.empty() )
 606                 return node;
 607
 608             wxString cls(node->GetAttribute(wxS("class")));
 609
 610             // object_ref may not have 'class' attribute:
 611             if (cls.empty() && node->GetName() == wxS("object_ref"))
 612             {
 613                 wxString refName = node->GetAttribute(wxS("ref"));
 614                 if (refName.empty())
 615                     continue;
 616
 617                 const wxXmlNode * const refNode = GetResourceNode(refName);
 618                 if ( refNode )
 619                     cls = refNode->GetAttribute(wxS("class"));
 620             }
 621
 622             if ( cls == classname )
 623                 return node;
 624         }
 625     }
 626
 627     // then recurse in child nodes
 628     if ( recursive )
 629     {
 630         for (node = parent->GetChildren(); node; node = node->GetNext())
 631         {
 632             if ( IsObjectNode(node) )
 633             {
 634                 wxXmlNode* found = DoFindResource(node, name, classname, true);
 635                 if ( found )
 636                     return found;
 637             }
 638         }
 639     }
 640
 641     return NULL;
 642 }
 643
 644 wxXmlNode *wxXmlResource::FindResource(const wxString& name,
 645                                        const wxString& classname,
 646                                        bool recursive)
 647 {
 648     wxString path;
 649     wxXmlNode * const
 650         node = GetResourceNodeAndLocation(name, classname, recursive, &path);
 651
 652     if ( !node )
 653     {
 654         wxLogError(_("XRC resource '%s' (class '%s') not found!"),
 655                    name, classname);
 656     }
 657 #if wxUSE_FILESYSTEM
 658     else // node was found
 659     {
 660         // ensure that relative paths work correctly when loading this node
 661         // (which should happen as soon as we return as FindResource() result
 662         // is always passed to CreateResFromNode())
 663         m_curFileSystem.ChangePathTo(path);
 664     }
 665 #endif // wxUSE_FILESYSTEM
 666
 667     return node;
 668 }
 669
 670 wxXmlNode *
 671 wxXmlResource::GetResourceNodeAndLocation(const wxString& name,
 672                                           const wxString& classname,
 673                                           bool recursive,
 674                                           wxString *path) const
 675 {
 676     // ensure everything is up-to-date: this is needed to support on-remand
 677     // reloading of XRC files
 678     const_cast<wxXmlResource *>(this)->UpdateResources();
 679
 680     for ( wxXmlResourceDataRecords::const_iterator f = Data().begin();
 681           f != Data().end(); ++f )
 682     {
 683         wxXmlResourceDataRecord *const rec = *f;
 684         wxXmlDocument * const doc = rec->Doc;
 685         if ( !doc || !doc->GetRoot() )
 686             continue;
 687
 688         wxXmlNode * const
 689             found = DoFindResource(doc->GetRoot(), name, classname, recursive);
 690         if ( found )
 691         {
 692             if ( path )
 693                 *path = rec->File;
 694
 695             return found;
 696         }
 697     }
 698
 699     return NULL;
 700 }
 701
 702 static void MergeNodes(wxXmlNode& dest, wxXmlNode& with)
 703 {
 704     // Merge attributes:
 705     for ( wxXmlAttribute *attr = with.GetAttributes();
 706           attr; attr = attr->GetNext() )
 707     {
 708         wxXmlAttribute *dattr;
 709         for (dattr = dest.GetAttributes(); dattr; dattr = dattr->GetNext())
 710         {
 711
 712             if ( dattr->GetName() == attr->GetName() )
 713             {
 714                 dattr->SetValue(attr->GetValue());
 715                 break;
 716             }
 717         }
 718
 719         if ( !dattr )
 720             dest.AddAttribute(attr->GetName(), attr->GetValue());
 721    }
 722
 723     // Merge child nodes:
 724     for (wxXmlNode* node = with.GetChildren(); node; node = node->GetNext())
 725     {
 726         wxString name = node->GetAttribute(wxT("name"), wxEmptyString);
 727         wxXmlNode *dnode;
 728
 729         for (dnode = dest.GetChildren(); dnode; dnode = dnode->GetNext() )
 730         {
 731             if ( dnode->GetName() == node->GetName() &&
 732                  dnode->GetAttribute(wxT("name"), wxEmptyString) == name &&
 733                  dnode->GetType() == node->GetType() )
 734             {
 735                 MergeNodes(*dnode, *node);
 736                 break;
 737             }
 738         }
 739
 740         if ( !dnode )
 741         {
 742             static const wxChar *AT_END = wxT("end");
 743             wxString insert_pos = node->GetAttribute(wxT("insert_at"), AT_END);
 744             if ( insert_pos == AT_END )
 745             {
 746                 dest.AddChild(new wxXmlNode(*node));
 747             }
 748             else if ( insert_pos == wxT("begin") )
 749             {
 750                 dest.InsertChild(new wxXmlNode(*node), dest.GetChildren());
 751             }
 752         }
 753     }
 754
 755     if ( dest.GetType() == wxXML_TEXT_NODE && with.GetContent().length() )
 756          dest.SetContent(with.GetContent());
 757 }
 758
 759 wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent,
 760                                            wxObject *instance,
 761                                            wxXmlResourceHandler *handlerToUse)
 762 {
 763     if (node == NULL) return NULL;
 764
 765     // handling of referenced resource
 766     if ( node->GetName() == wxT("object_ref") )
 767     {
 768         wxString refName = node->GetAttribute(wxT("ref"), wxEmptyString);
 769         wxXmlNode* refNode = FindResource(refName, wxEmptyString, true);
 770
 771         if ( !refNode )
 772         {
 773             wxLogError(_("Referenced object node with ref=\"%s\" not found!"),
 774                        refName.c_str());
 775             return NULL;
 776         }
 777
 778         wxXmlNode copy(*refNode);
 779         MergeNodes(copy, *node);
 780
 781         return CreateResFromNode(&copy, parent, instance);
 782     }
 783
 784     if (handlerToUse)
 785     {
 786         if (handlerToUse->CanHandle(node))
 787         {
 788             return handlerToUse->CreateResource(node, parent, instance);
 789         }
 790     }
 791     else if (node->GetName() == wxT("object"))
 792     {
 793         for ( wxVector<wxXmlResourceHandler*>::iterator h = m_handlers.begin();
 794               h != m_handlers.end(); ++h )
 795         {
 796             wxXmlResourceHandler *handler = *h;
 797             if (handler->CanHandle(node))
 798                 return handler->CreateResource(node, parent, instance);
 799         }
 800     }
 801
 802     wxLogError(_("No handler found for XML node '%s', class '%s'!"),
 803                node->GetName().c_str(),
 804                node->GetAttribute(wxT("class"), wxEmptyString).c_str());
 805     return NULL;
 806 }
 807
 808
 809 class wxXmlSubclassFactories : public wxVector<wxXmlSubclassFactory*>
 810 {
 811     // this is a class so that it can be forward-declared
 812 };
 813
 814 wxXmlSubclassFactories *wxXmlResource::ms_subclassFactories = NULL;
 815
 816 /*static*/ void wxXmlResource::AddSubclassFactory(wxXmlSubclassFactory *factory)
 817 {
 818     if (!ms_subclassFactories)
 819     {
 820         ms_subclassFactories = new wxXmlSubclassFactories;
 821     }
 822     ms_subclassFactories->push_back(factory);
 823 }
 824
 825 class wxXmlSubclassFactoryCXX : public wxXmlSubclassFactory
 826 {
 827 public:
 828     ~wxXmlSubclassFactoryCXX() {}
 829
 830     wxObject *Create(const wxString& className)
 831     {
 832         wxClassInfo* classInfo = wxClassInfo::FindClass(className);
 833
 834         if (classInfo)
 835             return classInfo->CreateObject();
 836         else
 837             return NULL;
 838     }
 839 };
 840
 841
 842
 843
 844 wxXmlResourceHandler::wxXmlResourceHandler()
 845         : m_node(NULL), m_parent(NULL), m_instance(NULL),
 846           m_parentAsWindow(NULL)
 847 {}
 848
 849
 850
 851 wxObject *wxXmlResourceHandler::CreateResource(wxXmlNode *node, wxObject *parent, wxObject *instance)
 852 {
 853     wxXmlNode *myNode = m_node;
 854     wxString myClass = m_class;
 855     wxObject *myParent = m_parent, *myInstance = m_instance;
 856     wxWindow *myParentAW = m_parentAsWindow;
 857
 858     m_instance = instance;
 859     if (!m_instance && node->HasAttribute(wxT("subclass")) &&
 860         !(m_resource->GetFlags() & wxXRC_NO_SUBCLASSING))
 861     {
 862         wxString subclass = node->GetAttribute(wxT("subclass"), wxEmptyString);
 863         if (!subclass.empty())
 864         {
 865             for (wxXmlSubclassFactories::iterator i = wxXmlResource::ms_subclassFactories->begin();
 866                  i != wxXmlResource::ms_subclassFactories->end(); ++i)
 867             {
 868                 m_instance = (*i)->Create(subclass);
 869                 if (m_instance)
 870                     break;
 871             }
 872
 873             if (!m_instance)
 874             {
 875                 wxString name = node->GetAttribute(wxT("name"), wxEmptyString);
 876                 wxLogError(_("Subclass '%s' not found for resource '%s', not subclassing!"),
 877                            subclass.c_str(), name.c_str());
 878             }
 879         }
 880     }
 881
 882     m_node = node;
 883     m_class = node->GetAttribute(wxT("class"), wxEmptyString);
 884     m_parent = parent;
 885     m_parentAsWindow = wxDynamicCast(m_parent, wxWindow);
 886
 887     wxObject *returned = DoCreateResource();
 888
 889     m_node = myNode;
 890     m_class = myClass;
 891     m_parent = myParent; m_parentAsWindow = myParentAW;
 892     m_instance = myInstance;
 893
 894     return returned;
 895 }
 896
 897
 898 void wxXmlResourceHandler::AddStyle(const wxString& name, int value)
 899 {
 900     m_styleNames.Add(name);
 901     m_styleValues.Add(value);
 902 }
 903
 904
 905
 906 void wxXmlResourceHandler::AddWindowStyles()
 907 {
 908     XRC_ADD_STYLE(wxCLIP_CHILDREN);
 909
 910     // the border styles all have the old and new names, recognize both for now
 911     XRC_ADD_STYLE(wxSIMPLE_BORDER); XRC_ADD_STYLE(wxBORDER_SIMPLE);
 912     XRC_ADD_STYLE(wxSUNKEN_BORDER); XRC_ADD_STYLE(wxBORDER_SUNKEN);
 913     XRC_ADD_STYLE(wxDOUBLE_BORDER); XRC_ADD_STYLE(wxBORDER_DOUBLE);
 914     XRC_ADD_STYLE(wxRAISED_BORDER); XRC_ADD_STYLE(wxBORDER_RAISED);
 915     XRC_ADD_STYLE(wxSTATIC_BORDER); XRC_ADD_STYLE(wxBORDER_STATIC);
 916     XRC_ADD_STYLE(wxNO_BORDER);     XRC_ADD_STYLE(wxBORDER_NONE);
 917
 918     XRC_ADD_STYLE(wxTRANSPARENT_WINDOW);
 919     XRC_ADD_STYLE(wxWANTS_CHARS);
 920     XRC_ADD_STYLE(wxTAB_TRAVERSAL);
 921     XRC_ADD_STYLE(wxNO_FULL_REPAINT_ON_RESIZE);
 922     XRC_ADD_STYLE(wxFULL_REPAINT_ON_RESIZE);
 923     XRC_ADD_STYLE(wxALWAYS_SHOW_SB);
 924     XRC_ADD_STYLE(wxWS_EX_BLOCK_EVENTS);
 925     XRC_ADD_STYLE(wxWS_EX_VALIDATE_RECURSIVELY);
 926 }
 927
 928
 929
 930 bool wxXmlResourceHandler::HasParam(const wxString& param)
 931 {
 932     return (GetParamNode(param) != NULL);
 933 }
 934
 935
 936 int wxXmlResourceHandler::GetStyle(const wxString& param, int defaults)
 937 {
 938     wxString s = GetParamValue(param);
 939
 940     if (!s) return defaults;
 941
 942     wxStringTokenizer tkn(s, wxT("| \t\n"), wxTOKEN_STRTOK);
 943     int style = 0;
 944     int index;
 945     wxString fl;
 946     while (tkn.HasMoreTokens())
 947     {
 948         fl = tkn.GetNextToken();
 949         index = m_styleNames.Index(fl);
 950         if (index != wxNOT_FOUND)
 951             style |= m_styleValues[index];
 952         else
 953             wxLogError(_("Unknown style flag ") + fl);
 954     }
 955     return style;
 956 }
 957
 958
 959
 960 wxString wxXmlResourceHandler::GetText(const wxString& param, bool translate)
 961 {
 962     wxXmlNode *parNode = GetParamNode(param);
 963     wxString str1(GetNodeContent(parNode));
 964     wxString str2;
 965
 966     // "\\" wasn't translated to "\" prior to 2.5.3.0:
 967     const bool escapeBackslash = (m_resource->CompareVersion(2,5,3,0) >= 0);
 968
 969     // VS: First version of XRC resources used $ instead of & (which is
 970     //     illegal in XML), but later I realized that '_' fits this purpose
 971     //     much better (because &File means "File with F underlined").
 972     const wxChar amp_char = (m_resource->CompareVersion(2,3,0,1) < 0)
 973                             ? '$' : '_';
 974
 975     for ( wxString::const_iterator dt = str1.begin(); dt != str1.end(); ++dt )
 976     {
 977         // Remap amp_char to &, map double amp_char to amp_char (for things
 978         // like "&File..." -- this is illegal in XML, so we use "_File..."):
 979         if ( *dt == amp_char )
 980         {
 981             if ( *(++dt) == amp_char )
 982                 str2 << amp_char;
 983             else
 984                 str2 << wxT('&') << *dt;
 985         }
 986         // Remap \n to CR, \r to LF, \t to TAB, \\ to \:
 987         else if ( *dt == wxT('\\') )
 988         {
 989             switch ( (*(++dt)).GetValue() )
 990             {
 991                 case wxT('n'):
 992                     str2 << wxT('\n');
 993                     break;
 994
 995                 case wxT('t'):
 996                     str2 << wxT('\t');
 997                     break;
 998
 999                 case wxT('r'):
1000                     str2 << wxT('\r');
1001                     break;
1002
1003                 case wxT('\\') :
1004                     // "\\" wasn't translated to "\" prior to 2.5.3.0:
1005                     if ( escapeBackslash )
1006                     {
1007                         str2 << wxT('\\');
1008                         break;
1009                     }
1010                     // else fall-through to default: branch below
1011
1012                 default:
1013                     str2 << wxT('\\') << *dt;
1014                     break;
1015             }
1016         }
1017         else
1018         {
1019             str2 << *dt;
1020         }
1021     }
1022
1023     if (m_resource->GetFlags() & wxXRC_USE_LOCALE)
1024     {
1025         if (translate && parNode &&
1026             parNode->GetAttribute(wxT("translate"), wxEmptyString) != wxT("0"))
1027         {
1028             return wxGetTranslation(str2, m_resource->GetDomain());
1029         }
1030         else
1031         {
1032 #if wxUSE_UNICODE
1033             return str2;
1034 #else
1035             // The string is internally stored as UTF-8, we have to convert
1036             // it into system's default encoding so that it can be displayed:
1037             return wxString(str2.wc_str(wxConvUTF8), wxConvLocal);
1038 #endif
1039         }
1040     }
1041
1042     // If wxXRC_USE_LOCALE is not set, then the string is already in
1043     // system's default encoding in ANSI build, so we don't have to
1044     // do anything special here.
1045     return str2;
1046 }
1047
1048
1049
1050 long wxXmlResourceHandler::GetLong(const wxString& param, long defaultv)
1051 {
1052     long value;
1053     wxString str1 = GetParamValue(param);
1054
1055     if (!str1.ToLong(&value))
1056         value = defaultv;
1057
1058     return value;
1059 }
1060
1061 float wxXmlResourceHandler::GetFloat(const wxString& param, float defaultv)
1062 {
1063     wxString str = GetParamValue(param);
1064
1065 #if wxUSE_INTL
1066     // strings in XRC always use C locale but wxString::ToDouble() uses the
1067     // current one, so transform the string to it supposing that the only
1068     // difference between them is the decimal separator
1069     //
1070     // TODO: use wxString::ToCDouble() when we have it
1071     str.Replace(wxT("."), wxLocale::GetInfo(wxLOCALE_DECIMAL_POINT,
1072                                             wxLOCALE_CAT_NUMBER));
1073 #endif // wxUSE_INTL
1074
1075     double value;
1076     if (!str.ToDouble(&value))
1077         value = defaultv;
1078
1079     return wx_truncate_cast(float, value);
1080 }
1081
1082
1083 int wxXmlResourceHandler::GetID()
1084 {
1085     return wxXmlResource::GetXRCID(GetName());
1086 }
1087
1088
1089
1090 wxString wxXmlResourceHandler::GetName()
1091 {
1092     return m_node->GetAttribute(wxT("name"), wxT("-1"));
1093 }
1094
1095
1096
1097 bool wxXmlResourceHandler::GetBoolAttr(const wxString& attr, bool defaultv)
1098 {
1099     wxString v;
1100     return m_node->GetAttribute(attr, &v) ? v == '1' : defaultv;
1101 }
1102
1103 bool wxXmlResourceHandler::GetBool(const wxString& param, bool defaultv)
1104 {
1105     const wxString v = GetParamValue(param);
1106
1107     return v.empty() ? defaultv : (v == '1');
1108 }
1109
1110
1111 static wxColour GetSystemColour(const wxString& name)
1112 {
1113     if (!name.empty())
1114     {
1115         #define SYSCLR(clr) \
1116             if (name == _T(#clr)) return wxSystemSettings::GetColour(clr);
1117         SYSCLR(wxSYS_COLOUR_SCROLLBAR)
1118         SYSCLR(wxSYS_COLOUR_BACKGROUND)
1119         SYSCLR(wxSYS_COLOUR_DESKTOP)
1120         SYSCLR(wxSYS_COLOUR_ACTIVECAPTION)
1121         SYSCLR(wxSYS_COLOUR_INACTIVECAPTION)
1122         SYSCLR(wxSYS_COLOUR_MENU)
1123         SYSCLR(wxSYS_COLOUR_WINDOW)
1124         SYSCLR(wxSYS_COLOUR_WINDOWFRAME)
1125         SYSCLR(wxSYS_COLOUR_MENUTEXT)
1126         SYSCLR(wxSYS_COLOUR_WINDOWTEXT)
1127         SYSCLR(wxSYS_COLOUR_CAPTIONTEXT)
1128         SYSCLR(wxSYS_COLOUR_ACTIVEBORDER)
1129         SYSCLR(wxSYS_COLOUR_INACTIVEBORDER)
1130         SYSCLR(wxSYS_COLOUR_APPWORKSPACE)
1131         SYSCLR(wxSYS_COLOUR_HIGHLIGHT)
1132         SYSCLR(wxSYS_COLOUR_HIGHLIGHTTEXT)
1133         SYSCLR(wxSYS_COLOUR_BTNFACE)
1134         SYSCLR(wxSYS_COLOUR_3DFACE)
1135         SYSCLR(wxSYS_COLOUR_BTNSHADOW)
1136         SYSCLR(wxSYS_COLOUR_3DSHADOW)
1137         SYSCLR(wxSYS_COLOUR_GRAYTEXT)
1138         SYSCLR(wxSYS_COLOUR_BTNTEXT)
1139         SYSCLR(wxSYS_COLOUR_INACTIVECAPTIONTEXT)
1140         SYSCLR(wxSYS_COLOUR_BTNHIGHLIGHT)
1141         SYSCLR(wxSYS_COLOUR_BTNHILIGHT)
1142         SYSCLR(wxSYS_COLOUR_3DHIGHLIGHT)
1143         SYSCLR(wxSYS_COLOUR_3DHILIGHT)
1144         SYSCLR(wxSYS_COLOUR_3DDKSHADOW)
1145         SYSCLR(wxSYS_COLOUR_3DLIGHT)
1146         SYSCLR(wxSYS_COLOUR_INFOTEXT)
1147         SYSCLR(wxSYS_COLOUR_INFOBK)
1148         SYSCLR(wxSYS_COLOUR_LISTBOX)
1149         SYSCLR(wxSYS_COLOUR_HOTLIGHT)
1150         SYSCLR(wxSYS_COLOUR_GRADIENTACTIVECAPTION)
1151         SYSCLR(wxSYS_COLOUR_GRADIENTINACTIVECAPTION)
1152         SYSCLR(wxSYS_COLOUR_MENUHILIGHT)
1153         SYSCLR(wxSYS_COLOUR_MENUBAR)
1154         #undef SYSCLR
1155     }
1156
1157     return wxNullColour;
1158 }
1159
1160 wxColour wxXmlResourceHandler::GetColour(const wxString& param, const wxColour& defaultv)
1161 {
1162     wxString v = GetParamValue(param);
1163
1164     if ( v.empty() )
1165         return defaultv;
1166
1167     wxColour clr;
1168
1169     // wxString -> wxColour conversion
1170     if (!clr.Set(v))
1171     {
1172         // the colour doesn't use #RRGGBB format, check if it is symbolic
1173         // colour name:
1174         clr = GetSystemColour(v);
1175         if (clr.Ok())
1176             return clr;
1177
1178         wxLogError(_("XRC resource: Incorrect colour specification '%s' for attribute '%s'."),
1179                    v.c_str(), param.c_str());
1180         return wxNullColour;
1181     }
1182
1183     return clr;
1184 }
1185
1186
1187
1188 wxBitmap wxXmlResourceHandler::GetBitmap(const wxString& param,
1189                                          const wxArtClient& defaultArtClient,
1190                                          wxSize size)
1191 {
1192     /* If the bitmap is specified as stock item, query wxArtProvider for it: */
1193     wxXmlNode *bmpNode = GetParamNode(param);
1194     if ( bmpNode )
1195     {
1196         wxString sid = bmpNode->GetAttribute(wxT("stock_id"), wxEmptyString);
1197         if ( !sid.empty() )
1198         {
1199             wxString scl = bmpNode->GetAttribute(wxT("stock_client"), wxEmptyString);
1200             if (scl.empty())
1201                 scl = defaultArtClient;
1202             else
1203                 scl = wxART_MAKE_CLIENT_ID_FROM_STR(scl);
1204
1205             wxBitmap stockArt =
1206                 wxArtProvider::GetBitmap(wxART_MAKE_ART_ID_FROM_STR(sid),
1207                                          scl, size);
1208             if ( stockArt.Ok() )
1209                 return stockArt;
1210         }
1211     }
1212
1213     /* ...or load the bitmap from file: */
1214     wxString name = GetParamValue(param);
1215     if (name.empty()) return wxNullBitmap;
1216 #if wxUSE_FILESYSTEM
1217     wxFSFile *fsfile = GetCurFileSystem().OpenFile(name, wxFS_READ | wxFS_SEEKABLE);
1218     if (fsfile == NULL)
1219     {
1220         wxLogError(_("XRC resource: Cannot create bitmap from '%s'."),
1221                    name.c_str());
1222         return wxNullBitmap;
1223     }
1224     wxImage img(*(fsfile->GetStream()));
1225     delete fsfile;
1226 #else
1227     wxImage img(name);
1228 #endif
1229
1230     if (!img.Ok())
1231     {
1232         wxLogError(_("XRC resource: Cannot create bitmap from '%s'."),
1233                    name.c_str());
1234         return wxNullBitmap;
1235     }
1236     if (!(size == wxDefaultSize)) img.Rescale(size.x, size.y);
1237     return wxBitmap(img);
1238 }
1239
1240
1241 wxIcon wxXmlResourceHandler::GetIcon(const wxString& param,
1242                                      const wxArtClient& defaultArtClient,
1243                                      wxSize size)
1244 {
1245     wxIcon icon;
1246     icon.CopyFromBitmap(GetBitmap(param, defaultArtClient, size));
1247     return icon;
1248 }
1249
1250
1251
1252 wxXmlNode *wxXmlResourceHandler::GetParamNode(const wxString& param)
1253 {
1254     wxCHECK_MSG(m_node, NULL, wxT("You can't access handler data before it was initialized!"));
1255
1256     wxXmlNode *n = m_node->GetChildren();
1257
1258     while (n)
1259     {
1260         if (n->GetType() == wxXML_ELEMENT_NODE && n->GetName() == param)
1261         {
1262             // TODO: check that there are no other properties/parameters with
1263             //       the same name and log an error if there are (can't do this
1264             //       right now as I'm not sure if it's not going to break code
1265             //       using this function in unintentional way (i.e. for
1266             //       accessing other things than properties), for example
1267             //       wxBitmapComboBoxXmlHandler almost surely does
1268             return n;
1269         }
1270         n = n->GetNext();
1271     }
1272     return NULL;
1273 }
1274
1275 bool wxXmlResourceHandler::IsOfClass(wxXmlNode *node, const wxString& classname)
1276 {
1277     return node->GetAttribute(wxT("class"), wxEmptyString) == classname;
1278 }
1279
1280
1281
1282 wxString wxXmlResourceHandler::GetNodeContent(wxXmlNode *node)
1283 {
1284     wxXmlNode *n = node;
1285     if (n == NULL) return wxEmptyString;
1286     n = n->GetChildren();
1287
1288     while (n)
1289     {
1290         if (n->GetType() == wxXML_TEXT_NODE ||
1291             n->GetType() == wxXML_CDATA_SECTION_NODE)
1292             return n->GetContent();
1293         n = n->GetNext();
1294     }
1295     return wxEmptyString;
1296 }
1297
1298
1299
1300 wxString wxXmlResourceHandler::GetParamValue(const wxString& param)
1301 {
1302     if (param.empty())
1303         return GetNodeContent(m_node);
1304     else
1305         return GetNodeContent(GetParamNode(param));
1306 }
1307
1308
1309
1310 wxSize wxXmlResourceHandler::GetSize(const wxString& param,
1311                                      wxWindow *windowToUse)
1312 {
1313     wxString s = GetParamValue(param);
1314     if (s.empty()) s = wxT("-1,-1");
1315     bool is_dlg;
1316     long sx, sy = 0;
1317
1318     is_dlg = s[s.length()-1] == wxT('d');
1319     if (is_dlg) s.RemoveLast();
1320
1321     if (!s.BeforeFirst(wxT(',')).ToLong(&sx) ||
1322         !s.AfterLast(wxT(',')).ToLong(&sy))
1323     {
1324         wxLogError(_("Cannot parse coordinates from '%s'."), s.c_str());
1325         return wxDefaultSize;
1326     }
1327
1328     if (is_dlg)
1329     {
1330         if (windowToUse)
1331         {
1332             return wxDLG_UNIT(windowToUse, wxSize(sx, sy));
1333         }
1334         else if (m_parentAsWindow)
1335         {
1336             return wxDLG_UNIT(m_parentAsWindow, wxSize(sx, sy));
1337         }
1338         else
1339         {
1340             wxLogError(_("Cannot convert dialog units: dialog unknown."));
1341             return wxDefaultSize;
1342         }
1343     }
1344
1345     return wxSize(sx, sy);
1346 }
1347
1348
1349
1350 wxPoint wxXmlResourceHandler::GetPosition(const wxString& param)
1351 {
1352     wxSize sz = GetSize(param);
1353     return wxPoint(sz.x, sz.y);
1354 }
1355
1356
1357
1358 wxCoord wxXmlResourceHandler::GetDimension(const wxString& param,
1359                                            wxCoord defaultv,
1360                                            wxWindow *windowToUse)
1361 {
1362     wxString s = GetParamValue(param);
1363     if (s.empty()) return defaultv;
1364     bool is_dlg;
1365     long sx;
1366
1367     is_dlg = s[s.length()-1] == wxT('d');
1368     if (is_dlg) s.RemoveLast();
1369
1370     if (!s.ToLong(&sx))
1371     {
1372         wxLogError(_("Cannot parse dimension from '%s'."), s.c_str());
1373         return defaultv;
1374     }
1375
1376     if (is_dlg)
1377     {
1378         if (windowToUse)
1379         {
1380             return wxDLG_UNIT(windowToUse, wxSize(sx, 0)).x;
1381         }
1382         else if (m_parentAsWindow)
1383         {
1384             return wxDLG_UNIT(m_parentAsWindow, wxSize(sx, 0)).x;
1385         }
1386         else
1387         {
1388             wxLogError(_("Cannot convert dialog units: dialog unknown."));
1389             return defaultv;
1390         }
1391     }
1392
1393     return sx;
1394 }
1395
1396
1397 // Get system font index using indexname
1398 static wxFont GetSystemFont(const wxString& name)
1399 {
1400     if (!name.empty())
1401     {
1402         #define SYSFNT(fnt) \
1403             if (name == _T(#fnt)) return wxSystemSettings::GetFont(fnt);
1404         SYSFNT(wxSYS_OEM_FIXED_FONT)
1405         SYSFNT(wxSYS_ANSI_FIXED_FONT)
1406         SYSFNT(wxSYS_ANSI_VAR_FONT)
1407         SYSFNT(wxSYS_SYSTEM_FONT)
1408         SYSFNT(wxSYS_DEVICE_DEFAULT_FONT)
1409         SYSFNT(wxSYS_SYSTEM_FIXED_FONT)
1410         SYSFNT(wxSYS_DEFAULT_GUI_FONT)
1411         #undef SYSFNT
1412     }
1413
1414     return wxNullFont;
1415 }
1416
1417 wxFont wxXmlResourceHandler::GetFont(const wxString& param)
1418 {
1419     wxXmlNode *font_node = GetParamNode(param);
1420     if (font_node == NULL)
1421     {
1422         wxLogError(_("Cannot find font node '%s'."), param.c_str());
1423         return wxNullFont;
1424     }
1425
1426     wxXmlNode *oldnode = m_node;
1427     m_node = font_node;
1428
1429     // font attributes:
1430
1431     // size
1432     int isize = -1;
1433     bool hasSize = HasParam(wxT("size"));
1434     if (hasSize)
1435         isize = GetLong(wxT("size"), -1);
1436
1437     // style
1438     int istyle = wxNORMAL;
1439     bool hasStyle = HasParam(wxT("style"));
1440     if (hasStyle)
1441     {
1442         wxString style = GetParamValue(wxT("style"));
1443         if (style == wxT("italic"))
1444             istyle = wxITALIC;
1445         else if (style == wxT("slant"))
1446             istyle = wxSLANT;
1447     }
1448
1449     // weight
1450     int iweight = wxNORMAL;
1451     bool hasWeight = HasParam(wxT("weight"));
1452     if (hasWeight)
1453     {
1454         wxString weight = GetParamValue(wxT("weight"));
1455         if (weight == wxT("bold"))
1456             iweight = wxBOLD;
1457         else if (weight == wxT("light"))
1458             iweight = wxLIGHT;
1459     }
1460
1461     // underline
1462     bool hasUnderlined = HasParam(wxT("underlined"));
1463     bool underlined = hasUnderlined ? GetBool(wxT("underlined"), false) : false;
1464
1465     // family and facename
1466     int ifamily = wxDEFAULT;
1467     bool hasFamily = HasParam(wxT("family"));
1468     if (hasFamily)
1469     {
1470         wxString family = GetParamValue(wxT("family"));
1471              if (family == wxT("decorative")) ifamily = wxDECORATIVE;
1472         else if (family == wxT("roman")) ifamily = wxROMAN;
1473         else if (family == wxT("script")) ifamily = wxSCRIPT;
1474         else if (family == wxT("swiss")) ifamily = wxSWISS;
1475         else if (family == wxT("modern")) ifamily = wxMODERN;
1476         else if (family == wxT("teletype")) ifamily = wxTELETYPE;
1477     }
1478
1479
1480     wxString facename;
1481     bool hasFacename = HasParam(wxT("face"));
1482     if (hasFacename)
1483     {
1484         wxString faces = GetParamValue(wxT("face"));
1485         wxStringTokenizer tk(faces, wxT(","));
1486 #if wxUSE_FONTENUM
1487         wxArrayString facenames(wxFontEnumerator::GetFacenames());
1488         while (tk.HasMoreTokens())
1489         {
1490             int index = facenames.Index(tk.GetNextToken(), false);
1491             if (index != wxNOT_FOUND)
1492             {
1493                 facename = facenames[index];
1494                 break;
1495             }
1496         }
1497 #else // !wxUSE_FONTENUM
1498         // just use the first face name if we can't check its availability:
1499         if (tk.HasMoreTokens())
1500             facename = tk.GetNextToken();
1501 #endif // wxUSE_FONTENUM/!wxUSE_FONTENUM
1502     }
1503
1504     // encoding
1505     wxFontEncoding enc = wxFONTENCODING_DEFAULT;
1506     bool hasEncoding = HasParam(wxT("encoding"));
1507     if (hasEncoding)
1508     {
1509         wxString encoding = GetParamValue(wxT("encoding"));
1510         wxFontMapper mapper;
1511         if (!encoding.empty())
1512             enc = mapper.CharsetToEncoding(encoding);
1513         if (enc == wxFONTENCODING_SYSTEM)
1514             enc = wxFONTENCODING_DEFAULT;
1515     }
1516
1517     // is this font based on a system font?
1518     wxFont font = GetSystemFont(GetParamValue(wxT("sysfont")));
1519
1520     if (font.Ok())
1521     {
1522         if (hasSize && isize != -1)
1523             font.SetPointSize(isize);
1524         else if (HasParam(wxT("relativesize")))
1525             font.SetPointSize(int(font.GetPointSize() *
1526                                      GetFloat(wxT("relativesize"))));
1527
1528         if (hasStyle)
1529             font.SetStyle(istyle);
1530         if (hasWeight)
1531             font.SetWeight(iweight);
1532         if (hasUnderlined)
1533             font.SetUnderlined(underlined);
1534         if (hasFamily)
1535             font.SetFamily(ifamily);
1536         if (hasFacename)
1537             font.SetFaceName(facename);
1538         if (hasEncoding)
1539             font.SetDefaultEncoding(enc);
1540     }
1541     else // not based on system font
1542     {
1543         font = wxFont(isize == -1 ? wxNORMAL_FONT->GetPointSize() : isize,
1544                       ifamily, istyle, iweight,
1545                       underlined, facename, enc);
1546     }
1547
1548     m_node = oldnode;
1549     return font;
1550 }
1551
1552
1553 void wxXmlResourceHandler::SetupWindow(wxWindow *wnd)
1554 {
1555     //FIXME : add cursor
1556
1557     if (HasParam(wxT("exstyle")))
1558         // Have to OR it with existing style, since
1559         // some implementations (e.g. wxGTK) use the extra style
1560         // during creation
1561         wnd->SetExtraStyle(wnd->GetExtraStyle() | GetStyle(wxT("exstyle")));
1562     if (HasParam(wxT("bg")))
1563         wnd->SetBackgroundColour(GetColour(wxT("bg")));
1564     if (HasParam(wxT("fg")))
1565         wnd->SetForegroundColour(GetColour(wxT("fg")));
1566     if (GetBool(wxT("enabled"), 1) == 0)
1567         wnd->Enable(false);
1568     if (GetBool(wxT("focused"), 0) == 1)
1569         wnd->SetFocus();
1570     if (GetBool(wxT("hidden"), 0) == 1)
1571         wnd->Show(false);
1572 #if wxUSE_TOOLTIPS
1573     if (HasParam(wxT("tooltip")))
1574         wnd->SetToolTip(GetText(wxT("tooltip")));
1575 #endif
1576     if (HasParam(wxT("font")))
1577         wnd->SetFont(GetFont());
1578     if (HasParam(wxT("help")))
1579         wnd->SetHelpText(GetText(wxT("help")));
1580 }
1581
1582
1583 void wxXmlResourceHandler::CreateChildren(wxObject *parent, bool this_hnd_only)
1584 {
1585     for ( wxXmlNode *n = m_node->GetChildren(); n; n = n->GetNext() )
1586     {
1587         if ( IsObjectNode(n) )
1588         {
1589             m_resource->CreateResFromNode(n, parent, NULL,
1590                                           this_hnd_only ? this : NULL);
1591         }
1592     }
1593 }
1594
1595
1596 void wxXmlResourceHandler::CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode)
1597 {
1598     wxXmlNode *root;
1599     if (rootnode == NULL) root = m_node; else root = rootnode;
1600     wxXmlNode *n = root->GetChildren();
1601
1602     while (n)
1603     {
1604         if (n->GetType() == wxXML_ELEMENT_NODE && CanHandle(n))
1605         {
1606             CreateResource(n, parent, NULL);
1607         }
1608         n = n->GetNext();
1609     }
1610 }
1611
1612
1613
1614
1615
1616
1617
1618 // --------------- XRCID implementation -----------------------------
1619
1620 #define XRCID_TABLE_SIZE     1024
1621
1622
1623 struct XRCID_record
1624 {
1625     /* Hold the id so that once an id is allocated for a name, it
1626        does not get created again by NewControlId at least
1627        until we are done with it */
1628     wxWindowIDRef id;
1629     char *key;
1630     XRCID_record *next;
1631 };
1632
1633 static XRCID_record *XRCID_Records[XRCID_TABLE_SIZE] = {NULL};
1634
1635 static int XRCID_Lookup(const char *str_id, int value_if_not_found = wxID_NONE)
1636 {
1637     int index = 0;
1638
1639     for (const char *c = str_id; *c != '\0'; c++) index += (int)*c;
1640     index %= XRCID_TABLE_SIZE;
1641
1642     XRCID_record *oldrec = NULL;
1643     for (XRCID_record *rec = XRCID_Records[index]; rec; rec = rec->next)
1644     {
1645         if (wxStrcmp(rec->key, str_id) == 0)
1646         {
1647             return rec->id;
1648         }
1649         oldrec = rec;
1650     }
1651
1652     XRCID_record **rec_var = (oldrec == NULL) ?
1653                               &XRCID_Records[index] : &oldrec->next;
1654     *rec_var = new XRCID_record;
1655     (*rec_var)->key = wxStrdup(str_id);
1656     (*rec_var)->next = NULL;
1657
1658     char *end;
1659     if (value_if_not_found != wxID_NONE)
1660         (*rec_var)->id = value_if_not_found;
1661     else
1662     {
1663         int asint = wxStrtol(str_id, &end, 10);
1664         if (*str_id && *end == 0)
1665         {
1666             // if str_id was integer, keep it verbosely:
1667             (*rec_var)->id = asint;
1668         }
1669         else
1670         {
1671             (*rec_var)->id = wxWindowBase::NewControlId();
1672         }
1673     }
1674
1675     return (*rec_var)->id;
1676 }
1677
1678 static void AddStdXRCID_Records();
1679
1680 /*static*/
1681 int wxXmlResource::DoGetXRCID(const char *str_id, int value_if_not_found)
1682 {
1683     static bool s_stdIDsAdded = false;
1684
1685     if ( !s_stdIDsAdded )
1686     {
1687         s_stdIDsAdded = true;
1688         AddStdXRCID_Records();
1689     }
1690
1691     return XRCID_Lookup(str_id, value_if_not_found);
1692 }
1693
1694 /* static */
1695 wxString wxXmlResource::FindXRCIDById(int numId)
1696 {
1697     for ( int i = 0; i < XRCID_TABLE_SIZE; i++ )
1698     {
1699         for ( XRCID_record *rec = XRCID_Records[i]; rec; rec = rec->next )
1700         {
1701             if ( rec->id == numId )
1702                 return wxString(rec->key);
1703         }
1704     }
1705
1706     return wxString();
1707 }
1708
1709 static void CleanXRCID_Record(XRCID_record *rec)
1710 {
1711     if (rec)
1712     {
1713         CleanXRCID_Record(rec->next);
1714
1715         free(rec->key);
1716         delete rec;
1717     }
1718 }
1719
1720 static void CleanXRCID_Records()
1721 {
1722     for (int i = 0; i < XRCID_TABLE_SIZE; i++)
1723     {
1724         CleanXRCID_Record(XRCID_Records[i]);
1725         XRCID_Records[i] = NULL;
1726     }
1727 }
1728
1729 static void AddStdXRCID_Records()
1730 {
1731 #define stdID(id) XRCID_Lookup(#id, id)
1732     stdID(-1);
1733
1734     stdID(wxID_ANY);
1735     stdID(wxID_SEPARATOR);
1736
1737     stdID(wxID_OPEN);
1738     stdID(wxID_CLOSE);
1739     stdID(wxID_NEW);
1740     stdID(wxID_SAVE);
1741     stdID(wxID_SAVEAS);
1742     stdID(wxID_REVERT);
1743     stdID(wxID_EXIT);
1744     stdID(wxID_UNDO);
1745     stdID(wxID_REDO);
1746     stdID(wxID_HELP);
1747     stdID(wxID_PRINT);
1748     stdID(wxID_PRINT_SETUP);
1749     stdID(wxID_PAGE_SETUP);
1750     stdID(wxID_PREVIEW);
1751     stdID(wxID_ABOUT);
1752     stdID(wxID_HELP_CONTENTS);
1753     stdID(wxID_HELP_COMMANDS);
1754     stdID(wxID_HELP_PROCEDURES);
1755     stdID(wxID_HELP_CONTEXT);
1756     stdID(wxID_CLOSE_ALL);
1757     stdID(wxID_PREFERENCES);
1758     stdID(wxID_EDIT);
1759     stdID(wxID_CUT);
1760     stdID(wxID_COPY);
1761     stdID(wxID_PASTE);
1762     stdID(wxID_CLEAR);
1763     stdID(wxID_FIND);
1764     stdID(wxID_DUPLICATE);
1765     stdID(wxID_SELECTALL);
1766     stdID(wxID_DELETE);
1767     stdID(wxID_REPLACE);
1768     stdID(wxID_REPLACE_ALL);
1769     stdID(wxID_PROPERTIES);
1770     stdID(wxID_VIEW_DETAILS);
1771     stdID(wxID_VIEW_LARGEICONS);
1772     stdID(wxID_VIEW_SMALLICONS);
1773     stdID(wxID_VIEW_LIST);
1774     stdID(wxID_VIEW_SORTDATE);
1775     stdID(wxID_VIEW_SORTNAME);
1776     stdID(wxID_VIEW_SORTSIZE);
1777     stdID(wxID_VIEW_SORTTYPE);
1778     stdID(wxID_FILE1);
1779     stdID(wxID_FILE2);
1780     stdID(wxID_FILE3);
1781     stdID(wxID_FILE4);
1782     stdID(wxID_FILE5);
1783     stdID(wxID_FILE6);
1784     stdID(wxID_FILE7);
1785     stdID(wxID_FILE8);
1786     stdID(wxID_FILE9);
1787     stdID(wxID_OK);
1788     stdID(wxID_CANCEL);
1789     stdID(wxID_APPLY);
1790     stdID(wxID_YES);
1791     stdID(wxID_NO);
1792     stdID(wxID_STATIC);
1793     stdID(wxID_FORWARD);
1794     stdID(wxID_BACKWARD);
1795     stdID(wxID_DEFAULT);
1796     stdID(wxID_MORE);
1797     stdID(wxID_SETUP);
1798     stdID(wxID_RESET);
1799     stdID(wxID_CONTEXT_HELP);
1800     stdID(wxID_YESTOALL);
1801     stdID(wxID_NOTOALL);
1802     stdID(wxID_ABORT);
1803     stdID(wxID_RETRY);
1804     stdID(wxID_IGNORE);
1805     stdID(wxID_ADD);
1806     stdID(wxID_REMOVE);
1807     stdID(wxID_UP);
1808     stdID(wxID_DOWN);
1809     stdID(wxID_HOME);
1810     stdID(wxID_REFRESH);
1811     stdID(wxID_STOP);
1812     stdID(wxID_INDEX);
1813     stdID(wxID_BOLD);
1814     stdID(wxID_ITALIC);
1815     stdID(wxID_JUSTIFY_CENTER);
1816     stdID(wxID_JUSTIFY_FILL);
1817     stdID(wxID_JUSTIFY_RIGHT);
1818     stdID(wxID_JUSTIFY_LEFT);
1819     stdID(wxID_UNDERLINE);
1820     stdID(wxID_INDENT);
1821     stdID(wxID_UNINDENT);
1822     stdID(wxID_ZOOM_100);
1823     stdID(wxID_ZOOM_FIT);
1824     stdID(wxID_ZOOM_IN);
1825     stdID(wxID_ZOOM_OUT);
1826     stdID(wxID_UNDELETE);
1827     stdID(wxID_REVERT_TO_SAVED);
1828     stdID(wxID_SYSTEM_MENU);
1829     stdID(wxID_CLOSE_FRAME);
1830     stdID(wxID_MOVE_FRAME);
1831     stdID(wxID_RESIZE_FRAME);
1832     stdID(wxID_MAXIMIZE_FRAME);
1833     stdID(wxID_ICONIZE_FRAME);
1834     stdID(wxID_RESTORE_FRAME);
1835     stdID(wxID_CDROM);
1836     stdID(wxID_CONVERT);
1837     stdID(wxID_EXECUTE);
1838     stdID(wxID_FLOPPY);
1839     stdID(wxID_HARDDISK);
1840     stdID(wxID_BOTTOM);
1841     stdID(wxID_FIRST);
1842     stdID(wxID_LAST);
1843     stdID(wxID_TOP);
1844     stdID(wxID_INFO);
1845     stdID(wxID_JUMP_TO);
1846     stdID(wxID_NETWORK);
1847     stdID(wxID_SELECT_COLOR);
1848     stdID(wxID_SELECT_FONT);
1849     stdID(wxID_SORT_ASCENDING);
1850     stdID(wxID_SORT_DESCENDING);
1851     stdID(wxID_SPELL_CHECK);
1852     stdID(wxID_STRIKETHROUGH);
1853
1854 #undef stdID
1855 }
1856
1857
1858
1859
1860
1861 // --------------- module and globals -----------------------------
1862
1863 // normally we would do the cleanup from wxXmlResourceModule::OnExit() but it
1864 // can happen that some XRC records have been created because of the use of
1865 // XRCID() in event tables, which happens during static objects initialization,
1866 // but then the application initialization failed and so the wx modules were
1867 // neither initialized nor cleaned up -- this static object does the cleanup in
1868 // this case
1869 static struct wxXRCStaticCleanup
1870 {
1871     ~wxXRCStaticCleanup() { CleanXRCID_Records(); }
1872 } s_staticCleanup;
1873
1874 class wxXmlResourceModule: public wxModule
1875 {
1876 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule)
1877 public:
1878     wxXmlResourceModule() {}
1879     bool OnInit()
1880     {
1881         wxXmlResource::AddSubclassFactory(new wxXmlSubclassFactoryCXX);
1882         return true;
1883     }
1884     void OnExit()
1885     {
1886         delete wxXmlResource::Set(NULL);
1887         if(wxXmlResource::ms_subclassFactories)
1888         {
1889             for ( wxXmlSubclassFactories::iterator i = wxXmlResource::ms_subclassFactories->begin();
1890                   i != wxXmlResource::ms_subclassFactories->end(); ++i )
1891             {
1892                 delete *i;
1893             }
1894             wxDELETE(wxXmlResource::ms_subclassFactories);
1895         }
1896         CleanXRCID_Records();
1897     }
1898 };
1899
1900 IMPLEMENT_DYNAMIC_CLASS(wxXmlResourceModule, wxModule)
1901
1902
1903 // When wxXml is loaded dynamically after the application is already running
1904 // then the built-in module system won't pick this one up.  Add it manually.
1905 void wxXmlInitResourceModule()
1906 {
1907     wxModule* module = new wxXmlResourceModule;
1908     module->Init();
1909     wxModule::RegisterModule(module);
1910 }
1911
1912 #endif // wxUSE_XRC