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