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/module.h"
31 #include "wx/xml/xml.h"
32 #include "wx/xml/xmlres.h"
34 #include "wx/arrimpl.cpp"
35 WX_DEFINE_OBJARRAY(wxXmlResourceDataRecords
);
38 wxXmlResource::wxXmlResource()
40 m_Handlers
.DeleteContents(TRUE
);
43 wxXmlResource::wxXmlResource(const wxString
& filemask
)
45 m_Handlers
.DeleteContents(TRUE
);
49 wxXmlResource::~wxXmlResource()
55 bool wxXmlResource::Load(const wxString
& filemask
)
58 wxXmlResourceDataRecord
*drec
;
59 bool iswild
= wxIsWild(filemask
);
63 # define wxXmlFindFirst fsys.FindFirst(filemask, wxFILE)
64 # define wxXmlFindNext fsys.FindNext()
66 # define wxXmlFindFirst wxFindFirstFile(filemask, wxFILE)
67 # define wxXmlFindNext wxFindNextFile()
76 if (filemask
.Lower().Matches("*.zip") ||
77 filemask
.Lower().Matches("*.rsc"))
82 fnd2
= fs2
.FindFirst(fnd
+ wxT("#zip:*.xmb"), wxFILE
);
85 drec
= new wxXmlResourceDataRecord
;
88 fnd2
= fs2
.FindNext();
94 drec
= new wxXmlResourceDataRecord
;
104 # undef wxXmlFindFirst
105 # undef wxXmlFindNext
111 void wxXmlResource::AddHandler(wxXmlResourceHandler
*handler
)
113 m_Handlers
.Append(handler
);
114 handler
->SetParentResource(this);
119 void wxXmlResource::ClearHandlers()
126 wxMenu
*wxXmlResource::LoadMenu(const wxString
& name
)
128 return (wxMenu
*)CreateResFromNode(FindResource(name
, wxT("menu")), NULL
, NULL
);
133 wxMenuBar
*wxXmlResource::LoadMenuBar(const wxString
& name
)
135 return (wxMenuBar
*)CreateResFromNode(FindResource(name
, wxT("menubar")), NULL
, NULL
);
140 wxDialog
*wxXmlResource::LoadDialog(wxWindow
*parent
, const wxString
& name
)
142 wxDialog
*dialog
= new wxDialog
;
143 if (!LoadDialog(dialog
, parent
, name
))
144 { delete dialog
; return NULL
; }
148 bool wxXmlResource::LoadDialog(wxDialog
*dlg
, wxWindow
*parent
, const wxString
& name
)
150 return CreateResFromNode(FindResource(name
, wxT("dialog")), parent
, dlg
) != NULL
;
155 wxPanel
*wxXmlResource::LoadPanel(wxWindow
*parent
, const wxString
& name
)
157 wxPanel
*panel
= new wxPanel
;
158 if (!LoadPanel(panel
, parent
, name
))
159 { delete panel
; return NULL
; }
163 bool wxXmlResource::LoadPanel(wxPanel
*panel
, wxWindow
*parent
, const wxString
& name
)
165 return CreateResFromNode(FindResource(name
, wxT("panel")), parent
, panel
) != NULL
;
170 void wxXmlResource::ProcessPlatformProperty(wxXmlNode
*node
)
175 wxXmlNode
*c
= node
->GetChildren();
179 if (!c
->GetPropVal(_T("platform"), &s
))
183 wxStringTokenizer
tkn(s
, " |");
185 while (tkn
.HasMoreTokens())
187 s
= tkn
.GetNextToken();
190 s
== wxString(_T("win"))
191 #elif defined(__UNIX__)
192 s
== wxString(_T("unix"))
193 #elif defined(__MAC__)
194 s
== wxString(_T("mac"))
195 #elif defined(__OS2__)
196 s
== wxString(_T("os2"))
205 ProcessPlatformProperty(c
);
208 node
->RemoveChild(c
);
218 void wxXmlResource::UpdateResources()
221 # if wxUSE_FILESYSTEM
226 for (size_t i
= 0; i
< m_Data
.GetCount(); i
++)
228 modif
= (m_Data
[i
].Doc
== NULL
);
232 # if wxUSE_FILESYSTEM
233 file
= fsys
.OpenFile(m_Data
[i
].File
);
234 modif
= file
&& file
->GetModificationTime() > m_Data
[i
].Time
;
236 wxLogError(_("Cannot open file '%s'."), m_Data
[i
].File
.c_str());
239 modif
= wxDateTime(wxFileModificationTime(m_Data
[i
].File
)) > m_Data
[i
].Time
;
245 wxInputStream
*stream
;
247 # if wxUSE_FILESYSTEM
248 file
= fsys
.OpenFile(m_Data
[i
].File
);
249 stream
= file
->GetStream();
251 stream
= new wxFileInputStream(m_Data
[i
].File
);
256 delete m_Data
[i
].Doc
;
257 m_Data
[i
].Doc
= new wxXmlDocument
;
259 if (!stream
|| !m_Data
[i
].Doc
->Load(*stream
))
261 wxLogError(_("Cannot load resources from file '%s'."), m_Data
[i
].File
.c_str());
262 delete m_Data
[i
].Doc
;
263 m_Data
[i
].Doc
= NULL
;
265 else if (m_Data
[i
].Doc
->GetRoot()->GetName() != _T("resource"))
267 wxLogError(_("Invalid XML resource '%s': doesn't have root node 'resource'."), m_Data
[i
].File
.c_str());
268 delete m_Data
[i
].Doc
;
269 m_Data
[i
].Doc
= NULL
;
272 ProcessPlatformProperty(m_Data
[i
].Doc
->GetRoot());
274 # if wxUSE_FILESYSTEM
285 wxXmlNode
*wxXmlResource::FindResource(const wxString
& name
, const wxString
& type
)
287 UpdateResources(); //ensure everything is up-to-date
290 for (size_t f
= 0; f
< m_Data
.GetCount(); f
++)
292 if (m_Data
[f
].Doc
== NULL
|| m_Data
[f
].Doc
->GetRoot() == NULL
) continue;
293 for (wxXmlNode
*node
= m_Data
[f
].Doc
->GetRoot()->GetChildren();
294 node
; node
= node
->GetNext())
295 if ( node
->GetType() == wxXML_ELEMENT_NODE
&&
296 (!type
|| node
->GetName() == type
) &&
297 node
->GetPropVal(wxT("name"), &dummy
) &&
302 wxLogError(_("XML resource '%s' (type '%s') not found!"),
303 name
.c_str(), type
.c_str());
309 wxObject
*wxXmlResource::CreateResFromNode(wxXmlNode
*node
, wxObject
*parent
, wxObject
*instance
)
311 if (node
== NULL
) return NULL
;
313 wxXmlResourceHandler
*handler
;
315 wxNode
* ND
= m_Handlers
.GetFirst();
318 handler
= (wxXmlResourceHandler
*)ND
->GetData();
319 if (handler
->CanHandle(node
))
321 ret
= handler
->CreateResource(node
, parent
, instance
);
327 wxLogError(_("No handler found for XML node '%s'!"), node
->GetName().c_str());
339 wxXmlResourceHandler::wxXmlResourceHandler()
340 : m_Node(NULL
), m_Parent(NULL
), m_Instance(NULL
),
341 m_ParentAsWindow(NULL
), m_InstanceAsWindow(NULL
)
346 wxObject
*wxXmlResourceHandler::CreateResource(wxXmlNode
*node
, wxObject
*parent
, wxObject
*instance
)
348 wxXmlNode
*myNode
= m_Node
;
349 wxObject
*myParent
= m_Parent
, *myInstance
= m_Instance
;
350 wxWindow
*myParentAW
= m_ParentAsWindow
, *myInstanceAW
= m_InstanceAsWindow
;
354 m_Instance
= instance
;
355 m_ParentAsWindow
= wxDynamicCast(m_Parent
, wxWindow
);
356 m_InstanceAsWindow
= wxDynamicCast(m_Instance
, wxWindow
);
358 wxObject
*returned
= DoCreateResource();
361 m_Parent
= myParent
; m_ParentAsWindow
= myParentAW
;
362 m_Instance
= myInstance
; m_InstanceAsWindow
= myInstanceAW
;
368 void wxXmlResourceHandler::AddStyle(const wxString
& name
, int value
)
370 m_StyleNames
.Add(name
);
371 m_StyleValues
.Add(value
);
375 bool wxXmlResourceHandler::HasParam(const wxString
& param
)
377 return (GetParamNode(param
) != NULL
);
381 int wxXmlResourceHandler::GetStyle(const wxString
& param
, int defaults
)
383 wxString s
= GetParamValue(param
);
385 if (!s
) return defaults
;
387 wxStringTokenizer
tkn(s
, _T("| "), wxTOKEN_STRTOK
);
391 while (tkn
.HasMoreTokens())
393 fl
= tkn
.GetNextToken();
394 index
= m_StyleNames
.Index(fl
);
395 if (index
!= wxNOT_FOUND
)
396 style
|= m_StyleValues
[index
];
398 wxLogError(_("Unknown style flag ") + fl
);
405 wxString
wxXmlResourceHandler::GetText(const wxString
& param
)
407 wxString str1
= GetParamValue(param
);
411 for (dt
= str1
.c_str(); *dt
; dt
++)
413 // Remap $ to &, map $$ to $ (for things like "&File..." --
414 // this is illegal in XML, so we use "$File..."):
418 case '$' : str2
<< '$'; break;
419 default : str2
<< '&' << *dt
; break;
421 // Remap \n to CR, \r LF, \t to TAB:
422 else if (*dt
== '\\')
425 case 'n' : str2
<< '\n'; break;
426 case 't' : str2
<< '\t'; break;
427 case 'r' : str2
<< '\r'; break;
428 default : str2
<< '\\' << *dt
; break;
437 long wxXmlResourceHandler::GetLong(const wxString
& param
, long defaultv
)
440 wxString str1
= GetParamValue(param
);
442 if (!str1
.ToLong(&value
))
449 int wxXmlResourceHandler::GetID()
451 wxString sid
= GetName();
454 if (sid
== _T("-1")) return -1;
455 else if (sid
.IsNumber() && sid
.ToLong(&num
)) return num
;
456 #define stdID(id) else if (sid == _T(#id)) return id
457 stdID(wxID_OPEN
); stdID(wxID_CLOSE
); stdID(wxID_NEW
);
458 stdID(wxID_SAVE
); stdID(wxID_SAVEAS
); stdID(wxID_REVERT
);
459 stdID(wxID_EXIT
); stdID(wxID_UNDO
); stdID(wxID_REDO
);
460 stdID(wxID_HELP
); stdID(wxID_PRINT
); stdID(wxID_PRINT_SETUP
);
461 stdID(wxID_PREVIEW
); stdID(wxID_ABOUT
); stdID(wxID_HELP_CONTENTS
);
462 stdID(wxID_HELP_COMMANDS
); stdID(wxID_HELP_PROCEDURES
);
463 stdID(wxID_CUT
); stdID(wxID_COPY
); stdID(wxID_PASTE
);
464 stdID(wxID_CLEAR
); stdID(wxID_FIND
); stdID(wxID_DUPLICATE
);
465 stdID(wxID_SELECTALL
); stdID(wxID_OK
); stdID(wxID_CANCEL
);
466 stdID(wxID_APPLY
); stdID(wxID_YES
); stdID(wxID_NO
);
467 stdID(wxID_STATIC
); stdID(wxID_FORWARD
); stdID(wxID_BACKWARD
);
468 stdID(wxID_DEFAULT
); stdID(wxID_MORE
); stdID(wxID_SETUP
);
469 stdID(wxID_RESET
); stdID(wxID_HELP_CONTEXT
);
471 else return XMLID(sid
.c_str());
475 wxString
wxXmlResourceHandler::GetName()
477 return m_Node
->GetPropVal(_T("name"), _T("-1"));
482 bool wxXmlResourceHandler::GetBool(const wxString
& param
, bool defaultv
)
484 wxString v
= GetParamValue(param
);
486 if (!v
) return defaultv
;
487 else return (v
== _T("1"));
492 wxColour
wxXmlResourceHandler::GetColour(const wxString
& param
)
494 wxString v
= GetParamValue(param
);
495 unsigned long tmp
= 0;
497 if (v
.Length() != 7 || v
[0] != _T('#') ||
498 wxSscanf(v
.c_str(), _T("#%lX"), &tmp
) != 1)
500 wxLogError(_("XML resource: Incorrect colour specification '%s' for property '%s'."),
501 v
.c_str(), param
.c_str());
505 return wxColour((tmp
& 0xFF0000) >> 16 ,
506 (tmp
& 0x00FF00) >> 8,
511 wxXmlNode
*wxXmlResourceHandler::GetParamNode(const wxString
& param
)
513 wxXmlNode
*n
= m_Node
->GetChildren();
517 if (n
->GetType() == wxXML_ELEMENT_NODE
&& n
->GetName() == param
)
525 wxString
wxXmlResourceHandler::GetNodeContent(wxXmlNode
*node
)
528 if (n
== NULL
) return wxEmptyString
;
529 n
= n
->GetChildren();
533 if (n
->GetType() == wxXML_TEXT_NODE
||
534 n
->GetType() == wxXML_CDATA_SECTION_NODE
)
535 return n
->GetContent();
538 return wxEmptyString
;
543 wxString
wxXmlResourceHandler::GetParamValue(const wxString
& param
)
545 return GetNodeContent(GetParamNode(param
));
550 wxSize
wxXmlResourceHandler::GetSize(const wxString
& param
)
552 wxString s
= GetParamValue(param
);
553 if (s
.IsEmpty()) s
= _T("-1,-1");
557 is_dlg
= s
[s
.Length()-1] == _T('d');
558 if (is_dlg
) s
.RemoveLast();
560 if (!s
.BeforeFirst(_T(',')).ToLong(&sx
) ||
561 !s
.AfterLast(_T(',')).ToLong(&sy
))
563 wxLogError(_("Cannot parse coordinates from '%s'."), s
.mb_str());
564 return wxDefaultSize
;
569 if (m_InstanceAsWindow
)
570 return wxDLG_UNIT(m_InstanceAsWindow
, wxSize(sx
, sy
));
571 else if (m_ParentAsWindow
)
572 return wxDLG_UNIT(m_ParentAsWindow
, wxSize(sx
, sy
));
575 wxLogError(_("Cannot convert dialog units: dialog unknown."));
576 return wxDefaultSize
;
579 else return wxSize(sx
, sy
);
584 wxPoint
wxXmlResourceHandler::GetPosition(const wxString
& param
)
586 wxSize sz
= GetSize(param
);
587 return wxPoint(sz
.x
, sz
.y
);
592 void wxXmlResourceHandler::SetupWindow(wxWindow
*wnd
)
594 //FIXME : add font, cursor
596 if (HasParam(_T("exstyle")))
597 wnd
->SetExtraStyle(GetStyle(_T("exstyle")));
598 if (HasParam(_T("bg")))
599 wnd
->SetBackgroundColour(GetColour(_T("bg")));
600 if (HasParam(_T("fg")))
601 wnd
->SetForegroundColour(GetColour(_T("fg")));
602 if (GetBool(_T("enabled"), 1) == 0)
604 if (GetBool(_T("focused"), 0) == 1)
606 if (GetBool(_T("hidden"), 0) == 1)
609 if (HasParam(_T("tooltip")))
610 wnd
->SetToolTip(GetText(_T("tooltip")));
615 void wxXmlResourceHandler::CreateChildren(wxObject
*parent
,
616 bool only_this_handler
, wxXmlNode
*children_node
)
618 if (children_node
== NULL
) children_node
= GetParamNode(_T("children"));
619 if (children_node
== NULL
) return;
621 wxXmlNode
*n
= children_node
->GetChildren();
625 if (n
->GetType() == wxXML_ELEMENT_NODE
)
627 if (only_this_handler
)
630 CreateResource(n
, parent
, NULL
);
633 m_Resource
->CreateResFromNode(n
, parent
, NULL
);
647 // --------------- XMLID implementation -----------------------------
650 #define XMLID_TABLE_SIZE 1024
660 static XMLID_record
*XMLID_Records
[XMLID_TABLE_SIZE
] = {NULL
};
661 static int XMLID_LastID
= wxID_HIGHEST
;
663 /*static*/ int wxXmlResource::GetXMLID(const char *str_id
)
667 for (const char *c
= str_id
; *c
!= '\0'; c
++) index
+= (int)*c
;
668 index
%= XMLID_TABLE_SIZE
;
670 XMLID_record
*oldrec
= NULL
;
672 for (XMLID_record
*rec
= XMLID_Records
[index
]; rec
; rec
= rec
->next
)
674 if (strcmp(rec
->key
, str_id
) == 0)
676 #ifdef DEBUG_XMLID_HASH
677 printf("XMLID: matched '%s' (%ith item)\n", rec
->key
, matchcnt
);
685 XMLID_record
**rec_var
= (oldrec
== NULL
) ?
686 &XMLID_Records
[index
] : &oldrec
->next
;
687 *rec_var
= new XMLID_record
;
688 (*rec_var
)->id
= ++XMLID_LastID
;
689 (*rec_var
)->key
= strdup(str_id
);
690 (*rec_var
)->next
= NULL
;
691 #ifdef DEBUG_XMLID_HASH
692 printf("XMLID: new key for '%s': %i at %i (%ith item)\n",
693 (*rec_var
)->key
, (*rec_var
)->id
, index
, matchcnt
);
696 return (*rec_var
)->id
;
700 static void CleanXMLID_Record(XMLID_record
*rec
)
704 #ifdef DEBUG_XMLID_HASH
705 printf("XMLID: clearing '%s'\n", rec
->key
);
707 CleanXMLID_Record(rec
->next
);
713 static void CleanXMLID_Records()
715 for (int i
= 0; i
< XMLID_TABLE_SIZE
; i
++)
716 CleanXMLID_Record(XMLID_Records
[i
]);
726 // --------------- module and globals -----------------------------
729 static wxXmlResource gs_XmlResource
;
731 wxXmlResource
*wxTheXmlResource
= &gs_XmlResource
;
734 class wxXmlResourceModule
: public wxModule
736 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule
)
738 wxXmlResourceModule() {}
739 bool OnInit() {return TRUE
;}
742 wxTheXmlResource
->ClearHandlers();
743 CleanXMLID_Records();
747 IMPLEMENT_DYNAMIC_CLASS(wxXmlResourceModule
, wxModule
)