gtk_help.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <sys/time.h>
#include <sys/resource.h>
#include "genC.h"
#include "top-level.h"
#include "misc.h"
#include <gtk/gtk.h>
#include "gpips.h"

Include dependency graph for gtk_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 (GtkWidget *widget, gpointer *data)
void	create_help_window ()
static void	help_notify (GtkWidget *widget, gpointer data)
static void	help_launch_pips_firefox (GtkWidget *widget, gpointer data)
void	create_help_menu ()

Variables
static GtkWidget *	lines [HELP_LINES]
static gen_array_t	help_list = (gen_array_t) NULL
	GRRRRRRRR FC. More...
static char *	menu_data []

Macro Definition Documentation

HELP_LINES

#define HELP_LINES   32

Definition at line 43 of file gtk_help.c.

min

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

Definition at line 42 of file gtk_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 46 of file gtk_help.c.

Function Documentation

close_help_notify()

static void close_help_notify ( GtkWidget *  widget, gpointer *  data  )

static

Definition at line 73 of file gtk_help.c.

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

References gen_array_full_free(), help_list, help_window, 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

(

)

Definition at line 132 of file gtk_help.c.

                        {
        guint i;
        GtkWidget *help_menu, *help_menu_item;
        help_menu = gtk_menu_new();
        help_menu_item = gtk_menu_item_new_with_label("Help");
        gtk_menu_item_set_submenu(GTK_MENU_ITEM(help_menu_item), help_menu);
 
        GtkWidget * menu_item;
        for (i = 0; i < 9; i++) {
                menu_item = gtk_menu_item_new_with_label(menu_data[i * 2]);
                g_signal_connect(G_OBJECT(menu_item), "activate", G_CALLBACK(
                                help_notify), menu_data[i * 2 + 1]);
                gtk_menu_append(GTK_MENU(help_menu), menu_item);
        }
 
        gtk_menu_append(GTK_MENU(help_menu), gtk_separator_menu_item_new());
 
        menu_item = gtk_menu_item_new_with_label(
                        "The PIPS documentation on Internet with Firefox...");
        g_signal_connect(G_OBJECT(menu_item), "activate", G_CALLBACK(
                        help_launch_pips_firefox), NULL);
        gtk_menu_append(GTK_MENU(help_menu), menu_item);
 
        gtk_widget_show(help_menu_item);
        gtk_widget_show_all(help_menu);
        gtk_menu_bar_append(main_window_menu_bar, help_menu_item);
}

References help_launch_pips_firefox(), help_notify(), main_window_menu_bar, and menu_data.

Referenced by create_menus().

Here is the call graph for this function:

Here is the caller graph for this function:

create_help_window()

void create_help_window

(

)

Definition at line 78 of file gtk_help.c.

                          {
        guint i;
        GtkWidget *vbox;
        GtkWidget *close_button;
        //      help_panel = xv_create(help_frame, PANEL, NULL);
        help_frame = gtk_frame_new(NULL);
        gtk_container_add(GTK_CONTAINER(help_window), help_frame);
 
        // Literal translation from XV
        // need to put in in a more gtk-like form
        vbox = gtk_vbox_new(FALSE, 0);
        for (i = 0; i < HELP_LINES; i++) {
                //              lines[i] = xv_create(help_panel, PANEL_MESSAGE, XV_X, 15, XV_Y, 15*
                //                              (i +1),
                //                              0);
                //                      }
                lines[i] = gtk_label_new(NULL);
                gtk_box_pack_start(GTK_BOX(vbox), lines[i], FALSE, FALSE, 0);
                gtk_widget_show(lines[i]);
        }
        //      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);
        close_button = gtk_button_new_with_label("CLOSE");
        gtk_box_pack_start(GTK_BOX(vbox), close_button, FALSE, FALSE, 15);
        gtk_widget_show(close_button);
 
        gtk_container_add(GTK_CONTAINER(help_frame), vbox);
 
        gtk_signal_connect(GTK_OBJECT(close_button), "clicked", GTK_SIGNAL_FUNC(
                        close_help_notify), NULL);
 
        gtk_widget_show_all(help_frame);
}

References close_help_notify(), help_frame, HELP_LINES, help_window, and lines.

Referenced by gpips_main(), and wpips_main().

Here is the call graph for this function:

Here is the caller graph for this function:

display_help()

void display_help

(

char *

topic

)

Definition at line 50 of file gtk_help.c.

                                {
        int i, n;
 
        if(help_list != NULL)
                gen_array_free(help_list);
        //      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++) {
                gtk_label_set_text(GTK_LABEL(lines[i]), gen_array_item(help_list, 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++) {
                gtk_label_set_text(GTK_LABEL(lines[i]), "");
        }
 
        gtk_widget_show_all(help_window);
}

References gen_array_free(), gen_array_item(), gen_array_make(), gen_array_nitems(), get_help_topic(), HELP_LINES, help_list, help_window, lines, and min.

Referenced by help_notify(), help_query_notify(), mchoose_help_notify(), and schoose_help_notify().

Here is the call graph for this function:

Here is the caller graph for this function:

help_launch_pips_firefox()

static void help_launch_pips_firefox ( GtkWidget *  widget, gpointer  data  )

static

Definition at line 119 of file gtk_help.c.

                                                                        {
        safe_system("firefox " PIPS_DOCUMENTATION_URL " &");
}

References PIPS_DOCUMENTATION_URL, and safe_system().

Referenced by create_help_menu().

Here is the call graph for this function:

Here is the caller graph for this function:

help_notify()

static void help_notify ( GtkWidget *  widget, gpointer  data  )

static

Definition at line 114 of file gtk_help.c.

                                                           {
        //      display_help((char *) xv_get(menu_item, MENU_CLIENT_DATA));
        display_help((char *) 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 48 of file gtk_help.c.

Referenced by close_help_notify(), and display_help().

lines

GtkWidget* lines[HELP_LINES]

static

Definition at line 47 of file gtk_help.c.

Referenced by clean_file(), create_help_window(), display_help(), and ensure_comment_consistency().

menu_data

char* menu_data[]

static

Initial value:

= { "A few introductory words...", "Introduction",
                "A few words about \"Workspace\"...", "Workspace",
                "A few words about \"Module\"...", "Module",
                "A few words about \"Directory\"...", "Directory",
                "A few words about \"View\"...", "View",
                "A few words about \"Transform/Edit\"...", "Transform/Edit",
                "A few words about \"Compile\"...", "Compile",
                "A few words about \"Options\"...", "Options",
                "A few words about \"Log\"...", "Log" }

Definition at line 122 of file gtk_help.c.

Referenced by create_help_menu().