Namespace: Consultingwerk.Studio.Git
Class 
FileSystemBranchInfoProvider Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.Studio.Git.IBranchInfoProvider

/* The IConfigurationProvider property that names the folder of the Git
repository, relative to the working directory of the session or absolute



Top Method Summary
Options Name Purpose
Consultingwerk.Studio.Git.BranchInfo GetBranchInfo () Returns BranchInfo for the current workspace
CHARACTER GetConfiguredGitEntry () Returns the .git entry of the repository named by the GitRepository configuration property
CHARACTER GetConfiguredRepositoryFolder () Returns the value of the GitRepository configuration property
CHARACTER GetFirstLine (character) Returns the first line of the given text file
CHARACTER GetGitBranchName () Returns the current Git branch name
CHARACTER GetGitDirectory () Returns the Git meta data folder of the repository the session belongs to
CHARACTER GetSmartDbBranchName () Returns the SmartDB branch name from the SmartFramework configuration value SmartDB-BranchName
CHARACTER ResolveGitDirectory (character) Returns the Git meta data folder for the given .git entry
CHARACTER SearchGitEntry () Searches the .git entry by walking up the folder hierarchy from the StartFolder

Top Property Summary
Options Name Purpose
CHARACTER StartFolder


Method Detail
Top

Consultingwerk.Studio.Git.BranchInfo GetBranchInfo ()

Purpose: Returns BranchInfo for the current workspace
Notes:

Returns Consultingwerk.Studio.Git.BranchInfo
A BranchInfo instance
Top

CHARACTER GetConfiguredGitEntry ()

Purpose: Returns the .git entry of the repository named by the
GitRepository configuration property
Notes: Returns ? when the property is not maintained, when the folder
cannot be resolved or when it does not hold a .git entry, so
that the caller can fall back to searching the repository

Returns CHARACTER
The name of the .git entry or ? when it cannot be located
Top

CHARACTER GetConfiguredRepositoryFolder ()

Purpose: Returns the value of the GitRepository configuration property
Notes: Returns "" when no IConfigurationProvider is registered in the
ServiceContainer or when the property is not maintained

Returns CHARACTER
The folder of the Git repository
Top

CHARACTER GetFirstLine (character)

Purpose: Returns the first line of the given text file
Notes: Used to read the single line HEAD and .git files of a Git
repository

Parameters:
pcFileName CHARACTER
The name of the file to read
Returns CHARACTER
The first line of the file without leading or trailing whitespace
Top

CHARACTER GetGitBranchName ()

Purpose: Returns the current Git branch name
Notes: Returns "" when the Git repository cannot be located, when the
HEAD file cannot be read or when the repository is in the
detached HEAD state

Returns CHARACTER
The Git branch name
Top

CHARACTER GetGitDirectory ()

Purpose: Returns the Git meta data folder of the repository the session
belongs to
Notes: The repository named by the GitRepository configuration property
is used when that property points to a Git repository, otherwise
the repository is searched by walking up the folder hierarchy
from the StartFolder

Returns CHARACTER
The name of the Git meta data folder or ? when it cannot be located
Top

CHARACTER GetSmartDbBranchName ()

Purpose: Returns the SmartDB branch name from the SmartFramework
configuration value SmartDB-BranchName
Notes: Returns "" when the configuration value is not maintained

Returns CHARACTER
The SmartDB branch name
Top

CHARACTER ResolveGitDirectory (character)

Purpose: Returns the Git meta data folder for the given .git entry
Notes: When .git is a file rather than a folder - which is the case in
a Git worktree or in a submodule - the "gitdir:" reference
stored in that file is resolved

Parameters:
pcGitEntry CHARACTER
The name of the .git entry of the repository
Returns CHARACTER
The name of the Git meta data folder or ? when it cannot be resolved
Top

CHARACTER SearchGitEntry ()

Purpose: Searches the .git entry by walking up the folder hierarchy from
the StartFolder
Notes:

Returns CHARACTER
The name of the .git entry or ? when it cannot be located


Property Detail
Top

CHARACTER StartFolder


Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:17:31