1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: XML resource compiler
4 // Author: Vaclav Slavik, Eduardo Marques <edrdo@netcabo.pt>
7 // Copyright: (c) 2000 Vaclav Slavik
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // For compilers that support precompilation, includes "wx/wx.h".
12 #include "wx/wxprec.h"
18 // for all others, include the necessary headers
24 #include "wx/cmdline.h"
25 #include "wx/xml/xml.h"
27 #include "wx/filename.h"
28 #include "wx/wfstream.h"
35 XRCWidgetData(const wxString
& vname
,const wxString
& vclass
)
36 : m_class(vclass
), m_name(vname
) {}
37 const wxString
& GetName() const { return m_name
; }
38 const wxString
& GetClass() const { return m_class
; }
44 #include "wx/arrimpl.cpp"
45 WX_DECLARE_OBJARRAY(XRCWidgetData
,ArrayOfXRCWidgetData
);
46 WX_DEFINE_OBJARRAY(ArrayOfXRCWidgetData
);
52 wxString m_parentClassName
;
53 ArrayOfXRCWidgetData m_wdata
;
55 void BrowseXmlNode(wxXmlNode
* node
)
62 if (node
->GetName() == _T("object")
63 && node
->GetPropVal(_T("class"),&classValue
)
64 && node
->GetPropVal(_T("name"),&nameValue
))
66 m_wdata
.Add(XRCWidgetData(nameValue
,classValue
));
68 children
= node
->GetChildren();
70 BrowseXmlNode(children
);
71 node
= node
->GetNext();
76 XRCWndClassData(const wxString
& className
,const wxString
& parentClassName
, const wxXmlNode
* node
) :
77 m_className(className
) , m_parentClassName(parentClassName
)
79 BrowseXmlNode(node
->GetChildren());
82 const ArrayOfXRCWidgetData
& GetWidgetData()
87 bool IsRealClass(const wxString
& name
)
89 if (name
== _T("tool") ||
90 name
== _T("unknown") ||
91 name
== _T("notebookpage") ||
92 name
== _T("separator") ||
93 name
== _T("sizeritem") ||
94 name
== _T("wxMenuItem"))
101 void GenerateHeaderCode(wxFFile
& file
)
104 file
.Write(_T("class ") + m_className
+ _T(" : public ") + m_parentClassName
105 + _T(" {\nprotected:\n"));
107 for(i
=0;i
<m_wdata
.Count();++i
)
109 const XRCWidgetData
& w
= m_wdata
.Item(i
);
110 if( !IsRealClass(w
.GetClass()) ) continue;
111 if( w
.GetName().Length() == 0 ) continue;
113 _T(" ") + w
.GetClass() + _T("* ") + w
.GetName()
116 file
.Write(_T("\nprivate:\n void InitWidgetsFromXRC(){\n")
117 _T(" wxXmlResource::Get()->LoadObject(this,NULL,_T(\"")
122 for(i
=0;i
<m_wdata
.Count();++i
)
124 const XRCWidgetData
& w
= m_wdata
.Item(i
);
125 if( !IsRealClass(w
.GetClass()) ) continue;
126 if( w
.GetName().Length() == 0 ) continue;
129 + _T(" = XRCCTRL(*this,\"")
136 file
.Write(_T(" }\n"));
144 + _T(" InitWidgetsFromXRC();\n")
150 WX_DECLARE_OBJARRAY(XRCWndClassData
,ArrayOfXRCWndClassData
);
151 WX_DEFINE_OBJARRAY(ArrayOfXRCWndClassData
);
154 class XmlResApp
: public wxAppConsole
157 // don't use builtin cmd line parsing:
158 virtual bool OnInit() { return true; }
162 void ParseParams(const wxCmdLineParser
& cmdline
);
164 wxArrayString
PrepareTempFiles();
165 void FindFilesInXML(wxXmlNode
*node
, wxArrayString
& flist
, const wxString
& inputPath
);
167 wxString
GetInternalFileName(const wxString
& name
, const wxArrayString
& flist
);
168 void DeleteTempFiles(const wxArrayString
& flist
);
169 void MakePackageZIP(const wxArrayString
& flist
);
170 void MakePackageCPP(const wxArrayString
& flist
);
171 void MakePackagePython(const wxArrayString
& flist
);
173 void OutputGettext();
174 wxArrayString
FindStrings();
175 wxArrayString
FindStrings(wxXmlNode
*node
);
177 bool flagVerbose
, flagCPP
, flagPython
, flagGettext
;
178 wxString parOutput
, parFuncname
, parOutputPath
;
179 wxArrayString parFiles
;
182 ArrayOfXRCWndClassData aXRCWndClassData
;
187 IMPLEMENT_APP_CONSOLE(XmlResApp
)
189 int XmlResApp::OnRun()
191 static const wxCmdLineEntryDesc cmdLineDesc
[] =
193 { wxCMD_LINE_SWITCH
, _T("h"), _T("help"), _T("show help message"),
194 wxCMD_LINE_VAL_NONE
, wxCMD_LINE_OPTION_HELP
},
195 { wxCMD_LINE_SWITCH
, _T("v"), _T("verbose"), _T("be verbose"), (wxCmdLineParamType
)0, 0 },
196 { wxCMD_LINE_SWITCH
, _T("e"), _T("extra-cpp-code"), _T("output C++ header file with XRC derived classes"), (wxCmdLineParamType
)0, 0 },
197 { wxCMD_LINE_SWITCH
, _T("c"), _T("cpp-code"), _T("output C++ source rather than .rsc file"), (wxCmdLineParamType
)0, 0 },
198 { wxCMD_LINE_SWITCH
, _T("p"), _T("python-code"), _T("output wxPython source rather than .rsc file"), (wxCmdLineParamType
)0, 0 },
199 { wxCMD_LINE_SWITCH
, _T("g"), _T("gettext"), _T("output list of translatable strings (to stdout or file if -o used)"), (wxCmdLineParamType
)0, 0 },
200 { wxCMD_LINE_OPTION
, _T("n"), _T("function"), _T("C++/Python function name (with -c or -p) [InitXmlResource]"), (wxCmdLineParamType
)0, 0 },
201 { wxCMD_LINE_OPTION
, _T("o"), _T("output"), _T("output file [resource.xrs/cpp]"), (wxCmdLineParamType
)0, 0 },
202 #if 0 // not yet implemented
203 { wxCMD_LINE_OPTION
, _T("l"), _T("list-of-handlers"), _T("output list of necessary handlers to this file"), (wxCmdLineParamType
)0, 0 },
205 { wxCMD_LINE_PARAM
, NULL
, NULL
, _T("input file(s)"),
206 wxCMD_LINE_VAL_STRING
,
207 wxCMD_LINE_PARAM_MULTIPLE
| wxCMD_LINE_OPTION_MANDATORY
},
209 { wxCMD_LINE_NONE
, NULL
, NULL
, NULL
, (wxCmdLineParamType
)0, 0 }
212 wxCmdLineParser
parser(cmdLineDesc
, argc
, argv
);
214 switch (parser
.Parse())
234 void XmlResApp::ParseParams(const wxCmdLineParser
& cmdline
)
236 flagGettext
= cmdline
.Found(_T("g"));
237 flagVerbose
= cmdline
.Found(_T("v"));
238 flagCPP
= cmdline
.Found(_T("c"));
239 flagPython
= cmdline
.Found(_T("p"));
240 flagH
= flagCPP
&& cmdline
.Found(_T("e"));
243 if (!cmdline
.Found(_T("o"), &parOutput
))
246 parOutput
= wxEmptyString
;
250 parOutput
= _T("resource.cpp");
252 parOutput
= _T("resource.py");
254 parOutput
= _T("resource.xrs");
257 if (!parOutput
.empty())
259 wxFileName
fn(parOutput
);
261 parOutput
= fn
.GetFullPath();
262 parOutputPath
= wxPathOnly(parOutput
);
264 if (!parOutputPath
) parOutputPath
= _T(".");
266 if (!cmdline
.Found(_T("n"), &parFuncname
))
267 parFuncname
= _T("InitXmlResource");
269 for (size_t i
= 0; i
< cmdline
.GetParamCount(); i
++)
272 wxString fn
=wxFindFirstFile(cmdline
.GetParam(i
), wxFILE
);
279 parFiles
.Add(cmdline
.GetParam(i
));
287 void XmlResApp::CompileRes()
289 wxArrayString files
= PrepareTempFiles();
291 wxRemoveFile(parOutput
);
296 MakePackageCPP(files
);
301 MakePackagePython(files
);
303 MakePackageZIP(files
);
306 DeleteTempFiles(files
);
310 wxString
XmlResApp::GetInternalFileName(const wxString
& name
, const wxArrayString
& flist
)
312 wxString name2
= name
;
313 name2
.Replace(_T(":"), _T("_"));
314 name2
.Replace(_T("/"), _T("_"));
315 name2
.Replace(_T("\\"), _T("_"));
316 name2
.Replace(_T("*"), _T("_"));
317 name2
.Replace(_T("?"), _T("_"));
319 wxString s
= wxFileNameFromPath(parOutput
) + _T("$") + name2
;
321 if (wxFileExists(s
) && flist
.Index(s
) == wxNOT_FOUND
)
323 for (int i
= 0;; i
++)
325 s
.Printf(wxFileNameFromPath(parOutput
) + _T("$%03i-") + name2
, i
);
326 if (!wxFileExists(s
) || flist
.Index(s
) != wxNOT_FOUND
)
333 wxArrayString
XmlResApp::PrepareTempFiles()
337 for (size_t i
= 0; i
< parFiles
.Count(); i
++)
340 wxPrintf(_T("processing ") + parFiles
[i
] + _T("...\n"));
344 if (!doc
.Load(parFiles
[i
]))
346 wxLogError(_T("Error parsing file ") + parFiles
[i
]);
351 wxString name
, ext
, path
;
352 wxSplitPath(parFiles
[i
], &path
, &name
, &ext
);
354 FindFilesInXML(doc
.GetRoot(), flist
, path
);
357 wxXmlNode
* node
= (doc
.GetRoot())->GetChildren();
358 wxString classValue
,nameValue
;
360 if(node
->GetName() == _T("object")
361 && node
->GetPropVal(_T("class"),&classValue
)
362 && node
->GetPropVal(_T("name"),&nameValue
)){
364 aXRCWndClassData
.Add(
365 XRCWndClassData(nameValue
,classValue
,node
)
368 node
= node
-> GetNext();
371 wxString internalName
= GetInternalFileName(parFiles
[i
], flist
);
373 doc
.Save(parOutputPath
+ wxFILE_SEP_PATH
+ internalName
);
374 flist
.Add(internalName
);
381 // Does 'node' contain filename information at all?
382 static bool NodeContainsFilename(wxXmlNode
*node
)
385 if (node
->GetName() == _T("bitmap"))
388 if (node
->GetName() == _T("icon"))
391 // URLs in wxHtmlWindow:
392 if (node
->GetName() == _T("url"))
396 wxXmlNode
*parent
= node
->GetParent();
397 if (parent
!= NULL
&&
398 parent
->GetPropVal(_T("class"), _T("")) == _T("wxBitmapButton") &&
399 (node
->GetName() == _T("focus") ||
400 node
->GetName() == _T("disabled") ||
401 node
->GetName() == _T("selected")))
404 // wxBitmap or wxIcon toplevel resources:
405 if (node
->GetName() == _T("object"))
407 wxString klass
= node
->GetPropVal(_T("class"), wxEmptyString
);
408 if (klass
== _T("wxBitmap") || klass
== _T("wxIcon"))
415 // find all files mentioned in structure, e.g. <bitmap>filename</bitmap>
416 void XmlResApp::FindFilesInXML(wxXmlNode
*node
, wxArrayString
& flist
, const wxString
& inputPath
)
418 // Is 'node' XML node element?
419 if (node
== NULL
) return;
420 if (node
->GetType() != wxXML_ELEMENT_NODE
) return;
422 bool containsFilename
= NodeContainsFilename(node
);
424 wxXmlNode
*n
= node
->GetChildren();
427 if (containsFilename
&&
428 (n
->GetType() == wxXML_TEXT_NODE
||
429 n
->GetType() == wxXML_CDATA_SECTION_NODE
))
432 if (wxIsAbsolutePath(n
->GetContent()) || inputPath
.empty())
433 fullname
= n
->GetContent();
435 fullname
= inputPath
+ wxFILE_SEP_PATH
+ n
->GetContent();
438 wxPrintf(_T("adding ") + fullname
+ _T("...\n"));
440 wxString filename
= GetInternalFileName(n
->GetContent(), flist
);
441 n
->SetContent(filename
);
443 if (flist
.Index(filename
) == wxNOT_FOUND
)
446 wxFileInputStream
sin(fullname
);
447 wxFileOutputStream
sout(parOutputPath
+ wxFILE_SEP_PATH
+ filename
);
448 sin
.Read(sout
); // copy the stream
452 if (n
->GetType() == wxXML_ELEMENT_NODE
)
453 FindFilesInXML(n
, flist
, inputPath
);
461 void XmlResApp::DeleteTempFiles(const wxArrayString
& flist
)
463 for (size_t i
= 0; i
< flist
.Count(); i
++)
464 wxRemoveFile(parOutputPath
+ wxFILE_SEP_PATH
+ flist
[i
]);
469 void XmlResApp::MakePackageZIP(const wxArrayString
& flist
)
473 for (size_t i
= 0; i
< flist
.Count(); i
++)
474 files
+= flist
[i
] + _T(" ");
478 wxPrintf(_T("compressing ") + parOutput
+ _T("...\n"));
480 wxString cwd
= wxGetCwd();
481 wxSetWorkingDirectory(parOutputPath
);
482 int execres
= wxExecute(_T("zip -9 -j ") +
483 wxString(flagVerbose
? _T("\"") : _T("-q \"")) +
484 parOutput
+ _T("\" ") + files
, true);
485 wxSetWorkingDirectory(cwd
);
488 wxLogError(_T("Unable to execute zip program. Make sure it is in the path."));
489 wxLogError(_T("You can download it at http://www.cdrom.com/pub/infozip/"));
497 static wxString
FileToCppArray(wxString filename
, int num
)
502 wxFFile
file(filename
, wxT("rb"));
503 wxFileOffset offset
= file
.Length();
504 wxASSERT_MSG( offset
>= 0 , wxT("Invalid file length") );
505 wxASSERT_MSG( offset
== wxFileOffset(size_t(offset
)) , wxT("Huge file not supported") );
506 size_t lng
= (size_t)offset
;
508 snum
.Printf(_T("%i"), num
);
509 output
.Printf(_T("static size_t xml_res_size_") + snum
+ _T(" = %i;\n"), lng
);
510 output
+= _T("static unsigned char xml_res_file_") + snum
+ _T("[] = {\n");
511 // we cannot use string literals because MSVC is dumb wannabe compiler
512 // with arbitrary limitation to 2048 strings :(
514 unsigned char *buffer
= new unsigned char[lng
];
515 file
.Read(buffer
, lng
);
517 for (size_t i
= 0, linelng
= 0; i
< lng
; i
++)
519 tmp
.Printf(_T("%i"), buffer
[i
]);
520 if (i
!= 0) output
<< _T(',');
527 linelng
+= tmp
.Length()+1;
532 output
+= _T("};\n\n");
538 void XmlResApp::MakePackageCPP(const wxArrayString
& flist
)
540 wxFFile
file(parOutput
, wxT("wt"));
544 wxPrintf(_T("creating C++ source file ") + parOutput
+ _T("...\n"));
548 _T("// This file was automatically generated by wxrc, do not edit by hand.\n")
550 _T("#include <wx/wxprec.h>\n")
552 _T("#ifdef __BORLANDC__\n")
553 _T(" #pragma hdrstop\n")
557 _T("#include <wx/filesys.h>\n")
558 _T("#include <wx/fs_mem.h>\n")
559 _T("#include <wx/xrc/xmlres.h>\n")
560 _T("#include <wx/xrc/xh_all.h>\n")
563 for (i
= 0; i
< flist
.Count(); i
++)
565 FileToCppArray(parOutputPath
+ wxFILE_SEP_PATH
+ flist
[i
], i
));
568 _T("void ") + parFuncname
+ wxT("()\n")
571 _T(" // Check for memory FS. If not present, load the handler:\n")
573 _T(" wxMemoryFSHandler::AddFile(wxT(\"XRC_resource/dummy_file\"), wxT(\"dummy one\"));\n")
574 _T(" wxFileSystem fsys;\n")
575 _T(" wxFSFile *f = fsys.OpenFile(wxT(\"memory:XRC_resource/dummy_file\"));\n")
576 _T(" wxMemoryFSHandler::RemoveFile(wxT(\"XRC_resource/dummy_file\"));\n")
577 _T(" if (f) delete f;\n")
578 _T(" else wxFileSystem::AddHandler(new wxMemoryFSHandler);\n")
582 for (i
= 0; i
< flist
.Count(); i
++)
585 s
.Printf(_T(" wxMemoryFSHandler::AddFile(wxT(\"XRC_resource/") + flist
[i
] +
586 _T("\"), xml_res_file_%i, xml_res_size_%i);\n"), i
, i
);
590 for (i
= 0; i
< parFiles
.Count(); i
++)
592 file
.Write(_T(" wxXmlResource::Get()->Load(wxT(\"memory:XRC_resource/") +
593 GetInternalFileName(parFiles
[i
], flist
) + _T("\"));\n"));
596 file
.Write(_T("}\n"));
601 void XmlResApp::GenCPPHeader()
603 wxString fileSpec
= ((parOutput
.BeforeLast('.')).AfterLast('/')).AfterLast('\\');
604 wxString heaFileName
= fileSpec
+ _T(".h");
606 wxFFile
file(heaFileName
, wxT("wt"));
609 _T("// This file was automatically generated by wxrc, do not edit by hand.\n")
611 _T("#ifndef __") + fileSpec
+ _T("_h__\n")
612 _T("#define __") + fileSpec
+ _T("_h__\n")
614 for(size_t i
=0;i
<aXRCWndClassData
.Count();++i
){
615 aXRCWndClassData
.Item(i
).GenerateHeaderCode(file
);
620 + _T("();\n#endif\n"));
623 static wxString
FileToPythonArray(wxString filename
, int num
)
628 wxFFile
file(filename
, wxT("rb"));
629 wxFileOffset offset
= file
.Length();
630 wxASSERT_MSG( offset
>= 0 , wxT("Invalid file length") );
631 wxASSERT_MSG( offset
== wxFileOffset(size_t(offset
)) , wxT("Huge file not supported") );
632 size_t lng
= (size_t)offset
;
634 snum
.Printf(_T("%i"), num
);
635 output
= _T(" xml_res_file_") + snum
+ _T(" = '''\\\n");
637 unsigned char *buffer
= new unsigned char[lng
];
638 file
.Read(buffer
, lng
);
640 for (size_t i
= 0, linelng
= 0; i
< lng
; i
++)
642 unsigned char c
= buffer
[i
];
648 else if (c
< 32 || c
> 127 || c
== '\'')
649 tmp
.Printf(_T("\\x%02x"), c
);
657 output
<< _T("\\\n");
660 linelng
+= tmp
.Length();
665 output
+= _T("'''\n\n");
671 void XmlResApp::MakePackagePython(const wxArrayString
& flist
)
673 wxFFile
file(parOutput
, wxT("wt"));
677 wxPrintf(_T("creating Python source file ") + parOutput
+ _T("...\n"));
681 _T("# This file was automatically generated by wxrc, do not edit by hand.\n")
684 _T("import wx.xrc\n\n")
688 file
.Write(_T("def ") + parFuncname
+ _T("():\n"));
690 for (i
= 0; i
< flist
.Count(); i
++)
692 FileToPythonArray(parOutputPath
+ wxFILE_SEP_PATH
+ flist
[i
], i
));
695 _T(" # check if the memory filesystem handler has been loaded yet, and load it if not\n")
696 _T(" wx.MemoryFSHandler.AddFile('XRC_resource/dummy_file', 'dummy value')\n")
697 _T(" fsys = wx.FileSystem()\n")
698 _T(" f = fsys.OpenFile('memory:XRC_resource/dummy_file')\n")
699 _T(" wx.MemoryFSHandler.RemoveFile('XRC_resource/dummy_file')\n")
700 _T(" if f is not None:\n")
703 _T(" wx.FileSystem.AddHandler(wx.MemoryFSHandler())\n")
705 _T(" # load all the strings as memory files and load into XmlRes\n")
709 for (i
= 0; i
< flist
.Count(); i
++)
712 s
.Printf(_T(" wx.MemoryFSHandler.AddFile('XRC_resource/") + flist
[i
] +
713 _T("', xml_res_file_%i)\n"), i
);
716 for (i
= 0; i
< parFiles
.Count(); i
++)
718 file
.Write(_T(" wx.xrc.XmlResource.Get().Load('memory:XRC_resource/") +
719 GetInternalFileName(parFiles
[i
], flist
) + _T("')\n"));
722 file
.Write(_T("\n"));
727 void XmlResApp::OutputGettext()
729 wxArrayString str
= FindStrings();
732 if (parOutput
.empty())
735 fout
.Open(parOutput
, wxT("wt"));
737 for (size_t i
= 0; i
< str
.GetCount(); i
++)
738 fout
.Write(_T("_(\"") + str
[i
] + _T("\");\n"));
740 if (!parOutput
) fout
.Detach();
745 wxArrayString
XmlResApp::FindStrings()
747 wxArrayString arr
, a2
;
749 for (size_t i
= 0; i
< parFiles
.Count(); i
++)
752 wxPrintf(_T("processing ") + parFiles
[i
] + _T("...\n"));
755 if (!doc
.Load(parFiles
[i
]))
757 wxLogError(_T("Error parsing file ") + parFiles
[i
]);
761 a2
= FindStrings(doc
.GetRoot());
762 WX_APPEND_ARRAY(arr
, a2
);
770 static wxString
ConvertText(const wxString
& str
)
775 for (dt
= str
.c_str(); *dt
; dt
++)
779 if ( *(++dt
) == wxT('_') )
782 str2
<< wxT('&') << *dt
;
788 case wxT('\n') : str2
<< wxT("\\n"); break;
789 case wxT('\t') : str2
<< wxT("\\t"); break;
790 case wxT('\r') : str2
<< wxT("\\r"); break;
791 case wxT('\\') : if ((*(dt
+1) != 'n') &&
798 case wxT('"') : str2
<< wxT("\\\""); break;
799 default : str2
<< *dt
; break;
808 wxArrayString
XmlResApp::FindStrings(wxXmlNode
*node
)
813 if (n
== NULL
) return arr
;
814 n
= n
->GetChildren();
818 if ((node
->GetType() == wxXML_ELEMENT_NODE
) &&
819 // parent is an element, i.e. has subnodes...
820 (n
->GetType() == wxXML_TEXT_NODE
||
821 n
->GetType() == wxXML_CDATA_SECTION_NODE
) &&
822 // ...it is textnode...
824 node
/*not n!*/->GetName() == _T("label") ||
825 (node
/*not n!*/->GetName() == _T("value") &&
826 !n
->GetContent().IsNumber()) ||
827 node
/*not n!*/->GetName() == _T("help") ||
828 node
/*not n!*/->GetName() == _T("longhelp") ||
829 node
/*not n!*/->GetName() == _T("tooltip") ||
830 node
/*not n!*/->GetName() == _T("htmlcode") ||
831 node
/*not n!*/->GetName() == _T("title") ||
832 node
/*not n!*/->GetName() == _T("item")
834 // ...and known to contain translatable string
837 node
->GetPropVal(_T("translate"), _T("1")) != _T("0"))
839 arr
.Add(ConvertText(n
->GetContent()));
844 if (n
->GetType() == wxXML_ELEMENT_NODE
)
846 wxArrayString a2
= FindStrings(n
);
847 WX_APPEND_ARRAY(arr
, a2
);