utils/wxrc/wxrc.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wxrc.cpp
   3 // Purpose:     XML resource compiler
   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
  13     #pragma interface
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx/wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20     #pragma hdrstop
  21 #endif
  22
  23 // for all others, include the necessary headers (this file is usually all you
  24 // need because it includes almost all "standard" wxWindows headers
  25 #ifndef WX_PRECOMP
  26     #include "wx/wx.h"
  27 #endif
  28
  29 #include "wx/cmdline.h"
  30 #include "wx/xrc/xml.h"
  31 #include "wx/ffile.h"
  32 #include "wx/wfstream.h"
  33
  34
  35
  36
  37
  38 /*
  39 #if wxUSE_GUI
  40 #error "You must compile the resource compiler with wxBase!"
  41 #endif
  42 */
  43
  44 class XmlResApp : public wxApp
  45 {
  46 public:
  47
  48 #if wxUSE_GUI
  49     bool OnInit();
  50 #else
  51     virtual int OnRun();
  52 #endif
  53
  54 private:
  55
  56     void ParseParams(const wxCmdLineParser& cmdline);
  57     void CompileRes();
  58     wxArrayString PrepareTempFiles();
  59     void FindFilesInXML(wxXmlNode *node, wxArrayString& flist, const wxString& inputPath);
  60
  61     void DeleteTempFiles(const wxArrayString& flist);
  62     void MakePackageZIP(const wxArrayString& flist);
  63     void MakePackageCPP(const wxArrayString& flist);
  64
  65     void OutputGettext();
  66     wxArrayString FindStrings();
  67     wxArrayString FindStrings(wxXmlNode *node);
  68
  69     bool flagVerbose, flagCPP, flagGettext;
  70     wxString parOutput, parFuncname, parOutputPath;
  71     wxArrayString parFiles;
  72     int retCode;
  73 };
  74
  75 IMPLEMENT_APP(XmlResApp)
  76
  77 #if wxUSE_GUI
  78 bool XmlResApp::OnInit()
  79 #else
  80 int XmlResApp::OnRun()
  81 #endif
  82 {
  83     static const wxCmdLineEntryDesc cmdLineDesc[] =
  84     {
  85         { wxCMD_LINE_SWITCH, "h", "help",  "show help message" },
  86         { wxCMD_LINE_SWITCH, "v", "verbose", "be verbose" },
  87         { wxCMD_LINE_SWITCH, "c", "cpp-code",  "output C++ source rather than .rsc file" },
  88         { wxCMD_LINE_SWITCH, "g", "gettext",  "output list of translatable strings (to stdout or file if -o used)" },
  89         { wxCMD_LINE_OPTION, "n", "function",  "C++ function name (with -c) [InitXmlResource]" },
  90         { wxCMD_LINE_OPTION, "o", "output",  "output file [resource.xrs/cpp]" },
  91         { wxCMD_LINE_OPTION, "l", "list-of-handlers",  "output list of neccessary handlers to this file" },
  92
  93         { wxCMD_LINE_PARAM,  NULL, NULL, "input file(s)",
  94             wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_MULTIPLE },
  95
  96         { wxCMD_LINE_NONE }
  97     };
  98
  99 #if wxUSE_GUI
 100     // VS: I need reasonable output to console from wxCmdLineParser
 101     wxLog::SetTimestamp(NULL);
 102     delete wxLog::SetActiveTarget(new wxLogStderr);
 103 #endif
 104
 105     wxCmdLineParser parser(cmdLineDesc, argc, argv);
 106
 107     switch (parser.Parse())
 108     {
 109         case -1:
 110             return 0;
 111             break;
 112
 113         case 0:
 114             retCode = 0;
 115             ParseParams(parser);
 116             if (flagGettext)
 117                 OutputGettext();
 118             else
 119                 CompileRes();
 120 #if wxUSE_GUI
 121             return FALSE;
 122 #else
 123             return retCode;
 124 #endif
 125             break;
 126
 127         default:
 128 #if wxUSE_GUI
 129             return FALSE;
 130 #else
 131             return 1;
 132 #endif
 133             break;
 134     }
 135 }
 136
 137
 138
 139
 140 void XmlResApp::ParseParams(const wxCmdLineParser& cmdline)
 141 {
 142     flagGettext = cmdline.Found("g");
 143     flagVerbose = cmdline.Found("v");
 144     flagCPP = cmdline.Found("c");
 145
 146     if (!cmdline.Found("o", &parOutput))
 147     {
 148         if (flagGettext)
 149             parOutput = wxEmptyString;
 150         else
 151             parOutput = flagCPP ? "resource.cpp" : "resource.xrs";
 152     }
 153     parOutputPath = wxPathOnly(parOutput);
 154     if (!parOutputPath) parOutputPath = ".";
 155
 156     if (!cmdline.Found("n", &parFuncname))
 157         parFuncname = "InitXmlResource";
 158
 159     for (size_t i = 0; i < cmdline.GetParamCount(); i++)
 160         parFiles.Add(cmdline.GetParam(i));
 161 }
 162
 163
 164
 165
 166 void XmlResApp::CompileRes()
 167 {
 168     wxArrayString files = PrepareTempFiles();
 169
 170     wxRemoveFile(parOutput);
 171
 172     if (!retCode)
 173     {
 174         if (flagCPP)
 175             MakePackageCPP(files);
 176         else
 177             MakePackageZIP(files);
 178     }
 179
 180     DeleteTempFiles(files);
 181 }
 182
 183
 184
 185 wxArrayString XmlResApp::PrepareTempFiles()
 186 {
 187     wxArrayString flist;
 188
 189     for (size_t i = 0; i < parFiles.Count(); i++)
 190     {
 191         if (flagVerbose)
 192             wxPrintf("processing " + parFiles[i] +  "...\n");
 193
 194         wxXmlDocument doc;
 195
 196         if (!doc.Load(parFiles[i]))
 197         {
 198             wxLogError("Error parsing file " + parFiles[i]);
 199             retCode = 1;
 200             continue;
 201         }
 202
 203         wxString name, ext, path;
 204         wxSplitPath(parFiles[i], &path, &name, &ext);
 205
 206         FindFilesInXML(doc.GetRoot(), flist, path);
 207
 208         doc.Save(parOutputPath + "/" + name + ".xrc");
 209         flist.Add(name + ".xrc");
 210     }
 211
 212     return flist;
 213 }
 214
 215
 216
 217 // find all files mentioned in structure, e.g. <bitmap>filename</bitmap>
 218 void XmlResApp::FindFilesInXML(wxXmlNode *node, wxArrayString& flist, const wxString& inputPath)
 219 {
 220     wxXmlNode *n = node;
 221     if (n == NULL) return;
 222     n = n->GetChildren();
 223
 224     while (n)
 225     {
 226         if ((node->GetType() == wxXML_ELEMENT_NODE) &&
 227             // parent is an element, i.e. has subnodes...
 228             (n->GetType() == wxXML_TEXT_NODE ||
 229             n->GetType() == wxXML_CDATA_SECTION_NODE) &&
 230             // ...it is textnode...
 231             ((node/*not n!*/->GetName() == "bitmap") ||
 232              (node/*not n!*/->GetName() == "url")))
 233             // ...and known to contain filename
 234         {
 235             wxString fullname;
 236             wxString filename = n->GetContent();
 237             if (wxIsAbsolutePath(n->GetContent())) fullname = n->GetContent();
 238             else fullname = inputPath + "/" + n->GetContent();
 239
 240             filename.Replace("/", "_");
 241             filename.Replace("\\", "_");
 242             filename.Replace("*", "_");
 243             filename.Replace("?", "_");
 244             n->SetContent(filename);
 245
 246             if (flagVerbose)
 247                 wxPrintf("adding " + filename +  "...\n");
 248
 249             flist.Add(filename);
 250
 251             wxFileInputStream sin(fullname);
 252             wxFileOutputStream sout(parOutputPath + "/" + filename);
 253             sin.Read(sout); // copy the stream
 254         }
 255
 256         // subnodes:
 257         if (n->GetType() == wxXML_ELEMENT_NODE)
 258             FindFilesInXML(n, flist, inputPath);
 259
 260         n = n->GetNext();
 261     }
 262 }
 263
 264
 265
 266 void XmlResApp::DeleteTempFiles(const wxArrayString& flist)
 267 {
 268     for (size_t i = 0; i < flist.Count(); i++)
 269         wxRemoveFile(parOutputPath + "/" + flist[i]);
 270 }
 271
 272
 273
 274 void XmlResApp::MakePackageZIP(const wxArrayString& flist)
 275 {
 276     wxString files;
 277
 278     for (size_t i = 0; i < flist.Count(); i++)
 279         files += flist[i] + " ";
 280     files.RemoveLast();
 281
 282     if (flagVerbose)
 283         wxPrintf("compressing " + parOutput +  "...\n");
 284
 285     if (wxExecute("zip -9 -j " + wxString(flagVerbose ? "" : "-q ") +
 286                   parOutput + " " + files, TRUE) == -1)
 287     {
 288         wxLogError("Unable to execute zip program. Make sure it is in the path.");
 289         wxLogError("You can download it at http://www.cdrom.com/pub/infozip/");
 290         retCode = 1;
 291         return;
 292     }
 293 }
 294
 295
 296
 297
 298 static wxString FileToCppArray(wxString filename, int num)
 299 {
 300     wxString output;
 301     wxString tmp;
 302     wxString snum;
 303     wxFFile file(filename, "rb");
 304     size_t lng = file.Length();
 305
 306     snum.Printf("%i", num);
 307     output.Printf("static size_t xml_res_size_" + snum + " = %i;\n", lng);
 308     output += "static unsigned char xml_res_file_" + snum + "[] = {\n";
 309     // we cannot use string literals because MSVC is dumb wannabe compiler
 310     // with arbitrary limitation to 2048 strings :(
 311
 312     unsigned char *buffer = new unsigned char[lng];
 313     file.Read(buffer, lng);
 314
 315     for (size_t i = 0, linelng = 0; i < lng; i++)
 316     {
 317         tmp.Printf("%i", buffer[i]);
 318         if (i != 0) output << ',';
 319         if (linelng > 70)
 320         {
 321             linelng = 0;
 322             output << "\n";
 323         }
 324         output << tmp;
 325         linelng += tmp.Length()+1;
 326     }
 327
 328     delete[] buffer;
 329
 330     output += "};\n\n";
 331
 332     return output;
 333 }
 334
 335
 336 void XmlResApp::MakePackageCPP(const wxArrayString& flist)
 337 {
 338     wxFFile file(parOutput, "wt");
 339     size_t i;
 340
 341     if (flagVerbose)
 342         wxPrintf("creating C++ source file " + parOutput +  "...\n");
 343
 344     file.Write("\
 345 #include \"wx/wxprec.h\"\n\
 346 \n\
 347 #ifdef __BORLANDC__\n\
 348     #pragma hdrstop\n\
 349 #endif\n\
 350 \n\
 351 #ifndef WX_PRECOMP\n\
 352     #include \"wx/wx.h\"\n\
 353 #endif\n\
 354 \
 355 #include \"wx/filesys.h\"\n\
 356 #include \"wx/fs_mem.h\"\n\
 357 #include \"wx/xrc/xmlres.h\"\n\
 358 #include \"wx/xrc/xh_all.h\"\n\
 359 \n");
 360
 361     for (i = 0; i < flist.Count(); i++)
 362         file.Write(FileToCppArray(flist[i], i));
 363
 364     file.Write("\
 365 void " + parFuncname + "()\n\
 366 {\n\
 367 \n\
 368     // Check for memory FS. If not present, load the handler:\n\
 369     {\n\
 370         wxMemoryFSHandler::AddFile(\"xml_resource/dummy_file\", \"dummy one\");\n\
 371         wxFileSystem fsys;\n\
 372         wxFSFile *f = fsys.OpenFile(\"memory:xml_resource/dummy_file\");\n\
 373         wxMemoryFSHandler::RemoveFile(\"xml_resource/dummy_file\");\n\
 374         if (f) delete f;\n\
 375         else wxFileSystem::AddHandler(new wxMemoryFSHandler);\n\
 376     }\n\
 377 \n");
 378
 379     for (i = 0; i < flist.Count(); i++)
 380     {
 381         wxString s;
 382         s.Printf("    wxMemoryFSHandler::AddFile(\"xml_resource/" + flist[i] +
 383                  "\", xml_res_file_%i, xml_res_size_%i);\n", i, i);
 384         file.Write(s);
 385     }
 386
 387     for (i = 0; i < parFiles.Count(); i++)
 388     {
 389         wxString name, ext, path;
 390         wxSplitPath(parFiles[i], &path, &name, &ext);
 391         file.Write("    wxXmlResource::Get()->Load(\"memory:xml_resource/" +
 392                    name + ".xrc" + "\");\n");
 393     }
 394
 395     file.Write("}\n");
 396
 397
 398 }
 399
 400
 401
 402 void XmlResApp::OutputGettext()
 403 {
 404     wxArrayString str = FindStrings();
 405
 406     wxFFile fout;
 407     if (!parOutput) fout.Attach(stdout);
 408     else fout.Open(parOutput, _T("wt"));
 409
 410     for (size_t i = 0; i < str.GetCount(); i++)
 411         fout.Write(_T("_(\"") + str[i] + _T("\")\n"));
 412
 413     if (!parOutput) fout.Detach();
 414 }
 415
 416
 417
 418 wxArrayString XmlResApp::FindStrings()
 419 {
 420     wxArrayString arr, a2;
 421
 422     for (size_t i = 0; i < parFiles.Count(); i++)
 423     {
 424         if (flagVerbose)
 425             wxPrintf("processing " + parFiles[i] +  "...\n");
 426
 427         wxXmlDocument doc;
 428         if (!doc.Load(parFiles[i]))
 429         {
 430             wxLogError("Error parsing file " + parFiles[i]);
 431             retCode = 1;
 432             continue;
 433         }
 434         a2 = FindStrings(doc.GetRoot());
 435         WX_APPEND_ARRAY(arr, a2);
 436     }
 437
 438     return arr;
 439 }
 440
 441
 442
 443 static wxString ConvertText(const wxString& str)
 444 {
 445     wxString str2;
 446     const wxChar *dt;
 447
 448     for (dt = str.c_str(); *dt; dt++)
 449     {
 450         if (*dt == wxT('_'))
 451         {
 452             if ( *(++dt) == wxT('_') )
 453                 str2 << wxT('_');
 454             else
 455                 str2 << wxT('&') << *dt;
 456         }
 457         else
 458         {
 459             switch (*dt)
 460             {
 461                 case wxT('\n') : str2 << wxT("\\n"); break;
 462                 case wxT('\t') : str2 << wxT("\\t"); break;
 463                 case wxT('\r') : str2 << wxT("\\r"); break;
 464                 default        : str2 << *dt; break;
 465             }
 466         }
 467     }
 468
 469     return str2;
 470 }
 471
 472
 473 wxArrayString XmlResApp::FindStrings(wxXmlNode *node)
 474 {
 475     wxArrayString arr;
 476
 477     wxXmlNode *n = node;
 478     if (n == NULL) return arr;
 479     n = n->GetChildren();
 480
 481     while (n)
 482     {
 483         if ((node->GetType() == wxXML_ELEMENT_NODE) &&
 484             // parent is an element, i.e. has subnodes...
 485             (n->GetType() == wxXML_TEXT_NODE ||
 486             n->GetType() == wxXML_CDATA_SECTION_NODE) &&
 487             // ...it is textnode...
 488             (
 489                 node/*not n!*/->GetName() == _T("label") ||
 490                 (node/*not n!*/->GetName() == _T("value") &&
 491                                !n->GetContent().IsNumber()) ||
 492                 node/*not n!*/->GetName() == _T("help") ||
 493                 node/*not n!*/->GetName() == _T("longhelp") ||
 494                 node/*not n!*/->GetName() == _T("tooltip") ||
 495                 node/*not n!*/->GetName() == _T("htmlcode") ||
 496                 node/*not n!*/->GetName() == _T("title")
 497             ))
 498             // ...and known to contain translatable string
 499         {
 500             arr.Add(ConvertText(n->GetContent()));
 501         }
 502
 503         // subnodes:
 504         if (n->GetType() == wxXML_ELEMENT_NODE)
 505         {
 506             wxArrayString a2 = FindStrings(n);
 507             WX_APPEND_ARRAY(arr, a2);
 508         }
 509
 510         n = n->GetNext();
 511     }
 512     return arr;
 513 }