source/help.c

   1 static const char CVSID[] = "$Id: help.c,v 1.107 2008/08/19 22:24:41 ajbj Exp $";
   2 /*******************************************************************************
   3 *                                                                              *
   4 * help.c -- Nirvana Editor help display                                        *
   5 *                                                                              *
   6 * Copyright (C) 1999 Mark Edel                                                 *
   7 *                                                                              *
   8 * This is free software; you can redistribute it and/or modify it under the    *
   9 * terms of the GNU General Public License as published by the Free Software    *
  10 * Foundation; either version 2 of the License, or (at your option) any later   *
  11 * version. In addition, you may distribute version of this program linked to   *
  12 * Motif or Open Motif. See README for details.                                 *
  13 *                                                                              *
  14 * This software is distributed in the hope that it will be useful, but WITHOUT *
  15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
  16 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License        *
  17 * for more details.                                                            *
  18 *                                                                              *
  19 * You should have received a copy of the GNU General Public License along with *
  20 * software; if not, write to the Free Software Foundation, Inc., 59 Temple     *
  21 * Place, Suite 330, Boston, MA  02111-1307 USA                                 *
  22 *                                                                              *
  23 * Nirvana Text Editor                                                          *
  24 * September 10, 1991                                                           *
  25 *                                                                              *
  26 * Written by Mark Edel, mostly rewritten by Steve Haehn for new help system,   *
  27 * December, 2001                                                               *
  28 *                                                                              *
  29 *******************************************************************************/
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include "../config.h"
  33 #endif
  34
  35 #include "help.h"
  36 #include "textBuf.h"
  37 #include "text.h"
  38 #include "textP.h"
  39 #include "textDisp.h"
  40 #include "textSel.h"
  41 #include "nedit.h"
  42 #include "search.h"
  43 #include "window.h"
  44 #include "preferences.h"
  45 #include "help_data.h"
  46 #include "file.h"
  47 #include "highlight.h"
  48 #include "../util/motif.h"
  49 #include "../util/misc.h"
  50 #include "../util/DialogF.h"
  51 #include "../util/system.h"
  52
  53 #include <locale.h>
  54 #include <stdlib.h>
  55 #include <stdio.h>
  56 #include <string.h>
  57 #ifdef VMS
  58 #include "../util/VMSparam.h"
  59 #else
  60 #ifndef __MVS__
  61 #include <sys/param.h>
  62 #endif
  63 #endif /*VMS*/
  64
  65 #include <Xm/Xm.h>
  66 #include <Xm/XmP.h>         /* These are for applying style info to help text */
  67 #include <Xm/Form.h>
  68 #include <Xm/PrimitiveP.h>
  69 #include <Xm/ScrolledW.h>
  70 #include <Xm/ScrollBar.h>
  71 #include <Xm/PushB.h>
  72 #ifdef EDITRES
  73 #include <X11/Xmu/Editres.h>
  74 /* extern void _XEditResCheckMessages(); */
  75 #endif /* EDITRES */
  76
  77 #ifdef HAVE_DEBUG_H
  78 #include "../debug.h"
  79 #endif
  80
  81 /*============================================================================*/
  82 /*                              SYMBOL DEFINITIONS                            */
  83 /*============================================================================*/
  84
  85 #define EOS '\0'              /* end-of-string character                  */
  86
  87 #define CLICK_THRESHOLD 5     /* number of pixels mouse may move from its */
  88                               /* pressed location for mouse-up to be      */
  89                               /* considered a valid click (as opposed to  */
  90                               /* a drag or mouse-pick error)              */
  91
  92 /*============================================================================*/
  93 /*                             VARIABLE DECLARATIONS                          */
  94 /*============================================================================*/
  95
  96 static Widget HelpWindows[NUM_TOPICS] = {NULL};
  97 static Widget HelpTextPanes[NUM_TOPICS] = {NULL};
  98 static textBuffer *HelpStyleBuffers[NUM_TOPICS] = {NULL};
  99 static int navHistForw[NUM_TOPICS];
 100 static int navHistBack[NUM_TOPICS];
 101
 102 /* Information on the last search for search-again */
 103 static char LastSearchString[DF_MAX_PROMPT_LENGTH] = "";
 104 static int LastSearchTopic = -1;
 105 static int LastSearchPos = 0;
 106 static int LastSearchWasAllTopics = False;
 107
 108 /* Fonts for each help text style generated by the help generator (setext).
 109    The NEdit text widget uses the first help style, 'A', to calculate window
 110    width, so making 'A' a fixed font will yield window widths calibrated to
 111    match width-dependent fixed font layouts in the help text. */
 112 static enum helpFonts StyleFonts[] =
 113 {
 114     /* Fixed fonts, styles: 'A', 'B', 'C', 'D' */
 115     FIXED_HELP_FONT, BOLD_FIXED_HELP_FONT, ITALIC_FIXED_HELP_FONT,
 116     BOLD_ITALIC_FIXED_HELP_FONT,
 117
 118     /* Underlined fixed fonts, styles: 'E', 'F', 'G', 'H' */
 119     FIXED_HELP_FONT, BOLD_FIXED_HELP_FONT, ITALIC_FIXED_HELP_FONT,
 120     BOLD_ITALIC_FIXED_HELP_FONT,
 121
 122     /* Normal (proportional) fonts, styles: 'I', 'J', 'K', 'L' */
 123     HELP_FONT, BOLD_HELP_FONT, ITALIC_HELP_FONT, BOLD_ITALIC_HELP_FONT,
 124
 125     /* Underlined fonts, styles: 'M', 'N', 'O', 'P' */
 126     HELP_FONT, BOLD_HELP_FONT, ITALIC_HELP_FONT, BOLD_ITALIC_HELP_FONT,
 127
 128     /* Link font, style: 'Q' */
 129     HELP_FONT,
 130
 131     /* Heading fonts, styles: 'R', 'S', 'T' */
 132     H1_HELP_FONT, H2_HELP_FONT,  H3_HELP_FONT
 133 };
 134
 135 static int StyleUnderlines[] =
 136 {
 137     /* Fixed fonts, styles: 'A', 'B', 'C', 'D' */
 138     False, False, False, False,
 139
 140     /* Underlined fixed fonts, styles: 'E', 'F', 'G', 'H' */
 141     True, True, True, True,
 142
 143     /* Normal (proportional) fonts, styles: 'I', 'J', 'K', 'L' */
 144     False, False, False, False,
 145
 146     /* Underlined fonts, styles: 'M', 'N', 'O', 'P' */
 147     True, True, True, True,
 148
 149     /* Link font, style: 'Q' */
 150     True,
 151
 152     /* Heading fonts, styles: 'R', 'S', 'T' */
 153     False, False, False
 154 };
 155
 156 #define N_STYLES (XtNumber(StyleFonts))
 157
 158 static styleTableEntry HelpStyleInfo[ N_STYLES ];
 159
 160 /* Translation table for style codes (A, B, C, ...) to their ASCII codes.
 161    For systems using ASCII, this is just a one-to-one mapping, but the
 162    table makes it possible to use the style codes also on an EBCDIC system.
 163    */
 164 static unsigned char AlphabetToAsciiTable[256];
 165
 166 /* Macro that calculates the zero-based index for a given style, taking
 167    into account that the character set may not use ASCII coding, but EBCDIC.
 168    The "style" argument must be one of the characters A - Z.
 169    In ASCII, this comes down to "style - STYLE_PLAIN". */
 170 #define STYLE_INDEX(style)                              \
 171     (AlphabetToAsciiTable[(unsigned char)style] -       \
 172      AlphabetToAsciiTable[(unsigned char)STYLE_PLAIN])
 173
 174 /*============================================================================*/
 175 /*                             PROGRAM PROTOTYPES                             */
 176 /*============================================================================*/
 177
 178 static Widget createHelpPanel(enum HelpTopic topic);
 179 static void closeCB(Widget w, XtPointer clientData, XtPointer callData);
 180 static void prevTopicCB(Widget w, XtPointer clientData, XtPointer callData);
 181 static void nextTopicCB(Widget w, XtPointer clientData, XtPointer callData);
 182 static void bwHistoryCB(Widget w, XtPointer clientData, XtPointer callData);
 183 static void fwHistoryCB(Widget w, XtPointer clientData, XtPointer callData);
 184 static void searchHelpCB(Widget w, XtPointer clientData, XtPointer callData);
 185 static void searchHelpAgainCB(Widget w, XtPointer clientData,
 186         XtPointer callData);
 187 static void printCB(Widget w, XtPointer clientData, XtPointer callData);
 188 static char *stitch(Widget  parent, char **string_list,char **styleMap);
 189 static void searchHelpText(Widget parent, int parentTopic,
 190         const char *searchFor, int allSections, int startPos, int startTopic);
 191 static void changeWindowTopic(int existingTopic, enum HelpTopic newTopic);
 192 static int findTopicFromShellWidget(Widget shellWidget);
 193 static void loadFontsAndColors(Widget parent, int style);
 194 static void initNavigationHistory(void);
 195
 196 #ifdef HAVE__XMVERSIONSTRING
 197 extern char _XmVersionString[];
 198 #else
 199 static char _XmVersionString[] = "unknown";
 200 #endif
 201
 202 /*============================================================================*/
 203 /*================================= PROGRAMS =================================*/
 204 /*============================================================================*/
 205
 206 /*
 207 ** Create a string containing information on the build environment.  Returned
 208 ** string must NOT be freed by caller.
 209 */
 210
 211 static char *bldInfoString = NULL;
 212
 213 static void freeBuildInfo(void)
 214 {
 215     /* This keeps memory leak detectors happy */
 216     XtFree(bldInfoString);
 217 }
 218
 219 static const char *const warning =
 220     "\nThis NEdit was built with a known-bad version of Motif.  Please "
 221     "do not report any bugs you encounter unless you can reproduce "
 222     "them with a known-good binary from the www.nedit.org website. "
 223     "If this binary was supplied with your Linux distribution please "
 224     "file a bug report with them asking them to build NEdit with a "
 225     "known-good version of Motif.\n";
 226
 227
 228 static const char *getBuildInfo(void)
 229 {
 230     static const char *bldFormat =
 231         "%s\n"
 232         "     Built on: %s, %s, %s\n"
 233         "     Built at: %s, %s\n"
 234         "   With Motif: %s%d.%d.%d [%s]\n"
 235         "Running Motif: %d.%d [%s]\n"
 236         "       Server: %s %d\n"
 237         "       Visual: %s\n"
 238         "       Locale: %s\n"
 239        ;
 240
 241     static const char *visualClass[] = {"StaticGray",  "GrayScale",
 242                                         "StaticColor", "PseudoColor",
 243                                         "TrueColor",   "DirectColor"};
 244
 245     static const char *const stabilities[] = {"", "(Untested) ", "(Known Bad) "};
 246
 247     if (bldInfoString == NULL)
 248     {
 249         const char *locale;
 250         char visualStr[500] = "<unknown>";
 251         const enum MotifStability stab = GetMotifStability();
 252
 253         if (TheDisplay) {
 254             Visual     *visual;
 255             int         depth;
 256             Colormap    map;
 257             Boolean usingDefaultVisual = FindBestVisual(TheDisplay, APP_NAME,
 258                                                         APP_CLASS, &visual,
 259                                                         &depth, &map);
 260             sprintf(visualStr,"%d-bit %s (ID %#lx%s)",
 261                     depth,
 262                     visualClass[visual->class],
 263                     visual->visualid,
 264                     usingDefaultVisual ? ", Default" : "");
 265         }
 266
 267         bldInfoString = XtMalloc(strlen(bldFormat) + strlen(warning) + 1024);
 268         locale = setlocale(LC_MESSAGES, "");
 269
 270         sprintf(bldInfoString, bldFormat,
 271              NEditVersion,
 272              COMPILE_OS, COMPILE_MACHINE, COMPILE_COMPILER,
 273              linkdate, linktime,
 274              stabilities[stab], XmVERSION, XmREVISION, XmUPDATE_LEVEL,
 275              XmVERSION_STRING,
 276              xmUseVersion/1000, xmUseVersion%1000,
 277              _XmVersionString,
 278              (NULL == TheDisplay ? "<unknown>" : ServerVendor(TheDisplay)),
 279              (NULL == TheDisplay ? 0 : VendorRelease(TheDisplay)),
 280              visualStr,
 281              locale ? locale : "None");
 282
 283         if (stab == MotifKnownBad)
 284             strcat(bldInfoString, warning);
 285
 286         atexit(freeBuildInfo);
 287     }
 288
 289     return bldInfoString;
 290 }
 291
 292 /*
 293 ** Initialization for help system data, needs to be done only once.
 294 */
 295 static void initHelpStyles (Widget parent)
 296 {
 297     static int styleTableInitialized = False;
 298
 299     if (! styleTableInitialized)
 300     {
 301         Pixel fg;
 302         int   styleIndex;
 303         char ** line;
 304
 305         XtVaGetValues(parent, XtNforeground, &fg, NULL);
 306
 307         for (styleIndex = 0; styleIndex < STL_HD + MAX_HEADING; styleIndex++)
 308         {
 309             HelpStyleInfo[ styleIndex ].color     = fg;
 310             HelpStyleInfo[ styleIndex ].underline = StyleUnderlines[styleIndex];
 311             HelpStyleInfo[ styleIndex ].font      = NULL;
 312         }
 313
 314         styleTableInitialized  = True;
 315
 316         /*-------------------------------------------------------
 317         * Only attempt to add build information to version text
 318         * when string formatting symbols are present in the text.
 319         * This special case is needed to incorporate this
 320         * dynamically created information into the static help.
 321         *-------------------------------------------------------*/
 322         for (line = HelpText[ HELP_VERSION ]; *line != NULL; line++)
 323         {
 324             /*--------------------------------------------------
 325             * If and when this printf format is found in the
 326             * version help text, replace that line with the
 327             * build information. Then stitching the help text
 328             * will have the final count of characters to use.
 329             *--------------------------------------------------*/
 330             if (strstr (*line, "%s")  != NULL)
 331             {
 332                 const char * bldInfo  = getBuildInfo();
 333                 char * text     = XtMalloc (strlen (*line)  + strlen (bldInfo));
 334                 sprintf (text, *line, bldInfo);
 335                 *line = text;
 336                 break;
 337             }
 338         }
 339
 340         /*---------------------------------------------------------
 341          * Also initialize the alphabet-to-ASCII-code table (to
 342          * make the style mapping also work on EBCDIC).
 343          * DON'T use 'A' to initialize the table! 'A' != 65 in EBCDIC.
 344          *--------------------------------------------------------*/
 345         AlphabetToAsciiTable[(unsigned char)'A'] = ASCII_A +  0;
 346         AlphabetToAsciiTable[(unsigned char)'B'] = ASCII_A +  1;
 347         AlphabetToAsciiTable[(unsigned char)'C'] = ASCII_A +  2;
 348         AlphabetToAsciiTable[(unsigned char)'D'] = ASCII_A +  3;
 349         AlphabetToAsciiTable[(unsigned char)'E'] = ASCII_A +  4;
 350         AlphabetToAsciiTable[(unsigned char)'F'] = ASCII_A +  5;
 351         AlphabetToAsciiTable[(unsigned char)'G'] = ASCII_A +  6;
 352         AlphabetToAsciiTable[(unsigned char)'H'] = ASCII_A +  7;
 353         AlphabetToAsciiTable[(unsigned char)'I'] = ASCII_A +  8;
 354         AlphabetToAsciiTable[(unsigned char)'J'] = ASCII_A +  9;
 355         AlphabetToAsciiTable[(unsigned char)'K'] = ASCII_A + 10;
 356         AlphabetToAsciiTable[(unsigned char)'L'] = ASCII_A + 11;
 357         AlphabetToAsciiTable[(unsigned char)'M'] = ASCII_A + 12;
 358         AlphabetToAsciiTable[(unsigned char)'N'] = ASCII_A + 13;
 359         AlphabetToAsciiTable[(unsigned char)'O'] = ASCII_A + 14;
 360         AlphabetToAsciiTable[(unsigned char)'P'] = ASCII_A + 15;
 361         AlphabetToAsciiTable[(unsigned char)'Q'] = ASCII_A + 16;
 362         AlphabetToAsciiTable[(unsigned char)'R'] = ASCII_A + 17;
 363         AlphabetToAsciiTable[(unsigned char)'S'] = ASCII_A + 18;
 364         AlphabetToAsciiTable[(unsigned char)'T'] = ASCII_A + 19;
 365         AlphabetToAsciiTable[(unsigned char)'U'] = ASCII_A + 20;
 366         AlphabetToAsciiTable[(unsigned char)'V'] = ASCII_A + 21;
 367         AlphabetToAsciiTable[(unsigned char)'W'] = ASCII_A + 22;
 368         AlphabetToAsciiTable[(unsigned char)'X'] = ASCII_A + 23;
 369         AlphabetToAsciiTable[(unsigned char)'Y'] = ASCII_A + 24;
 370         AlphabetToAsciiTable[(unsigned char)'Z'] = ASCII_A + 25;
 371     }
 372 }
 373
 374 /*
 375 ** Help fonts are not loaded until they're actually needed.  This function
 376 ** checks if the style's font is loaded, and loads it if it's not.
 377 */
 378 static void loadFontsAndColors(Widget parent, int style)
 379 {
 380     XFontStruct *font;
 381     int r,g,b;
 382     if (HelpStyleInfo[STYLE_INDEX(style)].font == NULL)
 383     {
 384         font = XLoadQueryFont(XtDisplay(parent),
 385                 GetPrefHelpFontName(StyleFonts[STYLE_INDEX(style)]));
 386         if (font == NULL)
 387         {
 388             fprintf(stderr, "NEdit: help font, %s, not available\n",
 389                     GetPrefHelpFontName(StyleFonts[STYLE_INDEX(style)]));
 390             font = XLoadQueryFont(XtDisplay(parent), "fixed");
 391             if (font == NULL)
 392             {
 393                 fprintf(stderr, "NEdit: fallback help font, \"fixed\", not "
 394                         "available, cannot continue\n");
 395                 exit(EXIT_FAILURE);
 396             }
 397         }
 398         HelpStyleInfo[STYLE_INDEX(style)].font = font;
 399
 400         if (style == STL_NM_LINK)
 401             HelpStyleInfo[STYLE_INDEX(style)].color =
 402                 AllocColor(parent, GetPrefHelpLinkColor(), &r, &g, &b);
 403     }
 404 }
 405
 406 static void adaptNavigationButtons(int topic) {
 407     Widget btn;
 408
 409     if(HelpWindows[topic] == NULL)
 410         return; /* Shouldn't happen */
 411
 412     btn=XtNameToWidget(HelpWindows[topic], "helpForm.prevTopic");
 413     if(btn)
 414     {
 415         if(topic > 0)
 416             XtSetSensitive(btn, True);
 417         else
 418             XtSetSensitive(btn, False);
 419     }
 420
 421     btn=XtNameToWidget(HelpWindows[topic], "helpForm.nextTopic");
 422     if(btn)
 423     {
 424         if(topic < (NUM_TOPICS - 1))
 425             XtSetSensitive(btn, True);
 426         else
 427             XtSetSensitive(btn, False);
 428     }
 429
 430     btn=XtNameToWidget(HelpWindows[topic], "helpForm.histBack");
 431     if(btn)
 432     {
 433         if(navHistBack[topic] != -1)
 434             XtSetSensitive(btn, True);
 435         else
 436             XtSetSensitive(btn, False);
 437     }
 438
 439     btn=XtNameToWidget(HelpWindows[topic], "helpForm.histForw");
 440     if(btn)
 441     {
 442         if(navHistForw[topic] != -1)
 443             XtSetSensitive(btn, True);
 444         else
 445             XtSetSensitive(btn, False);
 446     }
 447
 448 }
 449
 450 /*
 451 ** Put together stored help strings to create the text and optionally the style
 452 ** information for a given help topic.
 453 */
 454 static char * stitch (
 455
 456     Widget  parent,      /* used for dynamic font/color allocation */
 457     char ** string_list, /* given help strings to stitch together */
 458     char ** styleMap     /* NULL, or a place to store help styles */
 459 )
 460 {
 461     char  *  cp;
 462     char  *  section, * sp;       /* resulting help text section            */
 463     char  *  styleData, * sdp;    /* resulting style data for text          */
 464     char     style = STYLE_PLAIN; /* start off each section with this style */
 465     int      total_size = 0;      /* help text section size                 */
 466     char  ** crnt_line;
 467
 468     /*----------------------------------------------------
 469     * How many characters are there going to be displayed?
 470     *----------------------------------------------------*/
 471     for (crnt_line = string_list; *crnt_line != NULL; crnt_line++)
 472     {
 473         for (cp = *crnt_line; *cp != EOS; cp++)
 474         {
 475             /*---------------------------------------------
 476             * The help text has embedded style information
 477             * consisting of the style marker and a single
 478             * character style, for a total of 2 characters.
 479             * This style information is not to be included
 480             * in the character counting below.
 481             *---------------------------------------------*/
 482             if (*cp != STYLE_MARKER)  {
 483                 total_size++;
 484             }
 485             else {
 486                 cp++;  /* skipping style marker, loop will handle style */
 487             }
 488         }
 489     }
 490
 491     /*--------------------------------------------------------
 492     * Get the needed space, one area for the help text being
 493     * stitched together, another for the styles to be applied.
 494     *--------------------------------------------------------*/
 495     sp  = section   = XtMalloc (total_size +1);
 496     sdp = styleData = (styleMap) ? XtMalloc (total_size +1)  : NULL;
 497     *sp = EOS;
 498
 499     /*--------------------------------------------
 500     * Fill in the newly acquired contiguous space
 501     * with help text and style information.
 502     *--------------------------------------------*/
 503     for (crnt_line = string_list; *crnt_line != NULL; crnt_line++)
 504     {
 505         for (cp = *crnt_line; *cp != EOS; cp++)
 506         {
 507             if (*cp == STYLE_MARKER)
 508             {
 509                 style = *(++cp);
 510                 loadFontsAndColors(parent, style);
 511             } else
 512             {
 513                 *(sp++)  = *cp;
 514
 515                 /* Beware of possible EBCDIC coding! Use the mapping table. */
 516                 if (styleMap)
 517                     *(sdp++) = AlphabetToAsciiTable[(unsigned char)style];
 518             }
 519         }
 520     }
 521
 522     *sp = EOS;
 523
 524     /*-----------------------------------------
 525     * Only deal with style map, when available.
 526     *-----------------------------------------*/
 527     if (styleMap)  {
 528         *styleMap = styleData;
 529         *sdp      = EOS;
 530     }
 531
 532     return section;
 533 }
 534
 535 /*
 536 ** Display help for subject "topic".  "parent" is a widget over which the help
 537 ** dialog may be posted.  Help dialogs are preserved when popped down by the
 538 ** user, and may appear posted over a previous parent, regardless of the parent
 539 ** argument.
 540 */
 541 void Help(enum HelpTopic topic)
 542 {
 543     if (HelpWindows[topic] != NULL)
 544         RaiseShellWindow(HelpWindows[topic], True);
 545     else
 546         HelpWindows[topic] = createHelpPanel(topic);
 547     adaptNavigationButtons(topic);
 548 }
 549
 550
 551 /* Setup Window/Icon title for the help window. */
 552 static void setHelpWinTitle(Widget win, enum HelpTopic topic)
 553 {
 554     char * buf, *topStr=HelpTitles[topic];
 555
 556     buf=malloc(strlen(topStr) + 24);
 557     topic++;
 558
 559     sprintf(buf, "NEdit Help (%d)", (int)topic);
 560     XtVaSetValues(win, XmNiconName, buf, NULL);
 561
 562     sprintf(buf, "NEdit Help: %s (%d)", topStr, (int)topic);
 563     XtVaSetValues(win, XmNtitle, buf, NULL);
 564
 565     free(buf);
 566 }
 567
 568 /*
 569 ** Create a new help window displaying a given subject, "topic"
 570 **
 571 ** Important hint: If this widget is restructured or the name of the text
 572 ** subwidget is changed don't forget to adapt the default translations of the
 573 ** help text. They are located in nedit.c, look for
 574 **   static char *fallbackResources
 575 **   (currently:  nedit.helpForm.sw.helpText*translations...)
 576 */
 577 static Widget createHelpPanel(enum HelpTopic topic)
 578 {
 579     Arg al[50];
 580     int ac;
 581     Widget appShell, btn, closeBtn, form, btnFW;
 582     Widget sw, hScrollBar, vScrollBar;
 583     XmString st1;
 584     char * helpText  = NULL;
 585     char * styleData = NULL;
 586
 587     ac = 0;
 588     XtSetArg(al[ac], XmNdeleteResponse, XmDO_NOTHING); ac++;
 589     appShell = CreateWidget(TheAppShell, "help",
 590             topLevelShellWidgetClass, al, ac);
 591     AddSmallIcon(appShell);
 592     /* With openmotif 2.1.30, a crash may occur when the text widget of the
 593        help window is (slowly) resized to a zero width. By imposing a
 594        minimum _window_ width, we can work around this problem. The minimum
 595        width should be larger than the width of the scrollbar. 50 is probably
 596        a safe value; this leaves room for a few characters */
 597     XtVaSetValues(appShell, XtNminWidth, 50, NULL);
 598     form = XtVaCreateManagedWidget("helpForm", xmFormWidgetClass, appShell,
 599             NULL);
 600     XtVaSetValues(form, XmNshadowThickness, 0, NULL);
 601
 602     /* Create the bottom row of buttons */
 603     btn = XtVaCreateManagedWidget("find", xmPushButtonWidgetClass, form,
 604             XmNlabelString, st1=XmStringCreateSimple("Find..."),
 605             XmNmnemonic, 'F',
 606             XmNbottomAttachment, XmATTACH_FORM,
 607             XmNleftAttachment, XmATTACH_POSITION,
 608             XmNleftPosition, 3,
 609             XmNrightAttachment, XmATTACH_POSITION,
 610             XmNrightPosition, 25,
 611             NULL);
 612     XtAddCallback(btn, XmNactivateCallback, searchHelpCB, appShell);
 613     XmStringFree(st1);
 614
 615     btn = XtVaCreateManagedWidget("findAgain", xmPushButtonWidgetClass, form,
 616             XmNlabelString, st1=XmStringCreateSimple("Find Again"),
 617             XmNmnemonic, 'A',
 618             XmNbottomAttachment, XmATTACH_FORM,
 619             XmNleftAttachment, XmATTACH_POSITION,
 620             XmNleftPosition, 27,
 621             XmNrightAttachment, XmATTACH_POSITION,
 622             XmNrightPosition, 49,
 623             NULL);
 624     XtAddCallback(btn, XmNactivateCallback, searchHelpAgainCB, appShell);
 625     XmStringFree(st1);
 626
 627     btn = XtVaCreateManagedWidget("print", xmPushButtonWidgetClass, form,
 628             XmNlabelString, st1=XmStringCreateSimple("Print..."),
 629             XmNmnemonic, 'P',
 630             XmNbottomAttachment, XmATTACH_FORM,
 631             XmNleftAttachment, XmATTACH_POSITION,
 632             XmNleftPosition, 51,
 633             XmNrightAttachment, XmATTACH_POSITION,
 634             XmNrightPosition, 73,
 635             NULL);
 636     XtAddCallback(btn, XmNactivateCallback, printCB, appShell);
 637     XmStringFree(st1);
 638
 639     closeBtn = XtVaCreateManagedWidget("close",
 640             xmPushButtonWidgetClass, form,
 641             XmNlabelString, st1=XmStringCreateSimple("Close"),
 642             XmNbottomAttachment, XmATTACH_FORM,
 643             XmNleftAttachment, XmATTACH_POSITION,
 644             XmNleftPosition, 75,
 645             XmNrightAttachment, XmATTACH_POSITION,
 646             XmNrightPosition, 97,
 647             NULL);
 648     XtAddCallback(closeBtn, XmNactivateCallback, closeCB, appShell);
 649     XmStringFree(st1);
 650
 651     /* Create the next row of buttons (for navigation) */
 652     btn = XtVaCreateManagedWidget("prevTopic", xmPushButtonWidgetClass, form,
 653             XmNlabelString, st1=XmStringCreateSimple("<< Browse"),
 654             XmNmnemonic, 'o',
 655             XmNbottomAttachment, XmATTACH_WIDGET,
 656             XmNbottomWidget, closeBtn,
 657             XmNleftAttachment, XmATTACH_POSITION,
 658             XmNleftPosition, 51,
 659             XmNrightAttachment, XmATTACH_POSITION,
 660             XmNrightPosition, 73,
 661             NULL);
 662     XtAddCallback(btn, XmNactivateCallback, prevTopicCB, appShell);
 663     XmStringFree(st1);
 664
 665     btn = XtVaCreateManagedWidget("nextTopic", xmPushButtonWidgetClass, form,
 666             XmNlabelString, st1=XmStringCreateSimple("Browse >>"),
 667             XmNmnemonic, 'e',
 668             XmNbottomAttachment, XmATTACH_WIDGET,
 669             XmNbottomWidget, closeBtn,
 670             XmNleftAttachment, XmATTACH_POSITION,
 671             XmNleftPosition, 75,
 672             XmNrightAttachment, XmATTACH_POSITION,
 673             XmNrightPosition, 97,
 674             NULL);
 675     XtAddCallback(btn, XmNactivateCallback, nextTopicCB, appShell);
 676     XmStringFree(st1);
 677
 678     btn = XtVaCreateManagedWidget("histBack", xmPushButtonWidgetClass, form,
 679             XmNlabelString, st1=XmStringCreateSimple("Back"),
 680             XmNmnemonic, 'B',
 681             XmNbottomAttachment, XmATTACH_WIDGET,
 682             XmNbottomWidget, closeBtn,
 683             XmNleftAttachment, XmATTACH_POSITION,
 684             XmNleftPosition, 3,
 685             XmNrightAttachment, XmATTACH_POSITION,
 686             XmNrightPosition, 25,
 687             NULL);
 688     XtAddCallback(btn, XmNactivateCallback, bwHistoryCB, appShell);
 689     XmStringFree(st1);
 690
 691     btnFW = XtVaCreateManagedWidget("histForw", xmPushButtonWidgetClass, form,
 692             XmNlabelString, st1=XmStringCreateSimple("Forward"),
 693             XmNmnemonic, 'w',
 694             XmNbottomAttachment, XmATTACH_WIDGET,
 695             XmNbottomWidget, closeBtn,
 696             XmNleftAttachment, XmATTACH_POSITION,
 697             XmNleftPosition, 27,
 698             XmNrightAttachment, XmATTACH_POSITION,
 699             XmNrightPosition, 49,
 700             NULL);
 701     XtAddCallback(btnFW, XmNactivateCallback, fwHistoryCB, appShell);
 702     XmStringFree(st1);
 703
 704     /* Create a text widget inside of a scrolled window widget */
 705     sw = XtVaCreateManagedWidget("sw", xmScrolledWindowWidgetClass, form,
 706             XmNshadowThickness, 2,
 707             XmNtopAttachment, XmATTACH_FORM,
 708             XmNleftAttachment, XmATTACH_FORM,
 709             XmNrightAttachment, XmATTACH_FORM,
 710             XmNbottomAttachment, XmATTACH_WIDGET,
 711             XmNbottomWidget, btnFW,
 712             NULL);
 713     hScrollBar = XtVaCreateManagedWidget("hScrollBar",
 714             xmScrollBarWidgetClass, sw,
 715             XmNorientation, XmHORIZONTAL,
 716             XmNrepeatDelay, 10,
 717             NULL);
 718     vScrollBar = XtVaCreateManagedWidget("vScrollBar",
 719             xmScrollBarWidgetClass, sw,
 720             XmNorientation, XmVERTICAL,
 721             XmNrepeatDelay, 10,
 722             NULL);
 723     /* Make sure the fixed size help font is loaded, such that we can base
 724        our text widget size calculation on it. */
 725     loadFontsAndColors(sw, 'A');
 726     HelpTextPanes[topic] = XtVaCreateManagedWidget("helpText",
 727             textWidgetClass, sw,
 728             textNfont, HelpStyleInfo[0].font, /* MUST correspond to 'A' above */
 729             textNrows, 30,
 730             textNcolumns, 65,
 731             textNbacklightCharTypes, NULL,
 732             textNhScrollBar, hScrollBar,
 733             textNvScrollBar, vScrollBar,
 734             textNreadOnly, True,
 735             textNcontinuousWrap, True,
 736             textNautoShowInsertPos, True,
 737             NULL);
 738     XtVaSetValues(sw, XmNworkWindow, HelpTextPanes[topic],
 739             XmNhorizontalScrollBar, hScrollBar,
 740             XmNverticalScrollBar, vScrollBar,
 741             NULL);
 742
 743     /* Initialize help style information, if it hasn't already been init'd */
 744     initHelpStyles (HelpTextPanes[topic]);
 745
 746     /* Put together the text to display and separate it into parallel text
 747        and style data for display by the widget */
 748     helpText = stitch (HelpTextPanes[topic], HelpText[topic], &styleData);
 749
 750     /* Stuff the text into the widget's text buffer */
 751     BufSetAll (TextGetBuffer (HelpTextPanes[topic]) , helpText);
 752     XtFree (helpText);
 753
 754     /* Create a style buffer for the text widget and fill it with the style
 755        data which was generated along with the text content */
 756     HelpStyleBuffers[topic] = BufCreate();
 757     BufSetAll(HelpStyleBuffers[topic], styleData);
 758     XtFree (styleData);
 759     TextDAttachHighlightData(((TextWidget)HelpTextPanes[topic])->text.textD,
 760             HelpStyleBuffers[topic], HelpStyleInfo, N_STYLES, '\0', NULL, NULL);
 761
 762     /* This shouldn't be necessary (what's wrong in text.c?) */
 763     HandleXSelections(HelpTextPanes[topic]);
 764
 765     /* Process dialog mnemonic keys */
 766     AddDialogMnemonicHandler(form, FALSE);
 767
 768     /* Set the default button */
 769     XtVaSetValues(form, XmNdefaultButton, closeBtn, NULL);
 770     XtVaSetValues(form, XmNcancelButton, closeBtn, NULL);
 771
 772     /* realize all of the widgets in the new window */
 773     RealizeWithoutForcingPosition(appShell);
 774
 775     /* Give the text pane the initial focus */
 776     XmProcessTraversal(HelpTextPanes[topic], XmTRAVERSE_CURRENT);
 777
 778     /* Make close command in window menu gracefully prompt for close */
 779     AddMotifCloseCallback(appShell, (XtCallbackProc)closeCB, appShell);
 780
 781     /* Initialize navigation information, if it hasn't already been init'd */
 782     initNavigationHistory();
 783
 784     /* Set the window title */
 785     setHelpWinTitle(appShell, topic);
 786
 787
 788 #ifdef EDITRES
 789     XtAddEventHandler (appShell, (EventMask)0, True,
 790             (XtEventHandler)_XEditResCheckMessages, NULL);
 791 #endif /* EDITRES */
 792
 793     return appShell;
 794 }
 795
 796 static void changeTopicOrRaise(int existingTopic, int newTopic) {
 797     if(HelpWindows[newTopic] == NULL)
 798     {
 799         changeWindowTopic(existingTopic, (enum HelpTopic) newTopic);
 800         adaptNavigationButtons(newTopic);
 801     } else
 802     {
 803         RaiseShellWindow(HelpWindows[newTopic], True);
 804         adaptNavigationButtons(existingTopic);
 805         adaptNavigationButtons(newTopic);
 806     }
 807
 808 }
 809
 810 /*
 811 ** Callbacks for window controls
 812 */
 813 static void closeCB(Widget w, XtPointer clientData, XtPointer callData)
 814 {
 815     int topic;
 816
 817     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 818         return;
 819
 820     /* I don't understand the mechanism by which this can be called with
 821        HelpWindows[topic] as NULL, but it has happened */
 822     XtDestroyWidget(HelpWindows[topic]);
 823     HelpWindows[topic] = NULL;
 824     if (HelpStyleBuffers[topic] != NULL)
 825     {
 826         BufFree(HelpStyleBuffers[topic]);
 827         HelpStyleBuffers[topic] = NULL;
 828     }
 829 }
 830
 831 static void prevTopicCB(Widget w, XtPointer clientData, XtPointer callData)
 832 {   int topic;
 833
 834     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 835         return; /* shouldn't happen */
 836
 837     topic--;
 838     if(topic >= 0)
 839         changeTopicOrRaise(topic+1, topic);
 840 }
 841
 842 static void nextTopicCB(Widget w, XtPointer clientData, XtPointer callData)
 843 {   int topic;
 844
 845     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 846         return; /* shouldn't happen */
 847
 848     topic++;
 849     if(topic < NUM_TOPICS)
 850         changeTopicOrRaise(topic-1, topic);
 851 }
 852
 853 static void bwHistoryCB(Widget w, XtPointer clientData, XtPointer callData)
 854 {   int topic, goTo;
 855
 856     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 857         return; /* shouldn't happen */
 858
 859     goTo=navHistBack[topic];
 860     if(goTo >= 0 && goTo < NUM_TOPICS)
 861     {
 862         navHistForw[goTo]=topic;
 863         changeTopicOrRaise(topic, goTo);
 864     }
 865 }
 866
 867 static void fwHistoryCB(Widget w, XtPointer clientData, XtPointer callData)
 868 {   int topic, goTo;
 869
 870     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 871         return; /* shouldn't happen */
 872
 873     goTo=navHistForw[topic];
 874     if(goTo >= 0 && goTo < NUM_TOPICS)
 875     {
 876         navHistBack[goTo]=topic;
 877         changeTopicOrRaise(topic, goTo);
 878     }
 879 }
 880
 881 static void searchHelpCB(Widget w, XtPointer clientData, XtPointer callData)
 882 {
 883     char promptText[DF_MAX_PROMPT_LENGTH];
 884     int response, topic;
 885     static char **searchHistory = NULL;
 886     static int nHistoryStrings = 0;
 887
 888     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 889         return; /* shouldn't happen */
 890     SetDialogFPromptHistory(searchHistory, nHistoryStrings);
 891     response = DialogF(DF_PROMPT, HelpWindows[topic], 3, "Find",
 892             "Search for:    (use up arrow key to recall previous)", promptText,
 893             "This Section", "All Sections", "Cancel");
 894     if (response == 3)
 895         return;
 896     AddToHistoryList(promptText, &searchHistory, &nHistoryStrings);
 897     searchHelpText(HelpWindows[topic], topic, promptText, response == 2, 0, 0);
 898 }
 899
 900 static void searchHelpAgainCB(Widget w, XtPointer clientData,
 901         XtPointer callData)
 902 {
 903     int topic;
 904
 905     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 906         return; /* shouldn't happen */
 907     searchHelpText(HelpWindows[topic], topic, LastSearchString,
 908             LastSearchWasAllTopics, LastSearchPos, LastSearchTopic);
 909 }
 910
 911 static void printCB(Widget w, XtPointer clientData, XtPointer callData)
 912 {
 913     int topic, helpStringLen;
 914     char *helpString;
 915
 916     if ((topic = findTopicFromShellWidget((Widget)clientData)) == -1)
 917         return; /* shouldn't happen */
 918
 919     helpString = TextGetWrapped(HelpTextPanes[topic], 0,
 920             TextGetBuffer(HelpTextPanes[topic])->length, &helpStringLen);
 921     PrintString(helpString, helpStringLen, HelpWindows[topic],
 922             HelpTitles[topic]);
 923     XtFree(helpString);
 924 }
 925
 926
 927 /*
 928 ** Find the topic and text position within that topic targeted by a hyperlink
 929 ** with name "link_name". Returns true if the link was successfully interpreted.
 930 */
 931 static int is_known_link(char *link_name, int *topic, int *textPosition)
 932 {
 933     Href * hypertext;
 934
 935     /*------------------------------
 936     * Direct topic links found here.
 937     *------------------------------*/
 938     for (*topic=0; HelpTitles[*topic] != NULL; (*topic)++)
 939     {
 940         if (strcmp (link_name, HelpTitles[*topic])  == 0)
 941         {
 942             *textPosition = 0;
 943             return 1;
 944         }
 945     }
 946
 947     /*------------------------------------
 948     * Links internal to topics found here.
 949     *------------------------------------*/
 950     for (hypertext = &H_R[0]; hypertext != NULL; hypertext = hypertext->next)
 951     {
 952         if (strcmp (link_name, hypertext->source)  == 0)
 953         {
 954             *topic  = hypertext->topic;
 955             *textPosition = hypertext->location;
 956             return 1;
 957         }
 958     }
 959
 960    return 0;
 961 }
 962
 963 /*
 964 ** Find the text of a hyperlink from a clicked character position somewhere
 965 ** within the hyperlink text, and display the help that it links to.
 966 */
 967 static void followHyperlink(int topic, int charPosition, int newWindow)
 968 {
 969     textDisp *textD = ((TextWidget)HelpTextPanes[topic])->text.textD;
 970     char * link_text;
 971     int    link_topic;
 972     int    link_pos;
 973     int end        = charPosition;
 974     int begin      = charPosition;
 975     char whatStyle = BufGetCharacter(textD->styleBuffer, end);
 976
 977     /*--------------------------------------------------
 978     * Locate beginning and ending of current text style.
 979     *--------------------------------------------------*/
 980     while (whatStyle == BufGetCharacter(textD->styleBuffer, ++end));
 981     while (whatStyle == BufGetCharacter(textD->styleBuffer, begin-1))  begin--;
 982
 983     link_text = BufGetRange (textD->buffer, begin, end);
 984
 985     if (is_known_link (link_text, &link_topic, &link_pos) )
 986     {
 987         if (HelpWindows[link_topic] != NULL)
 988         {
 989             RaiseShellWindow(HelpWindows[link_topic], True);
 990         } else
 991         {
 992             if (newWindow)
 993             {
 994                 HelpWindows[link_topic]
 995                         = createHelpPanel((enum HelpTopic) link_topic);
 996             } else
 997             {
 998                 changeWindowTopic(topic, (enum HelpTopic) link_topic);
 999             }
1000         }
1001         navHistBack[link_topic] = topic;
1002         navHistForw[topic] = link_topic;
1003         TextSetCursorPos(HelpTextPanes[link_topic], link_pos);
1004         adaptNavigationButtons(link_topic);
1005         adaptNavigationButtons(topic);
1006     }
1007     XtFree (link_text);
1008 }
1009
1010 static void helpFocusButtonsAP(Widget w, XEvent *event, String *args,
1011         Cardinal *nArgs)
1012 {
1013     XmProcessTraversal(w, XmTRAVERSE_NEXT_TAB_GROUP);
1014 }
1015
1016 /*
1017  * handler for help-button-action(<button-name>)
1018  * Calls the activate callback for the named button widget of the help text win.
1019  */
1020 static void helpButtonActionAP(Widget w, XEvent *event, String *args,
1021         Cardinal *nArgs)
1022 {
1023     char buf[80];
1024     int topic;
1025     Widget btn;
1026
1027     if(*nArgs != 1)
1028     {
1029         fprintf(stderr, "help-button-action: requires exactly one argument.\n");
1030         return;
1031     }
1032
1033     /* Find the topic being displayed by this widget */
1034     for (topic = 0; topic < NUM_TOPICS; topic++)
1035         if (HelpTextPanes[topic] == w)
1036             break;
1037
1038     if(topic == NUM_TOPICS || HelpWindows[topic] == NULL)
1039         return; /* Shouldn't happen */
1040
1041     /* Compose the button widget name */
1042     strcpy(&buf[0], "helpForm.");
1043     if (strlen(args[0]) <= 70)
1044     {
1045         strcat(&buf[0], args[0]);
1046     } else
1047     {
1048         fprintf(stderr, "help-button-action: argument too long");
1049         return;
1050     }
1051
1052     btn=XtNameToWidget(HelpWindows[topic], buf);
1053     if (btn)
1054     {
1055         XtCallCallbacks(btn, XmNactivateCallback, HelpWindows[topic]);
1056     } else
1057     {
1058         fprintf(stderr, "help-button-action: invalid argument: %s\n", args[0]);
1059     }
1060 }
1061
1062 /*
1063  * Handler for action help-hyperlink()
1064  * Arguments: none - init: record event position
1065  *            "current": if clicked on a link, follow link in same window
1066  *            "new":     if clicked on a link, follow link in new window
1067  *
1068  * With the 1st argument "current" or "new" this action can have two additional
1069  * arguments. These arguments must be valid names of XmText actions.
1070  * In this case, the action named in argument #2 is called if the action
1071  * help-hyperlink is about to follow the hyperlink. The Action in argument #3
1072  * is called if no hyperlink has been recognized at the current event position.
1073  */
1074 static void helpHyperlinkAP(Widget w, XEvent *event, String *args,
1075         Cardinal *nArgs)
1076 {
1077     XButtonEvent *e = (XButtonEvent *)event;
1078     int topic;
1079     textDisp *textD = ((TextWidget)w)->text.textD;
1080     int clickedPos, newWin;
1081     static int pressX=0, pressY=0;
1082
1083     /* called without arguments we just record coordinates */
1084     if (*nArgs == 0)
1085     {
1086         pressX = e->x;
1087         pressY = e->y;
1088         return;
1089     }
1090
1091     newWin = !strcmp(args[0], "new");
1092
1093     if(!newWin && strcmp(args[0], "current")) {
1094         fprintf(stderr, "help-hyperlink: Unrecognized argument %s\n", args[0]);
1095         return;
1096     }
1097
1098     /*
1099      * If for any reason (pointer moved - drag!, no hyperlink found)
1100      * this action can't follow a hyperlink then execute the the action
1101      * named in arg #3 (if provided)
1102      */
1103     if (abs(pressX - e->x) > CLICK_THRESHOLD
1104             || abs(pressY - e->y) > CLICK_THRESHOLD)
1105     {
1106         if (*nArgs == 3)
1107             XtCallActionProc(w, args[2], event, NULL, 0);
1108         return;
1109     }
1110
1111     clickedPos = TextDXYToCharPos(textD, e->x, e->y);
1112     /* Beware of possible EBCDIC coding! Use the mapping table. */
1113     if (BufGetCharacter(textD->styleBuffer, clickedPos) !=
1114            (char)AlphabetToAsciiTable[(unsigned char)STL_NM_LINK])
1115     {
1116         if (*nArgs == 3)
1117             XtCallActionProc(w, args[2], event, NULL, 0);
1118         return;
1119     }
1120
1121     /* Find the topic being displayed by this widget */
1122     for (topic = 0; topic < NUM_TOPICS; topic++)
1123         if (HelpTextPanes[topic] == w)
1124             break;
1125
1126     if (topic == NUM_TOPICS)
1127     {
1128         /* If we get here someone must have bound help-hyperlink to a non-help
1129          * text widget (!) Or some other really strange thing happened.
1130          */
1131         if (*nArgs == 3)
1132             XtCallActionProc(w, args[2], event, NULL, 0);
1133         return;
1134     }
1135
1136     /* If the action help-hyperlink had 3 arguments execute the action
1137      * named in arg #2 before really following the link.
1138      */
1139     if (*nArgs == 3)
1140         XtCallActionProc(w, args[1], event, NULL, 0);
1141
1142     followHyperlink(topic, clickedPos, newWin);
1143 }
1144
1145 /*
1146 ** Install the action for following hyperlinks in the help window
1147 */
1148 void InstallHelpLinkActions(XtAppContext context)
1149 {
1150     static XtActionsRec Actions[] =
1151     {
1152         {"help-hyperlink", helpHyperlinkAP},
1153         {"help-focus-buttons", helpFocusButtonsAP},
1154         {"help-button-action", helpButtonActionAP}
1155     };
1156
1157     XtAppAddActions(context, Actions, XtNumber(Actions));
1158 }
1159
1160 /*
1161 ** Search the help text.  If allSections is true, searches all of the help
1162 ** text, otherwise searches only in parentTopic.
1163 */
1164 static void searchHelpText(Widget parent, int parentTopic,
1165         const char *searchFor, int allSections, int startPos, int startTopic)
1166 {
1167     int topic, beginMatch, endMatch;
1168     int found = False;
1169     char * helpText  = NULL;
1170
1171     /* Search for the string */
1172     for (topic=startTopic; topic<NUM_TOPICS; topic++)
1173     {
1174         if (!allSections && topic != parentTopic)
1175             continue;
1176         helpText = stitch(parent, HelpText[topic], NULL);
1177
1178         if (SearchString(helpText, searchFor, SEARCH_FORWARD, SEARCH_LITERAL,
1179                 False, topic == startTopic ? startPos : 0, &beginMatch,
1180                 &endMatch, NULL, NULL, GetPrefDelimiters()))
1181         {
1182             found = True;
1183             XtFree(helpText);
1184             break;
1185         }
1186         XtFree(helpText);
1187     }
1188
1189     if (!found)
1190     {
1191         if (startPos != 0 || (allSections && startTopic != 0))
1192         {
1193             /* Wrap search */
1194             searchHelpText(parent, parentTopic, searchFor, allSections, 0, 0);
1195             return;
1196         }
1197         DialogF(DF_INF, parent, 1, "String Not Found", "String Not Found", "OK");
1198         return;
1199     }
1200
1201     /* update navigation history */
1202     if (parentTopic != topic)
1203     {
1204         navHistForw[parentTopic]= topic;
1205         navHistBack[topic]= parentTopic;
1206     }
1207
1208     /* If the appropriate window is already up, bring it to the top, if not,
1209        make the parent window become this topic */
1210     changeTopicOrRaise(parentTopic, topic);
1211     BufSelect(TextGetBuffer(HelpTextPanes[topic]), beginMatch, endMatch);
1212     TextSetCursorPos(HelpTextPanes[topic], endMatch);
1213
1214     /* Save the search information for search-again */
1215     strcpy(LastSearchString, searchFor);
1216     LastSearchTopic = topic;
1217     LastSearchPos = endMatch;
1218     LastSearchWasAllTopics = allSections;
1219 }
1220
1221 /*
1222 ** Change a help window to display a new topic.  (Help window data is stored
1223 ** and indexed by topic so if a given topic is already displayed or has been
1224 ** positioned by the user, it can be found and popped back up in the same
1225 ** place.)  To change the topic displayed, the stored data has to be relocated.
1226 */
1227 static void changeWindowTopic(int existingTopic, enum HelpTopic newTopic)
1228 {
1229     char *helpText, *styleData;
1230
1231     /* Relocate the window/widget/buffer information */
1232     if (newTopic != existingTopic)
1233     {
1234         HelpWindows[newTopic] = HelpWindows[existingTopic];
1235         HelpWindows[existingTopic] = NULL;
1236         HelpStyleBuffers[newTopic] = HelpStyleBuffers[existingTopic];
1237         HelpStyleBuffers[existingTopic] = NULL;
1238         HelpTextPanes[newTopic] = HelpTextPanes[existingTopic];
1239         HelpTextPanes[existingTopic] = NULL;
1240         setHelpWinTitle(HelpWindows[newTopic], newTopic);
1241     }
1242
1243     /* Set the existing text widget to display the new text.  Because it's
1244        highlighted, we have to turn off highlighting before changing the
1245        displayed text to prevent the text widget from trying to apply the
1246        old, mismatched, highlighting to the new text */
1247     helpText = stitch(HelpTextPanes[newTopic], HelpText[newTopic], &styleData);
1248     TextDAttachHighlightData(((TextWidget)HelpTextPanes[newTopic])->text.textD,
1249             NULL, NULL, 0, '\0', NULL, NULL);
1250     BufSetAll(TextGetBuffer(HelpTextPanes[newTopic]), helpText);
1251     XtFree(helpText);
1252     BufSetAll(HelpStyleBuffers[newTopic], styleData);
1253     XtFree(styleData);
1254     TextDAttachHighlightData(((TextWidget)HelpTextPanes[newTopic])->text.textD,
1255             HelpStyleBuffers[newTopic], HelpStyleInfo, N_STYLES, '\0', NULL,
1256             NULL);
1257 }
1258
1259 static int findTopicFromShellWidget(Widget shellWidget)
1260 {
1261     int i;
1262
1263     for (i=0; i<NUM_TOPICS; i++)
1264         if (shellWidget == HelpWindows[i])
1265             return i;
1266     return -1;
1267 }
1268
1269 static void initNavigationHistory(void) {
1270     static int doInitNavigationHistory = True;
1271     int i;
1272
1273     if (doInitNavigationHistory)
1274     {
1275         for (i=0; i<NUM_TOPICS; i++)
1276             navHistBack[i] = navHistForw[i] = -1;
1277
1278         doInitNavigationHistory = False;
1279     }
1280 }
1281
1282 #if XmVersion == 2000
1283 /* amai: This function may be called before the Motif part
1284          is being initialized. The following, public interface
1285          is known to initialize at least xmUseVersion.
1286          That interface is declared in <Xm/Xm.h> in Motif 1.2 only.
1287          As for Motif 2.1 we don't need this call anymore.
1288          This also holds for the Motif 2.1 version of LessTif
1289          releases > 0.93.0. */
1290 extern void XmRegisterConverters(void);
1291 #endif
1292
1293
1294 /* Print version info to stdout */
1295 void PrintVersion(void)
1296 {
1297     const char *text;
1298
1299 #if XmVersion < 2001
1300     XmRegisterConverters();  /* see comment above */
1301 #endif
1302     text = getBuildInfo();
1303     puts (text);
1304 }