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