src/Git/GitAdminDir.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2012, 2015-2017 - TortoiseGit
   4 // Copyright (C) 2003-2008 - 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
  21 #pragma once
  22
  23 class GitAdminDir
  24 {
  25 private:
  26         GitAdminDir() = delete;
  27
  28 public:
  29         /// Returns true if the path points to or below an admin directory
  30         static bool IsAdminDirPath(const CString& path);
  31
  32         static bool IsWorkingTreeOrBareRepo(const CString& path);
  33
  34         /// Returns true if the path points is a bare repository
  35         static bool IsBareRepo(const CString& path);
  36
  37         /// Returns true if the path (file or folder) has an admin directory
  38         /// associated, i.e. if the path is in a working copy.
  39         static bool HasAdminDir(const CString& path);
  40         static bool HasAdminDir(const CString& path, CString* ProjectTopDir);
  41         // IsAdminDirPath is only touched/set to true if and only if we the path is an AdminDirPath
  42         static bool HasAdminDir(const CString& path, bool bDir, CString* ProjectTopDir = nullptr, bool* IsAdminDirPath = nullptr);
  43         static CString GetSuperProjectRoot(const CString& path);
  44
  45         static bool GetAdminDirPath(const CString& projectTopDir, CString& adminDir, bool* isWorktree = nullptr);
  46         static bool GetWorktreeAdminDirPath(const CString& projectTopDir, CString& adminDir);
  47         static CString ReadGitLink(const CString& topDir, const CString& dotGitPath);
  48
  49         static CString GetAdminDirName() { return L".git"; }
  50 };