Interrogate the current state of a git repository.

Once the target directory is set, either on construction or using the dir() member function, the repo name, branch, commit hash, and modification status are interrogated with calls to git. This includes a list of uncommitted changes, including untracked files.

Examples:

mx::sys::gitRepo gr( "/path/to/repo/name");
std::cout << gr.modified() << '\n'; //will be 1 if modified, 0 if not modified
std::cout << gr.isNotCommitted("filename") << '\n'; //will be 1 if this file is not committed.  0 otherwise.

Definition at line 52 of file gitRepo.hpp.

#include <sys/gitRepo.hpp>

Public Member Functions
	gitRepo ()
	Default c'tor.

	gitRepo (const std::string &d)
	Constructor which sets the directory.

void	dir (const std::string &d)
	Set the directory.

std::string	dir ()
	Get the current directory.

std::string	gitDir ()
	Get the current repo's .git directory.

std::string	name ()
	Get the repo's name.

std::string	branch ()
	Get the current branch.

std::string	hash ()
	Get the current commit hash.

bool	modified ()
	Get whether the repo is modified.

bool	isNotCommitted (const std::string &file)
	Check whether a file is listed as not committed.

Protected Member Functions
int	getGitName ()
	Get the name of the git repo.

int	getGitHash ()
	Get the name of the current commit hash.

int	getGitModified ()
	Get the modification status of the repo.

int	getGitFileState ()
	Get the list of modified files, and the branch name.

Protected Attributes
std::string	m_dir
	The directory of the git repository.

std::string	m_name
	The repo name.

std::string	m_branch
	The current branch.

std::string	m_hash
	The complete commit hash.

bool	m_modified { false }
	The modification status, true or false.

std::set< std::string >	m_modifiedFiles
	Files which git lists as modified.

std::set< std::string >	m_deletedFiles
	Files which git lists as deleted.

std::set< std::string >	m_renamedFiles
	Files which git lists as renamed-from.

std::set< std::string >	m_renamedFiles2
	Files which git lists as renamed-to.

std::set< std::string >	m_untrackedFiles
	Files which git lists as untracked.

Constructor & Destructor Documentation

◆ gitRepo() [1/2]

mx::sys::gitRepo::gitRepo ( )

Default c'tor.

Definition at line 38 of file gitRepo.cpp.

◆ gitRepo() [2/2]

mx::sys::gitRepo::gitRepo ( const std::string & d )

Constructor which sets the directory.

This results in the git repo status being interrogated.

Definition at line 42 of file gitRepo.cpp.

References dir().

Member Function Documentation

◆ branch()

std::string mx::sys::gitRepo::branch ( )

Get the current branch.

Returns: the current branch name

Definition at line 305 of file gitRepo.cpp.

References m_branch.

◆ dir() [1/2]

std::string mx::sys::gitRepo::dir ( )

Get the current directory.

Returns: the git repo directory

Definition at line 57 of file gitRepo.cpp.

References m_dir.

Referenced by gitRepo(), getGitFileState(), getGitHash(), and getGitModified().

◆ dir() [2/2]

void mx::sys::gitRepo::dir ( const std::string & d )

Set the directory.

This results in the git repo status being interrogated.

Definition at line 47 of file gitRepo.cpp.

References getGitFileState(), getGitHash(), getGitModified(), getGitName(), and m_dir.

◆ getGitFileState()

int mx::sys::gitRepo::getGitFileState ( )

protected

Get the list of modified files, and the branch name.

Called whenever m_dir is set.

Returns: 0 on success; -1 on error

Definition at line 181 of file gitRepo.cpp.

References dir(), gitDir(), m_branch, m_deletedFiles, m_modifiedFiles, m_renamedFiles, m_renamedFiles2, m_untrackedFiles, mx::ioutils::removeWhiteSpace(), and mx::ipc::runCommand().

Referenced by dir().

◆ getGitHash()

int mx::sys::gitRepo::getGitHash ( )

protected

Get the name of the current commit hash.

Called whenever m_dir is set.

Returns: 0 on success; -1 on error

Definition at line 108 of file gitRepo.cpp.

References dir(), gitDir(), m_hash, and mx::ipc::runCommand().

Referenced by dir().

◆ getGitModified()

int mx::sys::gitRepo::getGitModified ( )

protected

Get the modification status of the repo.

Called whenever m_dir is set.

Returns: 0 on success; -1 on error

Definition at line 151 of file gitRepo.cpp.

References dir(), gitDir(), m_modified, and mx::ipc::runCommand().

Referenced by dir().

◆ getGitName()

int mx::sys::gitRepo::getGitName ( )

protected

Get the name of the git repo.

Called whenever m_dir is set.

Returns: 0 on success; -1 on error

Definition at line 67 of file gitRepo.cpp.

References gitDir(), m_name, mx::ioutils::pathFilename(), and mx::ipc::runCommand().

Referenced by dir().

◆ gitDir()

std::string mx::sys::gitRepo::gitDir ( )

Get the current repo's .git directory.

Returns: the directory plus "/.git"

Definition at line 62 of file gitRepo.cpp.

References m_dir.

Referenced by getGitFileState(), getGitHash(), getGitModified(), and getGitName().

◆ hash()

std::string mx::sys::gitRepo::hash ( )

Get the current commit hash.

Returns: the current value of the hash

Definition at line 310 of file gitRepo.cpp.

References m_hash.

◆ isNotCommitted()

bool mx::sys::gitRepo::isNotCommitted ( const std::string & file )

Check whether a file is listed as not committed.

Not committed means modified, deleted, renamed (from or to), or untracked.

Returns: true if not committed; false otherwise

Definition at line 320 of file gitRepo.cpp.

References m_deletedFiles, m_modifiedFiles, m_renamedFiles, m_renamedFiles2, and m_untrackedFiles.

◆ modified()

bool mx::sys::gitRepo::modified ( )

Get whether the repo is modified.

Returns: true is modified; false if not modified

Definition at line 315 of file gitRepo.cpp.

References m_modified.

◆ name()

std::string mx::sys::gitRepo::name ( )

Get the repo's name.

Returns: the repo's name

Definition at line 300 of file gitRepo.cpp.

References m_name.

Member Data Documentation

◆ m_branch

std::string mx::sys::gitRepo::m_branch

protected

The current branch.

Definition at line 60 of file gitRepo.hpp.

Referenced by branch(), and getGitFileState().

◆ m_deletedFiles

std::set<std::string> mx::sys::gitRepo::m_deletedFiles

protected

Files which git lists as deleted.

Definition at line 65 of file gitRepo.hpp.

Referenced by getGitFileState(), and isNotCommitted().

◆ m_dir

std::string mx::sys::gitRepo::m_dir

protected

The directory of the git repository.

Definition at line 56 of file gitRepo.hpp.

Referenced by dir(), dir(), and gitDir().

◆ m_hash

std::string mx::sys::gitRepo::m_hash

protected

The complete commit hash.

Definition at line 61 of file gitRepo.hpp.

Referenced by getGitHash(), and hash().

◆ m_modified

bool mx::sys::gitRepo::m_modified { false }

protected

The modification status, true or false.

Definition at line 62 of file gitRepo.hpp.

Referenced by getGitModified(), and modified().

◆ m_modifiedFiles

std::set<std::string> mx::sys::gitRepo::m_modifiedFiles

protected

Files which git lists as modified.

Definition at line 64 of file gitRepo.hpp.

Referenced by getGitFileState(), and isNotCommitted().

◆ m_name

std::string mx::sys::gitRepo::m_name

protected

The repo name.

Definition at line 59 of file gitRepo.hpp.

Referenced by getGitName(), and name().

◆ m_renamedFiles

std::set<std::string> mx::sys::gitRepo::m_renamedFiles

protected

Files which git lists as renamed-from.

Definition at line 66 of file gitRepo.hpp.

Referenced by getGitFileState(), and isNotCommitted().

◆ m_renamedFiles2

std::set<std::string> mx::sys::gitRepo::m_renamedFiles2

protected

Files which git lists as renamed-to.

Definition at line 67 of file gitRepo.hpp.

Referenced by getGitFileState(), and isNotCommitted().

◆ m_untrackedFiles

std::set<std::string> mx::sys::gitRepo::m_untrackedFiles

protected

Files which git lists as untracked.

Definition at line 68 of file gitRepo.hpp.

Referenced by getGitFileState(), and isNotCommitted().

The documentation for this class was generated from the following files:

sys/gitRepo.hpp
/home/jrmales/Source/mxlib/source/sys/gitRepo.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ gitRepo() [1/2]

◆ gitRepo() [2/2]

Member Function Documentation

◆ branch()

◆ dir() [1/2]

◆ dir() [2/2]

◆ getGitFileState()

◆ getGitHash()

◆ getGitModified()

◆ getGitName()

◆ gitDir()

◆ hash()

◆ isNotCommitted()

◆ modified()

◆ name()

Member Data Documentation

◆ m_branch

◆ m_deletedFiles

◆ m_dir

◆ m_hash

◆ m_modified

◆ m_modifiedFiles

◆ m_name

◆ m_renamedFiles

◆ m_renamedFiles2

◆ m_untrackedFiles