FindByContent.h

Go to the documentation of this file.

 
#ifndef __FINDBYCONTENT__
#define __FINDBYCONTENT__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __MACERRORS__
#include <MacErrors.h>
#endif
 
#ifndef __CFSTRING__
#include <CFString.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
   enum
   {
      /* languages that use the Roman character mapping*/
      englishHighWord = (long)0x80000000,
      dutchHighWord = 0x40000000, /* also Afrikaans*/
      germanHighWord = 0x20000000,
      swedishHighWord = 0x10000000, /* also Norwegian*/
      danishHighWord = 0x08000000,
      spanishHighWord = 0x04000000, /* also Catalan*/
      portugueseHighWord = 0x02000000,
      italianHighWord = 0x01000000,
      frenchHighWord = 0x00800000,
      romanHighWord = 0x00400000,     /* other languages using Roman alphabet*/
                                      /* Languages that use other mappings*/
      icelandicHighWord = 0x00200000, /* also Faroese*/
      hebrewHighWord = 0x00100000,    /* also Yiddish*/
      arabicHighWord = 0x00080000,    /* also Farsi, Urdu*/
      centeuroHighWord =
          0x00040000, /* Central European languages not using Cyrillic*/
      croatianHighWord = 0x00020000,
      turkishHighWord = 0x00010000,
      romanianHighWord = 0x00008000,
      greekHighWord = 0x00004000,
      cyrillicHighWord = 0x00002000, /* all languages using Cyrillic*/
      devanagariHighWord = 0x00001000,
      gujuratiHighWord = 0x00000800,
      gurmukhiHighWord = 0x00000400,
      japaneseHighWord = 0x00000200,
      koreanHighWord = 0x00000100,
      kDefaultLanguagesHighWord = (long)0xFF800000 /* sum of first 9*/
   };
 
   enum
   {
      /* indexing phases*/
      kFBCphIndexing = 0,
      kFBCphFlushing = 1,
      kFBCphMerging = 2,
      kFBCphMakingIndexAccessor = 3,
      kFBCphCompacting = 4,
      kFBCphIndexWaiting = 5, /* access phases*/
      kFBCphSearching = 6,
      kFBCphMakingAccessAccessor = 7,
      kFBCphAccessWaiting = 8, /* summarization*/
      kFBCphSummarizing = 9,   /* indexing or access*/
      kFBCphIdle = 10,
      kFBCphCanceling = 11
   };
 
   /* A collection of state information for searching*/
   typedef struct OpaqueFBCSearchSession *FBCSearchSession;
   /* An ordinary C string (used for hit/doc terms)*/
   typedef char *FBCWordItem;
   /* An array of WordItems*/
   typedef FBCWordItem *FBCWordList;
   typedef CALLBACK_API_C(Boolean, FBCCallbackProcPtr)(UInt16 phase,
                                                       float percentDone,
                                                       void *data);
   typedef TVECTOR_UPP_TYPE(FBCCallbackProcPtr) FBCCallbackUPP;
   FBCCallbackUPP
   NewFBCCallbackUPP(FBCCallbackProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
   enum
   {
      uppFBCCallbackProcInfo = 0x00000F91
   }; /* 1_byte Func(2_bytes, 4_bytes, 4_bytes) */
#ifdef __cplusplus
   inline FBCCallbackUPP NewFBCCallbackUPP(FBCCallbackProcPtr userRoutine)
   {
      return userRoutine;
   }
#else
#define NewFBCCallbackUPP(userRoutine) (userRoutine)
#endif
#endif
 
   void
   DisposeFBCCallbackUPP(FBCCallbackUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
   inline void DisposeFBCCallbackUPP(FBCCallbackUPP) {}
#else
#define DisposeFBCCallbackUPP(userUPP)
#endif
#endif
 
   Boolean
   InvokeFBCCallbackUPP(UInt16 phase, float percentDone, void *data,
                        FBCCallbackUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
   inline Boolean InvokeFBCCallbackUPP(UInt16 phase, float percentDone, void *data,
                                       FBCCallbackUPP userUPP)
   {
      return (*userUPP)(phase, percentDone, data);
   }
#else
#define InvokeFBCCallbackUPP(phase, percentDone, data, userUPP) \
   (*userUPP)(phase, percentDone, data)
#endif
#endif
 
   void
   FBCSetCallback(FBCCallbackUPP fn, void *data);
 
   void
   FBCSetHeapReservation(UInt32 bytes);
 
   Boolean
   FBCVolumeIsIndexed(SInt16 theVRefNum);
 
   Boolean
   FBCVolumeIsRemote(SInt16 theVRefNum);
 
   OSErr
   FBCVolumeIndexTimeStamp(SInt16 theVRefNum, UInt32 *timeStamp);
 
   OSErr
   FBCVolumeIndexPhysicalSize(SInt16 theVRefNum, UInt32 *size);
 
   OSErr
   FBCCreateSearchSession(FBCSearchSession *searchSession);
 
   OSErr
   FBCAddAllVolumesToSession(FBCSearchSession theSession, Boolean includeRemote);
 
   OSErr
   FBCSetSessionVolumes(FBCSearchSession theSession, const SInt16 vRefNums[],
                        UInt16 numVolumes);
 
   OSErr
   FBCAddVolumeToSession(FBCSearchSession theSession, SInt16 vRefNum);
 
   OSErr
   FBCRemoveVolumeFromSession(FBCSearchSession theSession, SInt16 vRefNum);
 
   OSErr
   FBCGetSessionVolumeCount(FBCSearchSession theSession, UInt16 *count);
 
   OSErr
   FBCGetSessionVolumes(FBCSearchSession theSession, SInt16 vRefNums[],
                        UInt16 *numVolumes);
 
   OSErr
   FBCCloneSearchSession(FBCSearchSession original, FBCSearchSession *clone);
 
   OSErr
   FBCDoQuerySearch(FBCSearchSession theSession, char *queryText,
                    const FSSpec targetDirs[], UInt32 numTargets, UInt32 maxHits,
                    UInt32 maxHitWords);
 
   OSErr
   FBCDoCFStringSearch(FBCSearchSession theSession, CFStringRef queryString,
                       const FSSpec targetDirs[], UInt32 numTargets,
                       UInt32 maxHits, UInt32 maxHitWords);
 
   OSErr
   FBCDoExampleSearch(FBCSearchSession theSession, const UInt32 *exampleHitNums,
                      UInt32 numExamples, const FSSpec targetDirs[],
                      UInt32 numTargets, UInt32 maxHits, UInt32 maxHitWords);
 
   OSErr
   FBCBlindExampleSearch(FSSpec examples[], UInt32 numExamples,
                         const FSSpec targetDirs[], UInt32 numTargets,
                         UInt32 maxHits, UInt32 maxHitWords, Boolean allIndexes,
                         Boolean includeRemote, FBCSearchSession *theSession);
 
   OSErr
   FBCGetHitCount(FBCSearchSession theSession, UInt32 *count);
 
   OSErr
   FBCGetHitDocument(FBCSearchSession theSession, UInt32 hitNumber,
                     FSSpec *theDocument);
 
   OSErr
   FBCGetHitDocumentRef(FBCSearchSession theSession, UInt32 hitNumber,
                        FSRef *theDocument);
 
   OSErr
   FBCGetHitScore(FBCSearchSession theSession, UInt32 hitNumber, float *score);
 
   OSErr
   FBCGetMatchedWords(FBCSearchSession theSession, UInt32 hitNumber,
                      UInt32 *wordCount, FBCWordList *list);
 
   OSErr
   FBCGetTopicWords(FBCSearchSession theSession, UInt32 hitNumber,
                    UInt32 *wordCount, FBCWordList *list);
 
   OSErr
   FBCSummarize(void *inBuf, UInt32 inLength, void *outBuf, UInt32 *outLength,
                UInt32 *numSentences);
 
   OSErr
   FBCReleaseSessionHits(FBCSearchSession theSession);
 
   OSErr
   FBCDestroyWordList(FBCWordList theList, UInt32 wordCount);
 
   OSErr
   FBCDestroySearchSession(FBCSearchSession theSession);
 
   OSErr
   FBCIndexItems(FSSpecArrayPtr theItems, UInt32 itemCount);
 
   OSErr
   FBCIndexItemsInLanguages(FSSpecArrayPtr theItems, UInt32 itemCount,
                            UInt32 languageHighBits, UInt32 languageLowBits);
 
   OSErr
   FBCFindIndexFileFolderForFolder(FSRef *inFolder, FSRef *outFolder);
 
   OSErr
   FBCDeleteIndexFileForFolder(const FSRef *folder);
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* __FINDBYCONTENT__ */