src/TortoiseProc/BstrSafeVector.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2023 - TortoiseGit
   4 // Copyright (C) 2010 - TortoiseSVN
   5
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 #pragma once
  21
  22 class CBstrSafeVector {
  23 public:
  24         CBstrSafeVector() = default;
  25         CBstrSafeVector( ULONG count );
  26         ~CBstrSafeVector() { release(); }
  27
  28         const SAFEARRAY* operator ->() { return controlled; }
  29         operator SAFEARRAY*() { return controlled; }
  30         operator const SAFEARRAY*() const { return controlled; }
  31
  32         SAFEARRAY** operator&();
  33
  34         HRESULT PutElement( LONG index, const CString& value );
  35
  36 private:
  37         SAFEARRAY* controlled = nullptr;
  38
  39         void release();
  40 };
  41
  42 inline CBstrSafeVector::CBstrSafeVector( ULONG count )
  43 {
  44         controlled = SafeArrayCreateVector(VT_BSTR, 0, count);
  45 }
  46
  47 inline SAFEARRAY** CBstrSafeVector::operator&()
  48 {
  49         release();
  50         return &controlled;
  51 }
  52
  53 inline HRESULT CBstrSafeVector::PutElement( LONG index, const CString& value )
  54 {
  55         ATL::CComBSTR valueBstr;
  56         valueBstr.Attach( value.AllocSysString() );
  57         return SafeArrayPutElement(controlled, &index, valueBstr);
  58 }
  59
  60 inline void CBstrSafeVector::release()
  61 {
  62         if (!controlled)
  63                 return;
  64         SafeArrayDestroy(controlled);
  65         controlled = 0;
  66 }