Fix all the memleaks in the corrector. Holy shit, the amount of hours I wasted trying...
[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
97 static char *correct_strndup(const char *src, size_t n) {
98     char   *ret;
99     size_t  len = strlen(src);
100
101     if (n < len)
102         len = n;
103
104     if (!(ret = (char*)mem_a(len + 1)))
105         return NULL;
106
107     ret[len] = '\0';
108     return (char*)memcpy(ret, src, len);
109 }
110
111 static char *correct_concat(char *str1, char *str2, bool next) {
112     char *ret = NULL;
113
114 #if 0
115     if (!str1) {
116          str1 = mem_a(1);
117         *str1 = '\0';
118     }
119 #endif
120
121     str1 = mem_r (str1, strlen(str1) + strlen(str2) + 1);
122     ret  = strcat(str1, str2);
123
124     if (str2 && next)
125         mem_d(str2);
126
127     return ret;
128 }
129
130 /*
131  * correcting logic for the following forms of transformations:
132  *  1) deletion
133  *  2) transposition
134  *  3) alteration
135  *  4) insertion
136  */
137 static size_t correct_deletion(const char *ident, char **array, size_t index) {
138     size_t itr;
139     size_t len = strlen(ident);
140
141     for (itr = 0; itr < len; itr++) {
142         array[index + itr] = correct_concat (
143             correct_strndup (ident,       itr),
144             correct_strndup (ident+itr+1, len-(itr+1)),
145             true
146         );
147     }
148
149     return itr;
150 }
151
152 static size_t correct_transposition(const char *ident, char **array, size_t index) {
153     size_t itr;
154     size_t len = strlen(ident);
155
156     for (itr = 0; itr < len - 1; itr++) {
157         array[index + itr] = correct_concat (
158             correct_concat (
159                 correct_strndup(ident,     itr),
160                 correct_strndup(ident+itr+1, 1),
161                 true
162             ),
163             correct_concat (
164                 correct_strndup(ident+itr,   1),
165                 correct_strndup(ident+itr+2, len-(itr+2)),
166                 true
167             ),
168             true
169         );
170     }
171
172     return itr;
173 }
174
175 static size_t correct_alteration(const char *ident, char **array, size_t index) {
176     size_t itr;
177     size_t jtr;
178     size_t ktr;
179     size_t len    = strlen(ident);
180     char   cct[2] = { 0, 0 }; /* char code table, for concatenation */
181
182     for (itr = 0, ktr = 0; itr < len; itr++) {
183         for (jtr = 0; jtr < sizeof(correct_alpha); jtr++, ktr++) {
184             *cct = correct_alpha[jtr];
185             array[index + ktr] = correct_concat (
186                 correct_concat (
187                     correct_strndup(ident, itr),
188                     (char *) &cct,
189                     false
190                 ),
191                 correct_strndup (
192                     ident + (itr+1),
193                     len   - (itr+1)
194                 ),
195                 true
196             );
197         }
198     }
199
200     return ktr;
201 }
202
203 static size_t correct_insertion(const char *ident, char **array, size_t index) {
204     size_t itr;
205     size_t jtr;
206     size_t ktr;
207     size_t len    = strlen(ident);
208     char   cct[2] = { 0, 0 }; /* char code table, for concatenation */
209
210     for (itr = 0, ktr = 0; itr <= len; itr++) {
211         for (jtr = 0; jtr < sizeof(correct_alpha); jtr++, ktr++) {
212             *cct = correct_alpha[jtr];
213             array[index + ktr] = correct_concat (
214                 correct_concat (
215                     correct_strndup (ident, itr),
216                     (char *) &cct,
217                     false
218                 ),
219                 correct_strndup (
220                     ident+itr,
221                     len - itr
222                 ),
223                 true
224             );
225         }
226     }
227
228     return ktr;
229 }
230
231 static GMQCC_INLINE size_t correct_size(const char *ident) {
232     /*
233      * deletion      = len
234      * transposition = len - 1
235      * alteration    = len * sizeof(correct_alpha)
236      * insertion     = (len + 1) * sizeof(correct_alpha)
237      */   
238
239     register size_t len = strlen(ident);
240     return (len) + (len - 1) + (len * sizeof(correct_alpha)) + ((len + 1) * sizeof(correct_alpha));
241 }
242
243 static char **correct_edit(const char *ident) {
244     size_t next;
245     char **find = (char**)mem_a(correct_size(ident) * sizeof(char*));
246
247     if (!find)
248         return NULL;
249
250     next  = correct_deletion     (ident, find, 0);
251     next += correct_transposition(ident, find, next);
252     next += correct_alteration   (ident, find, next);
253     /*****/ correct_insertion    (ident, find, next);
254
255     return find;
256 }
257
258 /*
259  * We could use a hashtable but the space complexity isn't worth it
260  * since we're only going to determine the "did you mean?" identifier
261  * on error.
262  */   
263 static int correct_exist(char **array, size_t rows, char *ident) {
264     size_t itr;
265     for (itr = 0; itr < rows; itr++)
266         if (!strcmp(array[itr], ident))
267             return 1;
268
269     return 0;
270 }
271
272 static char **correct_known(ht table, char **array, size_t rows, size_t *next) {
273     size_t itr;
274     size_t jtr;
275     size_t len;
276     size_t row;
277     char **res = NULL;
278     char **end;
279
280     for (itr = 0, len = 0; itr < rows; itr++) {
281         end = correct_edit(array[itr]);
282         row = correct_size(array[itr]);
283
284         for (jtr = 0; jtr < row; jtr++) {
285             if (correct_find(table, end[jtr]) && !correct_exist(res, len, end[jtr])) {
286                 res        = mem_r(res, sizeof(char*) * (len + 1));
287                 res[len++] = end[jtr];
288             } else {
289                 mem_d(end[jtr]);
290             }
291         }
292
293         mem_d(end);
294     }
295
296     *next = len;
297     return res;
298 }
299
300 static char *correct_maximum(ht table, char **array, size_t rows) {
301     char   *str  = NULL;
302     size_t *itm  = NULL;
303     size_t  itr;
304     size_t  top;
305
306     for (itr = 0, top = 0; itr < rows; itr++) {
307         if ((itm = correct_find(table, array[itr])) && (*itm > top)) {
308             top = *itm;
309             str = array[itr];
310         }
311     }
312
313     return str;
314 }
315
316 static void correct_cleanup(char **array, size_t rows) {
317     size_t itr;
318     for (itr = 0; itr < rows; itr++)
319         mem_d(array[itr]);
320
321     mem_d(array);
322 }
323
324 /*
325  * This is the exposed interface:
326  * takes a table for the dictonary a vector of sizes (used for internal
327  * probability calculation, and an identifier to "correct"
328  *
329  * the add function works the same.  Except the identifier is used to
330  * add to the dictonary.  
331  */   
332 void correct_add(ht table, size_t ***size, const char *ident) {
333     size_t     *data = NULL;
334     const char *add  = ident;
335     
336     if (!correct_update(&table, add)) {
337         data  = (size_t*)mem_a(sizeof(size_t));
338         *data = 1;
339
340         vec_push((*size), data);
341         util_htset(table, add, data);
342     }
343 }
344
345 char *correct_correct(ht table, const char *ident) {
346     char **e1;
347     char **e2;
348     char  *e1ident;
349     char  *e2ident;
350     char  *found = util_strdup(ident);
351
352     size_t e1rows = 0;
353     size_t e2rows = 0;
354
355     /* needs to be allocated for free later */
356     if (correct_find(table, ident))
357         return found;
358
359     mem_d(found);
360     if ((e1rows = correct_size(ident))) {
361         e1      = correct_edit(ident);
362
363         if ((e1ident = correct_maximum(table, e1, e1rows))) {
364             found = util_strdup(e1ident);
365             correct_cleanup(e1, e1rows);
366             return found;
367         }
368     }
369
370     e2 = correct_known(table, e1, e1rows, &e2rows);
371     if (e2rows && ((e2ident = correct_maximum(table, e2, e2rows))))
372         found = util_strdup(e2ident);
373     
374     correct_cleanup(e1, e1rows);
375     correct_cleanup(e2, e2rows);
376     
377     return found;
378 }
379
380 void correct_del(ht dictonary, size_t **data) {
381     size_t i;
382     for (i = 0; i < vec_size(data); i++)
383         mem_d(data[i]);
384
385     vec_free(data);
386     util_htdel(dictonary);
387 }
388
389 int main() {
390     opts.debug = true;
391     opts.memchk = true;
392     con_init();
393
394     ht       t = util_htnew(1024);
395     size_t **d = NULL;
396
397     correct_add(t, &d, "hellobain");
398     correct_add(t, &d, "ellor");
399     correct_add(t, &d, "world");
400
401     printf("found identifiers: (2)\n");
402     printf(" 1: hellobain\n");
403     printf(" 2: ellor\n");
404     printf(" 3: world\n");
405
406     char *b = correct_correct(t, "rld");
407     char *a = correct_correct(t, "ello");
408     char *c = correct_correct(t, "helbain");
409
410     printf("invalid identifier: `%s` (did you mean: `%s`?)\n", "ello", a);
411     printf("invalid identifier: `%s` (did you mean: `%s`?)\n", "rld", b);
412     printf("invalid identifier: `%s` (did you mean: `%s`?)\n", "helbain", c);
413
414     correct_del(t, d);
415     mem_d(b);
416     mem_d(a);
417     mem_d(c);
418
419     /*util_meminfo();*/
420
421 }