2008-01-05 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com>

	Added categorized option help. Specify category using --help 
option.
	Also added the ability to search options in forward match.
	* src/HelpItem.{h, cc}
	* test/HelpItemTest.cc
	* src/HelpItemFactory.{h, cc}
	* src/TagContainer.{h, cc}
	* test/TagContainerTest.cc
	* src/option_processing.cc
	* src/prefs.h
	* src/TaggedItem.{h, cc}
	* test/TaggedItemTest.cc
	* src/version_usage.cc
	* src/help_tags.h
	* src/usage_text.h

1 files changed, 49 insertions, 250 deletions

diff --git a/src/version_usage.cc b/src/version_usage.cc
index df90244c..a9cd28d6 100644
--- a/src/version_usage.cc
+++ b/src/version_usage.cc
@@ -38,12 +38,16 @@
 #ifdef ENABLE_MESSAGE_DIGEST
 # include "messageDigest.h"
 #endif // ENABLE_MESSAGE_DIGEST
-
-#define DEFAULT_MSG _("                              Default: ")
+#include "TagContainer.h"
+#include "HelpItem.h"
+#include "HelpItemFactory.h"
+#include "help_tags.h"
+#include "prefs.h"
+#include <iterator>
 
 void showVersion() {
   cout << PACKAGE << _(" version ") << PACKAGE_VERSION << "\n"
-       << "Copyright (C) 2006, 2007 Tatsuhiro Tsujikawa" << "\n"
+       << "Copyright (C) 2006, 2008 Tatsuhiro Tsujikawa" << "\n"
        << "\n"
        <<
     _("This program is free software; you can redistribute it and/or modify\n"
@@ -80,13 +84,12 @@ void showVersion() {
 #ifdef ENABLE_MESSAGE_DIGEST
        << "message digest algorithms: " << MessageDigestContext::getSupportedAlgoString() << "\n"
 #endif // ENABLE_MESSAGE_DIGEST
-       << "\n"
-       << _("Contact Info:") << "\n"
-       << "Tatsuhiro Tsujikawa <tujikawa at users dot sourceforge dot net>"
-       << endl;
+       << "\n";
+    printf(_("Report bugs to %s"), "<tujikawa at users dot sourceforge dot net>");
+    cout << endl;
 }
 
-void showUsage() {
+void showUsage(const string& category) {
   printf(_("Usage: %s [options] URL ...\n"), PACKAGE_NAME);
 #ifdef ENABLE_BITTORRENT
   printf(_("       %s [options] -T TORRENT_FILE URL ...\n"), PACKAGE_NAME);
@@ -95,248 +98,44 @@ void showUsage() {
   printf(_("       %s [options] -M METALINK_FILE\n"), PACKAGE_NAME);
 #endif // ENABLE_METALINK
   cout << endl;
-  cout << _("Options:") << endl;
-  cout << _(" -d, --dir=DIR                The directory to store the downloaded file.") << endl;
-  cout << _(" -o, --out=FILE               The file name of the downloaded file.") << endl;
-  cout << _(" -l, --log=LOG                The file name of the log file. If '-' is\n"
-	    "                              specified, log is written to stdout.") << endl;
-#ifdef HAVE_DAEMON
-  cout << _(" -D, --daemon                 Run as daemon.") << endl;
-#endif // HAVE_DAEMON
-  cout << _(" -s, --split=N                Download a file using N connections. N must be\n"
-	    "                              between 1 and 5. This option affects all URLs.\n"
-	    "                              Thus, aria2 connects to each URL with\n"
-	    "                              N connections.\n"
-	    "                              Default: 1") << endl;
-  cout << _(" --retry-wait=SEC             Set the seconds to wait to retry after an error\n"
-	    "                              has occured. Specify a value between 0 and 60.\n"
-	    "                              Default: 5") << endl;
-  cout << _(" -t, --timeout=SEC            Set timeout in seconds. Default: 60") << endl;
-  cout << _(" -m, --max-tries=N            Set number of tries. 0 means unlimited.\n"
-	    "                              Default: 5") << endl;
-  /*
-  cout << _(" --min-segment-size=SIZE[K|M] Set minimum segment size. You can append\n"
-	    "                              K or M(1K = 1024, 1M = 1024K). This\n"
-	    "                              value must be greater than or equal to\n"
-	    "                              1024. Default: 1M") << endl;
-  */
-  cout << _(" --http-proxy=HOST:PORT       Use HTTP proxy server. This affects all URLs.") << endl;
-  cout << _(" --http-user=USER             Set HTTP user. This affects all URLs.") << endl;
-  cout << _(" --http-passwd=PASSWD         Set HTTP password. This affects all URLs.") << endl;
-  cout << _(" --http-proxy-user=USER       Set HTTP proxy user. This affects all URLs.") << endl;
-  cout << _(" --http-proxy-passwd=PASSWD   Set HTTP proxy password. This affects all URLs.") << endl;
-  cout << _(" --http-proxy-method=METHOD   Set the method to use in proxy request.\n"
-	    "                              METHOD is either 'get' or 'tunnel'.\n"
-	    "                              Default: tunnel") << endl;
-  cout << _(" --http-auth-scheme=SCHEME    Set HTTP authentication scheme. Currently, basic\n"
-	    "                              is the only supported scheme.\n"
-	    "                              Default: basic") << endl;
-  cout << _(" --referer=REFERER            Set Referer. This affects all URLs.") << endl;
-  cout << _(" --ftp-user=USER              Set FTP user. This affects all URLs.\n"
-	    "                              Default: anonymous") << endl;
-  cout << _(" --ftp-passwd=PASSWD          Set FTP password. This affects all URLs.\n"
-	    "                              Default: ARIA2USER@") << endl;
-  cout << _(" --ftp-type=TYPE              Set FTP transfer type. TYPE is either 'binary'\n"
-	    "                              or 'ascii'.\n"
-	    "                              Default: binary") << endl;
-  cout << _(" -p, --ftp-pasv               Use passive mode in FTP.") << endl;
-  cout << _(" --ftp-via-http-proxy=METHOD  Use HTTP proxy in FTP. METHOD is either 'get' or\n"
-	    "                              'tunnel'.\n"
-	    "                              Default: tunnel") << endl;
-  cout << _(" --lowest-speed-limit=SPEED   Close connection if download speed is lower than\n"
-	    "                              or equal to this value(bytes per sec).\n"
-	    "                              0 means aria2 does not have a lowest speed limit.\n"
-	    "                              You can append K or M(1K = 1024, 1M = 1024K).\n"
 
-	    "                              This option does not affect BitTorrent downloads.\n"
-	    "                              Default: 0") << endl;
-  cout << _(" --max-download-limit=SPEED   Set max download speed in bytes per sec.\n"
-	    "                              0 means unrestricted.\n"
-	    "                              You can append K or M(1K = 1024, 1M = 1024K).\n"
-	    "                              Default: 0") << endl;
-  cout << _(" --file-allocation=METHOD     Specify file allocation method. METHOD is either\n"
-	    "                              'none' or 'prealloc'. 'none' doesn't pre-allocate\n"
-	    "                              file space. 'prealloc' pre-allocates file space\n"
-	    "                              before download begins. This may take some time\n"
-	    "                              depending on the size of the file.\n"
-	    "                              Default: prealloc") << endl;
-  cout << _(" --no-file-allocation-limit=SIZE No file allocation is made for files whose\n"
-	    "                              size is smaller than SIZE.\n"
-	    "                              You can append K or M(1K = 1024, 1M = 1024K).") << "\n"
-       << DEFAULT_MSG << "5M" << "\n";
-#ifdef ENABLE_DIRECT_IO
-  cout << _(" --enable-direct-io[=true|false] Enable directI/O, which lowers cpu usage while\n"
-	    "                              allocating files.\n"
-	    "                              Turn off if you encounter any error") << "\n"
-       << DEFAULT_MSG << "false" << "\n";
-#endif // ENABLE_DIRECT_IO
-  cout << _(" --allow-overwrite=true|false If false, aria2 doesn't download a file which\n"
-	    "                              already exists but the corresponding .aria2 file\n"
-	    "                              doesn't exist.\n"
-	    "                              Default: false") << endl;
-  cout << _(" --allow-piece-length-change=true|false If false is given, aria2 aborts download\n"
-	    "                              when a piece length is different from one in\n"
-	    "                              a control file. If true is given, you can proceed\n"
-	    "                              but some download progress will be lost.") << "\n"
-       << DEFAULT_MSG << "false" << "\n";
-  cout << _(" -Z, --force-sequential[=true|false] Fetch URIs in the command-line sequentially\n"
-	    "                              and download each URI in a separate session, like\n"
-	    "                              the usual command-line download utilities.\n"
-	    "                              Default: false") << endl;
-  cout << _(" --auto-file-renaming[=true|false] Rename file name if the same file already\n"
-	    "                              exists. This option works only in http(s)/ftp\n"
-	    "                              download.\n"
-	    "                              The new file name has a dot and a number(1..9999)\n"
-	    "                              appended.\n"
-	    "                              Default: true") << endl;
-  cout << _(" -P, --parameterized-uri[=true|false] Enable parameterized URI support.\n"
-	    "                              You can specify set of parts:\n"
-	    "                              http://{sv1,sv2,sv3}/foo.iso\n"
-	    "                              Also you can specify numeric sequences with step\n"
-	    "                              counter:\n"
-	    "                              http://host/image[000-100:2].img\n"
-	    "                              A step counter can be omitted.\n"
-	    "                              If all URIs do not point to the same file, such\n"
-	    "                              as the second example above, -Z option is\n"
-	    "                              required.\n"
-	    "                              Default: false") << endl;
-  cout << _(" --enable-http-keep-alive[=true|false] Enable HTTP/1.1 persistent connection.\n"
-	    "                              Default: false") << endl;
-  cout << _(" --enable-http-pipelining[=true|false] Enable HTTP/1.1 pipelining.\n"
-	    "                              Default: false") << endl;
-#ifdef ENABLE_MESSAGE_DIGEST
-  cout << _(" --check-integrity=true|false  Check file integrity by validating piece hash.\n"
-	    "                              This option only affects in BitTorrent downloads\n"
-	    "                              and Metalink downloads with chunk checksums.\n"
-	    "                              Use this option to re-download a damaged portion\n"
-	    "                              of a file.\n"
-	    "                              Default: false") << endl;
-  cout << _(" --realtime-chunk-checksum=true|false  Validate chunk checksum while\n"
-	    "                              downloading a file in Metalink mode. This option\n"
-	    "                              on affects Metalink mode with chunk checksums.\n"
-	    "                              Default: true") << endl;
-#endif // ENABLE_MESSAGE_DIGEST
-  cout << _(" -c, --continue               Continue downloading a partially downloaded\n"
-	    "                              file. Use this option to resume a download\n"
-	    "                              started by a web browser or another program\n"
-	    "                              which downloads files sequentially from the\n"
-	    "                              beginning. Currently this option is only\n"
-	    "                              applicable to http(s)/ftp downloads.") << endl;
-  cout << _(" -U, --user-agent=USER_AGENT  Set user agent for http(s) downloads.") << endl;
-  cout << _(" -n, --no-netrc               Disables netrc support.") << endl;
-  cout << _(" -i, --input-file=FILE        Downloads URIs found in FILE. You can specify\n"
-	    "                              multiple URIs for a single entity: separate\n"
-	    "                              URIs on a single line using the TAB character.\n"
-	    "                              Reads input from stdin when '-' is specified.") << endl;
-  cout << _(" -j, --max-concurrent-downloads=N Set maximum number of concurrent downloads.\n"
-	    "                              It should be used with the -i option.\n"
-	    "                              Default: 5") << endl;
-  cout << _(" --load-cookies=FILE          Load cookies from FILE. The format of FILE is\n"
-	    "                              the same used by Netscape and Mozilla.") << endl;
-#if defined ENABLE_BITTORRENT || ENABLE_METALINK
-  cout << _(" -S, --show-files             Print file listing of .torrent or .metalink file\n"
-	    "                              and exit. More detailed information will be listed\n"
-	    "                              in case of torrent file.") << endl;
-  cout << _(" --select-file=INDEX...       Set file to download by specifing its index.\n"
-	    "                              You can find the file index using the\n"
-	    "                              --show-files option. Multiple indexes can be\n"
-	    "                              specified by using ',', for example: \"3,6\".\n"
-	    "                              You can also use '-' to specify a range: \"1-5\".\n"
-	    "                              ',' and '-' can be used together.\n"
-	    "                              When used with the -M option, index may vary\n"
-	    "                              depending on the query(see --metalink-* options).") << endl;
-#endif // ENABLE_BITTORRENT || ENABLE_METALINK
-#ifdef ENABLE_BITTORRENT
-  cout << _(" -T, --torrent-file=TORRENT_FILE  The path to the .torrent file.") << endl;
-  cout << _(" --follow-torrent=true|false|mem If true or mem is specified, when a file\n"
-	    "                              whose suffix is .torrent or content type is\n"
-	    "                              application/x-bittorrent is downloaded, aria2\n"
-	    "                              parses it as a torrent file and downloads files\n"
-	    "                              mentioned in it.\n"
-	    "                              If mem is specified, a torrent file is not\n"
-	    "                              written to the disk, but is just kept in memory.\n"
-	    "                              If false is specified, the action mentioned above\n"
-	    "                              is not taken.") << "\n"
-       << DEFAULT_MSG << "true" << "\n";
-  cout << _(" --direct-file-mapping=true|false Directly read from and write to each file\n"
-	    "                              mentioned in .torrent file.\n"
-	    "                              Default: true") << endl;
-  cout << _(" --listen-port=PORT...        Set TCP port number for BitTorrent downloads.\n"
-	    "                              Multiple ports can be specified by using ',',\n"
-	    "                              for example: \"6881,6885\". You can also use '-'\n"
-	    "                              to specify a range: \"6881-6999\". ',' and '-' can\n"
-	    "                              be used together.") << "\n"
-       << DEFAULT_MSG << "6881-6999" << "\n";
-  cout << _(" --max-upload-limit=SPEED     Set max upload speed in bytes per sec.\n"
-	    "                              0 means unrestricted.\n"
-	    "                              You can append K or M(1K = 1024, 1M = 1024K).\n"
-	    "                              Default: 0") << endl;
-  cout << _(" --seed-time=MINUTES          Specify seeding time in minutes. Also see the\n"
-	    "                              --seed-ratio option.") << endl;
-  cout << _(" --seed-ratio=RATIO           Specify share ratio. Seed completed torrents\n"
-	    "                              until share ratio reaches RATIO. 1.0 is\n"
-	    "                              encouraged. Specify 0.0 if you intend to do\n"
-	    "                              seeding regardless of share ratio.\n"
-	    "                              If --seed-time option is specified along with\n"
-	    "                              this option, seeding ends when at least one of\n"
-	    "                              the conditions is satisfied.") << "\n"
-       << DEFAULT_MSG << "1.0" << "\n";
-  cout << _(" --peer-id-prefix=PEERI_ID_PREFIX Specify the prefix of peer ID. The peer ID in\n"
-	    "                              BitTorrent is 20 byte length. If more than 20\n"
-	    "                              bytes are specified, only first 20\n"
-	    "                              bytes are used. If less than 20 bytes are\n"
-	    "                              specified, the random alphabet characters are\n"
-	    "                              added to make it's length 20 bytes.\n"
-	    "                              Default: -aria2-") << endl;
-#endif // ENABLE_BITTORRENT
-#ifdef ENABLE_METALINK
-  cout << _(" -M, --metalink-file=METALINK_FILE The file path to the .metalink file.") << endl;
-  cout << _(" -C, --metalink-servers=NUM_SERVERS The number of servers to connect to\n"
-	    "                              simultaneously.\n"
-	    "                              Default: 5") << endl;
-  cout << _(" --metalink-version=VERSION   The version of the file to download.") << endl;
-  cout << _(" --metalink-language=LANGUAGE The language of the file to download.") << endl;
-  cout << _(" --metalink-os=OS             The operating system of the file to download.") << endl;
-  cout << _(" --metalink-location=LOCATION[,...] The location of the preferred server.\n"
-	    "                              A comma-deliminated list of locations is\n"
-	    "                              acceptable.") << endl;
-  cout << _(" --metalink-preferred-protocol=PROTO Specify preferred protocol. The possible\n"
-	    "                              values are 'http', 'https', 'ftp' and 'none'.\n"
-	    "                              Specifiy none to disable this feature.") << "\n"
-       << DEFAULT_MSG << "none" << "\n";
-  cout << _(" --follow-metalink=true|false|mem If true or mem is specified, when a file\n"
-	    "                              whose suffix is .metaink or content type is\n"
-	    "                              application/metalink+xml is downloaded, aria2\n"
-	    "                              parses it as a metalink file and downloads files\n"
-	    "                              mentioned in it.\n"
-	    "                              If mem is specified, a metalink file is not\n"
-	    "                              written to the disk, but is just kept in memory.\n"
-	    "                              If false is specified, the action mentioned above\n"
-	    "                              is not taken.") << "\n"
-       << DEFAULT_MSG << "true" << "\n";
-  cout << _(" --metalink-enable-unique-protocol=true|false If true is given and several\n"
-	    "                              protocols are available for a mirror in a metalink\n"
-	    "                              file, aria2 uses one of them.\n"
-	    "                              Use --metalink-preferred-protocol option to\n"
-	    "                              specify the preference of protocol.") << "\n"
-       << DEFAULT_MSG << "true" << "\n";
-#endif // ENABLE_METALINK
-  cout << _(" -v, --version                Print the version number and exit.") << endl;
-  cout << _(" -h, --help                   Print this message and exit.") << endl;
-  cout << endl;
-  cout << "URL:" << endl;
-  cout << _(" You can specify multiple URLs. Unless you specify -Z option, all URLs must\n"
-	    " point to the same file or downloading will fail.") << endl;
-  cout << _(" You can specify both torrent file with -T option and URLs. By doing this,\n"
-	    " download a file from both torrent swarm and http/ftp server at the same time,\n"
-	    " while the data from http/ftp are uploaded to the torrent swarm. Note that\n"
-	    " only single file torrent can be integrated with http/ftp.") << endl;
-  cout << "\n"
-       << _(" Make sure that URL is quoted with single(\') or double(\") quotation if it\n"
-	    " contains \"&\" or any characters that have special meaning in shell.") << "\n";
-  cout << endl;
+  TagContainerHandle tc = HelpItemFactory::createHelpItems();
+  TaggedItems items = category == V_ALL ? tc->getAllItems() : tc->search(category);
+  if(items.size() > 0) {
+    if(category == V_ALL) {
+      printf(_("Printing all options."));
+    } else {
+      printf(_("Printing options tagged with '%s'."), category.c_str());
+    }
+    cout << "\n";
+    cout << _("Options:") << endl;
+    copy(items.begin(), items.end(), ostream_iterator<HelpItemHandle>(cout, "\n"));
+  } else {
+    TaggedItems items = tc->nameMatchForward(category);
+    if(items.size() > 0) {
+      printf(_("Printing options whose name starts with '%s'."), category.c_str());
+      cout << "\n";
+      cout << _("Options:") << endl;
+      copy(items.begin(), items.end(), ostream_iterator<HelpItemHandle>(cout, "\n"));
+    } else {
+      printf(_("No help category or option name matching with '%s'."), category.c_str());
+      cout << "\n";
+      cout << HelpItemHandle(tc->nameMatchForward("help").front()) << "\n";
+    }
+  }
+  if(category == TAG_BASIC) {
+    cout << "\n"
+	 << "URL:" << "\n"
+	 << _(" You can specify multiple URLs. Unless you specify -Z option, all URLs must\n"
+	      " point to the same file or downloading will fail.") << "\n"
+	 << _(" You can specify both torrent file with -T option and URLs. By doing this,\n"
+	      " download a file from both torrent swarm and http/ftp server at the same time,\n"
+	      " while the data from http/ftp are uploaded to the torrent swarm. Note that\n"
+	      " only single file torrent can be integrated with http/ftp.") << "\n"
+	 << "\n"
+	 << _(" Make sure that URL is quoted with single(\') or double(\") quotation if it\n"
+	      " contains \"&\" or any characters that have special meaning in shell.") << "\n";
+  }
+  cout << "\n";
   cout << _("Refer to man page for more information.") << endl;
-  cout << endl;
-  printf(_("Report bugs to %s"), "<tujikawa at users dot sourceforge dot net>");
-  cout << endl;
 }