src/Utils/ShellUpdater.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2006, 2015 - 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 #include "TGitPath.h"
  22
  23 /**
  24 * \ingroup Utils
  25 * This singleton class contains a list of items which require a shell-update notification
  26 * This update is done lazily at the end of a run of Git operations
  27 */
  28 class CShellUpdater
  29 {
  30 private:
  31         CShellUpdater(void);
  32         ~CShellUpdater(void);
  33         // prevent cloning
  34         CShellUpdater(const CShellUpdater&) = delete;
  35         CShellUpdater& operator=(const CShellUpdater&) = delete;
  36 public:
  37         static CShellUpdater& Instance();
  38
  39 public:
  40         /**
  41          * Add a single path for updating.
  42          * The update will happen at some suitable time in the future
  43          */
  44         void AddPathForUpdate(const CTGitPath& path);
  45         /**
  46          * Add a list of paths for updating.
  47          * The update will happen at some suitable time in the future
  48          */
  49         void AddPathsForUpdate(const CTGitPathList& pathList);
  50         /**
  51          * Do the update, and clear the list of items waiting
  52          */
  53         void Flush();
  54
  55         static bool RebuildIcons();
  56
  57 private:
  58         void UpdateShell();
  59
  60 private:
  61         // The list of paths which will need updating
  62         CTGitPathList m_pathsForUpdating;
  63         // A handle to an event which, when set, tells the ShellExtension to purge its status cache
  64         HANDLE                  m_hInvalidationEvent;
  65 };