developer/VSSDK/VisualStudioIntegration/Common/Source/CPP/VSL/MockInterfaces/VSLMockIVsStructuredFileIO.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 IVSSTRUCTUREDFILEIO_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5
  15 #define IVSSTRUCTUREDFILEIO_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5
  16
  17 #if _MSC_VER > 1000
  18 #pragma once
  19 #endif
  20
  21 #include "vsshell.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 IVsStructuredFileIONotImpl :
  33         public IVsStructuredFileIO
  34 {
  35
  36 VSL_DECLARE_NONINSTANTIABLE_BASE_CLASS(IVsStructuredFileIONotImpl)
  37
  38 public:
  39
  40         typedef IVsStructuredFileIO Interface;
  41
  42         STDMETHOD(CreateNew)(
  43                 /*[in]*/ LPCOLESTR /*szFileName*/,
  44                 /*[in]*/ ULONG /*nFormatIndex*/,
  45                 /*[in]*/ DWORD /*dwShareMode*/,
  46                 /*[in]*/ DWORD /*dwCreationDisposition*/,
  47                 /*[in]*/ DWORD /*dwFlagsAndAttributes*/,
  48                 /*[in]*/ IVsStructuredFileIOHelper* /*pIVsStructuredFileIOHelper*/,
  49                 /*[in]*/ LPCOLESTR /*szFormatVersion*/,
  50                 /*[in]*/ LPCOLESTR /*szDescription*/,
  51                 /*[out]*/ IVsPropertyFileOut** /*ppIVsPropertyFileOut*/)VSL_STDMETHOD_NOTIMPL
  52
  53         STDMETHOD(OpenExisting)(
  54                 /*[in]*/ LPCOLESTR /*szFileName*/,
  55                 /*[in]*/ DWORD /*dwShareMode*/,
  56                 /*[in]*/ DWORD /*dwCreationDisposition*/,
  57                 /*[in]*/ DWORD /*dwFlagsAndAttributes*/,
  58                 /*[in]*/ IVsStructuredFileIOHelper* /*pIVsStructuredFileIOHelper*/,
  59                 /*[out]*/ ULONG* /*pnFormatIndex*/,
  60                 /*[out]*/ IVsPropertyFileIn** /*ppIVsPropertyFileIn*/,
  61                 /*[out,optional]*/ BSTR* /*pbstrFormatVersion*/)VSL_STDMETHOD_NOTIMPL
  62
  63         STDMETHOD(GetFormatList)(
  64                 /*[in]*/ LPCOLESTR /*szEntityName*/,
  65                 /*[in]*/ LPCOLESTR /*szFileTypes*/,
  66                 /*[out]*/ LPOLESTR* /*ppszFormatList*/)VSL_STDMETHOD_NOTIMPL
  67
  68         STDMETHOD(GetFormatInfo)(
  69                 /*[in]*/ ULONG /*nFormatIndex*/,
  70                 /*[out,optional]*/ UINT* /*puiCodePage*/)VSL_STDMETHOD_NOTIMPL
  71
  72         STDMETHOD(FindFormatIndex)(
  73                 /*[in]*/ UINT /*uiCodePage*/,
  74                 /*[out,optional]*/ ULONG* /*pnFormatIndex*/)VSL_STDMETHOD_NOTIMPL
  75 };
  76
  77 class IVsStructuredFileIOMockImpl :
  78         public IVsStructuredFileIO,
  79         public MockBase
  80 {
  81
  82 VSL_DECLARE_NONINSTANTIABLE_BASE_CLASS(IVsStructuredFileIOMockImpl)
  83
  84 public:
  85
  86 VSL_DEFINE_MOCK_CLASS_TYPDEFS(IVsStructuredFileIOMockImpl)
  87
  88         typedef IVsStructuredFileIO Interface;
  89         struct CreateNewValidValues
  90         {
  91                 /*[in]*/ LPCOLESTR szFileName;
  92                 /*[in]*/ ULONG nFormatIndex;
  93                 /*[in]*/ DWORD dwShareMode;
  94                 /*[in]*/ DWORD dwCreationDisposition;
  95                 /*[in]*/ DWORD dwFlagsAndAttributes;
  96                 /*[in]*/ IVsStructuredFileIOHelper* pIVsStructuredFileIOHelper;
  97                 /*[in]*/ LPCOLESTR szFormatVersion;
  98                 /*[in]*/ LPCOLESTR szDescription;
  99                 /*[out]*/ IVsPropertyFileOut** ppIVsPropertyFileOut;
 100                 HRESULT retValue;
 101         };
 102
 103         STDMETHOD(CreateNew)(
 104                 /*[in]*/ LPCOLESTR szFileName,
 105                 /*[in]*/ ULONG nFormatIndex,
 106                 /*[in]*/ DWORD dwShareMode,
 107                 /*[in]*/ DWORD dwCreationDisposition,
 108                 /*[in]*/ DWORD dwFlagsAndAttributes,
 109                 /*[in]*/ IVsStructuredFileIOHelper* pIVsStructuredFileIOHelper,
 110                 /*[in]*/ LPCOLESTR szFormatVersion,
 111                 /*[in]*/ LPCOLESTR szDescription,
 112                 /*[out]*/ IVsPropertyFileOut** ppIVsPropertyFileOut)
 113         {
 114                 VSL_DEFINE_MOCK_METHOD(CreateNew)
 115
 116                 VSL_CHECK_VALIDVALUE_STRINGW(szFileName);
 117
 118                 VSL_CHECK_VALIDVALUE(nFormatIndex);
 119
 120                 VSL_CHECK_VALIDVALUE(dwShareMode);
 121
 122                 VSL_CHECK_VALIDVALUE(dwCreationDisposition);
 123
 124                 VSL_CHECK_VALIDVALUE(dwFlagsAndAttributes);
 125
 126                 VSL_CHECK_VALIDVALUE_INTERFACEPOINTER(pIVsStructuredFileIOHelper);
 127
 128                 VSL_CHECK_VALIDVALUE_STRINGW(szFormatVersion);
 129
 130                 VSL_CHECK_VALIDVALUE_STRINGW(szDescription);
 131
 132                 VSL_SET_VALIDVALUE_INTERFACE(ppIVsPropertyFileOut);
 133
 134                 VSL_RETURN_VALIDVALUES();
 135         }
 136         struct OpenExistingValidValues
 137         {
 138                 /*[in]*/ LPCOLESTR szFileName;
 139                 /*[in]*/ DWORD dwShareMode;
 140                 /*[in]*/ DWORD dwCreationDisposition;
 141                 /*[in]*/ DWORD dwFlagsAndAttributes;
 142                 /*[in]*/ IVsStructuredFileIOHelper* pIVsStructuredFileIOHelper;
 143                 /*[out]*/ ULONG* pnFormatIndex;
 144                 /*[out]*/ IVsPropertyFileIn** ppIVsPropertyFileIn;
 145                 /*[out,optional]*/ BSTR* pbstrFormatVersion;
 146                 HRESULT retValue;
 147         };
 148
 149         STDMETHOD(OpenExisting)(
 150                 /*[in]*/ LPCOLESTR szFileName,
 151                 /*[in]*/ DWORD dwShareMode,
 152                 /*[in]*/ DWORD dwCreationDisposition,
 153                 /*[in]*/ DWORD dwFlagsAndAttributes,
 154                 /*[in]*/ IVsStructuredFileIOHelper* pIVsStructuredFileIOHelper,
 155                 /*[out]*/ ULONG* pnFormatIndex,
 156                 /*[out]*/ IVsPropertyFileIn** ppIVsPropertyFileIn,
 157                 /*[out,optional]*/ BSTR* pbstrFormatVersion)
 158         {
 159                 VSL_DEFINE_MOCK_METHOD(OpenExisting)
 160
 161                 VSL_CHECK_VALIDVALUE_STRINGW(szFileName);
 162
 163                 VSL_CHECK_VALIDVALUE(dwShareMode);
 164
 165                 VSL_CHECK_VALIDVALUE(dwCreationDisposition);
 166
 167                 VSL_CHECK_VALIDVALUE(dwFlagsAndAttributes);
 168
 169                 VSL_CHECK_VALIDVALUE_INTERFACEPOINTER(pIVsStructuredFileIOHelper);
 170
 171                 VSL_SET_VALIDVALUE(pnFormatIndex);
 172
 173                 VSL_SET_VALIDVALUE_INTERFACE(ppIVsPropertyFileIn);
 174
 175                 VSL_SET_VALIDVALUE_BSTR(pbstrFormatVersion);
 176
 177                 VSL_RETURN_VALIDVALUES();
 178         }
 179         struct GetFormatListValidValues
 180         {
 181                 /*[in]*/ LPCOLESTR szEntityName;
 182                 /*[in]*/ LPCOLESTR szFileTypes;
 183                 /*[out]*/ LPOLESTR* ppszFormatList;
 184                 HRESULT retValue;
 185         };
 186
 187         STDMETHOD(GetFormatList)(
 188                 /*[in]*/ LPCOLESTR szEntityName,
 189                 /*[in]*/ LPCOLESTR szFileTypes,
 190                 /*[out]*/ LPOLESTR* ppszFormatList)
 191         {
 192                 VSL_DEFINE_MOCK_METHOD(GetFormatList)
 193
 194                 VSL_CHECK_VALIDVALUE_STRINGW(szEntityName);
 195
 196                 VSL_CHECK_VALIDVALUE_STRINGW(szFileTypes);
 197
 198                 VSL_SET_VALIDVALUE(ppszFormatList);
 199
 200                 VSL_RETURN_VALIDVALUES();
 201         }
 202         struct GetFormatInfoValidValues
 203         {
 204                 /*[in]*/ ULONG nFormatIndex;
 205                 /*[out,optional]*/ UINT* puiCodePage;
 206                 HRESULT retValue;
 207         };
 208
 209         STDMETHOD(GetFormatInfo)(
 210                 /*[in]*/ ULONG nFormatIndex,
 211                 /*[out,optional]*/ UINT* puiCodePage)
 212         {
 213                 VSL_DEFINE_MOCK_METHOD(GetFormatInfo)
 214
 215                 VSL_CHECK_VALIDVALUE(nFormatIndex);
 216
 217                 VSL_SET_VALIDVALUE(puiCodePage);
 218
 219                 VSL_RETURN_VALIDVALUES();
 220         }
 221         struct FindFormatIndexValidValues
 222         {
 223                 /*[in]*/ UINT uiCodePage;
 224                 /*[out,optional]*/ ULONG* pnFormatIndex;
 225                 HRESULT retValue;
 226         };
 227
 228         STDMETHOD(FindFormatIndex)(
 229                 /*[in]*/ UINT uiCodePage,
 230                 /*[out,optional]*/ ULONG* pnFormatIndex)
 231         {
 232                 VSL_DEFINE_MOCK_METHOD(FindFormatIndex)
 233
 234                 VSL_CHECK_VALIDVALUE(uiCodePage);
 235
 236                 VSL_SET_VALIDVALUE(pnFormatIndex);
 237
 238                 VSL_RETURN_VALIDVALUES();
 239         }
 240 };
 241
 242
 243 } // namespace VSL
 244
 245 #pragma warning(pop)
 246
 247 #endif // IVSSTRUCTUREDFILEIO_H_10C49CA1_2F46_11D3_A504_00C04F5E0BA5