Screw you clang :-)
[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_POOL_SIZE (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_POOL_SIZE);
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_POOL_SIZE)
150         correct_pool_new();
151
152     data               = (void*)correct_pool_this;
153     correct_pool_this += bytes;
154     correct_pool_addr += bytes;
155     return data;
156 }
157
158 static GMQCC_INLINE void correct_pool_delete(void) {
159     size_t i;
160     for (i = 0; i < vec_size(correct_pool_data); ++i)
161         mem_d(correct_pool_data[i]);
162
163     correct_pool_data = NULL;
164     correct_pool_this = NULL;
165     correct_pool_addr = 0;
166 }
167
168
169 static GMQCC_INLINE char *correct_pool_claim(const char *data) {
170     char *claim = util_strdup(data);
171     correct_pool_delete();
172     return claim;
173 }
174
175 /*
176  * A fast space efficent trie for a dictionary of identifiers.  This is
177  * faster than a hashtable for one reason.  A hashtable itself may have
178  * fast constant lookup time, but the hash itself must be very fast. We
179  * have one of the fastest hash functions for strings, but if you do a
180  * lost of hashing (which we do, almost 3 million hashes per identifier)
181  * a hashtable becomes slow.
182  */   
183 correct_trie_t* correct_trie_new() {
184     correct_trie_t *t = (correct_trie_t*)mem_a(sizeof(correct_trie_t));
185     t->value   = NULL;
186     t->entries = NULL;
187     return t;
188 }
189
190 void correct_trie_del_sub(correct_trie_t *t) {
191     size_t i;
192     for (i = 0; i < vec_size(t->entries); ++i)
193         correct_trie_del_sub(&t->entries[i]);
194     vec_free(t->entries);
195 }
196
197 void correct_trie_del(correct_trie_t *t) {
198     size_t i;
199     for (i = 0; i < vec_size(t->entries); ++i)
200         correct_trie_del_sub(&t->entries[i]);
201     vec_free(t->entries);
202     mem_d(t);
203 }
204
205 void* correct_trie_get(const correct_trie_t *t, const char *key) {
206     const unsigned char *data = (const unsigned char*)key;
207
208     while (*data) {
209         const correct_trie_t *entries = t->entries;
210         unsigned char         ch      = *data;
211         const size_t          vs      = vec_size(entries);
212         size_t                i;
213
214         for (i = 0; i < vs; ++i) {
215             if (entries[i].ch == ch) {
216                 t = &entries[i];
217                 ++data;
218                 break;
219             }
220         }
221         if (i == vs)
222             return NULL;
223     }
224     return t->value;
225 }
226
227 void correct_trie_set(correct_trie_t *t, const char *key, void * const value) {
228     const unsigned char *data = (const unsigned char*)key;
229     while (*data) {
230         correct_trie_t *entries = t->entries;
231         const size_t    vs      = vec_size(entries);
232         unsigned char   ch      = *data;
233         size_t          i;
234
235         for (i = 0; i < vs; ++i) {
236             if (entries[i].ch == ch) {
237                 t = &entries[i];
238                 break;
239             }
240         }
241         if (i == vs) {
242             correct_trie_t *elem  = (correct_trie_t*)vec_add(t->entries, 1);
243
244             elem->ch      = ch;
245             elem->value   = NULL;
246             elem->entries = NULL;
247             t             = elem;
248         }
249         ++data;
250     }
251     t->value = value;
252 }
253
254
255 /*
256  * Implementation of the corrector algorithm commences. A very efficent
257  * brute-force attack (thanks to tries and mempool :-)).
258  */  
259 static GMQCC_INLINE size_t *correct_find(correct_trie_t *table, const char *word) {
260     return (size_t*)correct_trie_get(table, word);
261 }
262
263 static GMQCC_INLINE bool correct_update(correct_trie_t* *table, const char *word) {
264     size_t *data = correct_find(*table, word);
265     if (!data)
266         return false;
267
268     (*data)++;
269     return true;
270 }
271
272 void correct_add(correct_trie_t* table, size_t ***size, const char *ident) {
273     size_t     *data = NULL;
274     const char *add  = ident;
275     
276     if (!correct_update(&table, add)) {
277         data  = (size_t*)mem_a(sizeof(size_t));
278         *data = 1;
279
280         vec_push((*size), data);
281         correct_trie_set(table, add, data);
282     }
283 }
284
285 void correct_del(correct_trie_t* dictonary, size_t **data) {
286     size_t       i;
287     const size_t vs = vec_size(data);
288
289     for (i = 0; i < vs; i++)
290         mem_d(data[i]);
291
292     vec_free(data);
293     correct_trie_del(dictonary);
294 }
295
296 /*
297  * _ is valid in identifiers. I've yet to implement numerics however
298  * because they're only valid after the first character is of a _, or
299  * alpha character.
300  */
301 static const char correct_alpha[] = "abcdefghijklmnopqrstuvwxyz"
302                                     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
303                                     "_"; /* TODO: Numbers ... */
304
305 /*
306  * correcting logic for the following forms of transformations:
307  *  1) deletion
308  *  2) transposition
309  *  3) alteration
310  *  4) insertion
311  *
312  * These functions could take an additional size_t **size paramater
313  * and store back the results of their new length in an array that
314  * is the same as **array for the memcmp in correct_exists. I'm just
315  * not able to figure out how to do that just yet.  As my brain is
316  * not in the mood to figure out that logic.  This is a reminder to
317  * do it, or for someone else to :-) correct_edit however would also
318  * need to take a size_t ** to carry it along (would all the argument
319  * overhead be worth it?)  
320  */
321 static size_t correct_deletion(const char *ident, char **array, size_t index) {
322     size_t       itr = 0;
323     const size_t len = strlen(ident);
324
325     for (; itr < len; itr++) {
326         char *a = (char*)correct_pool_alloc(len+1);
327         memcpy(a, ident, itr);
328         memcpy(a + itr, ident + itr + 1, len - itr);
329         array[index + itr] = a;
330     }
331
332     return itr;
333 }
334
335 static size_t correct_transposition(const char *ident, char **array, size_t index) {
336     size_t       itr = 0;
337     const size_t len = strlen(ident);
338
339     for (; itr < len - 1; itr++) {
340         char  tmp;
341         char *a = (char*)correct_pool_alloc(len+1);
342         memcpy(a, ident, len+1);
343         tmp      = a[itr];
344         a[itr  ] = a[itr+1];
345         a[itr+1] = tmp;
346         array[index + itr] = a;
347     }
348
349     return itr;
350 }
351
352 static size_t correct_alteration(const char *ident, char **array, size_t index) {
353     size_t       itr = 0;
354     size_t       jtr = 0;
355     size_t       ktr = 0;
356     const size_t len = strlen(ident);
357
358     for (; itr < len; itr++) {
359         for (jtr = 0; jtr < sizeof(correct_alpha)-1; jtr++, ktr++) {
360             char *a = (char*)correct_pool_alloc(len+1);
361             memcpy(a, ident, len+1);
362             a[itr] = correct_alpha[jtr];
363             array[index + ktr] = a;
364         }
365     }
366
367     return ktr;
368 }
369
370 static size_t correct_insertion(const char *ident, char **array, size_t index) {
371     size_t       itr = 0;
372     size_t       jtr = 0;
373     size_t       ktr = 0;
374     const size_t len = strlen(ident);
375
376     for (; itr <= len; itr++) {
377         for (jtr = 0; jtr < sizeof(correct_alpha)-1; jtr++, ktr++) {
378             char *a = (char*)correct_pool_alloc(len+2);
379             memcpy(a, ident, itr);
380             memcpy(a + itr + 1, ident + itr, len - itr + 1);
381             a[itr] = correct_alpha[jtr];
382             array[index + ktr] = a;
383         }
384     }
385
386     return ktr;
387 }
388
389 static GMQCC_INLINE size_t correct_size(const char *ident) {
390     /*
391      * deletion      = len
392      * transposition = len - 1
393      * alteration    = len * sizeof(correct_alpha)
394      * insertion     = (len + 1) * sizeof(correct_alpha)
395      */   
396
397     register size_t len = strlen(ident);
398     return (len) + (len - 1) + (len * (sizeof(correct_alpha)-1)) + ((len + 1) * (sizeof(correct_alpha)-1));
399 }
400
401 static char **correct_edit(const char *ident) {
402     size_t next;
403     char **find = (char**)correct_pool_alloc(correct_size(ident) * sizeof(char*));
404
405     if (!find)
406         return NULL;
407
408     next  = correct_deletion     (ident, find, 0);
409     next += correct_transposition(ident, find, next);
410     next += correct_alteration   (ident, find, next);
411     /*****/ correct_insertion    (ident, find, next);
412
413     return find;
414 }
415
416 /*
417  * We could use a hashtable but the space complexity isn't worth it
418  * since we're only going to determine the "did you mean?" identifier
419  * on error.
420  */   
421 static int correct_exist(char **array, size_t rows, char *ident) {
422     size_t itr;
423     /*
424      * As an experiment I tried the following assembly for memcmp here:
425      *
426      * correct_cmp_loop: 
427      * incl %eax            ; eax =  LHS
428      * incl %edx            ; edx =  LRS
429      * cmpl %eax, %ebx      ; ebx = &LHS[END_POS]
430      *
431      * jbe correct_cmp_eq
432      * movb (%edx), %cl     ; micro-optimized on even atoms :-)
433      * cmpb %cl, (%eax)     ; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
434      * jg  correct_cmp_gt
435      * jge correct_cmp_loop
436      * ...
437      *
438      * Despite how much optimization went in to this, the speed was the
439      * being conflicted by the strlen(ident) used for &LHS[END_POS]
440      * If we could eliminate the strlen with what I suggested on line
441      * 311 ... we can accelerate this whole damn thing quite a bit.
442      *
443      * However there is still something we can do here that does give
444      * us a little more speed.  Although one more branch, we know for
445      * sure there is at least one byte to compare, if that one byte
446      * simply isn't the same we can skip the full check. Which means
447      * we skip a whole strlen call.
448      */
449     for (itr = 0; itr < rows; itr++) {
450         if (!memcmp(array[itr], ident, strlen(ident)))
451             return 1;
452     }
453
454     return 0;
455 }
456
457 static GMQCC_INLINE char **correct_known_resize(char **res, size_t *allocated, size_t size) {
458     size_t oldallocated = *allocated;
459     char **out;
460     if (size+1 < *allocated)
461         return res;
462
463     *allocated += 32;
464     out = correct_pool_alloc(sizeof(*res) * *allocated);
465     memcpy(out, res, sizeof(*res) * oldallocated);
466     return out;
467 }
468
469 static char **correct_known(correct_trie_t* table, char **array, size_t rows, size_t *next) {
470     size_t itr = 0;
471     size_t jtr = 0;
472     size_t len = 0;
473     size_t row = 0;
474     size_t nxt = 8;
475     char **res = correct_pool_alloc(sizeof(char *) * nxt);
476     char **end = NULL;
477
478     for (; itr < rows; itr++) {
479         end = correct_edit(array[itr]);
480         row = correct_size(array[itr]);
481
482         /* removing jtr=0 here speeds it up by 100ms O_o */
483         for (jtr = 0; jtr < row; jtr++) {
484             if (correct_find(table, end[jtr]) && !correct_exist(res, len, end[jtr])) {
485                 res        = correct_known_resize(res, &nxt, len+1);
486                 res[len++] = end[jtr];
487             }
488         }
489     }
490
491     *next = len;
492     return res;
493 }
494
495 static char *correct_maximum(correct_trie_t* table, char **array, size_t rows) {
496     char   *str = NULL;
497     size_t *itm = NULL;
498     size_t  itr = 0;
499     size_t  top = 0;
500
501     for (; itr < rows; itr++) {
502         if ((itm = correct_find(table, array[itr])) && (*itm > top)) {
503             top = *itm;
504             str = array[itr];
505         }
506     }
507
508     return str;
509 }
510
511 /*
512  * This is the exposed interface:
513  * takes a table for the dictonary a vector of sizes (used for internal
514  * probability calculation, and an identifier to "correct"
515  *
516  * the add function works the same.  Except the identifier is used to
517  * add to the dictonary.  
518  */
519 char *correct_str(correct_trie_t* table, const char *ident) {
520     char **e1      = NULL;
521     char **e2      = NULL;
522     char  *e1ident = NULL;
523     char  *e2ident = NULL;
524     size_t e1rows  = 0;
525     size_t e2rows  = 0;
526
527     correct_pool_new();
528
529     /* needs to be allocated for free later */
530     if (correct_find(table, ident))
531         return correct_pool_claim(ident);
532
533     if ((e1rows = correct_size(ident))) {
534         e1      = correct_edit(ident);
535
536         if ((e1ident = correct_maximum(table, e1, e1rows)))
537             return correct_pool_claim(e1ident);
538     }
539
540     e2 = correct_known(table, e1, e1rows, &e2rows);
541     if (e2rows && ((e2ident = correct_maximum(table, e2, e2rows))))
542         return correct_pool_claim(e2ident);
543
544
545     correct_pool_delete();
546     return util_strdup(ident);
547 }