lib/eggdrop/help.h File Reference

Go to the source code of this file.

Data Structures
struct	help_file_t
struct	help_summary_t
struct	help_section_t
struct	help_search_t
Functions
int	help_init ()
int	help_shutdown ()
int	help_set_default_path (const char *path)
int	help_set_default_lang (const char *lang)
int	help_count_sections ()
int	help_count_entries ()
int	help_load (const char *filename)
int	help_unload (const char *filename)
int	help_load_by_module (const char *name)
int	help_unload_by_module (const char *name)
help_summary_t *	help_lookup_summary (const char *name)
help_section_t *	help_lookup_section (const char *name)
xml_node_t *	help_lookup_entry (help_summary_t *entry)
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)

---

Function Documentation

int help_count_entries

(

)

int help_count_sections

(

)

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

(

const char *

filename

)

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_section_t* help_lookup_section

(

const char *

name

)

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_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);
}

int help_unload

(

const char *

filename

)

int help_unload_by_module

(

const char *

name

)