home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Programming / Python1.4_Source / Modules / soundex.c < prev    next >
Encoding:
C/C++ Source or Header  |  1998-06-24  |  4.0 KB  |  181 lines
  1. /*
  2.   [Header: soundexmodule.c,v 1.2 95/05/02 15:40:45 dwwillia Exp ]
  3.   
  4.   Perform soundex comparisons on strings.
  5.  
  6.   Soundex is an algorithm that hashes English strings into numerical value.
  7.   Strings that sound the same are hashed to the same value.  This allows 
  8.   for non-literal string matching.
  9.  
  10.   From: David Wayne Williams <dwwillia@iucf.indiana.edu>
  11.  
  12.   Apr 29 1996 - added get_soundex method that returns the soundex of a
  13.                 string (chrish@qnx.com)
  14.   May 2 1996  - added doc strings (chrish@qnx.com)
  15. */
  16.  
  17. #include <string.h>
  18. #include <ctype.h>
  19. #include "Python.h"
  20.  
  21. #ifdef toupper
  22. /* do not use toupper MACRO */
  23. #undef toupper
  24. #endif
  25.  
  26. static char soundex_module__doc__[] =
  27. "Perform Soundex comparisons on strings, allowing non-literal matching.";
  28.  
  29. static void soundex_hash(char *str, char *result)
  30. {
  31.     char *sptr = str;           /* pointer into str */
  32.     char *rptr = result;        /* pointer into result */
  33.     
  34.     if(*str == NULL)
  35.     {
  36.         strcpy(result,"000000");
  37.         return;
  38.     }
  39.             
  40.     /*  Preserve the first character of the input string.
  41.      */
  42.     *(rptr++) = toupper(*(sptr++));
  43.     
  44.     /* Translate the rest of the input string into result.  The following
  45.        transformations are used:
  46.  
  47.        1) All vowles, W, and H, are skipped.
  48.  
  49.        2) BFPV = 1
  50.           CGJKQSXZ = 2
  51.           DT = 3
  52.           L = 4
  53.           MN = 5
  54.  
  55.        3) Only translate the first of adjacent equal translations.  I.E.
  56.           remove duplicate digits.
  57.     */
  58.  
  59.     for(;(rptr - result) < 6 &&  *sptr != NULL;sptr++)
  60.     {
  61.         switch (toupper(*sptr))
  62.         {
  63.         case 'W':
  64.         case 'H':
  65.         case 'A':
  66.         case 'I':
  67.         case 'O':
  68.         case 'U':
  69.         case 'Y':
  70.             break;
  71.         case 'B':
  72.         case 'F':
  73.         case 'P':
  74.         case 'V':
  75.             if(*(rptr - 1) != '1')
  76.                 *(rptr++) = '1';
  77.             break;
  78.         case 'C':
  79.         case 'G':
  80.         case 'J':
  81.         case 'K':
  82.         case 'Q':
  83.         case 'S':
  84.         case 'X':
  85.         case 'Z':
  86.             if(*(rptr - 1) != '2')
  87.                 *(rptr++) = '2';
  88.             break;
  89.         case 'D':
  90.         case 'T':
  91.             if(*(rptr - 1) != '3')
  92.                 *(rptr++) = '3';
  93.             break;
  94.         case 'L':
  95.             if(*(rptr - 1) != '4')
  96.                 *(rptr++) = '4';
  97.             break;
  98.         case 'M':
  99.         case 'N':
  100.             if(*(rptr - 1) != '5')
  101.                 *(rptr++) = '5';
  102.             break;
  103.         default:
  104.             break;
  105.         }
  106.     }
  107.  
  108.     /* Pad 0's on right side of string out to 6 characters.
  109.      */
  110.     for(; rptr < result + 6; rptr++)
  111.         *rptr = '0';
  112.  
  113.     /* Terminate the result string.
  114.      */
  115.     *(result + 6) = NULL;
  116. }
  117.  
  118.  
  119. /* Return the actual soundex value.         */
  120. /* Added by Chris Herborth (chrish@qnx.com) */
  121. static char soundex_get_soundex__doc__[] =
  122.     "Return the (English) Soundex hash value for a string.";
  123. static PyObject *
  124. get_soundex(PyObject *self, PyObject *args)
  125. {
  126.     char *str;
  127.     int retval;
  128.     char sdx[7];
  129.  
  130.     if(!PyArg_ParseTuple( args, "s", &str))
  131.       return NULL;
  132.  
  133.     soundex_hash(str, sdx);
  134.  
  135.     return PyString_FromString(sdx);
  136. }
  137.  
  138. static char soundex_sound_similar__doc__[] =
  139.     "Compare two strings to see if they sound similar (English).";
  140. static PyObject *
  141. sound_similar(PyObject *self, PyObject *args)
  142. {
  143.     char *str1, *str2;
  144.     int return_value;
  145.     char res1[7], res2[7];
  146.     
  147.     if(!PyArg_ParseTuple(args, "ss", &str1, &str2))
  148.         return NULL;
  149.  
  150.     soundex_hash(str1, res1);
  151.     soundex_hash(str2, res2);
  152.  
  153.     if(!strcmp(res1,res2))
  154.         return Py_BuildValue("i",1);
  155.     else
  156.         return Py_BuildValue("i",0);
  157. }
  158.  
  159. /* Python Method Table.
  160.  */
  161. static PyMethodDef SoundexMethods[] =
  162. {
  163.     {"sound_similar", sound_similar, 1, soundex_sound_similar__doc__},
  164.     {"get_soundex", get_soundex, 1, soundex_get_soundex__doc__},
  165.  
  166.     {NULL, NULL }               /* sentinel */
  167. };
  168.  
  169.  
  170. /* Register the method table.
  171.  */
  172. void
  173. initsoundex()
  174. {
  175.     (void) Py_InitModule4("soundex",
  176.               SoundexMethods,
  177.               soundex_module__doc__,
  178.               (PyObject *)NULL,
  179.               PYTHON_API_VERSION);
  180. }
  181.