/* ScummVM - Graphic Adventure Engine * * ScummVM is the legal property of its developers, whose names * are too numerous to list here. Please refer to the COPYRIGHT * file distributed with this source distribution. * * This program 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 * of the License, or (at your option) any later version. * This program 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 this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * $URL$ * $Id$ * */ #ifndef SCI_SCICORE_VOCABULARY_H #define SCI_SCICORE_VOCABULARY_H #include "common/str.h" #include "common/hashmap.h" #include "common/hash-str.h" #include "common/list.h" #include "sci/sci.h" namespace Sci { class ResourceManager; /*#define VOCABULARY_DEBUG */ /** Number of bytes allocated on the heap to store bad words if parsing fails */ #define PARSE_HEAP_SIZE 64 struct opcode { int type; Common::String name; }; enum { VOCAB_RESOURCE_CLASSES = 996, VOCAB_RESOURCE_SNAMES = 997, VOCAB_RESOURCE_OPCODES = 998, VOCAB_RESOURCE_KNAMES = 999, VOCAB_RESOURCE_SCI0_MAIN_VOCAB = 0, VOCAB_RESOURCE_SCI0_PARSE_TREE_BRANCHES = 900, VOCAB_RESOURCE_SCI0_SUFFIX_VOCAB = 901, VOCAB_RESOURCE_SCI1_MAIN_VOCAB = 900, VOCAB_RESOURCE_SCI1_PARSE_TREE_BRANCHES = 901, VOCAB_RESOURCE_SCI1_SUFFIX_VOCAB = 902, VOCAB_RESOURCE_SCI1_CHAR_TRANSFORMS = 913 }; enum { VOCAB_CLASS_PREPOSITION = 0x01, VOCAB_CLASS_ARTICLE = 0x02, VOCAB_CLASS_ADJECTIVE = 0x04, VOCAB_CLASS_PRONOUN = 0x08, VOCAB_CLASS_NOUN = 0x10, VOCAB_CLASS_INDICATIVE_VERB = 0x20, VOCAB_CLASS_ADVERB = 0x40, VOCAB_CLASS_IMPERATIVE_VERB = 0x80, VOCAB_CLASS_NUMBER = 0x001 }; #define VOCAB_CLASS_ANYWORD 0xff /* Anywords are ignored by the parser */ #define VOCAB_MAGIC_NUMBER_GROUP 0xffd /* 0xffe ? */ /* This word class is used for numbers */ #define VOCAB_TREE_NODES 500 /* Number of nodes for each parse_tree_node structure */ #define VOCAB_TREE_NODE_LAST_WORD_STORAGE 0x140 #define VOCAB_TREE_NODE_COMPARE_TYPE 0x146 #define VOCAB_TREE_NODE_COMPARE_GROUP 0x14d #define VOCAB_TREE_NODE_FORCE_STORAGE 0x154 #define SAID_COMMA 0xf0 #define SAID_AMP 0xf1 #define SAID_SLASH 0xf2 #define SAID_PARENO 0xf3 #define SAID_PARENC 0xf4 #define SAID_BRACKO 0xf5 #define SAID_BRACKC 0xf6 #define SAID_HASH 0xf7 #define SAID_LT 0xf8 #define SAID_GT 0xf9 #define SAID_TERM 0xff #define SAID_FIRST SAID_COMMA /* There was no 'last matching word': */ #define SAID_FULL_MATCH 0xffff #define SAID_NO_MATCH 0xfffe #define SAID_PARTIAL_MATCH 0xfffd #define SAID_LONG(x) ((x) << 8) struct ResultWord { int _class; /* Word class */ int _group; /* Word group */ }; typedef Common::List ResultWordList; typedef Common::HashMap WordMap; struct parse_rule_t { int id; /* non-terminal ID */ int first_special; /* first terminal or non-terminal */ int specials_nr; /* number of terminals and non-terminals */ int length; int data[1]; /* actual data (size 1 to avoid compiler warnings) */ }; struct parse_rule_list_t { int terminal; /* Terminal character this rule matches against or 0 for a non-terminal rule */ parse_rule_t *rule; parse_rule_list_t *next; }; struct suffix_t { int class_mask; /* the word class this suffix applies to */ int result_class; /* the word class a word is morphed to if it doesn't fail this check */ int alt_suffix_length; /* String length of the suffix */ int word_suffix_length; /* String length of the other suffix */ const char *alt_suffix; /* The alternative suffix */ const char *word_suffix; /* The suffix as used in the word vocabulary */ }; typedef Common::List SuffixList; struct synonym_t { int replaceant; /* The word group to replace */ int replacement; /* The replacement word group for this one */ }; typedef Common::List SynonymList; struct parse_tree_branch_t { int id; int data[10]; }; #define PARSE_TREE_NODE_LEAF 0 #define PARSE_TREE_NODE_BRANCH 1 struct parse_tree_node_t { short type; /* leaf or branch */ union { int value; /* For leaves */ short branches[2]; /* For branches */ } content; }; /** * Fills the given StringList with selector names. * Returns true upon success, false otherwise. */ bool vocab_get_snames(ResourceManager *resmgr, bool isOldSci0, Common::StringList &selectorNames); /** * Obtain the list of opcodes. * Returns true upon success, false otherwise. */ bool vocab_get_opcodes(ResourceManager *resmgr, Common::Array &opcodes); /** * Fills a StringList with kernel function names. * * This function reads the kernel function name table from resource_map, * and fills the given StringList with them. * The resulting list has the same format regardless of the format of the * name table of the resource (the format changed between version 0 and 1). */ void vocab_get_knames(ResourceManager *resmgr, Common::StringList &names); /** * Gets all words from the main vocabulary. * @param resmr The resource manager to read from * @param words A list of all words * @return true on success, false on failure */ bool vocab_get_words(ResourceManager *resmgr, WordMap &words); /** * Loads all suffixes from the suffix vocabulary. * @param resmgr Resource manager the resources are read from * @return true on success, false on failure */ bool vocab_get_suffixes(ResourceManager *resmgr, SuffixList &suffixes); /** * Frees all suffixes in the given list. * @param resmgr The resource manager to free from * @param suffixes: The suffixes to free */ void vocab_free_suffixes(ResourceManager *resmgr, SuffixList &suffixes); /** * Retrieves all grammar rules from the resource data. * @param resmgr Resource manager the rules are read from * @param branches The rules are stored into this Array * @return true on success, false on error */ bool vocab_get_branches(ResourceManager *resmgr, Common::Array &branches); /* Looks up a single word in the words and suffixes list ** Parameters: (char *) word: Pointer to the word to look up ** (int) word_len: Length of the word to look up ** (const WordMap &) words: List of words ** (SuffixList) suffixes: List of suffixes ** Returns : (const ResultWordList &) A list containing 1 or 0 words */ ResultWord vocab_lookup_word(const char *word, int word_len, const WordMap &words, const SuffixList &suffixes); /* Tokenizes a string and compiles it into word_ts. ** Parameters: (char *) sentence: The sentence to examine ** (const WordMap &) words: The words to scan for ** (SuffixList) suffixes: suffixes to scan for ** (char **) error: Points to a malloc'd copy of the offending text or to NULL on error ** (ResultWordList) retval: A list of word_ts containing the result, or NULL. ** Returns : true on success, false on failure ** On error, NULL is returned. If *error is NULL, the sentence did not contain any useful words; ** if not, *error points to a malloc'd copy of the offending word. ** The returned list may contain anywords. */ bool vocab_tokenize_string(ResultWordList &retval, const char *sentence, const WordMap &words, const SuffixList &suffixes, char **error); /* Constructs the Greibach Normal Form of the grammar supplied in 'branches' ** Parameters: (parse_tree_branch_t *) branches: The parser's branches ** Returns : (parse_rule_list_t *): Pointer to a list of singly linked ** GNF rules describing the same language ** that was described by 'branches' ** The original SCI rules are in almost-CNF (Chomsky Normal Form). Note that ** branch[0] is used only for a few magical incantations, as it is treated ** specially by the SCI parser. */ parse_rule_list_t *vocab_build_gnf(const Common::Array &branches); /* Frees a parser rule list as returned by vocab_build_gnf() ** Parameters: (parse_rule_list_t *) rule_list: The rule list to free */ void vocab_free_rule_list(parse_rule_list_t *rule_list); /* Builds a parse tree from a list of words ** Parameters: (parse_tree_node_t *) nodes: A node list to store the tree in (must have ** at least VOCAB_TREE_NODES entries) ** (const ResultWordList &) words: The words to build the tree from ** (parse_tree_branch_t *) branche0: The zeroeth original branch of the ** original CNF parser grammar ** (parse_rule_list *) rules: The GNF ruleset to parse with ** Returns : 0 on success, 1 if the tree couldn't be built in VOCAB_TREE_NODES nodes ** or if the sentence structure in 'words' is not part of the language ** described by the grammar passed in 'rules'. */ int vocab_build_parse_tree(parse_tree_node_t *nodes, const ResultWordList &words, const parse_tree_branch_t &branch0, parse_rule_list_t *rules); /* Prints a parse tree ** Parameters: (const char *) tree_name: Name of the tree to dump (free-form) ** (parse_tree_node_t *) nodes: The nodes containing the parse tree */ void vocab_dump_parse_tree(const char *tree_name, parse_tree_node_t *nodes); /* Builds a parse tree from a spec and compares it to a parse tree ** Parameters: (EngineState *) s: The affected state ** (byte *) spec: Pointer to the spec to build ** (int) verbose: Whether to display the parse tree after building it ** Returns : (int) 1 on a match, 0 otherwise */ int said(EngineState *s, byte *spec, int verbose); /** * Gets any word from the specified group. For debugging only. * @param group Group number * @param words List of words */ const char *vocab_get_any_group_word(int group, const WordMap &words); /* Decyphers a said block and dumps its content via sciprintf. ** Parameters: (EngineState *) s: The state to use ** (byte *) pos: Pointer to the data to dump ** For debugging only. */ void vocab_decypher_said_block(EngineState *s, byte *pos); /* Synonymizes a token list ** Parameters: (ResultWordList &) words: The word list to synonymize ** (const SynonymList &) synonyms: Synonym list */ void vocab_synonymize_tokens(ResultWordList &words, const SynonymList &synonyms); int vocab_gnf_parse(parse_tree_node_t *nodes, const ResultWordList &words, const parse_tree_branch_t &branch0, parse_rule_list_t *tlist, int verbose); void vocab_gnf_dump(const Common::Array &branches); } // End of namespace Sci #endif // SCI_SCICORE_VOCABULARY_H