help.c File Reference

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <stdlib.h>
#include "genC.h"
#include "constants.h"
#include "misc.h"
#include "top-level.h"

Include dependency graph for help.c:

Go to the source code of this file.

Macros
#define	BEGIN_STR   "BEGIN"
#define	END_STR   "END"

Functions
void	get_help_topics (gen_array_t array)
	help.c More...
void	get_help_topic (string topic, gen_array_t array)
void	pips_checks (void)
	add checkings here (FI: why in help.c?) SG : PIPS_ROOT should not be required :) More...

Macro Definition Documentation

BEGIN_STR

#define BEGIN_STR   "BEGIN"

Definition at line 39 of file help.c.

END_STR

#define END_STR   "END"

Definition at line 40 of file help.c.

Function Documentation

get_help_topic()

void get_help_topic	(	string	topic,
		gen_array_t	array
	)

Parameters

topic	opic
array	rray

Definition at line 64 of file help.c.

{
    FILE *fd;
    int selected = false, index=0;
    int begin_length, end_length;
 
    char *line;
 
 
    begin_length = strlen(BEGIN_STR);
    end_length = strlen(END_STR);
 
    fd = fopen_config(XV_HELP_RC, NULL,NULL);
        while ((line = safe_readline(fd)) != NULL) 
        {
            if (strncmp(line, BEGIN_STR, begin_length) == 0 &&
                strcmp(line + begin_length + 1, topic) == 0) {
                selected = true;
            } else if (strncmp(line, END_STR, end_length) == 0) {
                if (selected) break;
            }
            else if (selected) 
                gen_array_dupaddto(array, index++, line);
            free(line);
        }
 
    if (! selected)
        gen_array_dupaddto(array, index++, "Sorry: no help on this topic");
 
    fclose(fd);
}

References array, BEGIN_STR, END_STR, fopen_config(), free(), gen_array_dupaddto(), line, and safe_readline().

Referenced by display_help().

Here is the call graph for this function:

Here is the caller graph for this function:

get_help_topics()

void get_help_topics

(

gen_array_t

array

)

help.c

Parameters

array

rray

Definition at line 43 of file help.c.

{
    int index = 0, begin_length;
    FILE *fd;
    char *line;
 
 
    begin_length = strlen(BEGIN_STR);
 
    fd = fopen_config(XV_HELP_RC, NULL,NULL);
 
    while ((line = safe_readline(fd)) != NULL) {
        if (strncmp(line, BEGIN_STR, begin_length) == 0)
            gen_array_dupaddto(array, index++, line+begin_length+1);
        free(line);
    }
 
    fclose(fd);
}

References array, BEGIN_STR, fopen_config(), free(), gen_array_dupaddto(), line, and safe_readline().

Here is the call graph for this function:

pips_checks()

void pips_checks

(

void

)

add checkings here (FI: why in help.c?) SG : PIPS_ROOT should not be required :)

Definition at line 100 of file help.c.

{
        /*
    if (!getenv("PIPS_ROOT")) {
        (void) fprintf(stderr, "PIPS_ROOT environment variable not set. \n"
                       "Set it properly and relaunch.\n");
        exit(1);
    }
        */
}

Referenced by gpips_main(), pips_main(), tpips_init(), and wpips_main().

Here is the caller graph for this function: