lib/eggdrop/help.c File Reference

#include <eggdrop/eggdrop.h>

Go to the source code of this file.

Functions
int	help_init ()
int	help_shutdown ()
int	help_set_default_path (const char *path)
int	help_set_default_lang (const char *lang)
char *	help_parse_syntax (xml_node_t *node)
help_summary_t *	help_summarize_entry (xml_node_t *node)
int	help_parse_file (const char *fname)
help_summary_t *	help_lookup_summary (const char *name)
xml_node_t *	help_lookup_entry (help_summary_t *entry)
static void	localized_help_fname (char *buf, size_t size, const char *filename)
int	help_load_by_module (const char *name)
help_search_t *	help_search_new (const char *searchstr)
int	help_search_end (help_search_t *search)
help_summary_t *	help_search_result (help_search_t *search)
Variables
static const char	rcsid [] = "$Id: help.c,v 1.20 2004-10-17 05:14:06 stdarg Exp $"
static help_file_t **	help_files = NULL
static int	nhelp_files = 0
static help_section_t *	sections = NULL
static int	nsections = 0
static char *	help_path = NULL
static char *	help_lang_default = NULL
static char *	help_lang_fallback = "en_US"

---

Function Documentation

int help_init

(

)

Definition at line 36 of file help.c.

References help_lang_default, and help_path.

Referenced by eggdrop_init().

{
  help_path = strdup("help/");
  help_lang_default = strdup("en_US");
  return(0);
}

int help_load_by_module

(

const char *

name

)

Definition at line 210 of file help.c.

References help_lang_fallback, help_parse_file(), help_path, and localized_help_fname().

Referenced by core_init().

{
  char fullname[256], buf[256];

  snprintf(fullname, sizeof(fullname), "%s-commands.xml", name);
  localized_help_fname(buf, sizeof(buf), fullname);
  if (help_parse_file(buf)) {
    snprintf(buf, sizeof(buf), "%s/%s/%s", help_path, help_lang_fallback, fullname);
    help_parse_file(buf);
  }
  return(0);
}

xml_node_t* help_lookup_entry

(

help_summary_t *

entry

)

Definition at line 171 of file help.c.

References help_summary_t::file, help_summary_t::name, help_file_t::name, xml_node::next_sibling, xml_node_get_str(), xml_node_lookup(), xml_node_unlink(), and xml_parse_file().

Referenced by party_help().

{
  xml_node_t *root = xml_parse_file(entry->file->name);
  xml_node_t *node;
  char *name;

  node = xml_node_lookup(root, 0, "help", 0, 0);
  for (; node; node = node->next_sibling) {
    xml_node_get_str(&name, node, "name", 0, 0);
    if (name && !strcasecmp(name, entry->name)) {
      xml_node_unlink(node);
      break;
    }
  }
  return(node);
}

help_summary_t* help_lookup_summary

(

const char *

name

)

Definition at line 155 of file help.c.

References help_section_t::entries, help_summary_t::name, help_section_t::nentries, nsections, and NULL.

Referenced by party_help().

{
  int i, j;
  help_section_t *section;

  for (i = 0; i < nsections; i++) {
    section = sections+i;
    for (j = 0; j < section->nentries; j++) {
      if (!strcasecmp(section->entries[j]->name, name)) {
          return(section->entries[j]);
      }
    }
  }
  return(NULL);
}

int help_parse_file

(

const char *

fname

)

Definition at line 107 of file help.c.

References help_section_t::entries, help_summary_t::file, help_summarize_entry(), help_file_t::name, help_section_t::name, help_section_t::nentries, xml_node::next_sibling, nhelp_files, nsections, NULL, help_file_t::ref, xml_node_delete(), xml_node_get_vars(), and xml_parse_file().

Referenced by help_load_by_module().

{
  xml_node_t *root = xml_parse_file(fname);
  xml_node_t *node;
  char *secname;
  help_summary_t *entry;
  help_section_t *section;
  int i;

  if (!root) return(-1);

  xml_node_get_vars(root, "sn", "section", &secname, "help", &node);
  if (!secname || !node) {
    xml_node_delete(root);
    return(-1);
  }

  for (i = 0; i < nsections; i++) {
    if (!strcasecmp(sections[i].name, secname)) break;
  }
  if (i == nsections) {
    sections = realloc(sections, sizeof(*sections) * (nsections+1));
    sections[nsections].name = strdup(secname);
    sections[nsections].entries = NULL;
    sections[nsections].nentries = 0;
    nsections++;
  }
  section = sections+i;

  help_files = realloc(help_files, sizeof(*help_files) * (nhelp_files+1));
  help_files[nhelp_files] = malloc(sizeof(**help_files));
  help_files[nhelp_files]->name = strdup(fname);
  help_files[nhelp_files]->ref = 0;

  for (; node; node = node->next_sibling) {
    entry = help_summarize_entry(node);
    if (!entry) continue;
    entry->file = help_files[nhelp_files];
    help_files[nhelp_files]->ref++;
    section->entries = realloc(section->entries, sizeof(entry) * (section->nentries+1));
    section->entries[section->nentries] = entry;
    section->nentries++;
  }
  nhelp_files++;
  xml_node_delete(root);
  return(0);
}

char* help_parse_syntax

(

xml_node_t *

node

)

Definition at line 60 of file help.c.

References egg_mprintf(), xml_node::next_sibling, and xml_node_get_vars().

Referenced by help_summarize_entry().

{
  xml_node_t *arg;
  char *name, *syntax, *args, *args2, *argname;
  int optional;

  xml_node_get_vars(node, "sn", "name", &name, "args.arg", &arg);
  args = strdup("");
  for (; arg; arg = arg->next_sibling) {
    xml_node_get_vars(arg, "si", "name", &argname, "optional", &optional);
    if (!name) continue;
    if (optional) args2 = egg_mprintf("%s [%s]", args, argname);
    else args2 = egg_mprintf("%s <%s>", args, argname);
    free(args);
    args = args2;
  }
  syntax = egg_mprintf("%s%s", name, args);
  free(args);
  return(syntax);
}

int help_search_end

(

help_search_t *

search

)

Definition at line 232 of file help.c.

References help_search_t::search.

Referenced by party_help().

{
  free(search->search);
  free(search);
  return(0);
}

help_search_t* help_search_new

(

const char *

searchstr

)

Definition at line 223 of file help.c.

References help_search_t::search.

Referenced by party_help().

{
  help_search_t *search;

  search = calloc(1, sizeof(*search));
  search->search = strdup(searchstr);
  return(search);
}

help_summary_t* help_search_result

(

help_search_t *

search

)

Definition at line 239 of file help.c.

References help_search_t::curentry, help_search_t::cursection, help_section_t::entries, help_summary_t::name, help_section_t::nentries, nsections, NULL, help_search_t::search, and wild_match().

Referenced by party_help().

{
  help_section_t *section;
  help_summary_t *entry;

  if (search->cursection < 0 || search->curentry < 0 || !search->search) return(NULL);

  while (search->cursection < nsections) {
    section = sections+search->cursection;
    while (search->curentry < section->nentries) {
      entry = section->entries[search->curentry++];
      if (wild_match(search->search, entry->name)) return(entry);
    }
    search->cursection++;
    search->curentry = 0;
  }
  search->cursection = search->curentry = -1;
  return(NULL);
}

int help_set_default_lang

(

const char *

lang

)

Definition at line 54 of file help.c.

References help_lang_default, and str_redup().

{
  str_redup(&help_lang_default, lang);
  return(0);
}

int help_set_default_path

(

const char *

path

)

Definition at line 48 of file help.c.

References help_path, and str_redup().

Referenced by core_init().

{
  str_redup(&help_path, path);
  return(0);
}

int help_shutdown

(

)

Definition at line 43 of file help.c.

{
  return(0);
}

help_summary_t* help_summarize_entry

(

xml_node_t *

node

)

Definition at line 81 of file help.c.

References help_parse_syntax(), help_summary_t::name, NULL, help_summary_t::summary, help_summary_t::syntax, and xml_node_get_vars().

Referenced by help_parse_file().

{
  help_summary_t *entry;
  char *name, *summary, *syntax;
  int len;

  xml_node_get_vars(node, "ss", "name", &name, "summary", &summary);
  if (!name) return(NULL);

  syntax = help_parse_syntax(node);

  /* Allocate everything at once since it's static. */
  len = strlen(name) + strlen(syntax);
  if (summary) len += strlen(summary);
  entry = malloc(sizeof(*entry) + len + 3);
  entry->name = ((char *)entry) + sizeof(*entry);
  entry->syntax = entry->name + strlen(name)+1;
  entry->summary = entry->syntax + strlen(syntax)+1;
  strcpy(entry->name, name);
  strcpy(entry->syntax, syntax);
  if (summary) strcpy(entry->summary, summary);
  else entry->summary[0] = 0;
  free(syntax);
  return(entry);
}

static void localized_help_fname	(	char *	buf,
		size_t	size,
		const char *	filename
	)			[static]

Definition at line 188 of file help.c.

References help_lang_default, help_path, and NULL.

Referenced by help_load_by_module().

{
  char *lang;
  char *pos;

  lang = getenv("LANG");
  if (lang) {
    lang = strdup(lang);
    pos = strchr(lang, '.');
    if (pos == NULL) {
      free(lang);
      lang = strdup(help_lang_default);
    }
    else *pos = 0;
  } else {
    lang = strdup(help_lang_default);
  }

  snprintf(buf, size, "%s/%s/%s", help_path, lang, filename);
  free(lang);
}

---

Variable Documentation

help_file_t** help_files = NULL [static]

Definition at line 26 of file help.c.

char* help_lang_default = NULL [static]

Definition at line 33 of file help.c.

Referenced by help_init(), help_set_default_lang(), and localized_help_fname().

char* help_lang_fallback = "en_US" [static]

Definition at line 34 of file help.c.

Referenced by help_load_by_module().

char* help_path = NULL [static]

Definition at line 32 of file help.c.

Referenced by help_init(), help_load_by_module(), help_set_default_path(), and localized_help_fname().

int nhelp_files = 0 [static]

Definition at line 27 of file help.c.

Referenced by help_parse_file().

int nsections = 0 [static]

Definition at line 30 of file help.c.

Referenced by help_lookup_summary(), help_parse_file(), and help_search_result().

const char rcsid[] = "$Id: help.c,v 1.20 2004-10-17 05:14:06 stdarg Exp $" [static]

Definition at line 21 of file help.c.

help_section_t* sections = NULL [static]

Definition at line 29 of file help.c.