text_eval_vcs.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <kicommon.h>
#include <text_eval/text_eval_environment.h>
#include <wx/string.h>
#include <string>
#include <cstdint>

namespace TEXT_EVAL_VCS
{
KICOMMON_API TEXT_EVAL::ENVIRONMENT::VCS_VALUE ReadSource( const TEXT_EVAL::ENVIRONMENT::VCS_KEY& aKey );

std::string GetCommitHash( const std::string& aPath = ".", int aLength = 40 );

std::string GetNearestTag( const std::string& aMatch = "", bool aAnyTags = false );

int GetDistanceFromTag( const std::string& aMatch = "", bool aAnyTags = false );

bool IsDirty( bool aIncludeUntracked = false );

std::string GetAuthor( const std::string& aPath = "." );

std::string GetAuthorEmail( const std::string& aPath = "." );

std::string GetCommitter( const std::string& aPath = "." );

std::string GetCommitterEmail( const std::string& aPath = "." );

std::string GetBranch();

int64_t GetCommitTimestamp( const std::string& aPath = "." );

std::string GetCommitDate( const std::string& aPath = "." );

KICOMMON_API void SetContextPath( const wxString& aPath );

KICOMMON_API wxString GetContextPath();

KICOMMON_API bool GetContextIsFile();

class KICOMMON_API CONTEXT_PATH_SCOPE
{
public:
    explicit CONTEXT_PATH_SCOPE( const wxString& aPath );
    ~CONTEXT_PATH_SCOPE();
 
    CONTEXT_PATH_SCOPE( const CONTEXT_PATH_SCOPE& ) = delete;
    CONTEXT_PATH_SCOPE& operator=( const CONTEXT_PATH_SCOPE& ) = delete;
 
private:
    wxString m_previous;
    bool     m_previousIsFile;
};
 
} // namespace TEXT_EVAL_VCS