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         char *repo_path;
  20         int root_fd;
  21         char *path_prefix;
  22         struct got_object_id *base_commit_id;
  23         char *head_ref_name;
  24         uuid_t uuid;
  25
  26         /*
  27          * File descriptor for the lock file, open while a work tree is open.
  28          * When a work tree is opened, a shared lock on the lock file is
  29          * acquired with flock(2). This shared lock is held until the work
  30          * tree is closed, i.e. throughout the lifetime of any operation
  31          * which uses a work tree.
  32          * Before any modifications are made to the on-disk state of work
  33          * tree meta data, tracked files, or directory tree structure, this
  34          * shared lock must be upgraded to an exclusive lock.
  35          */
  36         int lockfd;
  37
  38         /* Absolute path to worktree's got.conf file. */
  39         char *gotconfig_path;
  40
  41         /* Settings read from got.conf. */
  42         struct got_gotconfig *gotconfig;
  43 };
  44
  45 struct got_commitable {
  46         char *path;
  47         char *in_repo_path;
  48         char *ondisk_path;
  49         unsigned char status;
  50         unsigned char staged_status;
  51         struct got_object_id *blob_id;
  52         struct got_object_id *base_blob_id;
  53         struct got_object_id *staged_blob_id;
  54         struct got_object_id *base_commit_id;
  55         mode_t mode;
  56         int flags;
  57 #define GOT_COMMITABLE_ADDED 0x01
  58 };
  59
  60 #define GOT_WORKTREE_GOT_DIR            ".got"
  61 #define GOT_WORKTREE_FILE_INDEX         "file-index"
  62 #define GOT_WORKTREE_REPOSITORY         "repository"
  63 #define GOT_WORKTREE_PATH_PREFIX        "path-prefix"
  64 #define GOT_WORKTREE_HEAD_REF           "head-ref"
  65 #define GOT_WORKTREE_BASE_COMMIT        "base-commit"
  66 #define GOT_WORKTREE_LOCK               "lock"
  67 #define GOT_WORKTREE_FORMAT             "format"
  68 #define GOT_WORKTREE_UUID               "uuid"
  69 #define GOT_WORKTREE_HISTEDIT_SCRIPT    "histedit-script"
  70
  71 #define GOT_WORKTREE_FORMAT_VERSION     1
  72 #define GOT_WORKTREE_INVALID_COMMIT_ID  GOT_SHA1_STRING_ZERO
  73
  74 #define GOT_WORKTREE_BASE_REF_PREFIX "refs/got/worktree/base"
  75
  76 const struct got_error *got_worktree_get_base_ref_name(char **,
  77     struct got_worktree *worktree);
  78
  79 /* Temporary branch which accumulates commits during a rebase operation. */
  80 #define GOT_WORKTREE_REBASE_TMP_REF_PREFIX "refs/got/worktree/rebase/tmp"
  81
  82 /* Symbolic reference pointing at the name of the new base branch. */
  83 #define GOT_WORKTREE_NEWBASE_REF_PREFIX "refs/got/worktree/rebase/newbase"
  84
  85 /* Symbolic reference pointing at the name of the branch being rebased. */
  86 #define GOT_WORKTREE_REBASE_BRANCH_REF_PREFIX "refs/got/worktree/rebase/branch"
  87
  88 /* Reference pointing at the ID of the current commit being rebased. */
  89 #define GOT_WORKTREE_REBASE_COMMIT_REF_PREFIX "refs/got/worktree/rebase/commit"
  90
  91 /* Temporary branch which accumulates commits during a histedit operation. */
  92 #define GOT_WORKTREE_HISTEDIT_TMP_REF_PREFIX "refs/got/worktree/histedit/tmp"
  93
  94 /* Symbolic reference pointing at the name of the branch being edited. */
  95 #define GOT_WORKTREE_HISTEDIT_BRANCH_REF_PREFIX \
  96         "refs/got/worktree/histedit/branch"
  97
  98 /* Reference pointing at the ID of the work tree's pre-edit base commit. */
  99 #define GOT_WORKTREE_HISTEDIT_BASE_COMMIT_REF_PREFIX \
 100         "refs/got/worktree/histedit/base-commit"
 101
 102 /* Reference pointing at the ID of the current commit being edited. */
 103 #define GOT_WORKTREE_HISTEDIT_COMMIT_REF_PREFIX \
 104         "refs/got/worktree/histedit/commit"
 105
 106 /* Symbolic reference pointing at the name of the merge source branch. */
 107 #define GOT_WORKTREE_MERGE_BRANCH_REF_PREFIX "refs/got/worktree/merge/branch"
 108
 109 /* Reference pointing at the ID of the merge source branches's tip commit. */
 110 #define GOT_WORKTREE_MERGE_COMMIT_REF_PREFIX "refs/got/worktree/merge/commit"