src/apps/mail/Words.h

   1 /*
   2 Open Tracker License
   3
   4 Terms and Conditions
   5
   6 Copyright (c) 1991-2000, Be Incorporated. All rights reserved.
   7
   8 Permission is hereby granted, free of charge, to any person obtaining a copy of
   9 this software and associated documentation files (the "Software"), to deal in
  10 the Software without restriction, including without limitation the rights to
  11 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  12 of the Software, and to permit persons to whom the Software is furnished to do
  13 so, subject to the following conditions:
  14
  15 The above copyright notice and this permission notice applies to all licensees
  16 and shall be included in all copies or substantial portions of the Software.
  17
  18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF TITLE, MERCHANTABILITY,
  20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21 BE INCORPORATED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  22 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
  23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24
  25 Except as contained in this notice, the name of Be Incorporated shall not be
  26 used in advertising or otherwise to promote the sale, use or other dealings in
  27 this Software without prior written authorization from Be Incorporated.
  28
  29 BeMail(TM), Tracker(TM), Be(R), BeOS(R), and BeIA(TM) are trademarks or registered trademarks
  30 of Be Incorporated in the United States and other countries. Other brand product
  31 names are registered trademarks or trademarks of their respective holders.
  32 All rights reserved.
  33 */
  34 #ifndef _WORDS_H
  35 #define _WORDS_H
  36
  37
  38 #include <List.h>
  39 #include <String.h>
  40
  41 #include "WIndex.h"
  42
  43
  44 typedef enum {
  45         COMPARE,
  46         GENERATE
  47 } metaphlag;
  48
  49
  50 bool metaphone(const char* Word, char* Metaph, metaphlag Flag);
  51 int word_match(const char* reference, const char* test);
  52 int32 suffix_word(char* dst, const char* src, char flag);
  53 void sort_word_list(BList* matches, const char* reference);
  54
  55
  56 class Words : public WIndex {
  57 public:
  58                                                         Words(bool useMetaphone = true);
  59                                                         Words(BPositionIO* thes, bool useMetaphone = true);
  60                                                         Words(const char* dataPath, const char* indexPath,
  61                                                                 bool useMetaphone);
  62         virtual                                 ~Words(void);
  63
  64         virtual status_t                BuildIndex(void);
  65         virtual int32                   GetKey(const char* s);
  66
  67                         int32                   FindBestMatches(BList* matches, const char* word);
  68
  69 protected:
  70                         bool                    fUseMetaphone;
  71 };
  72
  73 #endif // #ifndef _WORDS_H
  74