lib/got_lib_worktree.h

   1 /*
   2  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
   3  *
   4  * Permission to use, copy, modify, and distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 struct got_worktree {
  18         char *root_path;
  19         const char *meta_dir;
  20         char *repo_path;
  21         int root_fd;
  22         char *path_prefix;
  23         struct got_object_id *base_commit_id;
  24         char *head_ref_name;
  25         uuid_t uuid;
  26
  27         /*
  28          * File descriptor for the lock file, open while a work tree is open.
  29          * When a work tree is opened, a shared lock on the lock file is
  30          * acquired with flock(2). This shared lock is held until the work
  31          * tree is closed, i.e. throughout the lifetime of any operation
  32          * which uses a work tree.
  33          * Before any modifications are made to the on-disk state of work
  34          * tree meta data, tracked files, or directory tree structure, this
  35          * shared lock must be upgraded to an exclusive lock.
  36          */
  37         int lockfd;
  38
  39         /* Absolute path to worktree's got.conf file. */
  40         char *gotconfig_path;
  41
  42         /* Settings read from got.conf. */
  43         struct got_gotconfig *gotconfig;
  44 };
  45
  46 struct got_commitable {
  47         char *path;
  48         char *in_repo_path;
  49         char *ondisk_path;
  50         unsigned char status;
  51         unsigned char staged_status;
  52         struct got_object_id *blob_id;
  53         struct got_object_id *base_blob_id;
  54         struct got_object_id *staged_blob_id;
  55         struct got_object_id *base_commit_id;
  56         mode_t mode;
  57         int flags;
  58 #define GOT_COMMITABLE_ADDED 0x01
  59 };
  60
  61 /* Also defined in got_worktree.h */
  62 #ifndef GOT_WORKTREE_GOT_DIR
  63 #define GOT_WORKTREE_GOT_DIR            ".got"
  64 #endif
  65 #ifndef GOT_WORKTREE_CVG_DIR
  66 #define GOT_WORKTREE_CVG_DIR            ".cvg"
  67 #endif
  68
  69 #define GOT_WORKTREE_FILE_INDEX         "file-index"
  70 #define GOT_WORKTREE_REPOSITORY         "repository"
  71 #define GOT_WORKTREE_PATH_PREFIX        "path-prefix"
  72 #define GOT_WORKTREE_HEAD_REF           "head-ref"
  73 #define GOT_WORKTREE_BASE_COMMIT        "base-commit"
  74 #define GOT_WORKTREE_LOCK               "lock"
  75 #define GOT_WORKTREE_FORMAT             "format"
  76 #define GOT_WORKTREE_UUID               "uuid"
  77 #define GOT_WORKTREE_HISTEDIT_SCRIPT    "histedit-script"
  78
  79 #define GOT_WORKTREE_FORMAT_VERSION     1
  80 #define GOT_WORKTREE_INVALID_COMMIT_ID  GOT_SHA1_STRING_ZERO
  81
  82 #define GOT_WORKTREE_BASE_REF_PREFIX "refs/got/worktree/base"
  83
  84 /* Temporary branch which accumulates commits during a rebase operation. */
  85 #define GOT_WORKTREE_REBASE_TMP_REF_PREFIX "refs/got/worktree/rebase/tmp"
  86
  87 /* Symbolic reference pointing at the name of the new base branch. */
  88 #define GOT_WORKTREE_NEWBASE_REF_PREFIX "refs/got/worktree/rebase/newbase"
  89
  90 /* Symbolic reference pointing at the name of the branch being rebased. */
  91 #define GOT_WORKTREE_REBASE_BRANCH_REF_PREFIX "refs/got/worktree/rebase/branch"
  92
  93 /* Reference pointing at the ID of the current commit being rebased. */
  94 #define GOT_WORKTREE_REBASE_COMMIT_REF_PREFIX "refs/got/worktree/rebase/commit"
  95
  96 /* Temporary branch which accumulates commits during a histedit operation. */
  97 #define GOT_WORKTREE_HISTEDIT_TMP_REF_PREFIX "refs/got/worktree/histedit/tmp"
  98
  99 /* Symbolic reference pointing at the name of the branch being edited. */
 100 #define GOT_WORKTREE_HISTEDIT_BRANCH_REF_PREFIX \
 101         "refs/got/worktree/histedit/branch"
 102
 103 /* Reference pointing at the ID of the work tree's pre-edit base commit. */
 104 #define GOT_WORKTREE_HISTEDIT_BASE_COMMIT_REF_PREFIX \
 105         "refs/got/worktree/histedit/base-commit"
 106
 107 /* Reference pointing at the ID of the current commit being edited. */
 108 #define GOT_WORKTREE_HISTEDIT_COMMIT_REF_PREFIX \
 109         "refs/got/worktree/histedit/commit"
 110
 111 /* Symbolic reference pointing at the name of the merge source branch. */
 112 #define GOT_WORKTREE_MERGE_BRANCH_REF_PREFIX "refs/got/worktree/merge/branch"
 113
 114 /* Reference pointing at the ID of the merge source branches's tip commit. */
 115 #define GOT_WORKTREE_MERGE_COMMIT_REF_PREFIX "refs/got/worktree/merge/commit"
 116
 117 /* Reference pointing to temporary commits that may need trivial rebasing. */
 118 #define GOT_WORKTREE_COMMIT_REF_PREFIX "refs/got/worktree/commit"