help.c

Go to the documentation of this file.

/*
 
  $Id: help.c 23065 2016-03-02 09:05:50Z coelho $
 
  Copyright 1989-2016 MINES ParisTech
 
  This file is part of PIPS.
 
  PIPS is free software: you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  any later version.
 
  PIPS is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.
 
  See the GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with PIPS.  If not, see <http://www.gnu.org/licenses/>.
 
*/
#ifdef HAVE_CONFIG_H
    #include "pips_config.h"
#endif
 
#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"
 
#define BEGIN_STR       "BEGIN"
#define END_STR         "END"
 
void 
get_help_topics(gen_array_t array)
{
    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);
}
 
void 
get_help_topic(string topic, gen_array_t array)
{
    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);
}
 
/* add checkings here (FI: why in help.c?)
 * SG : PIPS_ROOT should not be required :)
 */
void 
pips_checks(void)
{
        /*
    if (!getenv("PIPS_ROOT")) {
        (void) fprintf(stderr, "PIPS_ROOT environment variable not set. \n"
                       "Set it properly and relaunch.\n");
        exit(1);
    }
        */
}