developer/VSSDK/VisualStudioIntegration/Common/Source/CPP/VSL/MockInterfaces/VSLMockIVsFinder.h

   1 /***************************************************************************
   2
   3 Copyright (c) Microsoft Corporation. All rights reserved.
   4 This code is licensed under the Visual Studio SDK license terms.
   5 THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
   6 ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
   7 IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
   8 PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
   9
  10 This code is a part of the Visual Studio Library.
  11
  12 ***************************************************************************/
  13
  14 #ifndef IVSFINDER_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5
  15 #define IVSFINDER_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5
  16
  17 #if _MSC_VER > 1000
  18 #pragma once
  19 #endif
  20
  21 #include "textfind.h"
  22
  23 #pragma warning(push)
  24 #pragma warning(disable : 4510) // default constructor could not be generated
  25 #pragma warning(disable : 4610) // can never be instantiated - user defined constructor required
  26 #pragma warning(disable : 4512) // assignment operator could not be generated
  27 #pragma warning(disable : 6011) // Dereferencing NULL pointer (a NULL derference is just another kind of failure for a unit test
  28
  29 namespace VSL
  30 {
  31
  32 class IVsFinderNotImpl :
  33         public IVsFinder
  34 {
  35
  36 VSL_DECLARE_NONINSTANTIABLE_BASE_CLASS(IVsFinderNotImpl)
  37
  38 public:
  39
  40         typedef IVsFinder Interface;
  41
  42         STDMETHOD(AttachTextImage)(
  43                 /*[in]*/ IUnknown* /*pTextImage*/)VSL_STDMETHOD_NOTIMPL
  44
  45         STDMETHOD(Detach)()VSL_STDMETHOD_NOTIMPL
  46
  47         STDMETHOD(SetScope)(
  48                 /*[in]*/ IVsTextSpanSet* /*pSpanScope*/)VSL_STDMETHOD_NOTIMPL
  49
  50         STDMETHOD(Init)(
  51                 /*[in]*/ DWORD /*grfOptions*/,
  52                 /*[in]*/ LPCOLESTR /*pszFindPattern*/,
  53                 /*[in]*/ BOOL /*fReinit*/,
  54                 /*[out,retval]*/ VSFINDERROR* /*pResult*/)VSL_STDMETHOD_NOTIMPL
  55
  56         STDMETHOD(SetPosition)(
  57                 /*[in]*/ VSFINDPOS /*fp*/,
  58                 /*[in]*/ TextAddress /*ta*/)VSL_STDMETHOD_NOTIMPL
  59
  60         STDMETHOD(Find)(
  61                 /*[in]*/ VSFINDHOW /*grfFindHow*/,
  62                 /*[in,out]*/ TextSpan* /*ptsMatch*/,
  63                 /*[out,retval]*/ VSFINDSTATE* /*pgrfResult*/)VSL_STDMETHOD_NOTIMPL
  64
  65         STDMETHOD(GetMatch)(
  66                 /*[out,retval]*/ TextSpan* /*pts*/)VSL_STDMETHOD_NOTIMPL
  67
  68         STDMETHOD(GetMatchedSpans)(
  69                 /*[out,retval]*/ IVsTextSpanSet** /*ppSpans*/)VSL_STDMETHOD_NOTIMPL
  70
  71         STDMETHOD(GetTaggedSpans)(
  72                 /*[out,retval]*/ IVsTextSpanSet** /*ppTags*/)VSL_STDMETHOD_NOTIMPL
  73
  74         STDMETHOD(GetState)(
  75                 /*[out]*/ LONG* /*pcFound*/,
  76                 /*[out]*/ VSFINDERROR* /*pResult*/,
  77                 /*[out,retval]*/ VSFINDSTATE* /*pState*/)VSL_STDMETHOD_NOTIMPL
  78 };
  79
  80 class IVsFinderMockImpl :
  81         public IVsFinder,
  82         public MockBase
  83 {
  84
  85 VSL_DECLARE_NONINSTANTIABLE_BASE_CLASS(IVsFinderMockImpl)
  86
  87 public:
  88
  89 VSL_DEFINE_MOCK_CLASS_TYPDEFS(IVsFinderMockImpl)
  90
  91         typedef IVsFinder Interface;
  92         struct AttachTextImageValidValues
  93         {
  94                 /*[in]*/ IUnknown* pTextImage;
  95                 HRESULT retValue;
  96         };
  97
  98         STDMETHOD(AttachTextImage)(
  99                 /*[in]*/ IUnknown* pTextImage)
 100         {
 101                 VSL_DEFINE_MOCK_METHOD(AttachTextImage)
 102
 103                 VSL_CHECK_VALIDVALUE_INTERFACEPOINTER(pTextImage);
 104
 105                 VSL_RETURN_VALIDVALUES();
 106         }
 107         struct DetachValidValues
 108         {
 109                 HRESULT retValue;
 110         };
 111
 112         STDMETHOD(Detach)()
 113         {
 114                 VSL_DEFINE_MOCK_METHOD_NOARGS(Detach)
 115
 116                 VSL_RETURN_VALIDVALUES();
 117         }
 118         struct SetScopeValidValues
 119         {
 120                 /*[in]*/ IVsTextSpanSet* pSpanScope;
 121                 HRESULT retValue;
 122         };
 123
 124         STDMETHOD(SetScope)(
 125                 /*[in]*/ IVsTextSpanSet* pSpanScope)
 126         {
 127                 VSL_DEFINE_MOCK_METHOD(SetScope)
 128
 129                 VSL_CHECK_VALIDVALUE_INTERFACEPOINTER(pSpanScope);
 130
 131                 VSL_RETURN_VALIDVALUES();
 132         }
 133         struct InitValidValues
 134         {
 135                 /*[in]*/ DWORD grfOptions;
 136                 /*[in]*/ LPCOLESTR pszFindPattern;
 137                 /*[in]*/ BOOL fReinit;
 138                 /*[out,retval]*/ VSFINDERROR* pResult;
 139                 HRESULT retValue;
 140         };
 141
 142         STDMETHOD(Init)(
 143                 /*[in]*/ DWORD grfOptions,
 144                 /*[in]*/ LPCOLESTR pszFindPattern,
 145                 /*[in]*/ BOOL fReinit,
 146                 /*[out,retval]*/ VSFINDERROR* pResult)
 147         {
 148                 VSL_DEFINE_MOCK_METHOD(Init)
 149
 150                 VSL_CHECK_VALIDVALUE(grfOptions);
 151
 152                 VSL_CHECK_VALIDVALUE_STRINGW(pszFindPattern);
 153
 154                 VSL_CHECK_VALIDVALUE(fReinit);
 155
 156                 VSL_SET_VALIDVALUE(pResult);
 157
 158                 VSL_RETURN_VALIDVALUES();
 159         }
 160         struct SetPositionValidValues
 161         {
 162                 /*[in]*/ VSFINDPOS fp;
 163                 /*[in]*/ TextAddress ta;
 164                 HRESULT retValue;
 165         };
 166
 167         STDMETHOD(SetPosition)(
 168                 /*[in]*/ VSFINDPOS fp,
 169                 /*[in]*/ TextAddress ta)
 170         {
 171                 VSL_DEFINE_MOCK_METHOD(SetPosition)
 172
 173                 VSL_CHECK_VALIDVALUE(fp);
 174
 175                 VSL_CHECK_VALIDVALUE(ta);
 176
 177                 VSL_RETURN_VALIDVALUES();
 178         }
 179         struct FindValidValues
 180         {
 181                 /*[in]*/ VSFINDHOW grfFindHow;
 182                 /*[in,out]*/ TextSpan* ptsMatch;
 183                 /*[out,retval]*/ VSFINDSTATE* pgrfResult;
 184                 HRESULT retValue;
 185         };
 186
 187         STDMETHOD(Find)(
 188                 /*[in]*/ VSFINDHOW grfFindHow,
 189                 /*[in,out]*/ TextSpan* ptsMatch,
 190                 /*[out,retval]*/ VSFINDSTATE* pgrfResult)
 191         {
 192                 VSL_DEFINE_MOCK_METHOD(Find)
 193
 194                 VSL_CHECK_VALIDVALUE(grfFindHow);
 195
 196                 VSL_SET_VALIDVALUE(ptsMatch);
 197
 198                 VSL_SET_VALIDVALUE(pgrfResult);
 199
 200                 VSL_RETURN_VALIDVALUES();
 201         }
 202         struct GetMatchValidValues
 203         {
 204                 /*[out,retval]*/ TextSpan* pts;
 205                 HRESULT retValue;
 206         };
 207
 208         STDMETHOD(GetMatch)(
 209                 /*[out,retval]*/ TextSpan* pts)
 210         {
 211                 VSL_DEFINE_MOCK_METHOD(GetMatch)
 212
 213                 VSL_SET_VALIDVALUE(pts);
 214
 215                 VSL_RETURN_VALIDVALUES();
 216         }
 217         struct GetMatchedSpansValidValues
 218         {
 219                 /*[out,retval]*/ IVsTextSpanSet** ppSpans;
 220                 HRESULT retValue;
 221         };
 222
 223         STDMETHOD(GetMatchedSpans)(
 224                 /*[out,retval]*/ IVsTextSpanSet** ppSpans)
 225         {
 226                 VSL_DEFINE_MOCK_METHOD(GetMatchedSpans)
 227
 228                 VSL_SET_VALIDVALUE_INTERFACE(ppSpans);
 229
 230                 VSL_RETURN_VALIDVALUES();
 231         }
 232         struct GetTaggedSpansValidValues
 233         {
 234                 /*[out,retval]*/ IVsTextSpanSet** ppTags;
 235                 HRESULT retValue;
 236         };
 237
 238         STDMETHOD(GetTaggedSpans)(
 239                 /*[out,retval]*/ IVsTextSpanSet** ppTags)
 240         {
 241                 VSL_DEFINE_MOCK_METHOD(GetTaggedSpans)
 242
 243                 VSL_SET_VALIDVALUE_INTERFACE(ppTags);
 244
 245                 VSL_RETURN_VALIDVALUES();
 246         }
 247         struct GetStateValidValues
 248         {
 249                 /*[out]*/ LONG* pcFound;
 250                 /*[out]*/ VSFINDERROR* pResult;
 251                 /*[out,retval]*/ VSFINDSTATE* pState;
 252                 HRESULT retValue;
 253         };
 254
 255         STDMETHOD(GetState)(
 256                 /*[out]*/ LONG* pcFound,
 257                 /*[out]*/ VSFINDERROR* pResult,
 258                 /*[out,retval]*/ VSFINDSTATE* pState)
 259         {
 260                 VSL_DEFINE_MOCK_METHOD(GetState)
 261
 262                 VSL_SET_VALIDVALUE(pcFound);
 263
 264                 VSL_SET_VALIDVALUE(pResult);
 265
 266                 VSL_SET_VALIDVALUE(pState);
 267
 268                 VSL_RETURN_VALIDVALUES();
 269         }
 270 };
 271
 272
 273 } // namespace VSL
 274
 275 #pragma warning(pop)
 276
 277 #endif // IVSFINDER_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5