Add basic infrastructure to assign attributes to paths
This adds the basic infrastructure to assign attributes to
paths, in a way similar to what the exclusion mechanism does
based on $GIT_DIR/info/exclude and .gitignore files.
An attribute is just a simple string that does not contain any
whitespace. They can be specified in $GIT_DIR/info/attributes
file, and .gitattributes file in each directory.
Each line in these files defines a pattern matching rule.
Similar to the exclusion mechanism, a later match overrides an
earlier match in the same file, and entries from .gitattributes
file in the same directory takes precedence over the ones from
parent directories. Lines in $GIT_DIR/info/attributes file are
used as the lowest precedence default rules.
A line is either a comment (an empty line, or a line that begins
with a '#'), or a rule, which is a whitespace separated list of
tokens. The first token on the line is a shell glob pattern.
The rest are names of attributes, each of which can optionally
be prefixed with '!'. Such a line means "if a path matches this
glob, this attribute is set (or unset -- if the attribute name
is prefixed with '!'). For glob matching, the same "if the
pattern does not have a slash in it, the basename of the path is
matched with fnmatch(3) against the pattern, otherwise, the path
is matched with the pattern with FNM_PATHNAME" rule as the
exclusion mechanism is used.
This does not define what an attribute means. Tying an
attribute to various effects it has on git operation for paths
that have it will be specified separately.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-12 08:07:32 +00:00
|
|
|
#ifndef ATTR_H
|
|
|
|
#define ATTR_H
|
|
|
|
|
2019-11-17 21:04:47 +00:00
|
|
|
/**
|
|
|
|
* gitattributes mechanism gives a uniform way to associate various attributes
|
|
|
|
* to set of paths.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Querying Specific Attributes
|
|
|
|
* ----------------------------
|
|
|
|
*
|
|
|
|
* - Prepare `struct attr_check` using attr_check_initl() function, enumerating
|
|
|
|
* the names of attributes whose values you are interested in, terminated with
|
|
|
|
* a NULL pointer. Alternatively, an empty `struct attr_check` can be
|
|
|
|
* prepared by calling `attr_check_alloc()` function and then attributes you
|
|
|
|
* want to ask about can be added to it with `attr_check_append()` function.
|
|
|
|
*
|
|
|
|
* - Call `git_check_attr()` to check the attributes for the path.
|
|
|
|
*
|
|
|
|
* - Inspect `attr_check` structure to see how each of the attribute in the
|
|
|
|
* array is defined for the path.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Example
|
|
|
|
* -------
|
|
|
|
*
|
|
|
|
* To see how attributes "crlf" and "ident" are set for different paths.
|
|
|
|
*
|
|
|
|
* - Prepare a `struct attr_check` with two elements (because we are checking
|
|
|
|
* two attributes):
|
|
|
|
*
|
|
|
|
* ------------
|
|
|
|
* static struct attr_check *check;
|
|
|
|
* static void setup_check(void)
|
|
|
|
* {
|
|
|
|
* if (check)
|
|
|
|
* return; // already done
|
|
|
|
* check = attr_check_initl("crlf", "ident", NULL);
|
|
|
|
* }
|
|
|
|
* ------------
|
|
|
|
*
|
|
|
|
* - Call `git_check_attr()` with the prepared `struct attr_check`:
|
|
|
|
*
|
|
|
|
* ------------
|
|
|
|
* const char *path;
|
|
|
|
*
|
|
|
|
* setup_check();
|
2023-05-06 04:15:29 +00:00
|
|
|
* git_check_attr(&the_index, path, check);
|
2019-11-17 21:04:47 +00:00
|
|
|
* ------------
|
|
|
|
*
|
|
|
|
* - Act on `.value` member of the result, left in `check->items[]`:
|
|
|
|
*
|
|
|
|
* ------------
|
|
|
|
* const char *value = check->items[0].value;
|
|
|
|
*
|
|
|
|
* if (ATTR_TRUE(value)) {
|
|
|
|
* The attribute is Set, by listing only the name of the
|
|
|
|
* attribute in the gitattributes file for the path.
|
|
|
|
* } else if (ATTR_FALSE(value)) {
|
|
|
|
* The attribute is Unset, by listing the name of the
|
|
|
|
* attribute prefixed with a dash - for the path.
|
|
|
|
* } else if (ATTR_UNSET(value)) {
|
|
|
|
* The attribute is neither set nor unset for the path.
|
|
|
|
* } else if (!strcmp(value, "input")) {
|
|
|
|
* If none of ATTR_TRUE(), ATTR_FALSE(), or ATTR_UNSET() is
|
|
|
|
* true, the value is a string set in the gitattributes
|
|
|
|
* file for the path by saying "attr=value".
|
|
|
|
* } else if (... other check using value as string ...) {
|
|
|
|
* ...
|
|
|
|
* }
|
|
|
|
* ------------
|
|
|
|
*
|
|
|
|
* To see how attributes in argv[] are set for different paths, only
|
|
|
|
* the first step in the above would be different.
|
|
|
|
*
|
|
|
|
* ------------
|
|
|
|
* static struct attr_check *check;
|
|
|
|
* static void setup_check(const char **argv)
|
|
|
|
* {
|
|
|
|
* check = attr_check_alloc();
|
|
|
|
* while (*argv) {
|
|
|
|
* struct git_attr *attr = git_attr(*argv);
|
|
|
|
* attr_check_append(check, attr);
|
|
|
|
* argv++;
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* ------------
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Querying All Attributes
|
|
|
|
* -----------------------
|
|
|
|
*
|
|
|
|
* To get the values of all attributes associated with a file:
|
|
|
|
*
|
|
|
|
* - Prepare an empty `attr_check` structure by calling `attr_check_alloc()`.
|
|
|
|
*
|
|
|
|
* - Call `git_all_attrs()`, which populates the `attr_check` with the
|
|
|
|
* attributes attached to the path.
|
|
|
|
*
|
|
|
|
* - Iterate over the `attr_check.items[]` array to examine the attribute
|
|
|
|
* names and values. The name of the attribute described by an
|
|
|
|
* `attr_check.items[]` object can be retrieved via
|
|
|
|
* `git_attr_name(check->items[i].attr)`. (Please note that no items will be
|
|
|
|
* returned for unset attributes, so `ATTR_UNSET()` will return false for all
|
|
|
|
* returned `attr_check.items[]` objects.)
|
|
|
|
*
|
|
|
|
* - Free the `attr_check` struct by calling `attr_check_free()`.
|
|
|
|
*/
|
|
|
|
|
2022-12-01 14:45:48 +00:00
|
|
|
/**
|
|
|
|
* The maximum line length for a gitattributes file. If the line exceeds this
|
|
|
|
* length we will ignore it.
|
|
|
|
*/
|
|
|
|
#define ATTR_MAX_LINE_LENGTH 2048
|
|
|
|
|
2022-12-01 14:45:53 +00:00
|
|
|
/**
|
|
|
|
* The maximum size of the giattributes file. If the file exceeds this size we
|
|
|
|
* will ignore it.
|
|
|
|
*/
|
|
|
|
#define ATTR_MAX_FILE_SIZE (100 * 1024 * 1024)
|
|
|
|
|
2018-08-13 16:14:20 +00:00
|
|
|
struct index_state;
|
|
|
|
|
2019-11-17 21:04:47 +00:00
|
|
|
/**
|
|
|
|
* An attribute is an opaque object that is identified by its name. Pass the
|
|
|
|
* name to `git_attr()` function to obtain the object of this type.
|
|
|
|
* The internal representation of this structure is of no interest to the
|
|
|
|
* calling programs. The name of the attribute can be retrieved by calling
|
|
|
|
* `git_attr_name()`.
|
|
|
|
*/
|
Add basic infrastructure to assign attributes to paths
This adds the basic infrastructure to assign attributes to
paths, in a way similar to what the exclusion mechanism does
based on $GIT_DIR/info/exclude and .gitignore files.
An attribute is just a simple string that does not contain any
whitespace. They can be specified in $GIT_DIR/info/attributes
file, and .gitattributes file in each directory.
Each line in these files defines a pattern matching rule.
Similar to the exclusion mechanism, a later match overrides an
earlier match in the same file, and entries from .gitattributes
file in the same directory takes precedence over the ones from
parent directories. Lines in $GIT_DIR/info/attributes file are
used as the lowest precedence default rules.
A line is either a comment (an empty line, or a line that begins
with a '#'), or a rule, which is a whitespace separated list of
tokens. The first token on the line is a shell glob pattern.
The rest are names of attributes, each of which can optionally
be prefixed with '!'. Such a line means "if a path matches this
glob, this attribute is set (or unset -- if the attribute name
is prefixed with '!'). For glob matching, the same "if the
pattern does not have a slash in it, the basename of the path is
matched with fnmatch(3) against the pattern, otherwise, the path
is matched with the pattern with FNM_PATHNAME" rule as the
exclusion mechanism is used.
This does not define what an attribute means. Tying an
attribute to various effects it has on git operation for paths
that have it will be specified separately.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-12 08:07:32 +00:00
|
|
|
struct git_attr;
|
|
|
|
|
2017-01-28 02:02:05 +00:00
|
|
|
/* opaque structures used internally for attribute collection */
|
2017-01-28 02:02:02 +00:00
|
|
|
struct all_attrs_item;
|
2017-01-28 02:02:05 +00:00
|
|
|
struct attr_stack;
|
2017-01-28 02:02:02 +00:00
|
|
|
|
2023-05-06 04:15:29 +00:00
|
|
|
/*
|
|
|
|
* The textual object name for the tree-ish used by git_check_attr()
|
|
|
|
* to read attributes from (instead of from the working tree).
|
|
|
|
*/
|
|
|
|
void set_git_attr_source(const char *);
|
|
|
|
|
2007-04-18 23:16:37 +00:00
|
|
|
/*
|
|
|
|
* Given a string, return the gitattribute object that
|
|
|
|
* corresponds to it.
|
|
|
|
*/
|
2017-01-28 02:02:04 +00:00
|
|
|
const struct git_attr *git_attr(const char *);
|
Add basic infrastructure to assign attributes to paths
This adds the basic infrastructure to assign attributes to
paths, in a way similar to what the exclusion mechanism does
based on $GIT_DIR/info/exclude and .gitignore files.
An attribute is just a simple string that does not contain any
whitespace. They can be specified in $GIT_DIR/info/attributes
file, and .gitattributes file in each directory.
Each line in these files defines a pattern matching rule.
Similar to the exclusion mechanism, a later match overrides an
earlier match in the same file, and entries from .gitattributes
file in the same directory takes precedence over the ones from
parent directories. Lines in $GIT_DIR/info/attributes file are
used as the lowest precedence default rules.
A line is either a comment (an empty line, or a line that begins
with a '#'), or a rule, which is a whitespace separated list of
tokens. The first token on the line is a shell glob pattern.
The rest are names of attributes, each of which can optionally
be prefixed with '!'. Such a line means "if a path matches this
glob, this attribute is set (or unset -- if the attribute name
is prefixed with '!'). For glob matching, the same "if the
pattern does not have a slash in it, the basename of the path is
matched with fnmatch(3) against the pattern, otherwise, the path
is matched with the pattern with FNM_PATHNAME" rule as the
exclusion mechanism is used.
This does not define what an attribute means. Tying an
attribute to various effects it has on git operation for paths
that have it will be specified separately.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-12 08:07:32 +00:00
|
|
|
|
2007-04-17 04:33:31 +00:00
|
|
|
/* Internal use */
|
2007-04-18 23:16:37 +00:00
|
|
|
extern const char git_attr__true[];
|
|
|
|
extern const char git_attr__false[];
|
2007-04-17 04:33:31 +00:00
|
|
|
|
2019-11-17 21:04:47 +00:00
|
|
|
/**
|
|
|
|
* Attribute Values
|
|
|
|
* ----------------
|
|
|
|
*
|
|
|
|
* An attribute for a path can be in one of four states: Set, Unset, Unspecified
|
|
|
|
* or set to a string, and `.value` member of `struct attr_check_item` records
|
|
|
|
* it. The three macros check these, if none of them returns true, `.value`
|
|
|
|
* member points at a string value of the attribute for the path.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Returns true if the attribute is Set for the path. */
|
2007-04-18 23:16:37 +00:00
|
|
|
#define ATTR_TRUE(v) ((v) == git_attr__true)
|
2019-11-17 21:04:47 +00:00
|
|
|
|
|
|
|
/* Returns true if the attribute is Unset for the path. */
|
2007-04-18 23:16:37 +00:00
|
|
|
#define ATTR_FALSE(v) ((v) == git_attr__false)
|
2019-11-17 21:04:47 +00:00
|
|
|
|
|
|
|
/* Returns true if the attribute is Unspecified for the path. */
|
2007-04-18 23:16:37 +00:00
|
|
|
#define ATTR_UNSET(v) ((v) == NULL)
|
2007-04-17 04:33:31 +00:00
|
|
|
|
2019-11-17 21:04:47 +00:00
|
|
|
/* This structure represents one attribute and its value. */
|
2017-01-28 02:01:54 +00:00
|
|
|
struct attr_check_item {
|
2017-01-28 02:01:48 +00:00
|
|
|
const struct git_attr *attr;
|
2007-04-18 23:16:37 +00:00
|
|
|
const char *value;
|
Add basic infrastructure to assign attributes to paths
This adds the basic infrastructure to assign attributes to
paths, in a way similar to what the exclusion mechanism does
based on $GIT_DIR/info/exclude and .gitignore files.
An attribute is just a simple string that does not contain any
whitespace. They can be specified in $GIT_DIR/info/attributes
file, and .gitattributes file in each directory.
Each line in these files defines a pattern matching rule.
Similar to the exclusion mechanism, a later match overrides an
earlier match in the same file, and entries from .gitattributes
file in the same directory takes precedence over the ones from
parent directories. Lines in $GIT_DIR/info/attributes file are
used as the lowest precedence default rules.
A line is either a comment (an empty line, or a line that begins
with a '#'), or a rule, which is a whitespace separated list of
tokens. The first token on the line is a shell glob pattern.
The rest are names of attributes, each of which can optionally
be prefixed with '!'. Such a line means "if a path matches this
glob, this attribute is set (or unset -- if the attribute name
is prefixed with '!'). For glob matching, the same "if the
pattern does not have a slash in it, the basename of the path is
matched with fnmatch(3) against the pattern, otherwise, the path
is matched with the pattern with FNM_PATHNAME" rule as the
exclusion mechanism is used.
This does not define what an attribute means. Tying an
attribute to various effects it has on git operation for paths
that have it will be specified separately.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-12 08:07:32 +00:00
|
|
|
};
|
|
|
|
|
2019-11-17 21:04:47 +00:00
|
|
|
/**
|
|
|
|
* This structure represents a collection of `attr_check_item`. It is passed to
|
|
|
|
* `git_check_attr()` function, specifying the attributes to check, and
|
|
|
|
* receives their values.
|
|
|
|
*/
|
attr: (re)introduce git_check_attr() and struct attr_check
A common pattern to check N attributes for many paths is to
(1) prepare an array A of N attr_check_item items;
(2) call git_attr() to intern the N attribute names and fill A;
(3) repeatedly call git_check_attrs() for path with N and A;
A look-up for these N attributes for a single path P scans the
entire attr_stack, starting from the .git/info/attributes file and
then .gitattributes file in the directory the path P is in, going
upwards to find .gitattributes file found in parent directories.
An earlier commit 06a604e6 (attr: avoid heavy work when we know the
specified attr is not defined, 2014-12-28) tried to optimize out
this scanning for one trivial special case: when the attribute being
sought is known not to exist, we do not have to scan for it. While
this may be a cheap and effective heuristic, it would not work well
when N is (much) more than 1.
What we would want is a more customized way to skip irrelevant
entries in the attribute stack, and the definition of irrelevance
is tied to the set of attributes passed to git_check_attrs() call,
i.e. the set of attributes being sought. The data necessary for
this optimization needs to live alongside the set of attributes, but
a simple array of git_attr_check_elem simply does not have any place
for that.
Introduce "struct attr_check" that contains N, the number of
attributes being sought, and A, the array that holds N
attr_check_item items, and a function git_check_attr() that
takes a path P and this structure as its parameters. This structure
can later be extended to hold extra data necessary for optimization.
Also, to make it easier to write the first two steps in common
cases, introduce git_attr_check_initl() helper function, which takes
a NULL-terminated list of attribute names and initialize this
structure.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Brandon Williams <bmwill@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-01-30 18:05:20 +00:00
|
|
|
struct attr_check {
|
|
|
|
int nr;
|
|
|
|
int alloc;
|
|
|
|
struct attr_check_item *items;
|
2017-01-28 02:02:02 +00:00
|
|
|
int all_attrs_nr;
|
|
|
|
struct all_attrs_item *all_attrs;
|
2017-01-28 02:02:05 +00:00
|
|
|
struct attr_stack *stack;
|
attr: (re)introduce git_check_attr() and struct attr_check
A common pattern to check N attributes for many paths is to
(1) prepare an array A of N attr_check_item items;
(2) call git_attr() to intern the N attribute names and fill A;
(3) repeatedly call git_check_attrs() for path with N and A;
A look-up for these N attributes for a single path P scans the
entire attr_stack, starting from the .git/info/attributes file and
then .gitattributes file in the directory the path P is in, going
upwards to find .gitattributes file found in parent directories.
An earlier commit 06a604e6 (attr: avoid heavy work when we know the
specified attr is not defined, 2014-12-28) tried to optimize out
this scanning for one trivial special case: when the attribute being
sought is known not to exist, we do not have to scan for it. While
this may be a cheap and effective heuristic, it would not work well
when N is (much) more than 1.
What we would want is a more customized way to skip irrelevant
entries in the attribute stack, and the definition of irrelevance
is tied to the set of attributes passed to git_check_attrs() call,
i.e. the set of attributes being sought. The data necessary for
this optimization needs to live alongside the set of attributes, but
a simple array of git_attr_check_elem simply does not have any place
for that.
Introduce "struct attr_check" that contains N, the number of
attributes being sought, and A, the array that holds N
attr_check_item items, and a function git_check_attr() that
takes a path P and this structure as its parameters. This structure
can later be extended to hold extra data necessary for optimization.
Also, to make it easier to write the first two steps in common
cases, introduce git_attr_check_initl() helper function, which takes
a NULL-terminated list of attribute names and initialize this
structure.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Brandon Williams <bmwill@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-01-30 18:05:20 +00:00
|
|
|
};
|
|
|
|
|
2018-06-30 09:20:21 +00:00
|
|
|
struct attr_check *attr_check_alloc(void);
|
|
|
|
struct attr_check *attr_check_initl(const char *, ...);
|
|
|
|
struct attr_check *attr_check_dup(const struct attr_check *check);
|
attr: (re)introduce git_check_attr() and struct attr_check
A common pattern to check N attributes for many paths is to
(1) prepare an array A of N attr_check_item items;
(2) call git_attr() to intern the N attribute names and fill A;
(3) repeatedly call git_check_attrs() for path with N and A;
A look-up for these N attributes for a single path P scans the
entire attr_stack, starting from the .git/info/attributes file and
then .gitattributes file in the directory the path P is in, going
upwards to find .gitattributes file found in parent directories.
An earlier commit 06a604e6 (attr: avoid heavy work when we know the
specified attr is not defined, 2014-12-28) tried to optimize out
this scanning for one trivial special case: when the attribute being
sought is known not to exist, we do not have to scan for it. While
this may be a cheap and effective heuristic, it would not work well
when N is (much) more than 1.
What we would want is a more customized way to skip irrelevant
entries in the attribute stack, and the definition of irrelevance
is tied to the set of attributes passed to git_check_attrs() call,
i.e. the set of attributes being sought. The data necessary for
this optimization needs to live alongside the set of attributes, but
a simple array of git_attr_check_elem simply does not have any place
for that.
Introduce "struct attr_check" that contains N, the number of
attributes being sought, and A, the array that holds N
attr_check_item items, and a function git_check_attr() that
takes a path P and this structure as its parameters. This structure
can later be extended to hold extra data necessary for optimization.
Also, to make it easier to write the first two steps in common
cases, introduce git_attr_check_initl() helper function, which takes
a NULL-terminated list of attribute names and initialize this
structure.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Brandon Williams <bmwill@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-01-30 18:05:20 +00:00
|
|
|
|
2018-06-30 09:20:21 +00:00
|
|
|
struct attr_check_item *attr_check_append(struct attr_check *check,
|
|
|
|
const struct git_attr *attr);
|
attr: (re)introduce git_check_attr() and struct attr_check
A common pattern to check N attributes for many paths is to
(1) prepare an array A of N attr_check_item items;
(2) call git_attr() to intern the N attribute names and fill A;
(3) repeatedly call git_check_attrs() for path with N and A;
A look-up for these N attributes for a single path P scans the
entire attr_stack, starting from the .git/info/attributes file and
then .gitattributes file in the directory the path P is in, going
upwards to find .gitattributes file found in parent directories.
An earlier commit 06a604e6 (attr: avoid heavy work when we know the
specified attr is not defined, 2014-12-28) tried to optimize out
this scanning for one trivial special case: when the attribute being
sought is known not to exist, we do not have to scan for it. While
this may be a cheap and effective heuristic, it would not work well
when N is (much) more than 1.
What we would want is a more customized way to skip irrelevant
entries in the attribute stack, and the definition of irrelevance
is tied to the set of attributes passed to git_check_attrs() call,
i.e. the set of attributes being sought. The data necessary for
this optimization needs to live alongside the set of attributes, but
a simple array of git_attr_check_elem simply does not have any place
for that.
Introduce "struct attr_check" that contains N, the number of
attributes being sought, and A, the array that holds N
attr_check_item items, and a function git_check_attr() that
takes a path P and this structure as its parameters. This structure
can later be extended to hold extra data necessary for optimization.
Also, to make it easier to write the first two steps in common
cases, introduce git_attr_check_initl() helper function, which takes
a NULL-terminated list of attribute names and initialize this
structure.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Brandon Williams <bmwill@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-01-30 18:05:20 +00:00
|
|
|
|
2018-06-30 09:20:21 +00:00
|
|
|
void attr_check_reset(struct attr_check *check);
|
|
|
|
void attr_check_clear(struct attr_check *check);
|
|
|
|
void attr_check_free(struct attr_check *check);
|
attr: (re)introduce git_check_attr() and struct attr_check
A common pattern to check N attributes for many paths is to
(1) prepare an array A of N attr_check_item items;
(2) call git_attr() to intern the N attribute names and fill A;
(3) repeatedly call git_check_attrs() for path with N and A;
A look-up for these N attributes for a single path P scans the
entire attr_stack, starting from the .git/info/attributes file and
then .gitattributes file in the directory the path P is in, going
upwards to find .gitattributes file found in parent directories.
An earlier commit 06a604e6 (attr: avoid heavy work when we know the
specified attr is not defined, 2014-12-28) tried to optimize out
this scanning for one trivial special case: when the attribute being
sought is known not to exist, we do not have to scan for it. While
this may be a cheap and effective heuristic, it would not work well
when N is (much) more than 1.
What we would want is a more customized way to skip irrelevant
entries in the attribute stack, and the definition of irrelevance
is tied to the set of attributes passed to git_check_attrs() call,
i.e. the set of attributes being sought. The data necessary for
this optimization needs to live alongside the set of attributes, but
a simple array of git_attr_check_elem simply does not have any place
for that.
Introduce "struct attr_check" that contains N, the number of
attributes being sought, and A, the array that holds N
attr_check_item items, and a function git_check_attr() that
takes a path P and this structure as its parameters. This structure
can later be extended to hold extra data necessary for optimization.
Also, to make it easier to write the first two steps in common
cases, introduce git_attr_check_initl() helper function, which takes
a NULL-terminated list of attribute names and initialize this
structure.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Brandon Williams <bmwill@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-01-30 18:05:20 +00:00
|
|
|
|
2011-08-04 04:36:17 +00:00
|
|
|
/*
|
|
|
|
* Return the name of the attribute represented by the argument. The
|
|
|
|
* return value is a pointer to a null-delimited string that is part
|
|
|
|
* of the internal data structure; it should not be modified or freed.
|
|
|
|
*/
|
2018-06-30 09:20:21 +00:00
|
|
|
const char *git_attr_name(const struct git_attr *);
|
2011-08-04 04:36:17 +00:00
|
|
|
|
2021-04-01 01:49:39 +00:00
|
|
|
void git_check_attr(struct index_state *istate,
|
2023-05-06 04:15:29 +00:00
|
|
|
const char *path,
|
2023-01-14 08:30:38 +00:00
|
|
|
struct attr_check *check);
|
Add basic infrastructure to assign attributes to paths
This adds the basic infrastructure to assign attributes to
paths, in a way similar to what the exclusion mechanism does
based on $GIT_DIR/info/exclude and .gitignore files.
An attribute is just a simple string that does not contain any
whitespace. They can be specified in $GIT_DIR/info/attributes
file, and .gitattributes file in each directory.
Each line in these files defines a pattern matching rule.
Similar to the exclusion mechanism, a later match overrides an
earlier match in the same file, and entries from .gitattributes
file in the same directory takes precedence over the ones from
parent directories. Lines in $GIT_DIR/info/attributes file are
used as the lowest precedence default rules.
A line is either a comment (an empty line, or a line that begins
with a '#'), or a rule, which is a whitespace separated list of
tokens. The first token on the line is a shell glob pattern.
The rest are names of attributes, each of which can optionally
be prefixed with '!'. Such a line means "if a path matches this
glob, this attribute is set (or unset -- if the attribute name
is prefixed with '!'). For glob matching, the same "if the
pattern does not have a slash in it, the basename of the path is
matched with fnmatch(3) against the pattern, otherwise, the path
is matched with the pattern with FNM_PATHNAME" rule as the
exclusion mechanism is used.
This does not define what an attribute means. Tying an
attribute to various effects it has on git operation for paths
that have it will be specified separately.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-12 08:07:32 +00:00
|
|
|
|
2011-08-04 04:36:23 +00:00
|
|
|
/*
|
2017-01-30 18:06:08 +00:00
|
|
|
* Retrieve all attributes that apply to the specified path.
|
|
|
|
* check holds the attributes and their values.
|
2011-08-04 04:36:23 +00:00
|
|
|
*/
|
2023-05-06 04:15:29 +00:00
|
|
|
void git_all_attrs(struct index_state *istate,
|
2018-08-13 16:14:20 +00:00
|
|
|
const char *path, struct attr_check *check);
|
2011-08-04 04:36:23 +00:00
|
|
|
|
2009-03-14 04:24:08 +00:00
|
|
|
enum git_attr_direction {
|
|
|
|
GIT_ATTR_CHECKIN,
|
2009-04-17 22:17:58 +00:00
|
|
|
GIT_ATTR_CHECKOUT,
|
2010-05-14 09:31:35 +00:00
|
|
|
GIT_ATTR_INDEX
|
2009-03-14 04:24:08 +00:00
|
|
|
};
|
2018-08-13 16:14:33 +00:00
|
|
|
void git_attr_set_direction(enum git_attr_direction new_direction);
|
2009-03-14 04:24:08 +00:00
|
|
|
|
2018-06-30 09:20:21 +00:00
|
|
|
void attr_start(void);
|
2017-01-28 02:02:01 +00:00
|
|
|
|
2023-06-27 16:19:00 +00:00
|
|
|
/* Return the system gitattributes file. */
|
|
|
|
const char *git_attr_system_file(void);
|
|
|
|
|
|
|
|
/* Return the global gitattributes file, if any. */
|
|
|
|
const char *git_attr_global_file(void);
|
|
|
|
|
|
|
|
/* Return whether the system gitattributes file is enabled and should be used. */
|
|
|
|
int git_attr_system_is_enabled(void);
|
|
|
|
|
Add basic infrastructure to assign attributes to paths
This adds the basic infrastructure to assign attributes to
paths, in a way similar to what the exclusion mechanism does
based on $GIT_DIR/info/exclude and .gitignore files.
An attribute is just a simple string that does not contain any
whitespace. They can be specified in $GIT_DIR/info/attributes
file, and .gitattributes file in each directory.
Each line in these files defines a pattern matching rule.
Similar to the exclusion mechanism, a later match overrides an
earlier match in the same file, and entries from .gitattributes
file in the same directory takes precedence over the ones from
parent directories. Lines in $GIT_DIR/info/attributes file are
used as the lowest precedence default rules.
A line is either a comment (an empty line, or a line that begins
with a '#'), or a rule, which is a whitespace separated list of
tokens. The first token on the line is a shell glob pattern.
The rest are names of attributes, each of which can optionally
be prefixed with '!'. Such a line means "if a path matches this
glob, this attribute is set (or unset -- if the attribute name
is prefixed with '!'). For glob matching, the same "if the
pattern does not have a slash in it, the basename of the path is
matched with fnmatch(3) against the pattern, otherwise, the path
is matched with the pattern with FNM_PATHNAME" rule as the
exclusion mechanism is used.
This does not define what an attribute means. Tying an
attribute to various effects it has on git operation for paths
that have it will be specified separately.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-12 08:07:32 +00:00
|
|
|
#endif /* ATTR_H */
|