radiant/help.cpp

   1 /*
   2 Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3 For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 #include "help.h"
  23
  24 #include "debugging/debugging.h"
  25
  26 #include <vector>
  27 #include <list>
  28
  29 #include "libxml/parser.h"
  30 #include "generic/callback.h"
  31 #include "gtkutil/menu.h"
  32 #include "stream/stringstream.h"
  33 #include "os/file.h"
  34
  35 #include "url.h"
  36 #include "preferences.h"
  37 #include "mainframe.h"
  38
  39 /*!
  40 the urls to fire up in the game packs help menus
  41 */
  42 namespace
  43 {
  44   std::list<CopiedString> mHelpURLs;
  45 }
  46
  47 /*!
  48 needed for hooking in Gtk+
  49 */
  50 void HandleHelpCommand(CopiedString& str)
  51 {
  52   OpenURL(str.c_str());
  53 }
  54
  55 void process_xlink(const char* filename, const char *menu_name, const char *base_url, GtkMenu *menu)
  56 {
  57   if(file_exists(filename))
  58   {
  59     xmlDocPtr pDoc = xmlParseFile(filename);
  60     if (pDoc)
  61     {
  62       globalOutputStream() << "Processing .xlink file '" << filename << "'\n";
  63       // create sub menu
  64       GtkMenu* menu_in_menu = create_sub_menu_with_mnemonic(menu, menu_name);
  65       if (g_Layout_enableDetachableMenus.m_value)
  66         menu_tearoff (menu_in_menu);
  67       // start walking the nodes, find the 'links' one
  68       xmlNodePtr pNode = pDoc->children;
  69       while (pNode && strcmp((const char*)pNode->name, "links"))
  70         pNode=pNode->next;
  71       if (pNode)
  72       {
  73         pNode = pNode->children;
  74         while(pNode)
  75         {
  76           if(!strcmp((const char*)pNode->name, "item"))
  77           {
  78             // process the URL
  79             CopiedString url;
  80
  81             xmlChar* prop = xmlGetProp(pNode, reinterpret_cast<const xmlChar*>("url"));
  82             ASSERT_NOTNULL(prop);
  83             if(strstr(reinterpret_cast<const char*>(prop), "http://"))
  84             {
  85               // complete URL
  86               url = reinterpret_cast<const char*>(prop);
  87             }
  88             else
  89             {
  90               // relative URL
  91               StringOutputStream full(256);
  92               full << base_url << reinterpret_cast<const char*>(prop);
  93               url = full.c_str();
  94             }
  95
  96             mHelpURLs.push_back(url);
  97
  98             xmlFree(prop);
  99
 100             prop = xmlGetProp(pNode, reinterpret_cast<const xmlChar*>("name"));
 101             ASSERT_NOTNULL(prop);
 102             create_menu_item_with_mnemonic(menu_in_menu, reinterpret_cast<const char*>(prop), ReferenceCaller<CopiedString, HandleHelpCommand>(mHelpURLs.back()));
 103             xmlFree(prop);
 104           }
 105           pNode=pNode->next;
 106         }
 107       }
 108       xmlFreeDoc(pDoc);
 109     }
 110     else
 111     {
 112       globalOutputStream() << "'" << filename << "' parse failed\n";
 113     }
 114   }
 115   else
 116   {
 117     globalOutputStream() << "'" << filename << "' not found\n";
 118   }
 119 }
 120
 121 void create_game_help_menu(GtkMenu *menu)
 122 {
 123   StringOutputStream filename(256);
 124   filename << AppPath_get() << "global.xlink";
 125   process_xlink(filename.c_str(), "General", AppPath_get(), menu);
 126
 127 #if 1
 128   filename.clear();
 129   filename << g_pGameDescription->mGameToolsPath.c_str() << "game.xlink";
 130   process_xlink(filename.c_str(), g_pGameDescription->getRequiredKeyValue("name"), g_pGameDescription->mGameToolsPath.c_str(), menu);
 131 #else
 132   for(std::list<CGameDescription *>::iterator iGame = g_GamesDialog.mGames.begin(); iGame != g_GamesDialog.mGames.end(); ++iGame)
 133   {
 134     filename.clear();
 135     filename << (*iGame)->mGameToolsPath.c_str() << "game.xlink";
 136     process_xlink(filename.c_str(), (*iGame)->getRequiredKeyValue("name"), (*iGame)->mGameToolsPath.c_str(), menu);
 137   }
 138 #endif
 139 }
 140