include/indexsrv.idl

   1 /*
   2  * Copyright 2006 Mike McCormack
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 import "objidl.idl";
  20 /* FIXME: import "filter.idl"; */
  21
  22 /*
  23  * widl doesn't like the declaration of PFNFILLTEXTBUFFER, so work around it...
  24  * Not sure that function pointers are even legal in idl.
  25  */
  26 cpp_quote("struct tagTEXT_SOURCE;")
  27 cpp_quote("typedef HRESULT (WINAPI *PFNFILLTEXTBUFFER)(struct tagTEXT_SOURCE *pTextSource);")
  28 cpp_quote("#if 0")
  29 typedef void* PFNFILLTEXTBUFFER;
  30 cpp_quote("#endif")
  31
  32 typedef struct tagTEXT_SOURCE
  33 {
  34     PFNFILLTEXTBUFFER pfnFillTextBuffer;
  35     const WCHAR *awcBuffer;
  36     ULONG iEnd;
  37     ULONG iCur;
  38 } TEXT_SOURCE;
  39
  40 typedef enum tagWORDREP_BREAK_TYPE
  41 {
  42     WORDREP_BREAK_EOW = 0,
  43     WORDREP_BREAK_EOS = 1,
  44     WORDREP_BREAK_EOP = 2,
  45     WORDREP_BREAK_EOC = 3
  46 } WORDREP_BREAK_TYPE;
  47
  48
  49 /*****************************************************************************
  50  *    IWordSink interface
  51  */
  52 [
  53     unique,
  54     uuid(cc907054-c058-101a-b554-08002b33b0e6),
  55     object,
  56     local
  57 ]
  58 interface IWordSink : IUnknown
  59 {
  60     HRESULT PutWord(
  61               [in] ULONG cwc,
  62               [size_is(cwcSrcLen)][in] const WCHAR *pwcInBuf,
  63               [in] ULONG cwcSrcLen,
  64               [in] ULONG cwcSrcPos);
  65     HRESULT PutAltWord(
  66               [in] ULONG cwc,
  67               [size_is(cwcSrcLen)][in] const WCHAR *pwcInBuf,
  68               [in] ULONG cwcSrcLen,
  69               [in] ULONG cwcSrcPos);
  70     HRESULT StartAltPhrase(void);
  71     HRESULT EndAltPhrase(void);
  72     HRESULT PutBreak(
  73               [in] WORDREP_BREAK_TYPE breakType);
  74 }
  75
  76 /*****************************************************************************
  77  *    IPhraseSink interface
  78  */
  79 [
  80     unique,
  81     uuid(cc906ff0-c058-101a-b554-08002b33b0e6),
  82     object,
  83     local
  84 ]
  85 interface IPhraseSink: IUnknown
  86 {
  87     HRESULT PutSmallPhrase(
  88               [size_is(cwcNoun)][in] const WCHAR *pwcNoun,
  89               [in] ULONG cwcNoun,
  90               [size_is(cwcModifier)][in] const WCHAR *pwcModifier,
  91               [in] ULONG cwcModifier,
  92               [in] ULONG ulAttachmentType);
  93     HRESULT PutPhrase(
  94               [size_is(cwcPhrase)][in] const WCHAR *pwcPhrase,
  95               [in] ULONG cwcPhrase);
  96 }
  97
  98 /*****************************************************************************
  99  *    IWordBreaker interface
 100  */
 101 [
 102     unique,
 103     uuid(d53552c8-77e3-101a-b552-08002b33b0e6),
 104     object,
 105     local
 106 ]
 107 interface IWordBreaker: IUnknown
 108 {
 109     HRESULT Init(
 110               [in] BOOL fQuery,
 111               [in] ULONG ulMaxTokenSize,
 112               [out] BOOL *pfLicense);
 113     HRESULT BreakText(
 114               [in] TEXT_SOURCE *pTextSource,
 115               [in] IWordSink *pWordSink,
 116               [in] IPhraseSink *pPhraseSink);
 117     HRESULT ComposePhrase(
 118               [size_is(cwcNoun)][in] const WCHAR *pwcNoun,
 119               [in] ULONG cwcNoun,
 120               [size_is(cwcModifier)][in] const WCHAR *pwcModifier,
 121               [in] ULONG cwcModifier,
 122               [in] ULONG ulAttachmentType,
 123               [size_is(*pcwcPhrase)][out] WCHAR *pwcPhrase,
 124               [out][in] ULONG *pcwcPhrase);
 125     HRESULT GetLicenseToUse(
 126               [string][out] const WCHAR **ppwcsLicense);
 127 }