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