src/attr_file.h

   1 /*
   2  * Copyright (C) the libgit2 contributors. All rights reserved.
   3  *
   4  * This file is part of libgit2, distributed under the GNU GPL v2 with
   5  * a Linking Exception. For full terms see the included COPYING file.
   6  */
   7 #ifndef INCLUDE_attr_file_h__
   8 #define INCLUDE_attr_file_h__
   9
  10 #include "git2/oid.h"
  11 #include "git2/attr.h"
  12 #include "vector.h"
  13 #include "pool.h"
  14 #include "buffer.h"
  15 #include "fileops.h"
  16
  17 #define GIT_ATTR_FILE                   ".gitattributes"
  18 #define GIT_ATTR_FILE_INREPO    "info/attributes"
  19 #define GIT_ATTR_FILE_SYSTEM    "gitattributes"
  20
  21 #define GIT_ATTR_FNMATCH_NEGATIVE       (1U << 0)
  22 #define GIT_ATTR_FNMATCH_DIRECTORY      (1U << 1)
  23 #define GIT_ATTR_FNMATCH_FULLPATH       (1U << 2)
  24 #define GIT_ATTR_FNMATCH_MACRO          (1U << 3)
  25 #define GIT_ATTR_FNMATCH_IGNORE         (1U << 4)
  26 #define GIT_ATTR_FNMATCH_HASWILD        (1U << 5)
  27 #define GIT_ATTR_FNMATCH_ALLOWSPACE     (1U << 6)
  28 #define GIT_ATTR_FNMATCH_ICASE          (1U << 7)
  29
  30 extern const char *git_attr__true;
  31 extern const char *git_attr__false;
  32 extern const char *git_attr__unset;
  33
  34 typedef struct {
  35         char *pattern;
  36         size_t length;
  37         unsigned int flags;
  38 } git_attr_fnmatch;
  39
  40 typedef struct {
  41         git_attr_fnmatch match;
  42         git_vector assigns;             /* vector of <git_attr_assignment*> */
  43 } git_attr_rule;
  44
  45 typedef struct {
  46         git_refcount unused;
  47         const char *name;
  48     uint32_t name_hash;
  49 } git_attr_name;
  50
  51 typedef struct {
  52         git_refcount rc;                /* for macros */
  53         char *name;
  54     uint32_t name_hash;
  55     const char *value;
  56 } git_attr_assignment;
  57
  58 typedef struct {
  59         char *key;                              /* cache "source#path" this was loaded from */
  60         git_vector rules;               /* vector of <rule*> or <fnmatch*> */
  61         git_pool *pool;
  62         bool pool_is_allocated;
  63         union {
  64                 git_oid oid;
  65                 git_futils_filestamp stamp;
  66         } cache_data;
  67 } git_attr_file;
  68
  69 typedef struct {
  70         git_buf  full;
  71         char    *path;
  72         char    *basename;
  73         int      is_dir;
  74 } git_attr_path;
  75
  76 typedef enum {
  77         GIT_ATTR_FILE_FROM_FILE = 0,
  78         GIT_ATTR_FILE_FROM_INDEX = 1
  79 } git_attr_file_source;
  80
  81 /*
  82  * git_attr_file API
  83  */
  84
  85 extern int git_attr_file__new(
  86         git_attr_file **attrs_ptr, git_attr_file_source src, const char *path, git_pool *pool);
  87
  88 extern int git_attr_file__new_and_load(
  89         git_attr_file **attrs_ptr, const char *path);
  90
  91 extern void git_attr_file__free(git_attr_file *file);
  92
  93 extern void git_attr_file__clear_rules(git_attr_file *file);
  94
  95 extern int git_attr_file__parse_buffer(
  96         git_repository *repo, void *parsedata, const char *buf, git_attr_file *file);
  97
  98 extern int git_attr_file__lookup_one(
  99         git_attr_file *file,
 100         const git_attr_path *path,
 101         const char *attr,
 102         const char **value);
 103
 104 /* loop over rules in file from bottom to top */
 105 #define git_attr_file__foreach_matching_rule(file, path, iter, rule)    \
 106         git_vector_rforeach(&(file)->rules, (iter), (rule)) \
 107                 if (git_attr_rule__match((rule), (path)))
 108
 109 extern uint32_t git_attr_file__name_hash(const char *name);
 110
 111
 112 /*
 113  * other utilities
 114  */
 115
 116 extern int git_attr_fnmatch__parse(
 117         git_attr_fnmatch *spec,
 118         git_pool *pool,
 119         const char *source,
 120         const char **base);
 121
 122 extern bool git_attr_fnmatch__match(
 123         git_attr_fnmatch *rule,
 124         const git_attr_path *path);
 125
 126 extern void git_attr_rule__free(git_attr_rule *rule);
 127
 128 extern bool git_attr_rule__match(
 129         git_attr_rule *rule,
 130         const git_attr_path *path);
 131
 132 extern git_attr_assignment *git_attr_rule__lookup_assignment(
 133         git_attr_rule *rule, const char *name);
 134
 135 extern int git_attr_path__init(
 136         git_attr_path *info, const char *path, const char *base);
 137
 138 extern void git_attr_path__free(git_attr_path *info);
 139
 140 extern int git_attr_assignment__parse(
 141         git_repository *repo, /* needed to expand macros */
 142         git_pool *pool,
 143         git_vector *assigns,
 144         const char **scan);
 145
 146 #endif