workbench/utilities/Help/main.c

   1 /*
   2     Copyright © 2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 /******************************************************************************
   7
   8     NAME
   9
  10         Help name (section)
  11
  12     SYNOPSIS
  13
  14         NAME, SECTION
  15
  16     LOCATION
  17
  18         SYS:Utilities
  19
  20     FUNCTION
  21
  22         Shows help information for commands and system applications.
  23         The help files are stored in HELP:English with a sub-directory
  24         for each section. The utility "Multiview" is used to show the
  25         guide files. If neither NAME nor SECTION are given an index page
  26         will be shown.
  27
  28     INPUTS
  29
  30         NAME    --  the name of the command or application whose help
  31                     you want to view. The name is case-insensitive.
  32         SECTION --  the section where the help document will be searched.
  33                     Currently available are "commands" and "system". If you
  34                     don't specify the section all available sections will
  35                     be searched. The section is case-insensitive.
  36
  37     RESULT
  38
  39     NOTES
  40
  41     EXAMPLE
  42
  43         Help dir
  44         Help dir commands
  45         Help help
  46
  47     BUGS
  48
  49     SEE ALSO
  50
  51     INTERNALS
  52
  53 ******************************************************************************/
  54
  55 #include <proto/dos.h>
  56
  57 #include <string.h>
  58 #include <stdio.h>
  59 #include <stdlib.h>
  60
  61 //#define DEBUG 1
  62 #include <aros/debug.h>
  63
  64 #define ARG_TEMPLATE "NAME,SECTION"
  65
  66 const char *ver = "$VER: Help 1.1 (09.03.2013)";
  67
  68 enum
  69 {
  70     ARG_NAME,
  71     ARG_SECTION,
  72     ARG_COUNT
  73 };
  74
  75 struct RDArgs *rda;
  76 static STRPTR name;
  77 static STRPTR section;
  78 static TEXT docpath[100];
  79 static TEXT viewpath[256];
  80
  81 static CONST_STRPTR section_arr[] = {"Commands", "System", NULL};
  82
  83
  84 static void clean_exit(CONST_STRPTR s)
  85 {
  86     if (s) PutStr(s);
  87     if (rda) FreeArgs(rda);
  88     exit(0);
  89 }
  90
  91
  92 static LONG show_file(STRPTR buffer, ULONG buflen, CONST_STRPTR path)
  93 {
  94     strlcpy(buffer, "SYS:Utilities/Multiview ", buflen);
  95     strlcat(buffer, path, buflen);
  96     D(bug("[Help/show_file] SystemTags path %s\n", buffer));
  97     // FIXME: running asynchron?
  98     LONG error = SystemTags
  99     (
 100         buffer,
 101         TAG_DONE
 102     );
 103     return error;
 104 }
 105
 106
 107 static STRPTR find_file
 108 (
 109     STRPTR buffer, ULONG buflen,
 110     CONST_STRPTR name, CONST_STRPTR section
 111 )
 112 {
 113     // TODO: support different suffixes
 114
 115     STRPTR retval = NULL;
 116     struct FileInfoBlock *fib = AllocDosObjectTagList(DOS_FIB, NULL);
 117     if (fib)
 118     {
 119         snprintf(buffer, buflen, "HELP:English/%s/%s.guide", section, name);
 120         D(bug("[Help/find_file] search for %s\n", buffer));
 121         BPTR lock = Lock(buffer, ACCESS_READ);
 122         if (lock)
 123         {
 124             BOOL success = Examine(lock, fib);
 125             if (success)
 126             {
 127                 if (fib->fib_DirEntryType < 0) // is file?
 128                 {
 129                     retval = buffer;
 130                 }
 131             }
 132             UnLock(lock);
 133         }
 134         FreeDosObject(DOS_FIB, fib);
 135     }
 136     return retval;
 137 }
 138
 139
 140 int main(int argc, char **argv)
 141 {
 142     if (argc) // started from Shell
 143     {
 144         IPTR args[ARG_COUNT] = {0};
 145
 146         rda = ReadArgs(ARG_TEMPLATE, args, NULL);
 147         if (!rda)
 148         {
 149             PrintFault(IoErr(), argv[0]);
 150             clean_exit("ReadArgs() failed.\n");
 151         }
 152
 153         if (args[ARG_NAME])
 154         {
 155             name = (STRPTR)args[ARG_NAME];
 156             if (strpbrk(name, ":/()#?~"))
 157             {
 158                 clean_exit("Illegal characters in argument 'name'.\n");
 159             }
 160         }
 161
 162         if (args[ARG_SECTION])
 163         {
 164             section = (STRPTR)args[ARG_SECTION];
 165             if (strpbrk(section, ":/()#?~"))
 166             {
 167                 clean_exit("Illegal characters in argument 'section'.\n");
 168             }
 169         }
 170
 171         D(bug("[Help] name %s section %s\n", name, section));
 172
 173         if (name == NULL && section == NULL)
 174         {
 175             strcpy(docpath, "HELP:English/Index.guide");
 176             show_file(viewpath, sizeof(viewpath), docpath);
 177         }
 178         else if (section == NULL || *section == '\0')
 179         {
 180             CONST_STRPTR *sect;
 181             BOOL found = FALSE;
 182             for (sect = section_arr ; (found == FALSE) && (*sect) ; sect++)
 183             {
 184                 if (find_file(docpath, sizeof(docpath), name, *sect))
 185                 {
 186                     show_file(viewpath, sizeof(viewpath), docpath);
 187                     found = TRUE;
 188                 }
 189             }
 190             if (found == FALSE)
 191             {
 192                 clean_exit("Can't find help document.\n");
 193             }
 194         }
 195         else
 196         {
 197             if (find_file(docpath, sizeof(docpath), name, section))
 198             {
 199                 show_file(viewpath, sizeof(viewpath), docpath);
 200             }
 201             else
 202             {
 203                 clean_exit("Can't find help document.\n");
 204             }
 205         }
 206     }
 207     else // started from Wanderer
 208     {
 209         strcpy(docpath, "HELP:English/Index.guide");
 210         show_file(viewpath, sizeof(viewpath), docpath);
 211     }
 212
 213     clean_exit(NULL);
 214     return 0;
 215 }