added \ escaping in XRC (patch 1042675)
[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), m_instanceAsWindow(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, *myInstanceAW = m_instanceAsWindow;
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 m_instanceAsWindow = wxDynamicCast(m_instance, wxWindow);
696
697 wxObject *returned = DoCreateResource();
698
699 m_node = myNode;
700 m_class = myClass;
701 m_parent = myParent; m_parentAsWindow = myParentAW;
702 m_instance = myInstance; m_instanceAsWindow = myInstanceAW;
703
704 return returned;
705 }
706
707
708 void wxXmlResourceHandler::AddStyle(const wxString& name, int value)
709 {
710 m_styleNames.Add(name);
711 m_styleValues.Add(value);
712 }
713
714
715
716 void wxXmlResourceHandler::AddWindowStyles()
717 {
718 XRC_ADD_STYLE(wxCLIP_CHILDREN);
719 XRC_ADD_STYLE(wxSIMPLE_BORDER);
720 XRC_ADD_STYLE(wxSUNKEN_BORDER);
721 XRC_ADD_STYLE(wxDOUBLE_BORDER);
722 XRC_ADD_STYLE(wxRAISED_BORDER);
723 XRC_ADD_STYLE(wxSTATIC_BORDER);
724 XRC_ADD_STYLE(wxNO_BORDER);
725 XRC_ADD_STYLE(wxTRANSPARENT_WINDOW);
726 XRC_ADD_STYLE(wxWANTS_CHARS);
727 XRC_ADD_STYLE(wxNO_FULL_REPAINT_ON_RESIZE);
728 XRC_ADD_STYLE(wxFULL_REPAINT_ON_RESIZE);
729 XRC_ADD_STYLE(wxWS_EX_BLOCK_EVENTS);
730 }
731
732
733
734 bool wxXmlResourceHandler::HasParam(const wxString& param)
735 {
736 return (GetParamNode(param) != NULL);
737 }
738
739
740 int wxXmlResourceHandler::GetStyle(const wxString& param, int defaults)
741 {
742 wxString s = GetParamValue(param);
743
744 if (!s) return defaults;
745
746 wxStringTokenizer tkn(s, wxT("| \t\n"), wxTOKEN_STRTOK);
747 int style = 0;
748 int index;
749 wxString fl;
750 while (tkn.HasMoreTokens())
751 {
752 fl = tkn.GetNextToken();
753 index = m_styleNames.Index(fl);
754 if (index != wxNOT_FOUND)
755 style |= m_styleValues[index];
756 else
757 wxLogError(_("Unknown style flag ") + fl);
758 }
759 return style;
760 }
761
762
763
764 wxString wxXmlResourceHandler::GetText(const wxString& param, bool translate)
765 {
766 wxXmlNode *parNode = GetParamNode(param);
767 wxString str1(GetNodeContent(parNode));
768 wxString str2;
769 const wxChar *dt;
770 wxChar amp_char;
771
772 // VS: First version of XRC resources used $ instead of & (which is
773 // illegal in XML), but later I realized that '_' fits this purpose
774 // much better (because &File means "File with F underlined").
775 if (m_resource->CompareVersion(2,3,0,1) < 0)
776 amp_char = wxT('$');
777 else
778 amp_char = wxT('_');
779
780 for (dt = str1.c_str(); *dt; dt++)
781 {
782 // Remap amp_char to &, map double amp_char to amp_char (for things
783 // like "&File..." -- this is illegal in XML, so we use "_File..."):
784 if (*dt == amp_char)
785 {
786 if ( *(++dt) == amp_char )
787 str2 << amp_char;
788 else
789 str2 << wxT('&') << *dt;
790 }
791 // Remap \n to CR, \r to LF, \t to TAB, \\ to \:
792 else if (*dt == wxT('\\'))
793 switch (*(++dt))
794 {
795 case wxT('n'):
796 str2 << wxT('\n');
797 break;
798
799 case wxT('t'):
800 str2 << wxT('\t');
801 break;
802
803 case wxT('r'):
804 str2 << wxT('\r');
805 break;
806
807 case wxT('\\') :
808 // "\\" wasn't translated to "\" prior to 2.5.3.0:
809 if (m_resource->CompareVersion(2,5,3,0) >= 0)
810 {
811 str2 << wxT('\\');
812 break;
813 }
814 // else fall-through to default: branch below
815
816 default:
817 str2 << wxT('\\') << *dt;
818 break;
819 }
820 else str2 << *dt;
821 }
822
823 if (m_resource->GetFlags() & wxXRC_USE_LOCALE)
824 {
825 if (translate && parNode &&
826 parNode->GetPropVal(wxT("translate"), wxEmptyString) != wxT("0"))
827 {
828 return wxGetTranslation(str2);
829 }
830 else
831 {
832 #if wxUSE_UNICODE
833 return str2;
834 #else
835 // The string is internally stored as UTF-8, we have to convert
836 // it into system's default encoding so that it can be displayed:
837 return wxString(str2.mb_str(wxConvUTF8), wxConvLocal);
838 #endif
839 }
840 }
841 else
842 {
843 // If wxXRC_USE_LOCALE is not set, then the string is already in
844 // system's default encoding in ANSI build, so we don't have to
845 // do anything special here.
846 return str2;
847 }
848 }
849
850
851
852 long wxXmlResourceHandler::GetLong(const wxString& param, long defaultv)
853 {
854 long value;
855 wxString str1 = GetParamValue(param);
856
857 if (!str1.ToLong(&value))
858 value = defaultv;
859
860 return value;
861 }
862
863
864
865 int wxXmlResourceHandler::GetID()
866 {
867 return wxXmlResource::GetXRCID(GetName());
868 }
869
870
871
872 wxString wxXmlResourceHandler::GetName()
873 {
874 return m_node->GetPropVal(wxT("name"), wxT("-1"));
875 }
876
877
878
879 bool wxXmlResourceHandler::GetBool(const wxString& param, bool defaultv)
880 {
881 wxString v = GetParamValue(param);
882 v.MakeLower();
883 if (!v) return defaultv;
884 else return (v == wxT("1"));
885 }
886
887
888
889 wxColour wxXmlResourceHandler::GetColour(const wxString& param)
890 {
891 wxString v = GetParamValue(param);
892 unsigned long tmp = 0;
893
894 if (v.Length() != 7 || v[0u] != wxT('#') ||
895 wxSscanf(v.c_str(), wxT("#%lX"), &tmp) != 1)
896 {
897 wxLogError(_("XRC resource: Incorrect colour specification '%s' for property '%s'."),
898 v.c_str(), param.c_str());
899 return wxNullColour;
900 }
901
902 return wxColour((unsigned char) ((tmp & 0xFF0000) >> 16) ,
903 (unsigned char) ((tmp & 0x00FF00) >> 8),
904 (unsigned char) ((tmp & 0x0000FF)));
905 }
906
907
908
909 wxBitmap wxXmlResourceHandler::GetBitmap(const wxString& param,
910 const wxArtClient& defaultArtClient,
911 wxSize size)
912 {
913 /* If the bitmap is specified as stock item, query wxArtProvider for it: */
914 wxXmlNode *bmpNode = GetParamNode(param);
915 if ( bmpNode )
916 {
917 wxString sid = bmpNode->GetPropVal(wxT("stock_id"), wxEmptyString);
918 if ( !sid.empty() )
919 {
920 wxString scl = bmpNode->GetPropVal(wxT("stock_client"), wxEmptyString);
921 if (scl.empty())
922 scl = defaultArtClient;
923 else
924 scl = wxART_MAKE_CLIENT_ID_FROM_STR(scl);
925
926 wxBitmap stockArt =
927 wxArtProvider::GetBitmap(wxART_MAKE_ART_ID_FROM_STR(sid),
928 scl, size);
929 if ( stockArt.Ok() )
930 return stockArt;
931 }
932 }
933
934 /* ...or load the bitmap from file: */
935 wxString name = GetParamValue(param);
936 if (name.IsEmpty()) return wxNullBitmap;
937 #if wxUSE_FILESYSTEM
938 wxFSFile *fsfile = GetCurFileSystem().OpenFile(name);
939 if (fsfile == NULL)
940 {
941 wxLogError(_("XRC resource: Cannot create bitmap from '%s'."),
942 name.c_str());
943 return wxNullBitmap;
944 }
945 wxImage img(*(fsfile->GetStream()));
946 delete fsfile;
947 #else
948 wxImage img(GetParamValue(wxT("bitmap")));
949 #endif
950
951 if (!img.Ok())
952 {
953 wxLogError(_("XRC resource: Cannot create bitmap from '%s'."), param.c_str());
954 return wxNullBitmap;
955 }
956 if (!(size == wxDefaultSize)) img.Rescale(size.x, size.y);
957 return wxBitmap(img);
958
959 }
960
961
962
963 wxIcon wxXmlResourceHandler::GetIcon(const wxString& param,
964 const wxArtClient& defaultArtClient,
965 wxSize size)
966 {
967 wxIcon icon;
968 icon.CopyFromBitmap(GetBitmap(param, defaultArtClient, size));
969 return icon;
970 }
971
972
973
974 wxXmlNode *wxXmlResourceHandler::GetParamNode(const wxString& param)
975 {
976 wxCHECK_MSG(m_node, NULL, wxT("You can't access handler data before it was initialized!"));
977
978 wxXmlNode *n = m_node->GetChildren();
979
980 while (n)
981 {
982 if (n->GetType() == wxXML_ELEMENT_NODE && n->GetName() == param)
983 return n;
984 n = n->GetNext();
985 }
986 return NULL;
987 }
988
989
990 wxString wxXmlResourceHandler::GetNodeContent(wxXmlNode *node)
991 {
992 wxXmlNode *n = node;
993 if (n == NULL) return wxEmptyString;
994 n = n->GetChildren();
995
996 while (n)
997 {
998 if (n->GetType() == wxXML_TEXT_NODE ||
999 n->GetType() == wxXML_CDATA_SECTION_NODE)
1000 return n->GetContent();
1001 n = n->GetNext();
1002 }
1003 return wxEmptyString;
1004 }
1005
1006
1007
1008 wxString wxXmlResourceHandler::GetParamValue(const wxString& param)
1009 {
1010 if (param.IsEmpty())
1011 return GetNodeContent(m_node);
1012 else
1013 return GetNodeContent(GetParamNode(param));
1014 }
1015
1016
1017
1018 wxSize wxXmlResourceHandler::GetSize(const wxString& param)
1019 {
1020 wxString s = GetParamValue(param);
1021 if (s.IsEmpty()) s = wxT("-1,-1");
1022 bool is_dlg;
1023 long sx, sy = 0;
1024
1025 is_dlg = s[s.Length()-1] == wxT('d');
1026 if (is_dlg) s.RemoveLast();
1027
1028 if (!s.BeforeFirst(wxT(',')).ToLong(&sx) ||
1029 !s.AfterLast(wxT(',')).ToLong(&sy))
1030 {
1031 wxLogError(_("Cannot parse coordinates from '%s'."), s.c_str());
1032 return wxDefaultSize;
1033 }
1034
1035 if (is_dlg)
1036 {
1037 if (m_instanceAsWindow)
1038 return wxDLG_UNIT(m_instanceAsWindow, wxSize(sx, sy));
1039 else if (m_parentAsWindow)
1040 return wxDLG_UNIT(m_parentAsWindow, wxSize(sx, sy));
1041 else
1042 {
1043 wxLogError(_("Cannot convert dialog units: dialog unknown."));
1044 return wxDefaultSize;
1045 }
1046 }
1047 else return wxSize(sx, sy);
1048 }
1049
1050
1051
1052 wxPoint wxXmlResourceHandler::GetPosition(const wxString& param)
1053 {
1054 wxSize sz = GetSize(param);
1055 return wxPoint(sz.x, sz.y);
1056 }
1057
1058
1059
1060 wxCoord wxXmlResourceHandler::GetDimension(const wxString& param, wxCoord defaultv)
1061 {
1062 wxString s = GetParamValue(param);
1063 if (s.IsEmpty()) return defaultv;
1064 bool is_dlg;
1065 long sx;
1066
1067 is_dlg = s[s.Length()-1] == wxT('d');
1068 if (is_dlg) s.RemoveLast();
1069
1070 if (!s.ToLong(&sx))
1071 {
1072 wxLogError(_("Cannot parse dimension from '%s'."), s.c_str());
1073 return defaultv;
1074 }
1075
1076 if (is_dlg)
1077 {
1078 if (m_instanceAsWindow)
1079 return wxDLG_UNIT(m_instanceAsWindow, wxSize(sx, 0)).x;
1080 else if (m_parentAsWindow)
1081 return wxDLG_UNIT(m_parentAsWindow, wxSize(sx, 0)).x;
1082 else
1083 {
1084 wxLogError(_("Cannot convert dialog units: dialog unknown."));
1085 return defaultv;
1086 }
1087 }
1088 else return sx;
1089 }
1090
1091
1092
1093 wxFont wxXmlResourceHandler::GetFont(const wxString& param)
1094 {
1095 wxXmlNode *font_node = GetParamNode(param);
1096 if (font_node == NULL)
1097 {
1098 wxLogError(_("Cannot find font node '%s'."), param.c_str());
1099 return wxNullFont;
1100 }
1101
1102 wxXmlNode *oldnode = m_node;
1103 m_node = font_node;
1104
1105 long size = GetLong(wxT("size"), 12);
1106
1107 wxString style = GetParamValue(wxT("style"));
1108 wxString weight = GetParamValue(wxT("weight"));
1109 int istyle = wxNORMAL, iweight = wxNORMAL;
1110 if (style == wxT("italic")) istyle = wxITALIC;
1111 else if (style == wxT("slant")) istyle = wxSLANT;
1112 if (weight == wxT("bold")) iweight = wxBOLD;
1113 else if (weight == wxT("light")) iweight = wxLIGHT;
1114
1115 wxString family = GetParamValue(wxT("family"));
1116 int ifamily = wxDEFAULT;
1117 if (family == wxT("decorative")) ifamily = wxDECORATIVE;
1118 else if (family == wxT("roman")) ifamily = wxROMAN;
1119 else if (family == wxT("script")) ifamily = wxSCRIPT;
1120 else if (family == wxT("swiss")) ifamily = wxSWISS;
1121 else if (family == wxT("modern")) ifamily = wxMODERN;
1122
1123 bool underlined = GetBool(wxT("underlined"), false);
1124
1125 wxString encoding = GetParamValue(wxT("encoding"));
1126 wxFontMapper mapper;
1127 wxFontEncoding enc = wxFONTENCODING_DEFAULT;
1128 if (!encoding.IsEmpty())
1129 enc = mapper.CharsetToEncoding(encoding);
1130 if (enc == wxFONTENCODING_SYSTEM)
1131 enc = wxFONTENCODING_DEFAULT;
1132
1133 wxString faces = GetParamValue(wxT("face"));
1134 wxString facename = wxEmptyString;
1135 wxFontEnumerator enu;
1136 enu.EnumerateFacenames();
1137 wxStringTokenizer tk(faces, wxT(","));
1138 while (tk.HasMoreTokens())
1139 {
1140 int index = enu.GetFacenames()->Index(tk.GetNextToken(), false);
1141 if (index != wxNOT_FOUND)
1142 {
1143 facename = (*enu.GetFacenames())[index];
1144 break;
1145 }
1146 }
1147
1148 m_node = oldnode;
1149
1150 wxFont font(size, ifamily, istyle, iweight, underlined, facename, enc);
1151 return font;
1152 }
1153
1154
1155 void wxXmlResourceHandler::SetupWindow(wxWindow *wnd)
1156 {
1157 //FIXME : add cursor
1158
1159 if (HasParam(wxT("exstyle")))
1160 // Have to OR it with existing style, since
1161 // some implementations (e.g. wxGTK) use the extra style
1162 // during creation
1163 wnd->SetExtraStyle(wnd->GetExtraStyle() | GetStyle(wxT("exstyle")));
1164 if (HasParam(wxT("bg")))
1165 wnd->SetBackgroundColour(GetColour(wxT("bg")));
1166 if (HasParam(wxT("fg")))
1167 wnd->SetForegroundColour(GetColour(wxT("fg")));
1168 if (GetBool(wxT("enabled"), 1) == 0)
1169 wnd->Enable(false);
1170 if (GetBool(wxT("focused"), 0) == 1)
1171 wnd->SetFocus();
1172 if (GetBool(wxT("hidden"), 0) == 1)
1173 wnd->Show(false);
1174 #if wxUSE_TOOLTIPS
1175 if (HasParam(wxT("tooltip")))
1176 wnd->SetToolTip(GetText(wxT("tooltip")));
1177 #endif
1178 if (HasParam(wxT("font")))
1179 wnd->SetFont(GetFont());
1180 }
1181
1182
1183 void wxXmlResourceHandler::CreateChildren(wxObject *parent, bool this_hnd_only)
1184 {
1185 wxXmlNode *n = m_node->GetChildren();
1186
1187 while (n)
1188 {
1189 if (n->GetType() == wxXML_ELEMENT_NODE &&
1190 (n->GetName() == wxT("object") || n->GetName() == wxT("object_ref")))
1191 {
1192 m_resource->CreateResFromNode(n, parent, NULL,
1193 this_hnd_only ? this : NULL);
1194 }
1195 n = n->GetNext();
1196 }
1197 }
1198
1199
1200 void wxXmlResourceHandler::CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode)
1201 {
1202 wxXmlNode *root;
1203 if (rootnode == NULL) root = m_node; else root = rootnode;
1204 wxXmlNode *n = root->GetChildren();
1205
1206 while (n)
1207 {
1208 if (n->GetType() == wxXML_ELEMENT_NODE && CanHandle(n))
1209 {
1210 CreateResource(n, parent, NULL);
1211 }
1212 n = n->GetNext();
1213 }
1214 }
1215
1216
1217
1218
1219
1220
1221
1222 // --------------- XRCID implementation -----------------------------
1223
1224 #define XRCID_TABLE_SIZE 1024
1225
1226
1227 struct XRCID_record
1228 {
1229 int id;
1230 wxChar *key;
1231 XRCID_record *next;
1232 };
1233
1234 static XRCID_record *XRCID_Records[XRCID_TABLE_SIZE] = {NULL};
1235
1236 static int XRCID_Lookup(const wxChar *str_id, int value_if_not_found = -2)
1237 {
1238 static int XRCID_LastID = wxID_HIGHEST;
1239
1240 int index = 0;
1241
1242 for (const wxChar *c = str_id; *c != wxT('\0'); c++) index += (int)*c;
1243 index %= XRCID_TABLE_SIZE;
1244
1245 XRCID_record *oldrec = NULL;
1246 for (XRCID_record *rec = XRCID_Records[index]; rec; rec = rec->next)
1247 {
1248 if (wxStrcmp(rec->key, str_id) == 0)
1249 {
1250 return rec->id;
1251 }
1252 oldrec = rec;
1253 }
1254
1255 XRCID_record **rec_var = (oldrec == NULL) ?
1256 &XRCID_Records[index] : &oldrec->next;
1257 *rec_var = new XRCID_record;
1258 (*rec_var)->key = wxStrdup(str_id);
1259 (*rec_var)->next = NULL;
1260
1261 wxChar *end;
1262 if (value_if_not_found != -2)
1263 (*rec_var)->id = value_if_not_found;
1264 else
1265 {
1266 int asint = wxStrtol(str_id, &end, 10);
1267 if (*str_id && *end == 0)
1268 {
1269 // if str_id was integer, keep it verbosely:
1270 (*rec_var)->id = asint;
1271 }
1272 else
1273 {
1274 (*rec_var)->id = ++XRCID_LastID;
1275 }
1276 }
1277
1278 return (*rec_var)->id;
1279 }
1280
1281 /*static*/ int wxXmlResource::GetXRCID(const wxChar *str_id)
1282 {
1283 return XRCID_Lookup(str_id);
1284 }
1285
1286
1287 static void CleanXRCID_Record(XRCID_record *rec)
1288 {
1289 if (rec)
1290 {
1291 CleanXRCID_Record(rec->next);
1292 free(rec->key);
1293 delete rec;
1294 }
1295 }
1296
1297 static void CleanXRCID_Records()
1298 {
1299 for (int i = 0; i < XRCID_TABLE_SIZE; i++)
1300 {
1301 CleanXRCID_Record(XRCID_Records[i]);
1302 XRCID_Records[i] = NULL;
1303 }
1304 }
1305
1306 static void AddStdXRCID_Records()
1307 {
1308 #define stdID(id) XRCID_Lookup(wxT(#id), id)
1309 stdID(-1);
1310
1311 stdID(wxID_ANY);
1312 stdID(wxID_SEPARATOR);
1313
1314 stdID(wxID_OPEN);
1315 stdID(wxID_CLOSE);
1316 stdID(wxID_NEW);
1317 stdID(wxID_SAVE);
1318 stdID(wxID_SAVEAS);
1319 stdID(wxID_REVERT);
1320 stdID(wxID_EXIT);
1321 stdID(wxID_UNDO);
1322 stdID(wxID_REDO);
1323 stdID(wxID_HELP);
1324 stdID(wxID_PRINT);
1325 stdID(wxID_PRINT_SETUP);
1326 stdID(wxID_PREVIEW);
1327 stdID(wxID_ABOUT);
1328 stdID(wxID_HELP_CONTENTS);
1329 stdID(wxID_HELP_COMMANDS);
1330 stdID(wxID_HELP_PROCEDURES);
1331 stdID(wxID_HELP_CONTEXT);
1332 stdID(wxID_CLOSE_ALL);
1333 stdID(wxID_PREFERENCES);
1334 stdID(wxID_CUT);
1335 stdID(wxID_COPY);
1336 stdID(wxID_PASTE);
1337 stdID(wxID_CLEAR);
1338 stdID(wxID_FIND);
1339 stdID(wxID_DUPLICATE);
1340 stdID(wxID_SELECTALL);
1341 stdID(wxID_DELETE);
1342 stdID(wxID_REPLACE);
1343 stdID(wxID_REPLACE_ALL);
1344 stdID(wxID_PROPERTIES);
1345 stdID(wxID_VIEW_DETAILS);
1346 stdID(wxID_VIEW_LARGEICONS);
1347 stdID(wxID_VIEW_SMALLICONS);
1348 stdID(wxID_VIEW_LIST);
1349 stdID(wxID_VIEW_SORTDATE);
1350 stdID(wxID_VIEW_SORTNAME);
1351 stdID(wxID_VIEW_SORTSIZE);
1352 stdID(wxID_VIEW_SORTTYPE);
1353 stdID(wxID_FILE1);
1354 stdID(wxID_FILE2);
1355 stdID(wxID_FILE3);
1356 stdID(wxID_FILE4);
1357 stdID(wxID_FILE5);
1358 stdID(wxID_FILE6);
1359 stdID(wxID_FILE7);
1360 stdID(wxID_FILE8);
1361 stdID(wxID_FILE9);
1362 stdID(wxID_OK);
1363 stdID(wxID_CANCEL);
1364 stdID(wxID_APPLY);
1365 stdID(wxID_YES);
1366 stdID(wxID_NO);
1367 stdID(wxID_STATIC);
1368 stdID(wxID_FORWARD);
1369 stdID(wxID_BACKWARD);
1370 stdID(wxID_DEFAULT);
1371 stdID(wxID_MORE);
1372 stdID(wxID_SETUP);
1373 stdID(wxID_RESET);
1374 stdID(wxID_CONTEXT_HELP);
1375 stdID(wxID_YESTOALL);
1376 stdID(wxID_NOTOALL);
1377 stdID(wxID_ABORT);
1378 stdID(wxID_RETRY);
1379 stdID(wxID_IGNORE);
1380 stdID(wxID_ADD);
1381 stdID(wxID_REMOVE);
1382 stdID(wxID_UP);
1383 stdID(wxID_DOWN);
1384 stdID(wxID_HOME);
1385 stdID(wxID_REFRESH);
1386 stdID(wxID_STOP);
1387 stdID(wxID_INDEX);
1388 stdID(wxID_BOLD);
1389 stdID(wxID_ITALIC);
1390 stdID(wxID_JUSTIFY_CENTER);
1391 stdID(wxID_JUSTIFY_FILL);
1392 stdID(wxID_JUSTIFY_RIGHT);
1393 stdID(wxID_JUSTIFY_LEFT);
1394 stdID(wxID_UNDERLINE);
1395 stdID(wxID_INDENT);
1396 stdID(wxID_UNINDENT);
1397 stdID(wxID_ZOOM_100);
1398 stdID(wxID_ZOOM_FIT);
1399 stdID(wxID_ZOOM_IN);
1400 stdID(wxID_ZOOM_OUT);
1401 stdID(wxID_UNDELETE);
1402 stdID(wxID_REVERT_TO_SAVED);
1403 stdID(wxID_SYSTEM_MENU);
1404 stdID(wxID_CLOSE_FRAME);
1405 stdID(wxID_MOVE_FRAME);
1406 stdID(wxID_RESIZE_FRAME);
1407 stdID(wxID_MAXIMIZE_FRAME);
1408 stdID(wxID_ICONIZE_FRAME);
1409 stdID(wxID_RESTORE_FRAME);
1410
1411 #undef stdID
1412 }
1413
1414
1415
1416
1417
1418 // --------------- module and globals -----------------------------
1419
1420 class wxXmlResourceModule: public wxModule
1421 {
1422 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule)
1423 public:
1424 wxXmlResourceModule() {}
1425 bool OnInit()
1426 {
1427 AddStdXRCID_Records();
1428 wxXmlResource::AddSubclassFactory(new wxXmlSubclassFactoryCXX);
1429 return true;
1430 }
1431 void OnExit()
1432 {
1433 delete wxXmlResource::Set(NULL);
1434 if(wxXmlResource::ms_subclassFactories)
1435 WX_CLEAR_LIST(wxXmlSubclassFactoriesList, *wxXmlResource::ms_subclassFactories);
1436 wxDELETE(wxXmlResource::ms_subclassFactories);
1437 CleanXRCID_Records();
1438 }
1439 };
1440
1441 IMPLEMENT_DYNAMIC_CLASS(wxXmlResourceModule, wxModule)
1442
1443
1444 // When wxXml is loaded dynamically after the application is already running
1445 // then the built-in module system won't pick this one up. Add it manually.
1446 void wxXmlInitResourceModule()
1447 {
1448 wxModule* module = new wxXmlResourceModule;
1449 module->Init();
1450 wxModule::RegisterModule(module);
1451 }
1452
1453 #endif // wxUSE_XRC