KiCad PCB EDA Suite
Loading...
Searching...
No Matches
kigit_ignore.h File Reference
#include <import_export.h>
#include <vector>
#include <wx/filename.h>
#include <wx/string.h>

Go to the source code of this file.

Classes

struct  KIGIT::IGNORE_STATE
 What an ignore rule for one path would achieve. More...
 

Namespaces

namespace  KIGIT
 

Functions

APIEXPORT wxFileName KIGIT::ProjectIgnoreFile (const wxString &aProjectPath)
 The ignore file that covers a project.
 
APIEXPORT wxString KIGIT::PathIgnoreRule (const wxString &aProjectRelPath, bool aIsDirectory)
 The rule that ignores one path and nothing else.
 
APIEXPORT wxString KIGIT::ExtensionIgnoreRule (const wxString &aProjectRelPath)
 The rule that ignores every file sharing a path's extension, or nothing when it has none.
 
APIEXPORT std::vector< wxString > KIGIT::ReadIgnoreRules (const wxFileName &aIgnoreFile)
 The rules an ignore file holds, in order, without its comments and blank lines.
 
APIEXPORT bool KIGIT::AddIgnoreRules (const wxFileName &aIgnoreFile, const std::vector< wxString > &aRules, const wxString &aHeader, wxString &aError)
 Append rules to an ignore file, creating it with aHeader as a comment when it is not there.
 
APIEXPORT bool KIGIT::RemoveIgnoreRules (const wxFileName &aIgnoreFile, const std::vector< wxString > &aRules, wxString &aError)
 Remove rules from an ignore file.
 
APIEXPORT IGNORE_STATE KIGIT::IgnoreState (KIGIT_COMMON &aCommon, const wxString &aProjectRelPath, bool aIsDirectory)
 What git's rules and its index say about a project path, so the user is offered only what would take effect.