help.h

Go to the documentation of this file.

/* Help-related definitions for Xconq.
   Copyright (C) 1991-1994, 1996, 1998, 1999 Stanley T. Shebs.

Xconq 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 2, or (at your option)
any later version.  See the file COPYING.  */

/* \file kernel/help.h
 * \brief Help-related definitions for Xconq.
 */

/* \brief Node types. */
enum nodeclass {
    miscnode,           
    utypenode,          
    mtypenode,          
    ttypenode,          
    atypenode           
};

/* Help output carbon copies. */
#define HELP_OUTPUT_CC_NONE     0
#define HELP_OUTPUT_CC_FILES    1

/* \brief Help output mode. */
/* Postscript and PDF can be gotten from TexInfo or LaTeX. */
/* The idea behind magic text is to allow an UI to give a better presentation 
   of the help output. An alternative would be for the UI to parse /a subset 
   of?\ HTML directly /see doc/PROJECTS: I58\ */
typedef enum help_output_mode {
    HELP_OUTPUT_PLAIN_TEXT = 0,     
    HELP_OUTPUT_HTML,               
    HELP_OUTPUT_TEXI,               
    HELP_OUTPUT_XML,                
    HELP_OUTPUT_LATEX,              
    HELP_OUTPUT_MAGIC_TEXT          
} HelpOutputMode;

/* \brief Help page enumeration. */
typedef enum help_page {
    HELP_PAGE_NONE = 0,
    HELP_PAGE_MASTER_INDEX,
    HELP_PAGE_TOC,
    HELP_PAGE_COPYRIGHT,
    HELP_PAGE_WARRANTY,
    HELP_PAGE_NEWS,
    HELP_PAGE_INSTRUCTIONS,
    HELP_PAGE_GAME_OVERVIEW,
    HELP_PAGE_SCORING,
    HELP_PAGE_MODULES,
    HELP_PAGE_GAME_SETUP,
    HELP_PAGE_WORLD,
    HELP_PAGE_UTYPE,
    HELP_PAGE_TTYPE,
    HELP_PAGE_MTYPE,
    HELP_PAGE_ATYPE,
    HELP_PAGE_CONCEPTS
} HelpPage;

/* \brief Help page description struct. */
typedef struct help_page_defn {
    char *filebname;
    char *name;
    HelpPage tocpage;
    HelpPage prevpage;
    HelpPage nextpage;
} HelpPageDefn;

#include "obstack.h"

typedef struct a_textbuffer {
    char *text;                 
    int bufmax;                 
    struct obstack ostack;      
} TextBuffer;

typedef struct a_helpnode {
    char *key;                  
    void (*fn)(int arg, char *key, TextBuffer *buf);
    enum nodeclass nclass;      
    int arg;                    
    char *text;                 
    int textend;                
    struct a_helpnode *prev;    
    struct a_helpnode *next;    
} HelpNode;

extern HelpNode *first_help_node;

extern HelpNode *copying_help_node;
extern HelpNode *warranty_help_node;

extern void tbprintf(TextBuffer *buf, char *str, ...);
extern void tbcat(TextBuffer *buf, char *str);
extern void tbcat_si(TextBuffer *buf, char *str);
extern void tbcatline(TextBuffer *buf, char *str);
extern void tbcatline_si(TextBuffer *buf, char *str);

extern void init_help(void);
extern HelpNode *create_help_node(void);
extern HelpNode *add_help_node(char *key,
                               void (*fn)(int, char *, TextBuffer *),
                               int arg, HelpNode *prevnode);
extern HelpNode *find_help_node(HelpNode *node, char *str);
extern void create_game_help_nodes(void);
extern char *get_help_text(HelpNode *node);

extern void describe_topics(int arg, char *key, TextBuffer *buf);
extern void describe_command(int ch, char *name, char *help, int onechar, 
                             TextBuffer *buf);
extern void append_blurb_strings(char *buf, Obj *notes);
extern void notify_instructions(void);

extern void print_any_news(void);
extern void print_game_description_to_file(FILE *fp);

extern void describe_copyright(int arg, char *key, TextBuffer *buf);
extern void describe_warranty(int arg, char *key, TextBuffer *buf);

extern void set_help_output_cc(int cctarget);
extern void set_help_output_mode(HelpOutputMode houtmode);
extern void set_help_output_dir(char *);
extern void set_help_toc_filep(FILE *htocfilep);

extern FILE *prep_help_file(char *hfilename);
extern void finish_help_file(FILE *hfilep);
extern void write_help_file_header(FILE *hfile, char *headerdata);
extern void write_help_file_footer(FILE *hfile, char *footerdata);
extern void write_help_toc_entry(char *hfilebname, char *sectionname,
                                 int indentlvl);
extern char *help_file_brand(void);
extern char *get_help_file_extension(void);

---