1/* $OpenBSD: rcs.h,v 1.104 2024/05/21 05:00:48 jsg Exp $ */ 2/* 3 * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. The name of the author may not be used to endorse or promote products 13 * derived from this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 16 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 17 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 18 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 21 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 22 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 23 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 24 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27#ifndef RCS_H 28#define RCS_H 29 30#include <stdio.h> 31#include <time.h> 32 33#include "buf.h" 34 35#define RCS_DIFF_DIV \ 36 "===================================================================" 37 38#define RCS_FILE_EXT ",v" 39 40#define RCS_HEAD_BRANCH "HEAD" 41#define RCS_HEAD_INIT "1.1" 42#define RCS_HEAD_REV ((RCSNUM *)(-1)) 43 44#define RCS_CONFLICT_MARKER1 "<<<<<<< " 45#define RCS_CONFLICT_MARKER2 ">>>>>>> " 46#define RCS_CONFLICT_MARKER3 "=======\n" 47 48#define RCS_SYM_INVALCHAR "$,.:;@" 49 50#define RCS_MAGIC_BRANCH ".0." 51#define RCS_STATE_EXP "Exp" 52#define RCS_STATE_DEAD "dead" 53 54/* lock types */ 55#define RCS_LOCK_INVAL (-1) 56#define RCS_LOCK_LOOSE 0 57#define RCS_LOCK_STRICT 1 58 59/* 60 * Keyword expansion table 61 */ 62#define RCS_KW_AUTHOR 0x1000 63#define RCS_KW_DATE 0x2000 64#define RCS_KW_LOG 0x4000 65#define RCS_KW_NAME 0x8000 66#define RCS_KW_RCSFILE 0x0100 67#define RCS_KW_REVISION 0x0200 68#define RCS_KW_SOURCE 0x0400 69#define RCS_KW_STATE 0x0800 70#define RCS_KW_FULLPATH 0x0010 71#define RCS_KW_MDOCDATE 0x0020 72#define RCS_KW_LOCKER 0x0040 73 74#define RCS_KW_ID \ 75 (RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \ 76 | RCS_KW_AUTHOR | RCS_KW_STATE) 77 78#define RCS_KW_HEADER (RCS_KW_ID | RCS_KW_FULLPATH) 79 80/* RCS keyword expansion modes (kflags) */ 81#define RCS_KWEXP_NONE 0x01 /* do not expand keywords */ 82#define RCS_KWEXP_NAME 0x02 /* include keyword name */ 83#define RCS_KWEXP_VAL 0x04 /* include keyword value */ 84#define RCS_KWEXP_LKR 0x08 /* include name of locker */ 85#define RCS_KWEXP_OLD 0x10 /* generate old keyword string */ 86#define RCS_KWEXP_ERR 0x20 /* mode has an error */ 87 88#define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL) 89#define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR) 90 91#define RCS_KWEXP_INVAL(k) \ 92 ((k & RCS_KWEXP_ERR) || \ 93 ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD))) 94 95struct rcs_kw { 96 char kw_str[16]; 97 int kw_type; 98}; 99 100#define RCS_NKWORDS (sizeof(rcs_expkw)/sizeof(rcs_expkw[0])) 101 102#define RCSNUM_MAXNUM USHRT_MAX 103#define RCSNUM_MAXLEN 16 104#define RCSNUM_MAXSTR 64 105 106#define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2) 107#define RCSNUM_ISBRANCHREV(n) (!((n)->rn_len % 2) && ((n)->rn_len >= 4)) 108 109/* file flags */ 110#define RCS_READ (1<<0) 111#define RCS_WRITE (1<<1) /* flush changes on rcs_close() */ 112#define RCS_CREATE (1<<2) /* create the file */ 113#define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */ 114 115/* internal flags */ 116#define RCS_PARSED (1<<4) /* file has been parsed */ 117#define RCS_SYNCED (1<<5) /* in-mem copy is sync with disk copy */ 118#define RCS_SLOCK (1<<6) /* strict lock */ 119 120/* parser flags */ 121#define PARSED_DELTAS (1<<7) /* all deltas are parsed */ 122#define PARSED_DESC (1<<8) /* the description is parsed */ 123#define PARSED_DELTATEXTS (1<<9) /* all delta texts are parsed */ 124 125/* delta flags */ 126#define RCS_RD_DEAD 0x01 /* dead */ 127#define RCS_RD_SELECT 0x02 /* select for operation */ 128 129/* commitids in cvs/cvsnt can be up to 64 bytes */ 130#define RCS_COMMITID_MAXLEN 64 131 132typedef struct rcs_num { 133 u_int rn_len; 134 u_int16_t rn_id[RCSNUM_MAXLEN]; 135} RCSNUM; 136 137struct rcs_access { 138 char *ra_name; 139 TAILQ_ENTRY(rcs_access) ra_list; 140}; 141 142struct rcs_sym { 143 char *rs_name; 144 RCSNUM *rs_num; 145 TAILQ_ENTRY(rcs_sym) rs_list; 146}; 147 148struct rcs_lock { 149 char *rl_name; 150 RCSNUM *rl_num; 151 152 TAILQ_ENTRY(rcs_lock) rl_list; 153}; 154 155struct rcs_branch { 156 RCSNUM *rb_num; 157 TAILQ_ENTRY(rcs_branch) rb_list; 158}; 159 160TAILQ_HEAD(rcs_dlist, rcs_delta); 161 162struct rcs_delta { 163 RCSNUM *rd_num; 164 RCSNUM *rd_next; 165 int rd_flags; 166 struct tm rd_date; 167 char *rd_author; 168 char *rd_state; 169 char *rd_commitid; 170 char *rd_log; 171 char *rd_locker; 172 u_char *rd_text; 173 size_t rd_tlen; 174 175 TAILQ_HEAD(, rcs_branch) rd_branches; 176 TAILQ_ENTRY(rcs_delta) rd_list; 177}; 178 179 180typedef struct rcs_file { 181 FILE *rf_file; 182 int rf_dead; 183 char *rf_path; 184 mode_t rf_mode; 185 int rf_flags; 186 187 RCSNUM *rf_head; 188 RCSNUM *rf_branch; 189 char *rf_comment; 190 char *rf_expand; 191 char *rf_desc; 192 193 u_int rf_ndelta; 194 struct rcs_dlist rf_delta; 195 TAILQ_HEAD(rcs_alist, rcs_access) rf_access; 196 TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols; 197 TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks; 198 199 void *rf_pdata; 200} RCSFILE; 201 202struct rcs_line; 203struct rcs_lines; 204 205RCSFILE *rcs_open(const char *, int, int, ...); 206void rcs_close(RCSFILE *); 207RCSNUM *rcs_head_get(RCSFILE *); 208int rcs_head_set(RCSFILE *, RCSNUM *); 209RCSNUM *rcs_branch_new(RCSFILE *, RCSNUM *); 210const RCSNUM *rcs_branch_get(RCSFILE *); 211int rcs_branch_set(RCSFILE *, const RCSNUM *); 212int rcs_access_add(RCSFILE *, const char *); 213int rcs_access_remove(RCSFILE *, const char *); 214struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *); 215int rcs_sym_add(RCSFILE *, const char *, RCSNUM *); 216int rcs_sym_check(const char *); 217struct rcs_sym *rcs_sym_get(RCSFILE *, const char *); 218int rcs_sym_remove(RCSFILE *, const char *); 219RCSNUM *rcs_sym_getrev(RCSFILE *, const char *); 220RCSNUM *rcs_translate_tag(const char *, RCSFILE *); 221int rcs_lock_getmode(RCSFILE *); 222int rcs_lock_setmode(RCSFILE *, int); 223int rcs_lock_add(RCSFILE *, const char *, RCSNUM *); 224int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *); 225int rcs_deltatext_set(RCSFILE *, RCSNUM *, BUF *); 226const char *rcs_desc_get(RCSFILE *); 227void rcs_desc_set(RCSFILE *, const char *); 228const char *rcs_comment_lookup(const char *); 229const char *rcs_comment_get(RCSFILE *); 230void rcs_comment_set(RCSFILE *, const char *); 231void rcs_kwexp_set(RCSFILE *, int); 232int rcs_kwexp_get(RCSFILE *); 233int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t, 234 const char *); 235time_t rcs_rev_getdate(RCSFILE *, RCSNUM *); 236int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *); 237int rcs_rev_remove(RCSFILE *, RCSNUM *); 238int rcs_state_set(RCSFILE *, RCSNUM *, const char *); 239const char *rcs_state_get(RCSFILE *, RCSNUM *); 240int rcs_state_check(const char *); 241void rcs_write(RCSFILE *); 242int rcs_rev_write_stmp(RCSFILE *, RCSNUM *, char *, int); 243void rcs_rev_write_fd(RCSFILE *, RCSNUM *, int, int); 244struct rcs_lines *rcs_rev_getlines(RCSFILE *, RCSNUM *, 245 struct rcs_line ***); 246void rcs_annotate_getlines(RCSFILE *, RCSNUM *, 247 struct rcs_line ***); 248BUF *rcs_rev_getbuf(RCSFILE *, RCSNUM *, int); 249void rcs_delta_stats(struct rcs_delta *, int *, int *); 250 251int rcs_kflag_get(const char *); 252 253RCSNUM *rcsnum_alloc(void); 254RCSNUM *rcsnum_parse(const char *); 255RCSNUM *rcsnum_brtorev(const RCSNUM *); 256RCSNUM *rcsnum_revtobr(const RCSNUM *); 257RCSNUM *rcsnum_inc(RCSNUM *); 258RCSNUM *rcsnum_dec(RCSNUM *); 259RCSNUM *rcsnum_branch_root(RCSNUM *); 260RCSNUM *rcsnum_new_branch(RCSNUM *); 261int rcsnum_addmagic(RCSNUM *); 262int rcsnum_aton(const char *, const char **, RCSNUM *); 263char *rcsnum_tostr(const RCSNUM *, char *, size_t); 264void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int); 265int rcsnum_cmp(RCSNUM *, RCSNUM *, u_int); 266int rcsnum_differ(RCSNUM *, RCSNUM *); 267 268#endif /* RCS_H */ 269