2 * Copyright © 2006 Carl Worth
4 * This program is free software; you can redistribute it and\/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2, or (at your option)
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA."
22 /* Portably, schmortability. I want ease of programming. */
38 typedef struct _trie {
40 struct _trie *next[26];
43 typedef trie_t dict_t;
44 typedef trie_t *dict_cursor_t;
45 typedef uint32_t dict_entry_t;
47 /* Initialization and cleanup */
49 dict_init (dict_t *dict);
52 dict_fini (dict_t *dict);
54 /* Adding new words */
56 dict_add_word (dict_t *dict,
59 dict_add_words_from_file (dict_t *dict,
60 const char *filename);
62 /* Looking up an entry in the dictionary */
64 dict_lookup (dict_t *dict,
68 (*dict_entry_predicate_t) (dict_entry_t entry);
71 dict_count_if (dict_t *dict,
72 dict_entry_predicate_t predicate);
75 dict_count (dict_t *dict);
77 /* Querying a dictionary entry. The dict interface uses 1 bit.
78 * All of the remaining bits are available for application use.
80 #define DICT_ENTRY_FLAG_IS_WORD (1<<0)
82 #define DICT_ENTRY_IS_WORD(entry) ((entry) && ((*entry) & DICT_ENTRY_FLAG_IS_WORD))
84 /* Printing the dictionary */
86 dict_print (dict_t *dict);
89 dict_print_of_length (dict_t *dict,
94 dict_print_if (dict_t *dict,
95 dict_entry_predicate_t predicate);
98 dict_print_of_length_if (dict_t *dict,
101 dict_entry_predicate_t predicate);
104 dict_print_by_length_if (dict_t *dict,
105 dict_entry_predicate_t predicate);
107 /* More general callback-based iteration of all entries */
108 typedef void (* dict_action_t) (void *closure, char *word, dict_entry_t *entry);
111 dict_for_each (dict_t *dict,
112 dict_action_t action,
116 dict_for_each_of_length (dict_t *dict,
117 dict_action_t action,
123 dict_for_each_if (dict_t *dict,
124 dict_action_t action,
126 dict_entry_predicate_t predicate);
129 dict_for_each_of_length_if (dict_t *dict,
130 dict_action_t action,
134 dict_entry_predicate_t predicate);
136 /* Character-by-character perusal of the dictionary */
138 dict_root (dict_t *dict);
141 dict_cursor_next (dict_cursor_t cursor,
145 dict_cursor_resolve (dict_cursor_t cursor);
147 #define DICT_CURSOR_NIL NULL
149 #endif /* _DICT_H_ */