///////////////////////////////////////////////////////////////////////////// // Name: wxrc.cpp // Purpose: XML resource compiler // Author: Vaclav Slavik // Created: 2000/03/05 // RCS-ID: $Id$ // Copyright: (c) 2000 Vaclav Slavik // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #if defined(__GNUG__) && !defined(__APPLE__) #pragma implementation #pragma interface #endif // For compilers that support precompilation, includes "wx/wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ #pragma hdrstop #endif // for all others, include the necessary headers (this file is usually all you // need because it includes almost all "standard" wxWindows headers #ifndef WX_PRECOMP #include "wx/wx.h" #endif #include "wx/cmdline.h" #include "wx/xrc/xml.h" #include "wx/ffile.h" #include "wx/wfstream.h" /* #if wxUSE_GUI #error "You must compile the resource compiler with wxBase!" #endif */ class XmlResApp : public wxApp { public: #if wxUSE_GUI bool OnInit(); #else virtual int OnRun(); #endif private: void ParseParams(const wxCmdLineParser& cmdline); void CompileRes(); wxArrayString PrepareTempFiles(); void FindFilesInXML(wxXmlNode *node, wxArrayString& flist, const wxString& inputPath); wxString GetInternalFileName(const wxString& name, const wxArrayString& flist); void DeleteTempFiles(const wxArrayString& flist); void MakePackageZIP(const wxArrayString& flist); void MakePackageCPP(const wxArrayString& flist); void MakePackagePython(const wxArrayString& flist); void OutputGettext(); wxArrayString FindStrings(); wxArrayString FindStrings(wxXmlNode *node); bool flagVerbose, flagCPP, flagPython, flagGettext; wxString parOutput, parFuncname, parOutputPath; wxArrayString parFiles; int retCode; }; IMPLEMENT_APP(XmlResApp) #if wxUSE_GUI bool XmlResApp::OnInit() #else int XmlResApp::OnRun() #endif { static const wxCmdLineEntryDesc cmdLineDesc[] = { { wxCMD_LINE_SWITCH, "h", "help", "show help message", wxCMD_LINE_VAL_NONE, wxCMD_LINE_OPTION_HELP }, { wxCMD_LINE_SWITCH, "v", "verbose", "be verbose" }, { wxCMD_LINE_SWITCH, "c", "cpp-code", "output C++ source rather than .rsc file" }, { wxCMD_LINE_SWITCH, "p", "python-code", "output wxPython source rather than .rsc file" }, { wxCMD_LINE_SWITCH, "g", "gettext", "output list of translatable strings (to stdout or file if -o used)" }, { wxCMD_LINE_OPTION, "n", "function", "C++/Python function name (with -c or -p) [InitXmlResource]" }, { wxCMD_LINE_OPTION, "o", "output", "output file [resource.xrs/cpp]" }, #if 0 // not yet implemented { wxCMD_LINE_OPTION, "l", "list-of-handlers", "output list of neccessary handlers to this file" }, #endif { wxCMD_LINE_PARAM, NULL, NULL, "input file(s)", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_MULTIPLE | wxCMD_LINE_OPTION_MANDATORY }, { wxCMD_LINE_NONE } }; wxCmdLineParser parser(cmdLineDesc, argc, argv); switch (parser.Parse()) { case -1: return 0; break; case 0: retCode = 0; ParseParams(parser); if (flagGettext) OutputGettext(); else CompileRes(); #if wxUSE_GUI return FALSE; #else return retCode; #endif break; default: #if wxUSE_GUI return FALSE; #else return 1; #endif break; } } void XmlResApp::ParseParams(const wxCmdLineParser& cmdline) { flagGettext = cmdline.Found("g"); flagVerbose = cmdline.Found("v"); flagCPP = cmdline.Found("c"); flagPython = cmdline.Found("p"); if (!cmdline.Found("o", &parOutput)) { if (flagGettext) parOutput = wxEmptyString; else { if (flagCPP) parOutput = "resource.cpp"; else if (flagPython) parOutput = "resource.py"; else parOutput = "resource.xrs"; } } parOutputPath = wxPathOnly(parOutput); if (!parOutputPath) parOutputPath = "."; if (!cmdline.Found("n", &parFuncname)) parFuncname = "InitXmlResource"; for (size_t i = 0; i < cmdline.GetParamCount(); i++) parFiles.Add(cmdline.GetParam(i)); } void XmlResApp::CompileRes() { wxArrayString files = PrepareTempFiles(); wxRemoveFile(parOutput); if (!retCode) { if (flagCPP) MakePackageCPP(files); else if (flagPython) MakePackagePython(files); else MakePackageZIP(files); } DeleteTempFiles(files); } wxString XmlResApp::GetInternalFileName(const wxString& name, const wxArrayString& flist) { wxString name2 = name; name2.Replace(":", "_"); name2.Replace("/", "_"); name2.Replace("\\", "_"); name2.Replace("*", "_"); name2.Replace("?", "_"); wxString s = wxFileNameFromPath(parOutput) + "$" + name2; if (wxFileExists(s) && flist.Index(s) == wxNOT_FOUND) { for (int i = 0;; i++) { s.Printf(wxFileNameFromPath(parOutput) + "$%03i-" + name2, i); if (!wxFileExists(s) || flist.Index(s) != wxNOT_FOUND) break; } } return s; } wxArrayString XmlResApp::PrepareTempFiles() { wxArrayString flist; for (size_t i = 0; i < parFiles.Count(); i++) { if (flagVerbose) wxPrintf("processing " + parFiles[i] + "...\n"); wxXmlDocument doc; if (!doc.Load(parFiles[i])) { wxLogError("Error parsing file " + parFiles[i]); retCode = 1; continue; } wxString name, ext, path; wxSplitPath(parFiles[i], &path, &name, &ext); FindFilesInXML(doc.GetRoot(), flist, path); wxString internalName = GetInternalFileName(parFiles[i], flist); doc.Save(parOutputPath + "/" + internalName); flist.Add(internalName); } return flist; } // find all files mentioned in structure, e.g. filename void XmlResApp::FindFilesInXML(wxXmlNode *node, wxArrayString& flist, const wxString& inputPath) { // Is 'node' XML node element? if (node == NULL) return; if (node->GetType() != wxXML_ELEMENT_NODE) return; // Does 'node' contain filename information at all? bool containsFilename = ( // Any bitmaps: (node->GetName() == _T("bitmap")) || // URLs in wxHtmlWindow: (node->GetName() == _T("url")) || // wxBitmapButton: (node->GetParent() != NULL && node->GetParent()->GetPropVal(_T("class"), _T("")) == _T("wxBitmapButton") && (node->GetName() == _T("focus") || node->GetName() == _T("disabled") || node->GetName() == _T("selected"))) ); wxXmlNode *n = node->GetChildren(); while (n) { if (containsFilename && (n->GetType() == wxXML_TEXT_NODE || n->GetType() == wxXML_CDATA_SECTION_NODE)) { wxString fullname; if (wxIsAbsolutePath(n->GetContent()) || inputPath == "") fullname = n->GetContent(); else fullname = inputPath + "/" + n->GetContent(); if (flagVerbose) wxPrintf("adding " + fullname + "...\n"); wxString filename = GetInternalFileName(n->GetContent(), flist); n->SetContent(filename); flist.Add(filename); wxFileInputStream sin(fullname); wxFileOutputStream sout(parOutputPath + "/" + filename); sin.Read(sout); // copy the stream } // subnodes: if (n->GetType() == wxXML_ELEMENT_NODE) FindFilesInXML(n, flist, inputPath); n = n->GetNext(); } } void XmlResApp::DeleteTempFiles(const wxArrayString& flist) { for (size_t i = 0; i < flist.Count(); i++) wxRemoveFile(parOutputPath + "/" + flist[i]); } void XmlResApp::MakePackageZIP(const wxArrayString& flist) { wxString files; for (size_t i = 0; i < flist.Count(); i++) files += flist[i] + " "; files.RemoveLast(); if (flagVerbose) wxPrintf("compressing " + parOutput + "...\n"); if (wxExecute("zip -9 -j " + wxString(flagVerbose ? "" : "-q ") + parOutput + " " + files, TRUE) == -1) { wxLogError("Unable to execute zip program. Make sure it is in the path."); wxLogError("You can download it at http://www.cdrom.com/pub/infozip/"); retCode = 1; return; } } static wxString FileToCppArray(wxString filename, int num) { wxString output; wxString tmp; wxString snum; wxFFile file(filename, "rb"); size_t lng = file.Length(); snum.Printf("%i", num); output.Printf("static size_t xml_res_size_" + snum + " = %i;\n", lng); output += "static unsigned char xml_res_file_" + snum + "[] = {\n"; // we cannot use string literals because MSVC is dumb wannabe compiler // with arbitrary limitation to 2048 strings :( unsigned char *buffer = new unsigned char[lng]; file.Read(buffer, lng); for (size_t i = 0, linelng = 0; i < lng; i++) { tmp.Printf("%i", buffer[i]); if (i != 0) output << ','; if (linelng > 70) { linelng = 0; output << "\n"; } output << tmp; linelng += tmp.Length()+1; } delete[] buffer; output += "};\n\n"; return output; } void XmlResApp::MakePackageCPP(const wxArrayString& flist) { wxFFile file(parOutput, "wt"); size_t i; if (flagVerbose) wxPrintf("creating C++ source file " + parOutput + "...\n"); file.Write("\ //\n\ // This file was automatically generated by wxrc, do not edit by hand.\n\ //\n\n\ #include \n\ \n\ #ifdef __BORLANDC__\n\ #pragma hdrstop\n\ #endif\n\ \n\ #ifndef WX_PRECOMP\n\ #include \n\ #endif\n\ \ #include \n\ #include \n\ #include \n\ #include \n\ \n"); for (i = 0; i < flist.Count(); i++) file.Write(FileToCppArray(flist[i], i)); file.Write("\ void " + parFuncname + "()\n\ {\n\ \n\ // Check for memory FS. If not present, load the handler:\n\ {\n\ wxMemoryFSHandler::AddFile(\"XRC_resource/dummy_file\", \"dummy one\");\n\ wxFileSystem fsys;\n\ wxFSFile *f = fsys.OpenFile(\"memory:XRC_resource/dummy_file\");\n\ wxMemoryFSHandler::RemoveFile(\"XRC_resource/dummy_file\");\n\ if (f) delete f;\n\ else wxFileSystem::AddHandler(new wxMemoryFSHandler);\n\ }\n\ \n"); for (i = 0; i < flist.Count(); i++) { wxString s; s.Printf(" wxMemoryFSHandler::AddFile(\"XRC_resource/" + flist[i] + "\", xml_res_file_%i, xml_res_size_%i);\n", i, i); file.Write(s); } for (i = 0; i < parFiles.Count(); i++) { file.Write(" wxXmlResource::Get()->Load(\"memory:XRC_resource/" + GetInternalFileName(parFiles[i], flist) + "\");\n"); } file.Write("}\n"); } static wxString FileToPythonArray(wxString filename, int num) { wxString output; wxString tmp; wxString snum; wxFFile file(filename, "rb"); size_t lng = file.Length(); snum.Printf("%i", num); output = " xml_res_file_" + snum + " = \"\"\"\\\n"; unsigned char *buffer = new unsigned char[lng]; file.Read(buffer, lng); for (size_t i = 0, linelng = 0; i < lng; i++) { unsigned char c = buffer[i]; if (c == '\n') { tmp = (wxChar)c; linelng = 0; } else if (c < 32 || c > 127) tmp.Printf("\\x%02x", c); else if (c == '\\') tmp = "\\\\"; else tmp = (wxChar)c; if (linelng > 70) { linelng = 0; output << "\\\n"; } output << tmp; linelng += tmp.Length(); } delete[] buffer; output += "\"\"\"\n\n"; return output; } void XmlResApp::MakePackagePython(const wxArrayString& flist) { wxFFile file(parOutput, "wt"); size_t i; if (flagVerbose) wxPrintf("creating Python source file " + parOutput + "...\n"); file.Write( "#\n" "# This file was automatically generated by wxrc, do not edit by hand.\n" "#\n\n" "from wxPython.wx import *\n" "from wxPython.xrc import *\n\n" ); file.Write("def " + parFuncname + "():\n"); for (i = 0; i < flist.Count(); i++) file.Write(FileToPythonArray(flist[i], i)); for (i = 0; i < flist.Count(); i++) { wxString s; s.Printf(" wxXmlResource_Get().LoadFromString(xml_res_file_%i)\n", i); file.Write(s); } } void XmlResApp::OutputGettext() { wxArrayString str = FindStrings(); wxFFile fout; if (!parOutput) fout.Attach(stdout); else fout.Open(parOutput, _T("wt")); for (size_t i = 0; i < str.GetCount(); i++) fout.Write(_T("_(\"") + str[i] + _T("\");\n")); if (!parOutput) fout.Detach(); } wxArrayString XmlResApp::FindStrings() { wxArrayString arr, a2; for (size_t i = 0; i < parFiles.Count(); i++) { if (flagVerbose) wxPrintf("processing " + parFiles[i] + "...\n"); wxXmlDocument doc; if (!doc.Load(parFiles[i])) { wxLogError("Error parsing file " + parFiles[i]); retCode = 1; continue; } a2 = FindStrings(doc.GetRoot()); WX_APPEND_ARRAY(arr, a2); } return arr; } static wxString ConvertText(const wxString& str) { wxString str2; const wxChar *dt; for (dt = str.c_str(); *dt; dt++) { if (*dt == wxT('_')) { if ( *(++dt) == wxT('_') ) str2 << wxT('_'); else str2 << wxT('&') << *dt; } else { switch (*dt) { case wxT('\n') : str2 << wxT("\\n"); break; case wxT('\t') : str2 << wxT("\\t"); break; case wxT('\r') : str2 << wxT("\\r"); break; case wxT('\\') : str2 << wxT("\\\\"); break; case wxT('"') : str2 << wxT("\\\""); break; default : str2 << *dt; break; } } } return str2; } wxArrayString XmlResApp::FindStrings(wxXmlNode *node) { wxArrayString arr; wxXmlNode *n = node; if (n == NULL) return arr; n = n->GetChildren(); while (n) { if ((node->GetType() == wxXML_ELEMENT_NODE) && // parent is an element, i.e. has subnodes... (n->GetType() == wxXML_TEXT_NODE || n->GetType() == wxXML_CDATA_SECTION_NODE) && // ...it is textnode... ( node/*not n!*/->GetName() == _T("label") || (node/*not n!*/->GetName() == _T("value") && !n->GetContent().IsNumber()) || node/*not n!*/->GetName() == _T("help") || node/*not n!*/->GetName() == _T("longhelp") || node/*not n!*/->GetName() == _T("tooltip") || node/*not n!*/->GetName() == _T("htmlcode") || node/*not n!*/->GetName() == _T("title") || node/*not n!*/->GetName() == _T("item") )) // ...and known to contain translatable string { arr.Add(ConvertText(n->GetContent())); } // subnodes: if (n->GetType() == wxXML_ELEMENT_NODE) { wxArrayString a2 = FindStrings(n); WX_APPEND_ARRAY(arr, a2); } n = n->GetNext(); } return arr; }