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