contrib/pg_trgm/trgm.h

   1 /*
   2  * $PostgreSQL$
   3  */
   4 #ifndef __TRGM_H__
   5 #define __TRGM_H__
   6
   7 #include "postgres.h"
   8
   9 #include "access/gist.h"
  10 #include "access/itup.h"
  11 #include "utils/builtins.h"
  12 #include "storage/bufpage.h"
  13
  14 /* options */
  15 #define LPADDING                2
  16 #define RPADDING                1
  17 #define KEEPONLYALNUM
  18 #define IGNORECASE
  19 #define DIVUNION
  20
  21
  22 typedef char trgm[3];
  23
  24 #define CMPCHAR(a,b) ( ((a)==(b)) ? 0 : ( ((a)<(b)) ? -1 : 1 ) )
  25 #define CMPPCHAR(a,b,i)  CMPCHAR( *(((char*)(a))+i), *(((char*)(b))+i) )
  26 #define CMPTRGM(a,b) ( CMPPCHAR(a,b,0) ? CMPPCHAR(a,b,0) : ( CMPPCHAR(a,b,1) ? CMPPCHAR(a,b,1) : CMPPCHAR(a,b,2) ) )
  27
  28 #define CPTRGM(a,b) do {                                \
  29         *(((char*)(a))+0) = *(((char*)(b))+0);  \
  30         *(((char*)(a))+1) = *(((char*)(b))+1);  \
  31         *(((char*)(a))+2) = *(((char*)(b))+2);  \
  32 } while(0);
  33
  34 uint32 trgm2int(trgm *ptr);
  35
  36 #ifdef KEEPONLYALNUM
  37 #define ISPRINTABLECHAR(a)      ( isascii( *(unsigned char*)(a) ) && (isalnum( *(unsigned char*)(a) ) || *(unsigned char*)(a)==' ') )
  38 #else
  39 #define ISPRINTABLECHAR(a)      ( isascii( *(unsigned char*)(a) ) && isprint( *(unsigned char*)(a) ) )
  40 #endif
  41 #define ISPRINTABLETRGM(t)      ( ISPRINTABLECHAR( ((char*)t) ) && ISPRINTABLECHAR( ((char*)t)+1 ) && ISPRINTABLECHAR( ((char*)t)+2 ) )
  42
  43 typedef struct
  44 {
  45         int32           vl_len_;                /* varlena header (do not touch directly!) */
  46         uint8           flag;
  47         char            data[1];
  48 }       TRGM;
  49
  50 #define TRGMHDRSIZE               (VARHDRSZ + sizeof(uint8))
  51
  52 /* gist */
  53 #define BITBYTE 8
  54 #define SIGLENINT  3                    /* >122 => key will toast, so very slow!!! */
  55 #define SIGLEN  ( sizeof(int)*SIGLENINT )
  56
  57 #define SIGLENBIT (SIGLEN*BITBYTE - 1)  /* see makesign */
  58
  59 typedef char BITVEC[SIGLEN];
  60 typedef char *BITVECP;
  61
  62 #define LOOPBYTE \
  63                         for(i=0;i<SIGLEN;i++)
  64
  65 #define GETBYTE(x,i) ( *( (BITVECP)(x) + (int)( (i) / BITBYTE ) ) )
  66 #define GETBITBYTE(x,i) ( ((char)(x)) >> i & 0x01 )
  67 #define CLRBIT(x,i)   GETBYTE(x,i) &= ~( 0x01 << ( (i) % BITBYTE ) )
  68 #define SETBIT(x,i)   GETBYTE(x,i) |=  ( 0x01 << ( (i) % BITBYTE ) )
  69 #define GETBIT(x,i) ( (GETBYTE(x,i) >> ( (i) % BITBYTE )) & 0x01 )
  70
  71 #define HASHVAL(val) (((unsigned int)(val)) % SIGLENBIT)
  72 #define HASH(sign, val) SETBIT((sign), HASHVAL(val))
  73
  74 #define ARRKEY                  0x01
  75 #define SIGNKEY                 0x02
  76 #define ALLISTRUE               0x04
  77
  78 #define ISARRKEY(x) ( ((TRGM*)x)->flag & ARRKEY )
  79 #define ISSIGNKEY(x)    ( ((TRGM*)x)->flag & SIGNKEY )
  80 #define ISALLTRUE(x)    ( ((TRGM*)x)->flag & ALLISTRUE )
  81
  82 #define CALCGTSIZE(flag, len) ( TRGMHDRSIZE + ( ( (flag) & ARRKEY ) ? ((len)*sizeof(trgm)) : (((flag) & ALLISTRUE) ? 0 : SIGLEN) ) )
  83 #define GETSIGN(x)              ( (BITVECP)( (char*)x+TRGMHDRSIZE ) )
  84 #define GETARR(x)               ( (trgm*)( (char*)x+TRGMHDRSIZE ) )
  85 #define ARRNELEM(x) ( ( VARSIZE(x) - TRGMHDRSIZE )/sizeof(trgm) )
  86
  87 extern float4 trgm_limit;
  88
  89 TRGM       *generate_trgm(char *str, int slen);
  90 float4          cnt_sml(TRGM * trg1, TRGM * trg2);
  91
  92 #endif