This is a work of art, it deserve nice comments :)
[xonotic/gmqcc.git] / correct.c
1 /*
2  * Copyright (C) 2012, 2013
3  *     Dale Weiler
4  *     Wolfgang Bumiller
5  * 
6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
7  * this software and associated documentation files (the "Software"), to deal in
8  * the Software without restriction, including without limitation the rights to
9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is furnished to do
11  * so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #include "gmqcc.h"
25
26 /*
27  * This is a very clever method for correcting mistakes in QuakeC code
28  * most notably when invalid identifiers are used or inproper assignments;
29  * we can proprly lookup in multiple dictonaries (depening on the rules
30  * of what the task is trying to acomplish) to find the best possible
31  * match.
32  *
33  *
34  * A little about how it works, and probability theory:
35  *
36  *  When given an identifier (which we will denote I), we're essentially
37  *  just trying to choose the most likely correction for that identifier.
38  *  (the actual "correction" can very well be the identifier itself).
39  *  There is actually no way to know for sure that certian identifers
40  *  such as "lates", need to be corrected to "late" or "latest" or any
41  *  other permutations that look lexically the same.  This is why we
42  *  must advocate the usage of probabilities.  This means that instead of
43  *  just guessing, instead we're trying to find the correction for C,
44  *  out of all possible corrections that maximizes the probability of C
45  *  for the original identifer I.
46  *
47  *  Thankfully there exists some theroies for probalistic interpretations
48  *  of data.  Since we're operating on two distictive intepretations, the
49  *  transposition from I to C. We need something that can express how much
50  *  degree of I should rationally change to become C.  this is called the
51  *  Bayesian interpretation. You can read more about it from here:
52  *  http://www.celiagreen.com/charlesmccreery/statistics/bayestutorial.pdf
53  *  (which is probably the only good online documentation for bayes theroy
54  *  no lie.  Everything else just sucks ..)  
55  * 
56  *  Bayes' Thereom suggests something like the following:
57  *      AC P(I|C) P(C) / P(I)
58  * 
59  *  However since P(I) is the same for every possibility of I, we can
60  *  completley ignore it giving just:
61  *      AC P(I|C) P(C)
62  *
63  *  This greatly helps visualize how the parts of the expression are performed
64  *  there is essentially three, from right to left we perform the following:
65  *
66  *  1: P(C), the probability that a proposed correction C will stand on its
67  *     own.  This is called the language model.
68  *
69  *  2: P(I|C), the probability that I would be used, when the programmer
70  *     really meant C.  This is the error model.
71  *
72  *  3: AC, the control mechanisim, an enumerator if you will, one that
73  *     enumerates all feasible values of C, to determine the one that
74  *     gives the greatest probability score.
75  * 
76  *  In reality the requirement for a more complex expression involving
77  *  two seperate models is considerably a waste.  But one must recognize
78  *  that P(C|I) is already conflating two factors.  It's just much simpler
79  *  to seperate the two models and deal with them explicitaly.  To properly
80  *  estimate P(C|I) you have to consider both the probability of C and
81  *  probability of the transposition from C to I.  It's simply much more
82  *  cleaner, and direct to seperate the two factors.
83  *
84  *  Research tells us that 80% to 95% of all spelling errors have an edit
85  *  distance no greater than one.  Knowing this we can optimize for most
86  *  cases of mistakes without taking a performance hit.  Which is what we
87  *  base longer edit distances off of.  Opposed to the original method of
88  *  I had concieved of checking everything.     
89  *  
90  * A little information on additional algorithms used:
91  *
92  *   Initially when I implemented this corrector, it was very slow.
93  *   Need I remind you this is essentially a brute force attack on strings,
94  *   and since every transformation requires dynamic memory allocations,
95  *   you can easily imagine where most of the runtime conflated.  Yes
96  *   It went right to malloc.  More than THREE MILLION malloc calls are
97  *   performed for an identifier about 16 bytes long.  This was such a
98  *   shock to me.  A forward allocator (or as some call it a bump-point
99  *   allocator, or just a memory pool) was implemented. To combat this.
100  *
101  *   But of course even other factors were making it slow.  Initially
102  *   this used a hashtable.  And hashtables have a good constant lookup
103  *   time complexity.  But the problem wasn't in the hashtable, it was
104  *   in the hashing (despite having one of the fastest hash functions
105  *   known).  Remember those 3 million mallocs? Well for every malloc
106  *   there is also a hash.  After 3 million hashes .. you start to get
107  *   very slow.  To combat this I had suggested burst tries to Blub.
108  *   The next day he had implemented them. Sure enough this brought
109  *   down the runtime by a factory > 100%
110  *
111  * Future Work (If we really need it)
112  *
113  *   Currently we can only distinguishes one source of error in the
114  *   language model we use.  This could become an issue for identifiers
115  *   that have close colliding rates, e.g colate->coat yields collate.
116  *
117  *   Currently the error model has been fairly trivial, the smaller the
118  *   edit distance the smaller the error.  This usually causes some un-
119  *   expected problems. e.g reciet->recite yields recipt.  For QuakeC
120  *   this could become a problem when lots of identifiers are involved. 
121  *
122  *   Our control mechanisim could use a limit, i.e limit the number of
123  *   sets of edits for distance X.  This would also increase execution
124  *   speed considerably.
125  */
126
127
128 #define CORRECT_POOLSIZE (128*1024*1024)
129 /*
130  * A forward allcator for the corrector.  This corrector requires a lot
131  * of allocations.  This forward allocator combats all those allocations
132  * and speeds us up a little.  It also saves us space in a way since each
133  * allocation isn't wasting a little header space for when NOTRACK isn't
134  * defined.
135  */    
136 static unsigned char **correct_pool_data = NULL;
137 static unsigned char  *correct_pool_this = NULL;
138 static size_t          correct_pool_addr = 0;
139
140 static GMQCC_INLINE void correct_pool_new(void) {
141     correct_pool_addr = 0;
142     correct_pool_this = (unsigned char *)mem_a(CORRECT_POOLSIZE);
143
144     vec_push(correct_pool_data, correct_pool_this);
145 }
146
147 static GMQCC_INLINE void *correct_pool_alloc(size_t bytes) {
148     void *data;
149     if (correct_pool_addr + bytes >= CORRECT_POOLSIZE)
150         correct_pool_new();
151
152     data               = correct_pool_this;
153     correct_pool_this += bytes;
154     correct_pool_addr += bytes;
155
156     return data;
157 }
158
159 static GMQCC_INLINE void correct_pool_delete(void) {
160     size_t i;
161     for (i = 0; i < vec_size(correct_pool_data); ++i)
162         mem_d(correct_pool_data[i]);
163
164     correct_pool_data = NULL;
165     correct_pool_this = NULL;
166     correct_pool_addr = 0;
167 }
168
169
170 static GMQCC_INLINE char *correct_pool_claim(const char *data) {
171     char *claim = util_strdup(data);
172     correct_pool_delete();
173     return claim;
174 }
175
176 /*
177  * A fast space efficent trie for a dictionary of identifiers.  This is
178  * faster than a hashtable for one reason.  A hashtable itself may have
179  * fast constant lookup time, but the hash itself must be very fast. We
180  * have one of the fastest hash functions for strings, but if you do a
181  * lost of hashing (which we do, almost 3 million hashes per identifier)
182  * a hashtable becomes slow.
183  */   
184 correct_trie_t* correct_trie_new() {
185     correct_trie_t *t = (correct_trie_t*)mem_a(sizeof(correct_trie_t));
186     t->value   = NULL;
187     t->entries = NULL;
188     return t;
189 }
190
191 void correct_trie_del_sub(correct_trie_t *t) {
192     size_t i;
193     for (i = 0; i < vec_size(t->entries); ++i)
194         correct_trie_del_sub(&t->entries[i]);
195     vec_free(t->entries);
196 }
197
198 void correct_trie_del(correct_trie_t *t) {
199     size_t i;
200     for (i = 0; i < vec_size(t->entries); ++i)
201         correct_trie_del_sub(&t->entries[i]);
202     vec_free(t->entries);
203     mem_d(t);
204 }
205
206 void* correct_trie_get(const correct_trie_t *t, const char *key) {
207     const unsigned char *data = (const unsigned char*)key;
208     while (*data) {
209         unsigned char ch = *data;
210         const size_t  vs = vec_size(t->entries);
211         size_t        i;
212         const correct_trie_t *entries = t->entries;
213         for (i = 0; i < vs; ++i) {
214             if (entries[i].ch == ch) {
215                 t = &entries[i];
216                 ++data;
217                 break;
218             }
219         }
220         if (i == vs)
221             return NULL;
222     }
223     return t->value;
224 }
225
226 void correct_trie_set(correct_trie_t *t, const char *key, void * const value) {
227     const unsigned char *data = (const unsigned char*)key;
228     while (*data) {
229         const size_t    vs      = vec_size(t->entries);
230         unsigned char   ch      = *data;
231         correct_trie_t *entries = t->entries;
232         size_t          i;
233
234         for (i = 0; i < vs; ++i) {
235             if (entries[i].ch == ch) {
236                 t = &entries[i];
237                 break;
238             }
239         }
240         if (i == vs) {
241             correct_trie_t *elem  = (correct_trie_t*)vec_add(t->entries, 1);
242
243             elem->ch      = ch;
244             elem->value   = NULL;
245             elem->entries = NULL;
246             t             = elem;
247         }
248         ++data;
249     }
250     t->value = value;
251 }
252
253
254 /*
255  * Implementation of the corrector algorithm commences. A very efficent
256  * brute-force attack (thanks to tries and mempool :-)).
257  */  
258 static size_t *correct_find(correct_trie_t *table, const char *word) {
259     return (size_t*)correct_trie_get(table, word);
260 }
261
262 static int correct_update(correct_trie_t* *table, const char *word) {
263     size_t *data = correct_find(*table, word);
264     if (!data)
265         return 0;
266
267     (*data)++;
268     return 1;
269 }
270
271 void correct_add(correct_trie_t* table, size_t ***size, const char *ident) {
272     size_t     *data = NULL;
273     const char *add  = ident;
274     
275     if (!correct_update(&table, add)) {
276         data  = (size_t*)mem_a(sizeof(size_t));
277         *data = 1;
278
279         vec_push((*size), data);
280         correct_trie_set(table, add, data);
281     }
282 }
283
284 void correct_del(correct_trie_t* dictonary, size_t **data) {
285     size_t       i;
286     const size_t vs = vec_size(data);
287
288     for (i = 0; i < vs; i++)
289         mem_d(data[i]);
290
291     vec_free(data);
292     correct_trie_del(dictonary);
293 }
294
295 /*
296  * _ is valid in identifiers. I've yet to implement numerics however
297  * because they're only valid after the first character is of a _, or
298  * alpha character.
299  */
300 static const char correct_alpha[] = "abcdefghijklmnopqrstuvwxyz"
301                                     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
302                                     "_"; /* TODO: Numbers ... */
303
304 /*
305  * correcting logic for the following forms of transformations:
306  *  1) deletion
307  *  2) transposition
308  *  3) alteration
309  *  4) insertion
310  *
311  * These functions could take an additional size_t **size paramater
312  * and store back the results of their new length in an array that
313  * is the same as **array for the memcmp in correct_exists. I'm just
314  * not able to figure out how to do that just yet.  As my brain is
315  * not in the mood to figure out that logic.  This is a reminder to
316  * do it, or for someone else to :-) correct_edit however would also
317  * need to take a size_t ** to carry it along (would all the argument
318  * overhead be worth it?)  
319  */
320 static size_t correct_deletion(const char *ident, char **array, size_t index) {
321     size_t       itr = 0;
322     const size_t len = strlen(ident);
323
324     for (; itr < len; itr++) {
325         char *a = (char*)correct_pool_alloc(len+1);
326         memcpy(a, ident, itr);
327         memcpy(a + itr, ident + itr + 1, len - itr);
328         array[index + itr] = a;
329     }
330
331     return itr;
332 }
333
334 static size_t correct_transposition(const char *ident, char **array, size_t index) {
335     size_t       itr = 0;
336     const size_t len = strlen(ident);
337
338     for (; itr < len - 1; itr++) {
339         char  tmp;
340         char *a = (char*)correct_pool_alloc(len+1);
341         memcpy(a, ident, len+1);
342         tmp      = a[itr];
343         a[itr  ] = a[itr+1];
344         a[itr+1] = tmp;
345         array[index + itr] = a;
346     }
347
348     return itr;
349 }
350
351 static size_t correct_alteration(const char *ident, char **array, size_t index) {
352     size_t       itr = 0;
353     size_t       jtr = 0;
354     size_t       ktr = 0;
355     const size_t len = strlen(ident);
356
357     for (; itr < len; itr++) {
358         for (jtr = 0; jtr < sizeof(correct_alpha)-1; jtr++, ktr++) {
359             char *a = (char*)correct_pool_alloc(len+1);
360             memcpy(a, ident, len+1);
361             a[itr] = correct_alpha[jtr];
362             array[index + ktr] = a;
363         }
364     }
365
366     return ktr;
367 }
368
369 static size_t correct_insertion(const char *ident, char **array, size_t index) {
370     size_t       itr = 0;
371     size_t       jtr = 0;
372     size_t       ktr = 0;
373     const size_t len = strlen(ident);
374
375     for (; itr <= len; itr++) {
376         for (jtr = 0; jtr < sizeof(correct_alpha)-1; jtr++, ktr++) {
377             char *a = (char*)correct_pool_alloc(len+2);
378             memcpy(a, ident, itr);
379             memcpy(a + itr + 1, ident + itr, len - itr + 1);
380             a[itr] = correct_alpha[jtr];
381             array[index + ktr] = a;
382         }
383     }
384
385     return ktr;
386 }
387
388 static GMQCC_INLINE size_t correct_size(const char *ident) {
389     /*
390      * deletion      = len
391      * transposition = len - 1
392      * alteration    = len * sizeof(correct_alpha)
393      * insertion     = (len + 1) * sizeof(correct_alpha)
394      */   
395
396     register size_t len = strlen(ident);
397     return (len) + (len - 1) + (len * (sizeof(correct_alpha)-1)) + ((len + 1) * (sizeof(correct_alpha)-1));
398 }
399
400 static char **correct_edit(const char *ident) {
401     size_t next;
402     char **find = (char**)correct_pool_alloc(correct_size(ident) * sizeof(char*));
403
404     if (!find)
405         return NULL;
406
407     next  = correct_deletion     (ident, find, 0);
408     next += correct_transposition(ident, find, next);
409     next += correct_alteration   (ident, find, next);
410     /*****/ correct_insertion    (ident, find, next);
411
412     return find;
413 }
414
415 /*
416  * We could use a hashtable but the space complexity isn't worth it
417  * since we're only going to determine the "did you mean?" identifier
418  * on error.
419  */   
420 static int correct_exist(char **array, size_t rows, char *ident) {
421     size_t itr;
422     for (itr = 0; itr < rows; itr++)
423         if (!memcmp(array[itr], ident, strlen(ident)))
424             return 1;
425
426     return 0;
427 }
428
429 static GMQCC_INLINE char **correct_known_resize(char **res, size_t *allocated, size_t size) {
430     size_t oldallocated = *allocated;
431     char **out;
432     if (size+1 < *allocated)
433         return res;
434
435     *allocated += 32;
436     out = correct_pool_alloc(sizeof(*res) * *allocated);
437     memcpy(out, res, sizeof(*res) * oldallocated);
438     return out;
439 }
440
441 static char **correct_known(correct_trie_t* table, char **array, size_t rows, size_t *next) {
442     size_t itr = 0;
443     size_t jtr = 0;
444     size_t len = 0;
445     size_t row = 0;
446     size_t nxt = 8;
447     char **res = correct_pool_alloc(sizeof(char *) * nxt);
448     char **end = NULL;
449
450     for (; itr < rows; itr++) {
451         end = correct_edit(array[itr]);
452         row = correct_size(array[itr]);
453
454         /* removing jtr=0 here speeds it up by 100ms O_o */
455         for (jtr = 0; jtr < row; jtr++) {
456             if (correct_find(table, end[jtr]) && !correct_exist(res, len, end[jtr])) {
457                 res        = correct_known_resize(res, &nxt, len+1);
458                 res[len++] = end[jtr];
459             }
460         }
461     }
462
463     *next = len;
464     return res;
465 }
466
467 static char *correct_maximum(correct_trie_t* table, char **array, size_t rows) {
468     char   *str = NULL;
469     size_t *itm = NULL;
470     size_t  itr = 0;
471     size_t  top = 0;
472
473     for (; itr < rows; itr++) {
474         if ((itm = correct_find(table, array[itr])) && (*itm > top)) {
475             top = *itm;
476             str = array[itr];
477         }
478     }
479
480     return str;
481 }
482
483 /*
484  * This is the exposed interface:
485  * takes a table for the dictonary a vector of sizes (used for internal
486  * probability calculation, and an identifier to "correct"
487  *
488  * the add function works the same.  Except the identifier is used to
489  * add to the dictonary.  
490  */
491 char *correct_str(correct_trie_t* table, const char *ident) {
492     char **e1      = NULL;
493     char **e2      = NULL;
494     char  *e1ident = NULL;
495     char  *e2ident = NULL;
496     size_t e1rows  = 0;
497     size_t e2rows  = 0;
498
499     correct_pool_new();
500
501     /* needs to be allocated for free later */
502     if (correct_find(table, ident))
503         return correct_pool_claim(ident);
504
505     if ((e1rows = correct_size(ident))) {
506         e1      = correct_edit(ident);
507
508         if ((e1ident = correct_maximum(table, e1, e1rows)))
509             return correct_pool_claim(e1ident);
510     }
511
512     e2 = correct_known(table, e1, e1rows, &e2rows);
513     if (e2rows && ((e2ident = correct_maximum(table, e2, e2rows))))
514         return correct_pool_claim(e2ident);
515
516
517     correct_pool_delete();
518     return util_strdup(ident);
519 }