Work on "did you mean? <ident>" support for errors. Using a three-part Bayes Theorem...
[xonotic/gmqcc.git] / correct.c
1 /*
2  * Copyright (C) 2012, 2013
3  *     Dale Weiler
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #include "gmqcc.h"
24
25 /*
26  * This is a very clever method for correcting mistakes in QuakeC code
27  * most notably when invalid identifiers are used or inproper assignments;
28  * we can proprly lookup in multiple dictonaries (depening on the rules
29  * of what the task is trying to acomplish) to find the best possible
30  * match.
31  *
32  *
33  * A little about how it works, and probability theory:
34  *
35  *  When given an identifier (which we will denote I), we're essentially
36  *  just trying to choose the most likely correction for that identifier.
37  *  (the actual "correction" can very well be the identifier itself).
38  *  There is actually no way to know for sure that certian identifers
39  *  such as "lates", need to be corrected to "late" or "latest" or any
40  *  other permutations that look lexically the same.  This is why we
41  *  must advocate the usage of probabilities.  This implies that we're
42  *  trying to find the correction for C, out of all possible corrections
43  *  that maximizes the probability of C for the original identifer I.
44  *
45  *  Bayes' Therom suggests something of the following:
46  *      AC P(I|C) P(C) / P(I)
47  *  Since P(I) is the same for every possibly I, we can ignore it giving
48  *      AC P(I|C) P(C)
49  *
50  *  This greatly helps visualize how the parts of the expression are performed
51  *  there is essentially three, from right to left we perform the following:
52  *
53  *  1: P(C), the probability that a proposed correction C will stand on its
54  *     own.  This is called the language model.
55  *
56  *  2: P(I|C), the probability that I would be used, when the programmer
57  *     really meant C.  This is the error model.
58  *
59  *  3: AC, the control mechanisim, which implies the enumeration of all
60  *     feasible values of C, and then determine the one that gives the
61  *     greatest probability score. Selecting it as the "correction"
62  *   
63  *
64  * The requirement for complex expression involving two models:
65  * 
66  *  In reality the requirement for a more complex expression involving
67  *  two seperate models is considerably a waste.  But one must recognize
68  *  that P(C|I) is already conflating two factors.  It's just much simpler
69  *  to seperate the two models and deal with them explicitaly.  To properly
70  *  estimate P(C|I) you have to consider both the probability of C and
71  *  probability of the transposition from C to I.  It's simply much more
72  *  cleaner, and direct to seperate the two factors.
73  */
74
75 /* some hashtable management for dictonaries */
76 static size_t *correct_find(ht table, const char *word) {
77     return (size_t*)util_htget(table, word);
78 }
79
80 static int correct_update(ht *table, const char *word) {
81     size_t *data = correct_find(*table, word);
82     if (!data)
83         return 0;
84
85     (*data)++;
86     return 1;
87 }
88
89
90 /*
91  * _ is valid in identifiers. I've yet to implement numerics however
92  * because they're only valid after the first character is of a _, or
93  * alpha character.
94  */
95 static const char correct_alpha[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_";
96 static char *correct_substr(const char *str, size_t off, size_t lim) {
97     char   *nstr;
98     size_t  slen = strlen(str);
99
100     /* lots of compares */
101     if ((lim > slen) || ((off + lim) > slen) || (slen < 1) || (!lim))
102         return NULL;
103
104     if (!(nstr = mem_a(lim + 1)))
105         return NULL;
106
107     strncpy(nstr, str+off, lim);
108     nstr[lim] = '\0';
109
110     return nstr;
111 }
112
113 static char *correct_concat(char *str1, char *str2) {
114     if (!str1) str1 = mem_a(1), *str1 = '\0';
115     if (!str2) str2 = mem_a(1), *str2 = '\0';
116
117     str1 = mem_r(str1, strlen(str1) + strlen(str2) + 1);
118     strcat(str1, str2);
119
120     return str1;
121 }
122
123 /*
124  * correcting logic for the following forms of transformations:
125  *  1) deletion
126  *  2) transposition
127  *  3) alteration
128  *  4) insertion
129  */
130 static size_t correct_deletion(const char *ident, char **array, size_t index) {
131     size_t itr;
132     size_t len = strlen(ident);
133
134     for (itr = 0; itr < len; itr++) {
135         array[index + itr] = correct_concat (
136             correct_substr (ident, 0,     itr),
137             correct_substr (ident, itr+1, len-(itr+1))
138         );
139     }
140
141     return itr;
142 }
143
144 static size_t correct_transposition(const char *ident, char **array, size_t index) {
145     size_t itr;
146     size_t len = strlen(ident);
147
148     for (itr = 0; itr < len - 1; itr++) {
149         array[index + itr] = correct_concat (
150             correct_concat (
151                 correct_substr(ident, 0,     itr),
152                 correct_substr(ident, itr+1, 1)
153             ),
154             correct_concat (
155                 correct_substr(ident, itr,   1),
156                 correct_substr(ident, itr+2, len-(itr+2))
157             )
158         );
159     }
160
161     return itr;
162 }
163
164 static size_t correct_alteration(const char *ident, char **array, size_t index) {
165     size_t itr;
166     size_t jtr;
167     size_t ktr;
168     size_t len    = strlen(ident);
169     char   cct[2] = { 0, 0 }; /* char code table, for concatenation */
170
171     for (itr = 0, ktr = 0; itr < len; itr++) {
172         for (jtr = 0; jtr < sizeof(correct_alpha); jtr++, ktr++) {
173             *cct = correct_alpha[jtr];
174             array[index + ktr] = correct_concat (
175                 correct_concat (
176                     correct_substr(ident, 0, itr),
177                     (char *) &cct
178                 ),
179                 correct_substr (
180                     ident,
181                     itr + 1,
182                     len - (itr + 1)
183                 )
184             );
185         }
186     }
187
188     return ktr;
189 }
190
191 static size_t correct_insertion(const char *ident, char **array, size_t index) {
192     size_t itr;
193     size_t jtr;
194     size_t ktr;
195     size_t len    = strlen(ident);
196     char   cct[2] = { 0, 0 }; /* char code table, for concatenation */
197
198     for (itr = 0, ktr = 0; itr <= len; itr++) {
199         for (jtr = 0; jtr < sizeof(correct_alpha); jtr++, ktr++) {
200             *cct = correct_alpha[jtr];
201             array[index + ktr] = correct_concat (
202                 correct_concat (
203                     correct_substr (ident, 0, itr),
204                     (char *) &cct
205                 ),
206                 correct_substr (
207                     ident,
208                     itr,
209                     len - itr
210                 )
211             );
212         }
213     }
214
215     return ktr;
216 }
217
218 static GMQCC_INLINE size_t correct_size(const char *ident) {
219     /*
220      * deletion      = len
221      * transposition = len - 1
222      * alteration    = len * sizeof(correct_alpha)
223      * insertion     = (len + 1) * sizeof(correct_alpha)
224      */   
225
226     register size_t len = strlen(ident);
227     return (len) + (len - 1) + (len * sizeof(correct_alpha)) + (len + 1) * sizeof(correct_alpha);
228 }
229
230 static char **correct_edit(const char *ident) {
231     size_t next;
232     char **find = mem_a(correct_size(ident) * sizeof(char*));
233
234     if (!find)
235         return NULL;
236
237     next  = correct_deletion     (ident, find, 0);
238     next += correct_transposition(ident, find, next);
239     next += correct_alteration   (ident, find, next);
240     /*****/ correct_insertion    (ident, find, next);
241
242     return find;
243 }
244
245 /*
246  * We could use a hashtable but the space complexity isn't worth it
247  * since we're only going to determine the "did you mean?" identifier
248  * on error.
249  */   
250 static int correct_exist(char **array, size_t rows, char *ident) {
251     size_t itr;
252     for (itr = 0; itr < rows; itr++)
253         if (!strcmp(array[itr], ident))
254             return 1;
255
256     return 0;
257 }
258
259 static char **correct_known(ht table, char **array, size_t rows, size_t *next) {
260     size_t itr;
261     size_t jtr;
262     size_t len;
263     size_t row;
264     char **res = NULL;
265     char **end;
266
267     for (itr = 0, len = 0; itr < rows; itr++) {
268         end = correct_edit(array[itr]);
269         row = correct_size(array[itr]);
270
271         for (jtr = 0; jtr < row; jtr++) {
272             if (correct_find(table, end[jtr]) && !correct_exist(res, len, end[jtr])) {
273                 res        = mem_r(res, sizeof(char*) * (len + 1));
274                 res[len++] = end[jtr];
275             }
276         }
277     }
278
279     *next = len;
280     return res;
281 }
282
283 static char *correct_maximum(ht table, char **array, size_t rows) {
284     char   *str  = NULL;
285     size_t *itm  = NULL;
286     size_t  itr;
287     size_t  top;
288
289     for (itr = 0, top = 0; itr < rows; itr++) {
290         if ((itm = correct_find(table, array[itr])) && (*itm > top)) {
291             top = *itm;
292             str = array[itr];
293         }
294     }
295
296     return str;
297 }
298
299 static void correct_cleanup(char **array, size_t rows) {
300     size_t itr;
301     for (itr = 0; itr < rows; itr++)
302         mem_d(array[itr]);
303 }
304
305 /*
306  * This is the exposed interface:
307  * takes a table for the dictonary a vector of sizes (used for internal
308  * probability calculation, and an identifier to "correct"
309  *
310  * the add function works the same.  Except the identifier is used to
311  * add to the dictonary.  
312  */   
313 void correct_add(ht table, size_t ***size, const char *ident) {
314     size_t     *data = NULL;
315     const char *add  = ident;
316     
317     if (!correct_update(&table, add)) {
318         data  = (size_t*)mem_a(sizeof(size_t));
319         *data = 1;
320
321         vec_push((*size), data);
322         util_htset(table, add, data);
323     }
324 }
325
326 char *correct_correct(ht table, const char *ident) {
327     char **e1;
328     char **e2;
329     char  *e1ident;
330     char  *e2ident;
331     char  *found = util_strdup(ident);
332
333     size_t e1rows;
334     size_t e2rows;
335
336     /* needs to be allocated for free later */
337     if (correct_find(table, ident))
338         return found;
339
340     mem_d(found);
341     if ((e1rows = correct_size(ident))) {
342         e1      = correct_edit(ident);
343
344         if ((e1ident = correct_maximum(table, e1, e1rows))) {
345             found = util_strdup(e1ident);
346             correct_cleanup(e1, e1rows);
347             mem_d(e1);
348             return found;
349         }
350     }
351
352     e2 = correct_known(table, e1, e1rows, &e2rows);
353     if (e2rows && ((e2ident = correct_maximum(table, e2, e2rows))))
354         found = util_strdup(e2ident);
355     
356     correct_cleanup(e1, e1rows);
357     correct_cleanup(e2, e2rows);
358
359     mem_d(e1);
360     mem_d(e2);
361     
362     return found;
363 }
364
365 void correct_del(ht dictonary, size_t **data) {
366     size_t i;
367     for (i = 0; i < vec_size(data); i++)
368         mem_d(data[i]);
369
370     vec_free(data);
371     util_htdel(dictonary);
372 }
373
374 int main() {
375     opts.debug = true;
376     opts.memchk = true;
377     con_init();
378
379     ht       t = util_htnew(1024);
380     size_t **d = NULL;
381
382     correct_add(t, &d, "hellobain");
383     correct_add(t, &d, "ellor");
384     correct_add(t, &d, "world");
385
386     printf("found identifiers: (2)\n");
387     printf(" 1: hello\n");
388     printf(" 2: world\n");
389
390     char *b = correct_correct(t, "rld");
391     char *a = correct_correct(t, "ello");
392
393     printf("%s, did you mean `%s` ?\n", "ello", a);
394     printf("%s, did you mean `%s` ?\n", "rld", b);
395
396     correct_del(t, d);
397     mem_d(b);
398     mem_d(a);
399
400     util_meminfo();
401
402 }