1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*** wordlist.c ***************************************************************
**
** This file is part of BibTool.
** It is distributed under the GNU General Public License.
** See the file COPYING for details.
**
** (c) 1996-2020 Gerd Neugebauer
**
** Net: gene@gerd-neugebauer.de
**
** 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, 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., 675 Mass Ave, Cambridge, MA 02139, USA.
**
**-----------------------------------------------------------------------------
** Description:
** This module contains functions which deal with lists of
** words. Those words are in fact simple strings. Thus this
** module provides a very general functionality, namely a list of
** strings and the associated methods.
**
******************************************************************************/
#include <bibtool/general.h>
#include <bibtool/error.h>
#include <bibtool/symbols.h>
#include <bibtool/wordlist.h>
/*****************************************************************************/
/* Internal Programs */
/*===========================================================================*/
/*****************************************************************************/
/* External Programs */
/*===========================================================================*/
/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------
** Function: add_word()
** Purpose: Put a string into a word list. The string itself is
** \emph{not} copied. Thus it is highly recommended to
** use symbols as words nevertheless this is not
** required as long as the string |s| persists as long as
** the word list exists.
**
** The second argument is a pointer to a |WordList|. This
** destination is modified by adding a new node. The use
** of a pointer allows a uniform treatment of empty and
** not empty word lists.
**
** If no memory is left then an error is raised and the program
** is terminated.
** Arguments:
** s String to add to the wordlist.
** wlp Pointer to a wordlist.
** Returns: nothing
**___________________________________________________ */
void add_word(sym, wlp) /* */
register Symbol sym; /* */
register WordList *wlp; /* */
{ register WordList wl; /* */
register int cmp = 1; /* */
/* */
while (*wlp != WordNULL /* */
&& (cmp=symcmp(ThisWord(*wlp), sym)) < 0) /* */
{ wlp = & NextWord(*wlp); } /* */
/* */
if ( cmp == 0 ) return; /* */
/* */
if ( (wl=(WordList)malloc(sizeof(SWordList))) == WordNULL )/* */
{ OUT_OF_MEMORY("WordList"); } /* */
/* */
LinkSymbol(sym); /* */
ThisWord(wl) = sym; /* */
NextWord(wl) = *wlp; /* */
*wlp = wl; /* */
} /*------------------------*/
/*-----------------------------------------------------------------------------
** Function: delete_word()
** Purpose: Remove a word from a |WordList|. Only the first
** appearance of such a word is removed. I a word is
** found which contains the same string as |s| then the
** associated node is removed from the list and the
** function |fct| is called to free the memory of the
** string in the |WordList| node if the function is not
** |NULL|. In this case the function returns
** |0|. Otherwise |1| is returned.
** Arguments:
** s Word to remove.
** wlp Pointer to the word list to modify.
** fct Function to call to free the memory occupied by the word.
** Returns: |0| if the word was not found. |1| otherwise.
**___________________________________________________ */
int delete_word(sym, wlp, fct) /* */
Symbol sym; /* */
WordList *wlp; /* */
void (*fct)_ARG((String)); /* */
{ WordList wl; /* */
int cmp = 1; /* */
while ( *wlp != WordNULL /* */
&& (cmp=symcmp(ThisWord(*wlp), sym)) < 0 )/* */
{ wlp = & NextWord(*wlp); } /* */
/* */
if ( cmp == 0 ) return 0; /* */
/* */
wl = *wlp; /* */
*wlp = NextWord(wl); /* */
if ( fct != NULL ) { (*fct)(SymbolValue(ThisWord(wl))); }/* */
free(wl); /* */
return 1; /* */
} /*------------------------*/
/*-----------------------------------------------------------------------------
** Function: free_words()
** Purpose: Release the memory allocated for a list of words.
** All nodes in the list are freed. The function |fct| is
** called to free the memory occupied by the string
** component if it is not |NULL|.
** Arguments:
** wlp Pointer to the |WordList|.
** fct Function to be called to free the memory of the word itself.
** If it is |NULL| then no function is called.
** Returns: nothing
**___________________________________________________ */
void free_words(wlp, fct) /* */
WordList *wlp; /* */
void (*fct)_ARG((Symbol)); /* */
{ WordList wl, next; /* */
/* */
if (wlp == NULL) return; /* */
/* */
if (fct != NULL) /* */
{ for ( wl = *wlp; wl; wl = next) /* */
{ next = NextWord(wl); /* */
(*fct)(ThisWord(wl)); /* */
free(wl); /* */
} /* */
} /* */
else /* */
{ for ( wl = *wlp; wl; wl = next) /* */
{ next = NextWord(wl); /* */
free(wl); /* */
} /* */
} /* */
*wlp = WordNULL; /* */
} /*------------------------*/
/*-----------------------------------------------------------------------------
** Function: foreach_word()
** Purpose: Applies the given function |fct| to all elements in
** the |WordList| as long as the function does not return
** 0. Thus it can be used to search for a specified word
** -- e.g. determined by matching against a
** template. Another application the the processing of
** all elements in the |WordList|. In this case |fct|
** must always return |true|.
** Arguments:
** wl WordList to traverse.
** fct function to apply.
** Returns: return value of last function or |true|.
**___________________________________________________ */
bool foreach_word(wl, fct) /* */
WordList wl; /* */
bool (*fct)_ARG((Symbol)); /* */
{ bool ret = true; /* */
while ( wl && (ret=(fct)(ThisWord(wl))) ) /* */
{ wl = NextWord(wl); } /* */
return ret; /* */
} /*------------------------*/
/*-----------------------------------------------------------------------------
** Function: find_word()
** Purpose: Look up a word in a word list. The comparison is done
** case insensitive.
** Arguments:
** s String to find.
** wl Word list to search in.
** Returns: |false| iff the word does not occur in the word list.
**___________________________________________________ */
bool find_word(s, wl) /* */
register String s; /* */
register WordList wl; /* */
{ /* */
while ( wl != WordNULL ) /* */
{ if (case_eq(SymbolValue(ThisWord(wl)), s)) /* */
{ return true; } /* */
wl = NextWord(wl); /* */
} /* */
/* */
return false; /* */
} /*------------------------*/
|
