contrib/src/xrc/xmlres.cpp

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