1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: XML resources
4 // Author: Vaclav Slavik
7 // Copyright: (c) 2000 Vaclav Slavik
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
12 #pragma implementation "xmlres.h"
15 // For compilers that support precompilation, includes "wx.h".
16 #include "wx/wxprec.h"
22 #include "wx/dialog.h"
24 #include "wx/wfstream.h"
25 #include "wx/filesys.h"
28 #include "wx/tokenzr.h"
29 #include "wx/fontenum.h"
30 #include "wx/module.h"
31 #include "wx/bitmap.h"
34 #include "wx/xml/xml.h"
35 #include "wx/xml/xmlres.h"
37 #include "wx/arrimpl.cpp"
38 WX_DEFINE_OBJARRAY(wxXmlResourceDataRecords
);
41 wxXmlResource::wxXmlResource(bool use_locale
= TRUE
)
43 m_Handlers
.DeleteContents(TRUE
);
44 m_UseLocale
= use_locale
;
47 wxXmlResource::wxXmlResource(const wxString
& filemask
, bool use_locale
= TRUE
)
49 m_UseLocale
= use_locale
;
50 m_Handlers
.DeleteContents(TRUE
);
54 wxXmlResource::~wxXmlResource()
60 bool wxXmlResource::Load(const wxString
& filemask
)
63 wxXmlResourceDataRecord
*drec
;
64 bool iswild
= wxIsWild(filemask
);
68 # define wxXmlFindFirst fsys.FindFirst(filemask, wxFILE)
69 # define wxXmlFindNext fsys.FindNext()
71 # define wxXmlFindFirst wxFindFirstFile(filemask, wxFILE)
72 # define wxXmlFindNext wxFindNextFile()
81 if (filemask
.Lower().Matches("*.zip") ||
82 filemask
.Lower().Matches("*.rsc"))
87 fnd2
= fs2
.FindFirst(fnd
+ wxT("#zip:*.xmb"), wxFILE
);
90 drec
= new wxXmlResourceDataRecord
;
93 fnd2
= fs2
.FindNext();
99 drec
= new wxXmlResourceDataRecord
;
109 # undef wxXmlFindFirst
110 # undef wxXmlFindNext
116 void wxXmlResource::AddHandler(wxXmlResourceHandler
*handler
)
118 m_Handlers
.Append(handler
);
119 handler
->SetParentResource(this);
124 void wxXmlResource::ClearHandlers()
131 wxMenu
*wxXmlResource::LoadMenu(const wxString
& name
)
133 return (wxMenu
*)CreateResFromNode(FindResource(name
, wxT("menu")), NULL
, NULL
);
138 wxMenuBar
*wxXmlResource::LoadMenuBar(const wxString
& name
)
140 return (wxMenuBar
*)CreateResFromNode(FindResource(name
, wxT("menubar")), NULL
, NULL
);
145 wxToolBar
*wxXmlResource::LoadToolBar(wxWindow
*parent
, const wxString
& name
)
147 return (wxToolBar
*)CreateResFromNode(FindResource(name
, wxT("toolbar")), parent
, NULL
);
152 wxDialog
*wxXmlResource::LoadDialog(wxWindow
*parent
, const wxString
& name
)
154 wxDialog
*dialog
= new wxDialog
;
155 if (!LoadDialog(dialog
, parent
, name
))
156 { delete dialog
; return NULL
; }
160 bool wxXmlResource::LoadDialog(wxDialog
*dlg
, wxWindow
*parent
, const wxString
& name
)
162 return CreateResFromNode(FindResource(name
, wxT("dialog")), parent
, dlg
) != NULL
;
167 wxPanel
*wxXmlResource::LoadPanel(wxWindow
*parent
, const wxString
& name
)
169 wxPanel
*panel
= new wxPanel
;
170 if (!LoadPanel(panel
, parent
, name
))
171 { delete panel
; return NULL
; }
175 bool wxXmlResource::LoadPanel(wxPanel
*panel
, wxWindow
*parent
, const wxString
& name
)
177 return CreateResFromNode(FindResource(name
, wxT("panel")), parent
, panel
) != NULL
;
182 wxBitmap
wxXmlResource::LoadBitmap(const wxString
& name
)
184 wxBitmap
*bmp
= (wxBitmap
*)CreateResFromNode(
185 FindResource(name
, wxT("bitmap")), NULL
, NULL
);
188 if (bmp
) { rt
= *bmp
; delete bmp
; }
192 wxIcon
wxXmlResource::LoadIcon(const wxString
& name
)
194 wxIcon
*icon
= (wxIcon
*)CreateResFromNode(
195 FindResource(name
, wxT("icon")), NULL
, NULL
);
198 if (icon
) { rt
= *icon
; delete icon
; }
204 void wxXmlResource::ProcessPlatformProperty(wxXmlNode
*node
)
209 wxXmlNode
*c
= node
->GetChildren();
213 if (!c
->GetPropVal(_T("platform"), &s
))
217 wxStringTokenizer
tkn(s
, " |");
219 while (tkn
.HasMoreTokens())
221 s
= tkn
.GetNextToken();
224 s
== wxString(_T("win"))
225 #elif defined(__UNIX__)
226 s
== wxString(_T("unix"))
227 #elif defined(__MAC__)
228 s
== wxString(_T("mac"))
229 #elif defined(__OS2__)
230 s
== wxString(_T("os2"))
239 ProcessPlatformProperty(c
);
242 node
->RemoveChild(c
);
252 void wxXmlResource::UpdateResources()
255 # if wxUSE_FILESYSTEM
260 for (size_t i
= 0; i
< m_Data
.GetCount(); i
++)
262 modif
= (m_Data
[i
].Doc
== NULL
);
266 # if wxUSE_FILESYSTEM
267 file
= fsys
.OpenFile(m_Data
[i
].File
);
268 modif
= file
&& file
->GetModificationTime() > m_Data
[i
].Time
;
270 wxLogError(_("Cannot open file '%s'."), m_Data
[i
].File
.c_str());
273 modif
= wxDateTime(wxFileModificationTime(m_Data
[i
].File
)) > m_Data
[i
].Time
;
279 wxInputStream
*stream
;
281 # if wxUSE_FILESYSTEM
282 file
= fsys
.OpenFile(m_Data
[i
].File
);
283 stream
= file
->GetStream();
285 stream
= new wxFileInputStream(m_Data
[i
].File
);
290 delete m_Data
[i
].Doc
;
291 m_Data
[i
].Doc
= new wxXmlDocument
;
293 if (!stream
|| !m_Data
[i
].Doc
->Load(*stream
))
295 wxLogError(_("Cannot load resources from file '%s'."), m_Data
[i
].File
.c_str());
296 delete m_Data
[i
].Doc
;
297 m_Data
[i
].Doc
= NULL
;
299 else if (m_Data
[i
].Doc
->GetRoot()->GetName() != _T("resource"))
301 wxLogError(_("Invalid XML resource '%s': doesn't have root node 'resource'."), m_Data
[i
].File
.c_str());
302 delete m_Data
[i
].Doc
;
303 m_Data
[i
].Doc
= NULL
;
306 ProcessPlatformProperty(m_Data
[i
].Doc
->GetRoot());
308 # if wxUSE_FILESYSTEM
319 wxXmlNode
*wxXmlResource::FindResource(const wxString
& name
, const wxString
& type
)
321 UpdateResources(); //ensure everything is up-to-date
324 for (size_t f
= 0; f
< m_Data
.GetCount(); f
++)
326 if (m_Data
[f
].Doc
== NULL
|| m_Data
[f
].Doc
->GetRoot() == NULL
) continue;
327 for (wxXmlNode
*node
= m_Data
[f
].Doc
->GetRoot()->GetChildren();
328 node
; node
= node
->GetNext())
329 if ( node
->GetType() == wxXML_ELEMENT_NODE
&&
330 (!type
|| node
->GetName() == type
) &&
331 node
->GetPropVal(wxT("name"), &dummy
) &&
335 m_CurFileSystem
.ChangePathTo(m_Data
[f
].File
);
341 wxLogError(_("XML resource '%s' (type '%s') not found!"),
342 name
.c_str(), type
.c_str());
348 wxObject
*wxXmlResource::CreateResFromNode(wxXmlNode
*node
, wxObject
*parent
, wxObject
*instance
)
350 if (node
== NULL
) return NULL
;
352 wxXmlResourceHandler
*handler
;
354 wxNode
* ND
= m_Handlers
.GetFirst();
357 handler
= (wxXmlResourceHandler
*)ND
->GetData();
358 if (handler
->CanHandle(node
))
360 ret
= handler
->CreateResource(node
, parent
, instance
);
366 wxLogError(_("No handler found for XML node '%s'!"), node
->GetName().c_str());
378 wxXmlResourceHandler::wxXmlResourceHandler()
379 : m_Node(NULL
), m_Parent(NULL
), m_Instance(NULL
),
380 m_ParentAsWindow(NULL
), m_InstanceAsWindow(NULL
)
385 wxObject
*wxXmlResourceHandler::CreateResource(wxXmlNode
*node
, wxObject
*parent
, wxObject
*instance
)
387 wxXmlNode
*myNode
= m_Node
;
388 wxObject
*myParent
= m_Parent
, *myInstance
= m_Instance
;
389 wxWindow
*myParentAW
= m_ParentAsWindow
, *myInstanceAW
= m_InstanceAsWindow
;
393 m_Instance
= instance
;
394 m_ParentAsWindow
= wxDynamicCast(m_Parent
, wxWindow
);
395 m_InstanceAsWindow
= wxDynamicCast(m_Instance
, wxWindow
);
397 wxObject
*returned
= DoCreateResource();
400 m_Parent
= myParent
; m_ParentAsWindow
= myParentAW
;
401 m_Instance
= myInstance
; m_InstanceAsWindow
= myInstanceAW
;
407 void wxXmlResourceHandler::AddStyle(const wxString
& name
, int value
)
409 m_StyleNames
.Add(name
);
410 m_StyleValues
.Add(value
);
415 void wxXmlResourceHandler::AddWindowStyles()
417 ADD_STYLE(wxSIMPLE_BORDER
);
418 ADD_STYLE(wxSUNKEN_BORDER
);
419 ADD_STYLE(wxDOUBLE_BORDER
);
420 ADD_STYLE(wxRAISED_BORDER
);
421 ADD_STYLE(wxSTATIC_BORDER
);
422 ADD_STYLE(wxTRANSPARENT_WINDOW
);
423 ADD_STYLE(wxWANTS_CHARS
);
424 ADD_STYLE(wxNO_FULL_REPAINT_ON_RESIZE
);
429 bool wxXmlResourceHandler::HasParam(const wxString
& param
)
431 return (GetParamNode(param
) != NULL
);
435 int wxXmlResourceHandler::GetStyle(const wxString
& param
, int defaults
)
437 wxString s
= GetParamValue(param
);
439 if (!s
) return defaults
;
441 wxStringTokenizer
tkn(s
, _T("| "), wxTOKEN_STRTOK
);
445 while (tkn
.HasMoreTokens())
447 fl
= tkn
.GetNextToken();
448 index
= m_StyleNames
.Index(fl
);
449 if (index
!= wxNOT_FOUND
)
450 style
|= m_StyleValues
[index
];
452 wxLogError(_("Unknown style flag ") + fl
);
459 wxString
wxXmlResourceHandler::GetText(const wxString
& param
)
461 wxString str1
= GetParamValue(param
);
465 for (dt
= str1
.c_str(); *dt
; dt
++)
467 // Remap $ to &, map $$ to $ (for things like "&File..." --
468 // this is illegal in XML, so we use "$File..."):
472 case '$' : str2
<< '$'; break;
473 default : str2
<< '&' << *dt
; break;
475 // Remap \n to CR, \r LF, \t to TAB:
476 else if (*dt
== '\\')
479 case 'n' : str2
<< '\n'; break;
480 case 't' : str2
<< '\t'; break;
481 case 'r' : str2
<< '\r'; break;
482 default : str2
<< '\\' << *dt
; break;
487 if (m_Resource
->GetUseLocale())
488 return wxGetTranslation(str2
);
495 long wxXmlResourceHandler::GetLong(const wxString
& param
, long defaultv
)
498 wxString str1
= GetParamValue(param
);
500 if (!str1
.ToLong(&value
))
507 int wxXmlResourceHandler::GetID()
509 wxString sid
= GetName();
512 if (sid
== _T("-1")) return -1;
513 else if (sid
.IsNumber() && sid
.ToLong(&num
)) return num
;
514 #define stdID(id) else if (sid == _T(#id)) return id
515 stdID(wxID_OPEN
); stdID(wxID_CLOSE
); stdID(wxID_NEW
);
516 stdID(wxID_SAVE
); stdID(wxID_SAVEAS
); stdID(wxID_REVERT
);
517 stdID(wxID_EXIT
); stdID(wxID_UNDO
); stdID(wxID_REDO
);
518 stdID(wxID_HELP
); stdID(wxID_PRINT
); stdID(wxID_PRINT_SETUP
);
519 stdID(wxID_PREVIEW
); stdID(wxID_ABOUT
); stdID(wxID_HELP_CONTENTS
);
520 stdID(wxID_HELP_COMMANDS
); stdID(wxID_HELP_PROCEDURES
);
521 stdID(wxID_CUT
); stdID(wxID_COPY
); stdID(wxID_PASTE
);
522 stdID(wxID_CLEAR
); stdID(wxID_FIND
); stdID(wxID_DUPLICATE
);
523 stdID(wxID_SELECTALL
); stdID(wxID_OK
); stdID(wxID_CANCEL
);
524 stdID(wxID_APPLY
); stdID(wxID_YES
); stdID(wxID_NO
);
525 stdID(wxID_STATIC
); stdID(wxID_FORWARD
); stdID(wxID_BACKWARD
);
526 stdID(wxID_DEFAULT
); stdID(wxID_MORE
); stdID(wxID_SETUP
);
527 stdID(wxID_RESET
); stdID(wxID_HELP_CONTEXT
);
529 else return XMLID(sid
.c_str());
533 wxString
wxXmlResourceHandler::GetName()
535 return m_Node
->GetPropVal(_T("name"), _T("-1"));
540 bool wxXmlResourceHandler::GetBool(const wxString
& param
, bool defaultv
)
542 wxString v
= GetParamValue(param
);
544 if (!v
) return defaultv
;
545 else return (v
== _T("1"));
550 wxColour
wxXmlResourceHandler::GetColour(const wxString
& param
)
552 wxString v
= GetParamValue(param
);
553 unsigned long tmp
= 0;
555 if (v
.Length() != 7 || v
[0] != _T('#') ||
556 wxSscanf(v
.c_str(), _T("#%lX"), &tmp
) != 1)
558 wxLogError(_("XML resource: Incorrect colour specification '%s' for property '%s'."),
559 v
.c_str(), param
.c_str());
563 return wxColour((tmp
& 0xFF0000) >> 16 ,
564 (tmp
& 0x00FF00) >> 8,
570 wxBitmap
wxXmlResourceHandler::GetBitmap(const wxString
& param
, wxSize size
)
572 wxString name
= GetParamValue(param
);
573 if (name
.IsEmpty()) return wxNullBitmap
;
575 wxFSFile
*fsfile
= GetCurFileSystem().OpenFile(name
);
578 wxLogError(_("XML resource: Cannot create bitmap from '%s'."), param
.mb_str());
581 wxImage
img(*(fsfile
->GetStream()));
584 wxImage
img(GetParamValue(_T("bitmap")));
588 wxLogError(_("XML resource: Cannot create bitmap from '%s'."), param
.mb_str());
591 if (!(size
== wxDefaultSize
)) img
.Rescale(size
.x
, size
.y
);
592 return img
.ConvertToBitmap();
597 wxIcon
wxXmlResourceHandler::GetIcon(const wxString
& param
, wxSize size
)
599 #if wxCHECK_VERSION(2,3,0) || defined(__WXMSW__)
601 icon
.CopyFromBitmap(GetBitmap(param
, size
));
604 wxBitmap bmppt
= GetBitmap(param
, size
);
605 iconpt
= (wxIcon
*)(&bmppt
);
606 wxIcon
icon(*iconpt
);
613 wxXmlNode
*wxXmlResourceHandler::GetParamNode(const wxString
& param
)
615 wxXmlNode
*n
= m_Node
->GetChildren();
619 if (n
->GetType() == wxXML_ELEMENT_NODE
&& n
->GetName() == param
)
627 wxString
wxXmlResourceHandler::GetNodeContent(wxXmlNode
*node
)
630 if (n
== NULL
) return wxEmptyString
;
631 n
= n
->GetChildren();
635 if (n
->GetType() == wxXML_TEXT_NODE
||
636 n
->GetType() == wxXML_CDATA_SECTION_NODE
)
637 return n
->GetContent();
640 return wxEmptyString
;
645 wxString
wxXmlResourceHandler::GetParamValue(const wxString
& param
)
648 return GetNodeContent(m_Node
);
650 return GetNodeContent(GetParamNode(param
));
655 wxSize
wxXmlResourceHandler::GetSize(const wxString
& param
)
657 wxString s
= GetParamValue(param
);
658 if (s
.IsEmpty()) s
= _T("-1,-1");
662 is_dlg
= s
[s
.Length()-1] == _T('d');
663 if (is_dlg
) s
.RemoveLast();
665 if (!s
.BeforeFirst(_T(',')).ToLong(&sx
) ||
666 !s
.AfterLast(_T(',')).ToLong(&sy
))
668 wxLogError(_("Cannot parse coordinates from '%s'."), s
.mb_str());
669 return wxDefaultSize
;
674 if (m_InstanceAsWindow
)
675 return wxDLG_UNIT(m_InstanceAsWindow
, wxSize(sx
, sy
));
676 else if (m_ParentAsWindow
)
677 return wxDLG_UNIT(m_ParentAsWindow
, wxSize(sx
, sy
));
680 wxLogError(_("Cannot convert dialog units: dialog unknown."));
681 return wxDefaultSize
;
684 else return wxSize(sx
, sy
);
689 wxPoint
wxXmlResourceHandler::GetPosition(const wxString
& param
)
691 wxSize sz
= GetSize(param
);
692 return wxPoint(sz
.x
, sz
.y
);
697 wxCoord
wxXmlResourceHandler::GetDimension(const wxString
& param
, wxCoord defaultv
)
699 wxString s
= GetParamValue(param
);
700 if (s
.IsEmpty()) return defaultv
;
704 is_dlg
= s
[s
.Length()-1] == _T('d');
705 if (is_dlg
) s
.RemoveLast();
709 wxLogError(_("Cannot parse dimension from '%s'."), s
.mb_str());
715 if (m_InstanceAsWindow
)
716 return wxDLG_UNIT(m_InstanceAsWindow
, wxSize(sx
, 0)).x
;
717 else if (m_ParentAsWindow
)
718 return wxDLG_UNIT(m_ParentAsWindow
, wxSize(sx
, 0)).x
;
721 wxLogError(_("Cannot convert dialog units: dialog unknown."));
730 wxFont
wxXmlResourceHandler::GetFont(const wxString
& param
)
732 wxXmlNode
*font_node
= GetParamNode(param
);
733 if (font_node
== NULL
)
735 wxLogError("Cannot find font node '%s'.", param
.mb_str());
739 wxXmlNode
*oldnode
= m_Node
;
742 long size
= GetLong(_("size"), 12);
744 wxString style
= GetParamValue(_("style"));
745 wxString weight
= GetParamValue(_("weight"));
746 int istyle
= wxNORMAL
, iweight
= wxNORMAL
;
747 if (style
== _("italic")) istyle
= wxITALIC
;
748 else if (style
== _("slant")) istyle
= wxSLANT
;
749 if (weight
== _("bold")) iweight
= wxBOLD
;
750 else if (weight
== _("light")) iweight
= wxLIGHT
;
752 bool underlined
= GetBool(_("underlined"), FALSE
);
754 wxString encoding
= GetParamValue(_("encoding"));
755 // FIXME - handle encoding
757 wxString faces
= GetParamValue(_("face"));
758 wxString facename
= wxEmptyString
;
759 wxFontEnumerator enu
;
760 enu
.EnumerateFacenames();
761 wxStringTokenizer
tk(faces
, ",");
762 while (tk
.HasMoreTokens())
764 int index
= enu
.GetFacenames()->Index(tk
.GetNextToken(), FALSE
);
765 if (index
!= wxNOT_FOUND
)
767 facename
= (*enu
.GetFacenames())[index
];
774 wxFont
font(size
, wxDEFAULT
, istyle
, iweight
, underlined
,
775 facename
, wxFONTENCODING_DEFAULT
);
780 void wxXmlResourceHandler::SetupWindow(wxWindow
*wnd
)
784 if (HasParam(_T("exstyle")))
785 wnd
->SetExtraStyle(GetStyle(_T("exstyle")));
786 if (HasParam(_T("bg")))
787 wnd
->SetBackgroundColour(GetColour(_T("bg")));
788 if (HasParam(_T("fg")))
789 wnd
->SetForegroundColour(GetColour(_T("fg")));
790 if (GetBool(_T("enabled"), 1) == 0)
792 if (GetBool(_T("focused"), 0) == 1)
794 if (GetBool(_T("hidden"), 0) == 1)
797 if (HasParam(_T("tooltip")))
798 wnd
->SetToolTip(GetText(_T("tooltip")));
800 if (HasParam(_T("font")))
801 wnd
->SetFont(GetFont());
805 void wxXmlResourceHandler::CreateChildren(wxObject
*parent
,
806 bool only_this_handler
, wxXmlNode
*children_node
)
808 if (children_node
== NULL
) children_node
= GetParamNode(_T("children"));
809 if (children_node
== NULL
) return;
811 wxXmlNode
*n
= children_node
->GetChildren();
815 if (n
->GetType() == wxXML_ELEMENT_NODE
)
817 if (only_this_handler
)
820 CreateResource(n
, parent
, NULL
);
823 m_Resource
->CreateResFromNode(n
, parent
, NULL
);
837 // --------------- XMLID implementation -----------------------------
839 #define XMLID_TABLE_SIZE 1024
849 static XMLID_record
*XMLID_Records
[XMLID_TABLE_SIZE
] = {NULL
};
850 static int XMLID_LastID
= wxID_HIGHEST
;
852 /*static*/ int wxXmlResource::GetXMLID(const char *str_id
)
856 for (const char *c
= str_id
; *c
!= '\0'; c
++) index
+= (int)*c
;
857 index
%= XMLID_TABLE_SIZE
;
859 XMLID_record
*oldrec
= NULL
;
861 for (XMLID_record
*rec
= XMLID_Records
[index
]; rec
; rec
= rec
->next
)
863 if (strcmp(rec
->key
, str_id
) == 0)
871 XMLID_record
**rec_var
= (oldrec
== NULL
) ?
872 &XMLID_Records
[index
] : &oldrec
->next
;
873 *rec_var
= new XMLID_record
;
874 (*rec_var
)->id
= ++XMLID_LastID
;
875 (*rec_var
)->key
= strdup(str_id
);
876 (*rec_var
)->next
= NULL
;
878 return (*rec_var
)->id
;
882 static void CleanXMLID_Record(XMLID_record
*rec
)
886 CleanXMLID_Record(rec
->next
);
892 static void CleanXMLID_Records()
894 for (int i
= 0; i
< XMLID_TABLE_SIZE
; i
++)
895 CleanXMLID_Record(XMLID_Records
[i
]);
905 // --------------- module and globals -----------------------------
908 static wxXmlResource gs_XmlResource
;
910 wxXmlResource
*wxTheXmlResource
= &gs_XmlResource
;
913 class wxXmlResourceModule
: public wxModule
915 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule
)
917 wxXmlResourceModule() {}
918 bool OnInit() {return TRUE
;}
921 wxTheXmlResource
->ClearHandlers();
922 CleanXMLID_Records();
926 IMPLEMENT_DYNAMIC_CLASS(wxXmlResourceModule
, wxModule
)