src/TortoiseProc/ILogReceiver.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2007-2007 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 ///////////////////////////////////////////////////////////////
  22 // temporarily used to disambiguate LogChangedPath definitions
  23 ///////////////////////////////////////////////////////////////
  24
  25 #ifndef __ILOGRECEIVER_H__
  26 #define __ILOGRECEIVER_H__
  27 #endif
  28
  29 ///////////////////////////////////////////////////////////////
  30 // required includes
  31 ///////////////////////////////////////////////////////////////
  32
  33 //#include "svn_types.h"
  34
  35
  36 /**
  37  * data structure to accommodate the change list.
  38  */
  39 struct LogChangedPath
  40 {
  41         CString sPath;
  42 //      CString sCopyFromPath;
  43         CString lCopyFromRev;
  44         DWORD action;
  45
  46         /// returns the action as a string
  47         const CString& GetAction() const;
  48
  49 private:
  50
  51         /// cached return value of GetAction()
  52         mutable CString actionAsString;
  53 };
  54
  55
  56
  57 /// auto-deleting extension of MFC Arrays for pointer arrays
  58
  59 template<class T>
  60 class CAutoArray : public CArray<T*,T*>
  61 {
  62 public:
  63
  64         // default and copy construction
  65
  66         CAutoArray()
  67         {
  68         }
  69
  70         CAutoArray (const CAutoArray& rhs)
  71         {
  72                 Copy (rhs);
  73         }
  74
  75         // destruction deletes members
  76
  77         ~CAutoArray()
  78         {
  79                 for (INT_PTR i = 0, count = GetCount(); i < count; ++i)
  80                         delete GetAt (i);
  81         }
  82 };
  83
  84 typedef CAutoArray<LogChangedPath> LogChangedPathArray;
  85
  86 /**
  87  * standard revision properties
  88  */
  89
  90 struct StandardRevProps
  91 {
  92         CString author;
  93 //      apr_time_t timeStamp;
  94         CString message;
  95 };
  96
  97 /**
  98  * data structure to accommodate the list of user-defined revision properties.
  99  */
 100 struct UserRevProp
 101 {
 102         CString name;
 103         CString value;
 104 };
 105
 106 typedef CAutoArray<UserRevProp> UserRevPropArray;
 107
 108
 109 /**
 110  * Interface for receiving log information. It will be used as a callback
 111  * in ILogQuery::Log().
 112  *
 113  * To cancel the log and/or indicate errors, throw an SVNError exception.
 114  */
 115 class ILogReceiver
 116 {
 117 public:
 118
 119         /// call-back for every revision found
 120         /// (called at most once per revision)
 121         ///
 122         /// the implementation may modify but not delete()
 123         /// the data containers passed to it
 124         ///
 125         /// any pointer may be NULL
 126         ///
 127         /// may throw a SVNError to cancel the log
 128
 129         virtual void ReceiveLog ( LogChangedPathArray* changes
 130                                                         , CString rev
 131                                                         , const StandardRevProps* stdRevProps
 132                                                         , UserRevPropArray* userRevProps
 133                                                         , bool mergesFollow) = 0;
 134 };