help.c File Reference

#include "conq.h"
#include <fcntl.h>

Include dependency graph for help.c:

Classes
struct	histo
Defines
#define	HELP_PAGE_LAST   HELP_PAGE_CONCEPTS
#define	obstack_chunk_alloc   xmalloc
#define	obstack_chunk_free   free
#define	bcopy(a, b, c)   memcpy(b,a,c)
#define	HELP_PLAIN_TEXT_COLS_MAX   72
#define	HELP_PLAIN_TEXT_TRUNC_COL   (HELP_PLAIN_TEXT_COLS_MAX - 1)
#define	HELP_PLAIN_TEXT_IDX_TRUNC_COL   39
Functions
int	may_detonate (int u)
int	any_ut_capacity_x (int u)
int	any_mp_to_enter_unit (int u)
int	any_mp_to_leave_unit (int u)
int	any_enter_indep (int u)
void	set_help_output_cc (int cctarget)
void	set_help_output_mode (HelpOutputMode houtmode)
void	set_help_output_dir (char *dir)
void	set_help_toc_filep (FILE *htocfilep)
void	init_help (void)
void	create_game_help_nodes (void)
HelpNode *	create_help_node (void)
HelpNode *	add_help_node (char *key, void(*fn)(int t, char *key, TextBuffer *buf), int arg, HelpNode *prevnode)
HelpNode *	find_help_node (HelpNode *node, char *str)
char *	get_help_text (HelpNode *node)
void	describe_topics (int arg, char *key, TextBuffer *buf)
void	describe_command (int ch, char *name, char *help, int onechar, TextBuffer *buf)
void	append_blurb_strings (char *buf, Obj *notes)
void	notify_instructions (void)
void	print_any_news (void)
void	print_game_description_to_file (FILE *fp)
void	tbprintf (TextBuffer *buf, char *str,...)
void	tbcat (TextBuffer *buf, char *str)
void	tbcat_si (TextBuffer *buf, char *str)
void	tbcatline (TextBuffer *buf, char *str)
void	tbcatline_si (TextBuffer *buf, char *str)
FILE *	prep_help_file (char *hfilename)
void	write_help_toc_entry (char *hfilebname, char *sectionname, int indentlvl)
void	finish_help_file (FILE *hfilep)
void	write_help_file_header (FILE *hfile, char *headerdata)
void	write_help_file_footer (FILE *hfile, char *footerdata)
char *	help_file_brand (void)
char *	get_help_file_extension (void)
Variables
HelpNode *	first_help_node
	First Help Node.
HelpNode *	last_help_node
HelpNode *	help_system_node
HelpNode *	copying_help_node
HelpNode *	warranty_help_node
HelpNode *	default_prev_help_node

---

Define Documentation

#define bcopy (  a, b, c   )     memcpy(b,a,c)

#define HELP_PAGE_LAST   HELP_PAGE_CONCEPTS

#define HELP_PLAIN_TEXT_COLS_MAX   72

#define HELP_PLAIN_TEXT_IDX_TRUNC_COL   39

#define HELP_PLAIN_TEXT_TRUNC_COL   (HELP_PLAIN_TEXT_COLS_MAX - 1)

#define obstack_chunk_alloc   xmalloc

#define obstack_chunk_free   free

---

Function Documentation

HelpNode* add_help_node (  char *  key, void(*  fn)(int t, char *key, TextBuffer *buf), int  arg, HelpNode *  prevnode )

int any_enter_indep (  int  u  )

int any_mp_to_enter_unit (  int  u  )

int any_mp_to_leave_unit (  int  u  )

int any_ut_capacity_x (  int  u  )

void append_blurb_strings (  char *  buf, Obj *  notes )

void create_game_help_nodes (  void   )

HelpNode* create_help_node (  void   )

void describe_command (  int  ch, char *  name, char *  help, int  onechar, TextBuffer *  buf )

void describe_topics (  int  arg, char *  key, TextBuffer *  buf )

HelpNode* find_help_node (  HelpNode *  node, char *  str )

void finish_help_file (  FILE *  hfilep  )

char* get_help_file_extension (  void   )

char* get_help_text (  HelpNode *  node  )

char* help_file_brand (  void   )

void init_help (  void   )

int may_detonate (  int  u  )

void notify_instructions (  void   )

FILE* prep_help_file (  char *  hfilename  )

void print_any_news (  void   )

void print_game_description_to_file (  FILE *  fp  )

void set_help_output_cc (  int  cctarget  )

void set_help_output_dir (  char *  dir  )

void set_help_output_mode (  HelpOutputMode  houtmode  )

void set_help_toc_filep (  FILE *  htocfilep  )

void tbcat (  TextBuffer *  buf, char *  str )

void tbcat_si (  TextBuffer *  buf, char *  str )

void tbcatline (  TextBuffer *  buf, char *  str )

void tbcatline_si (  TextBuffer *  buf, char *  str )

void tbprintf (  TextBuffer *  buf, char *  str, ...  )

void write_help_file_footer (  FILE *  hfile, char *  footerdata )

void write_help_file_header (  FILE *  hfile, char *  headerdata )

void write_help_toc_entry (  char *  hfilebname, char *  sectionname, int  indentlvl )

---

Variable Documentation

HelpNode* copying_help_node

Pointer to "Copying" help node.

HelpNode* default_prev_help_node

HelpNode* first_help_node

First Help Node.

HelpNode* help_system_node

HelpNode* last_help_node

HelpNode* warranty_help_node

Pointer to "Warranty" help node.

---