developer/VSSDK/VisualStudioIntegration/Common/Source/CPP/VSL/MockInterfaces/VSLMockIVsExpansionSession.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 IVSEXPANSIONSESSION_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5
  15 #define IVSEXPANSIONSESSION_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5
  16
  17 #if _MSC_VER > 1000
  18 #pragma once
  19 #endif
  20
  21 #include "textmgr2.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 IVsExpansionSessionNotImpl :
  33         public IVsExpansionSession
  34 {
  35
  36 VSL_DECLARE_NONINSTANTIABLE_BASE_CLASS(IVsExpansionSessionNotImpl)
  37
  38 public:
  39
  40         typedef IVsExpansionSession Interface;
  41
  42         STDMETHOD(EndCurrentExpansion)(
  43                 /*[in]*/ BOOL /*fLeaveCaret*/)VSL_STDMETHOD_NOTIMPL
  44
  45         STDMETHOD(GoToNextExpansionField)(
  46                 /*[in]*/ BOOL /*fCommitIfLast*/)VSL_STDMETHOD_NOTIMPL
  47
  48         STDMETHOD(GoToPreviousExpansionField)()VSL_STDMETHOD_NOTIMPL
  49
  50         STDMETHOD(GetFieldValue)(
  51                 /*[in]*/ BSTR /*bstrFieldName*/,
  52                 /*[out]*/ BSTR* /*pbstrValue*/)VSL_STDMETHOD_NOTIMPL
  53
  54         STDMETHOD(SetFieldDefault)(
  55                 /*[in]*/ BSTR /*bstrFieldName*/,
  56                 /*[in]*/ BSTR /*bstrNewValue*/)VSL_STDMETHOD_NOTIMPL
  57
  58         STDMETHOD(GetFieldSpan)(
  59                 /*[in]*/ BSTR /*bstrField*/,
  60                 /*[out]*/ TextSpan* /*ptsSpan*/)VSL_STDMETHOD_NOTIMPL
  61
  62         STDMETHOD(GetHeaderNode)(
  63                 /*[in]*/ BSTR /*bstrNode*/,
  64                 /*[out]*/ IXMLDOMNode** /*pNode*/)VSL_STDMETHOD_NOTIMPL
  65
  66         STDMETHOD(GetDeclarationNode)(
  67                 /*[in]*/ BSTR /*bstrNode*/,
  68                 /*[out]*/ IXMLDOMNode** /*pNode*/)VSL_STDMETHOD_NOTIMPL
  69
  70         STDMETHOD(GetSnippetNode)(
  71                 /*[in]*/ BSTR /*bstrNode*/,
  72                 /*[out]*/ IXMLDOMNode** /*pNode*/)VSL_STDMETHOD_NOTIMPL
  73
  74         STDMETHOD(GetSnippetSpan)(
  75                 /*[out]*/ TextSpan* /*pts*/)VSL_STDMETHOD_NOTIMPL
  76
  77         STDMETHOD(SetEndSpan)(
  78                 /*[in]*/ TextSpan /*ts*/)VSL_STDMETHOD_NOTIMPL
  79
  80         STDMETHOD(GetEndSpan)(
  81                 /*[out]*/ TextSpan* /*pts*/)VSL_STDMETHOD_NOTIMPL
  82 };
  83
  84 class IVsExpansionSessionMockImpl :
  85         public IVsExpansionSession,
  86         public MockBase
  87 {
  88
  89 VSL_DECLARE_NONINSTANTIABLE_BASE_CLASS(IVsExpansionSessionMockImpl)
  90
  91 public:
  92
  93 VSL_DEFINE_MOCK_CLASS_TYPDEFS(IVsExpansionSessionMockImpl)
  94
  95         typedef IVsExpansionSession Interface;
  96         struct EndCurrentExpansionValidValues
  97         {
  98                 /*[in]*/ BOOL fLeaveCaret;
  99                 HRESULT retValue;
 100         };
 101
 102         STDMETHOD(EndCurrentExpansion)(
 103                 /*[in]*/ BOOL fLeaveCaret)
 104         {
 105                 VSL_DEFINE_MOCK_METHOD(EndCurrentExpansion)
 106
 107                 VSL_CHECK_VALIDVALUE(fLeaveCaret);
 108
 109                 VSL_RETURN_VALIDVALUES();
 110         }
 111         struct GoToNextExpansionFieldValidValues
 112         {
 113                 /*[in]*/ BOOL fCommitIfLast;
 114                 HRESULT retValue;
 115         };
 116
 117         STDMETHOD(GoToNextExpansionField)(
 118                 /*[in]*/ BOOL fCommitIfLast)
 119         {
 120                 VSL_DEFINE_MOCK_METHOD(GoToNextExpansionField)
 121
 122                 VSL_CHECK_VALIDVALUE(fCommitIfLast);
 123
 124                 VSL_RETURN_VALIDVALUES();
 125         }
 126         struct GoToPreviousExpansionFieldValidValues
 127         {
 128                 HRESULT retValue;
 129         };
 130
 131         STDMETHOD(GoToPreviousExpansionField)()
 132         {
 133                 VSL_DEFINE_MOCK_METHOD_NOARGS(GoToPreviousExpansionField)
 134
 135                 VSL_RETURN_VALIDVALUES();
 136         }
 137         struct GetFieldValueValidValues
 138         {
 139                 /*[in]*/ BSTR bstrFieldName;
 140                 /*[out]*/ BSTR* pbstrValue;
 141                 HRESULT retValue;
 142         };
 143
 144         STDMETHOD(GetFieldValue)(
 145                 /*[in]*/ BSTR bstrFieldName,
 146                 /*[out]*/ BSTR* pbstrValue)
 147         {
 148                 VSL_DEFINE_MOCK_METHOD(GetFieldValue)
 149
 150                 VSL_CHECK_VALIDVALUE_BSTR(bstrFieldName);
 151
 152                 VSL_SET_VALIDVALUE_BSTR(pbstrValue);
 153
 154                 VSL_RETURN_VALIDVALUES();
 155         }
 156         struct SetFieldDefaultValidValues
 157         {
 158                 /*[in]*/ BSTR bstrFieldName;
 159                 /*[in]*/ BSTR bstrNewValue;
 160                 HRESULT retValue;
 161         };
 162
 163         STDMETHOD(SetFieldDefault)(
 164                 /*[in]*/ BSTR bstrFieldName,
 165                 /*[in]*/ BSTR bstrNewValue)
 166         {
 167                 VSL_DEFINE_MOCK_METHOD(SetFieldDefault)
 168
 169                 VSL_CHECK_VALIDVALUE_BSTR(bstrFieldName);
 170
 171                 VSL_CHECK_VALIDVALUE_BSTR(bstrNewValue);
 172
 173                 VSL_RETURN_VALIDVALUES();
 174         }
 175         struct GetFieldSpanValidValues
 176         {
 177                 /*[in]*/ BSTR bstrField;
 178                 /*[out]*/ TextSpan* ptsSpan;
 179                 HRESULT retValue;
 180         };
 181
 182         STDMETHOD(GetFieldSpan)(
 183                 /*[in]*/ BSTR bstrField,
 184                 /*[out]*/ TextSpan* ptsSpan)
 185         {
 186                 VSL_DEFINE_MOCK_METHOD(GetFieldSpan)
 187
 188                 VSL_CHECK_VALIDVALUE_BSTR(bstrField);
 189
 190                 VSL_SET_VALIDVALUE(ptsSpan);
 191
 192                 VSL_RETURN_VALIDVALUES();
 193         }
 194         struct GetHeaderNodeValidValues
 195         {
 196                 /*[in]*/ BSTR bstrNode;
 197                 /*[out]*/ IXMLDOMNode** pNode;
 198                 HRESULT retValue;
 199         };
 200
 201         STDMETHOD(GetHeaderNode)(
 202                 /*[in]*/ BSTR bstrNode,
 203                 /*[out]*/ IXMLDOMNode** pNode)
 204         {
 205                 VSL_DEFINE_MOCK_METHOD(GetHeaderNode)
 206
 207                 VSL_CHECK_VALIDVALUE_BSTR(bstrNode);
 208
 209                 VSL_SET_VALIDVALUE_INTERFACE(pNode);
 210
 211                 VSL_RETURN_VALIDVALUES();
 212         }
 213         struct GetDeclarationNodeValidValues
 214         {
 215                 /*[in]*/ BSTR bstrNode;
 216                 /*[out]*/ IXMLDOMNode** pNode;
 217                 HRESULT retValue;
 218         };
 219
 220         STDMETHOD(GetDeclarationNode)(
 221                 /*[in]*/ BSTR bstrNode,
 222                 /*[out]*/ IXMLDOMNode** pNode)
 223         {
 224                 VSL_DEFINE_MOCK_METHOD(GetDeclarationNode)
 225
 226                 VSL_CHECK_VALIDVALUE_BSTR(bstrNode);
 227
 228                 VSL_SET_VALIDVALUE_INTERFACE(pNode);
 229
 230                 VSL_RETURN_VALIDVALUES();
 231         }
 232         struct GetSnippetNodeValidValues
 233         {
 234                 /*[in]*/ BSTR bstrNode;
 235                 /*[out]*/ IXMLDOMNode** pNode;
 236                 HRESULT retValue;
 237         };
 238
 239         STDMETHOD(GetSnippetNode)(
 240                 /*[in]*/ BSTR bstrNode,
 241                 /*[out]*/ IXMLDOMNode** pNode)
 242         {
 243                 VSL_DEFINE_MOCK_METHOD(GetSnippetNode)
 244
 245                 VSL_CHECK_VALIDVALUE_BSTR(bstrNode);
 246
 247                 VSL_SET_VALIDVALUE_INTERFACE(pNode);
 248
 249                 VSL_RETURN_VALIDVALUES();
 250         }
 251         struct GetSnippetSpanValidValues
 252         {
 253                 /*[out]*/ TextSpan* pts;
 254                 HRESULT retValue;
 255         };
 256
 257         STDMETHOD(GetSnippetSpan)(
 258                 /*[out]*/ TextSpan* pts)
 259         {
 260                 VSL_DEFINE_MOCK_METHOD(GetSnippetSpan)
 261
 262                 VSL_SET_VALIDVALUE(pts);
 263
 264                 VSL_RETURN_VALIDVALUES();
 265         }
 266         struct SetEndSpanValidValues
 267         {
 268                 /*[in]*/ TextSpan ts;
 269                 HRESULT retValue;
 270         };
 271
 272         STDMETHOD(SetEndSpan)(
 273                 /*[in]*/ TextSpan ts)
 274         {
 275                 VSL_DEFINE_MOCK_METHOD(SetEndSpan)
 276
 277                 VSL_CHECK_VALIDVALUE(ts);
 278
 279                 VSL_RETURN_VALIDVALUES();
 280         }
 281         struct GetEndSpanValidValues
 282         {
 283                 /*[out]*/ TextSpan* pts;
 284                 HRESULT retValue;
 285         };
 286
 287         STDMETHOD(GetEndSpan)(
 288                 /*[out]*/ TextSpan* pts)
 289         {
 290                 VSL_DEFINE_MOCK_METHOD(GetEndSpan)
 291
 292                 VSL_SET_VALIDVALUE(pts);
 293
 294                 VSL_RETURN_VALIDVALUES();
 295         }
 296 };
 297
 298
 299 } // namespace VSL
 300
 301 #pragma warning(pop)
 302
 303 #endif // IVSEXPANSIONSESSION_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5