xv_help.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <xview/xview.h>
#include <xview/panel.h>
#include <xview/text.h>
#include "genC.h"
#include "top-level.h"
#include "wpips.h"
#include "xv_sizes.h"
#include "misc.h"

Include dependency graph for xv_help.c:

Go to the source code of this file.

Macros
#define	min(a, b)   ((a) < (b) ? (a) : (b))
#define	HELP_LINES   32
#define	PIPS_DOCUMENTATION_URL   "http://www.cri.ensmp.fr/pips"
	The URL of the PIPS documentation at the École des Mines de Paris: More...

Functions
void	display_help (char *topic)
static void	close_help_notify (Panel_item item, Event *event)
void	create_help_window ()
static void	help_notify (Menu menu, Menu_item menu_item)
static void	help_launch_pips_netscape (Menu menu, Menu_item menu_item)
static void	help_launch_pips_xmosaic (Menu menu, Menu_item menu_item)
void	create_help_menu ()

Variables
static Panel_item	lines [HELP_LINES]
static gen_array_t	help_list = (gen_array_t) NULL
	GRRRRRRRR FC. More...

Macro Definition Documentation

HELP_LINES

#define HELP_LINES   32

Definition at line 46 of file xv_help.c.

min

#define min	(		a,
			b
	)		((a) < (b) ? (a) : (b))

Definition at line 45 of file xv_help.c.

PIPS_DOCUMENTATION_URL

#define PIPS_DOCUMENTATION_URL   "http://www.cri.ensmp.fr/pips"

The URL of the PIPS documentation at the École des Mines de Paris:

Definition at line 49 of file xv_help.c.

Function Documentation

close_help_notify()

static void close_help_notify ( Panel_item  item, Event *  event  )

static

Definition at line 80 of file xv_help.c.

{
    gen_array_full_free(help_list), help_list = (gen_array_t) NULL;
    hide_window(help_frame);
}

References gen_array_full_free(), help_frame, help_list, and hide_window().

Referenced by create_help_window().

Here is the call graph for this function:

Here is the caller graph for this function:

create_help_menu()

void create_help_menu

(

)

Just a separator:

Align the Help button with the Quit button: XV_X, xv_get(quit_button, XV_X),

Definition at line 140 of file xv_help.c.

{
   Menu menu;
 
   menu = xv_create(XV_NULL, MENU_COMMAND_MENU, 
                    MENU_TITLE_ITEM,
                    "The PIPS documentation",
                    MENU_GEN_PIN_WINDOW, main_frame, "Help Menu",
                    MENU_ITEM,
                    MENU_STRING, "A few introductory words...",
                    MENU_CLIENT_DATA, strdup("Introduction"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Workspace\"...",
                    MENU_CLIENT_DATA, strdup("Workspace"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Module\"...",
                    MENU_CLIENT_DATA, strdup("Module"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Directory\"...",
                    MENU_CLIENT_DATA, strdup("Directory"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"View\"...",
                    MENU_CLIENT_DATA, strdup("View"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Transform/Edit\"...",
                    MENU_CLIENT_DATA, strdup("Transform/Edit"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Compile\"...",
                    MENU_CLIENT_DATA, strdup("Compile"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Options\"...",
                    MENU_CLIENT_DATA, strdup("Options"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    MENU_ITEM,
                    MENU_STRING, "A few words about \"Log\"...",
                    MENU_CLIENT_DATA, strdup("Log"),
                    MENU_NOTIFY_PROC, help_notify,
                    NULL,
                    /* Just a separator: */
                    WPIPS_MENU_SEPARATOR,
                    MENU_ACTION_ITEM, "The PIPS documentation on Internet with Netscape...",
                    help_launch_pips_netscape,
                    MENU_ACTION_ITEM, "The PIPS documentation on Internet with XMosaic...",
                    help_launch_pips_xmosaic,
                    NULL);
 
   (void) xv_create(main_panel, PANEL_BUTTON,
                    PANEL_LABEL_STRING, "Help ",
                    PANEL_ITEM_MENU, menu,
                    /* Align the Help button with the Quit button:
                    XV_X, xv_get(quit_button, XV_X), */
                    NULL);
}

References help_launch_pips_netscape(), help_launch_pips_xmosaic(), help_notify(), main_frame, main_panel, strdup(), and WPIPS_MENU_SEPARATOR.

Here is the call graph for this function:

create_help_window()

void create_help_window

(

)

Definition at line 90 of file xv_help.c.

{
   int i;
   Panel help_panel;
 
   help_panel = xv_create(help_frame, PANEL,
                          NULL);
 
   for (i = 0; i < HELP_LINES; i++) {
      lines[i] = xv_create(help_panel, PANEL_MESSAGE, 
                           XV_X, 15,
                           XV_Y, 15*(i+1),
                           0);
   }
 
   (void) xv_create(help_panel, PANEL_BUTTON,
                    PANEL_LABEL_STRING, "CLOSE",
                    XV_X, HELP_WIDTH/2-28,
                    XV_Y, 15*(HELP_LINES+1),
                    PANEL_NOTIFY_PROC, close_help_notify,
                    0);
 
 
}

References close_help_notify(), help_frame, HELP_LINES, help_panel, HELP_WIDTH, and lines.

Here is the call graph for this function:

display_help()

void display_help

(

char *

topic

)

lazy

Definition at line 55 of file xv_help.c.

{
   int i, n;
 
   if (!help_list) /* lazy */
       help_list = gen_array_make(0);
 
   get_help_topic(topic, help_list);
   n = gen_array_nitems(help_list);
 
   for (i = 0; i < min(HELP_LINES, n); i++) {
      xv_set(lines[i], PANEL_LABEL_STRING, 
             gen_array_item(help_list, i), 0);
   }
 
   for (i = min(HELP_LINES, n); i < HELP_LINES; i++) {
      xv_set(lines[i], PANEL_LABEL_STRING, "", 0);
   }
 
   unhide_window(help_frame);
}

References gen_array_item(), gen_array_make(), gen_array_nitems(), get_help_topic(), help_frame, HELP_LINES, help_list, lines, min, and unhide_window().

Referenced by help_notify().

Here is the call graph for this function:

Here is the caller graph for this function:

help_launch_pips_netscape()

static void help_launch_pips_netscape ( Menu  menu, Menu_item  menu_item  )

static

Definition at line 124 of file xv_help.c.

{
   system("netscape " PIPS_DOCUMENTATION_URL " &");
}

References PIPS_DOCUMENTATION_URL.

Referenced by create_help_menu().

Here is the caller graph for this function:

help_launch_pips_xmosaic()

static void help_launch_pips_xmosaic ( Menu  menu, Menu_item  menu_item  )

static

Definition at line 132 of file xv_help.c.

{
   system("xmosaic " PIPS_DOCUMENTATION_URL " &");
}

References PIPS_DOCUMENTATION_URL.

Referenced by create_help_menu().

Here is the caller graph for this function:

help_notify()

static void help_notify ( Menu  menu, Menu_item  menu_item  )

static

Definition at line 116 of file xv_help.c.

{
   display_help((char *) xv_get(menu_item, MENU_CLIENT_DATA));
}

References display_help().

Referenced by create_help_menu().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

help_list

gen_array_t help_list = (gen_array_t) NULL

static

GRRRRRRRR FC.

Definition at line 52 of file xv_help.c.

Referenced by close_help_notify(), and display_help().

lines

Panel_item lines[HELP_LINES]

static

Definition at line 51 of file xv_help.c.

Referenced by create_help_window(), and display_help().