1WNINTRO(3) WordNet™ Library Functions WNINTRO(3)
2
6 wnintro - introduction to WordNet library functions
7
9 This section of the WordNet Reference Manual contains manual pages that
10 describe the WordNet library functions and API.
11 Functions are organized into the following categories:
13 ┌────────────────┬──────────────┬─────────────┐
16 │Category │ Manual Page │ Object File │
17 ├────────────────┼──────────────┼─────────────┤
18 │Database Search │ wnsearch (3) │ search.o │
19 │Morphology │ morph (3) │ morph.o │
20 │Misc. Utility │ wnutil (3) │ wnutil.o │
21 │Binary Search │ binsrch (3) │ binsrch.o │
22 └────────────────┴──────────────┴─────────────┘
23 The WordNet library is used by all of the searching interfaces provided
24 with the various WordNet packages. Additional programs in the system,
25 such as grind(1), also use functions in this library.
26 The WordNet library is provided in both source and binary forms (on
28 some platforms) to allow users to build applications and tools to their
29 own specifications that utilize the WordNet database. We do not pro‐
30 vide programming support or assistance.
31 The code conforms to ANSI C standards. Functions are defined with
33 function prototypes. If you do not have a compiler that accepts proto‐
34 types, you must edit the source code and remove the prototypes before
35 compiling.
36
38 Not all library functions are listed below. Missing are mainly func‐
39 tions that are called by documented ones, or ones that were written for
40 specific applications or tools used during WordNet development. Data
41 structures are defined in wn.h.
42 Database Searching Functions (search.o)
45 findtheinfo Primary search function for WordNet database.
46 Returns formatted search results in text buf‐
47 fer. Used by WordNet interfaces to perform
48 requested search.
49 findtheinfo_ds Primary search function for WordNet database.
51 Returns search results in linked list data
52 structure.
53 is_defined Set bit for each search type that is valid for
55 the search word passed and return bit mask.
56 in_wn Set bit for each syntactic category that
58 search word is in.
59 index_lookup Find word in index file and return parsed
61 entry in data structure. Input word must be
62 exact match of string in database. Called by
63 getindex().
64 getindex Find word in index file, trying different
66 techniques - replace hyphens with underscores,
67 replace underscores with hyphens, strip
68 hyphens and underscores, strip periods.
69 read_synset Read synset from data file at byte offset
71 passed and return parsed entry in data struc‐
72 ture. Calls parse_synset().
73 parse_synset Read synset at current byte offset in file and
75 return parsed entry in data structure.
76 free_syns Free a synset linked list allocated by find‐
78 theinfo_ds().
79 free_synset Free a synset structure.
81 free_index Free an index structure.
83 traceptrs_ds Recursive search algorithm to trace a pointer
85 tree and return results in linked list.
86 do_trace Do requested search on synset passed returning
88 formatted output in buffer.
89 Morphology Functions (morph.o)
92 morphinit Open exception list files.
93 re_morphinit Close exception list files and reopen.
95 morphstr Try to find base form (lemma) of word or col‐
97 location in syntactic category passed. Calls
98 morphword() for each word in string passed.
99 morphword Try to find base form (lemma) of individual
101 word in syntactic category passed.
102 Utility Functions (wnutil.o)
105 wninit Top level function to open database files and
106 morphology exception lists.
107 re_wninit Top level function to close and reopen data‐
109 base files and morphology exception lists.
110 cntwords Count the number of underscore or space sepa‐
112 rated words in a string.
113 strtolower Convert string to lower case and remove trail‐
115 ing adjective marker if found.
116 ToLowerCase Convert string passed to lower case.
118 strsubst Replace all occurrences of from with to in
120 str.
121 getptrtype Return code for pointer type character passed.
123 getpos Return syntactic category code for string
125 passed.
126 getsstype Return synset type code for string passed.
128 FmtSynset Reconstruct synset string from synset pointer.
130 StrToPos Passed string for syntactic category, returns
132 corresponding integer value.
133 GetSynsetForSense Return synset for sense key passed.
135 GetDataOffset Find synset offset for sense.
137 GetPolyCount Find polysemy count for sense passed.
139 GetWORD Return word part of sense key.
141 GetPOS Return syntactic category code for sense key
143 passed.
144 WNSnsToStr Generate sense key for index entry passed.
146 GetValidIndexPointer Search for string and/or base form of word in
148 database and return index structure for word
149 if found.
150 GetWNSense Return sense number in database for sense key.
152 GetSenseIndex Return parsed sense index entry for sense key
154 passed.
155 default_display_message Default function to use as value of dis‐
157 play_message. Simply returns -1.
158 Binary Search Functions (binsrch.o)
161 bin_search General purpose binary search function to
162 search for key as first item on line in sorted
163 file.
164 copyfile Copy contents from one file to another.
166 replace_line Replace a line in a sorted file.
168 insert_line Insert a line into a sorted file.
170
172 wn.h WordNet include file of constants, data structures,
173 external declarations for global variables initial‐
174 ized in wnglobal.c. Also lists function prototypes
175 for library API. It must be included to use any
176 WordNet library functions.
177
179 All library functions that access the database files expect the files
180 to be open. The function wninit(3) must be called before other data‐
181 base access functions such as findtheinfo(3) or read_synset(3).
182 Inclusion of the header file wn.h is necessary.
184 The command line interface is a good example of a simple application
186 that uses several WordNet library functions.
187 Many of the library functions are passed or return syntactic category
189 or synset type information. The following table lists the possible
190 categories as integer codes, synset type constant names, syntactic cat‐
191 egory constant names, single characters and character strings.
192 ┌────────┬─────────────┬────────────────────┬──────┬─────────┐
195 │Integer │ Synset Type │ Syntactic Category │ Char │ String │
196 ├────────┼─────────────┼────────────────────┼──────┼─────────┤
197 │ 1 │ NOUN │ NOUN │ n │ noun │
198 │ 2 │ VERB │ VERB │ v │ verb │
199 │ 3 │ ADJ │ ADJ │ a │ adj │
200 │ 4 │ ADV │ ADV │ r │ adv │
201 │ 5 │ SATELLITE │ ADJ │ s │ n/a │
202 └────────┴─────────────┴────────────────────┴──────┴─────────┘
204 WNHOME Base directory for WordNet. Default is
205 /usr/local/WordNet-3.0.
206 WNSEARCHDIR Directory in which the WordNet database has been
208 installed. Default is WNHOME/dict.
209
211 HKEY_LOCAL_MACHINE\SOFTWARE\WordNet\3.0\WNHome
212 Base directory for WordNet. Default is C:\Pro‐
213 gram Files\WordNet\3.0.
214
216 lib/libwn.a WordNet library (Unix)
217 lib\wn.lib WordNet library (Windows)
219 include header files for use with WordNet library
221
223 wnintro(1), binsrch(3), morph(3), wnsearch(3), wnutil(3), wnintro(5),
224 wnintro(7).
225 Fellbaum, C. (1998), ed. "WordNet: An Electronic Lexical Database".
227 MIT Press, Cambridge, MA.
228
230 Please report bugs to wordnet@princeton.edu.
231WordNet 3.0 Dec 2006 WNINTRO(3)