rcs.h revision 1.17
1/* $OpenBSD: rcs.h,v 1.17 2016/05/09 13:03:55 schwarze 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 <sys/queue.h> 31 32#include <stdio.h> 33 34#include "buf.h" 35 36#define RCS_DIFF_MAXARG 32 37#define RCS_DIFF_DIV \ 38 "===================================================================" 39 40#define RCSDIR "RCS" 41#define RCS_FILE_EXT ",v" 42 43#define RCS_HEAD_BRANCH "HEAD" 44#define RCS_HEAD_INIT "1.1" 45#define RCS_HEAD_REV ((RCSNUM *)(-1)) 46 47 48#define RCS_STATE_INVALCHAR "$,:;@" 49#define RCS_SYM_INVALCHAR "$,.:;@" 50 51#define RCS_MAGIC_BRANCH ".0." 52#define RCS_STATE_EXP "Exp" 53#define RCS_STATE_DEAD "dead" 54 55/* lock types */ 56#define RCS_LOCK_INVAL (-1) 57#define RCS_LOCK_LOOSE 0 58#define RCS_LOCK_STRICT 1 59 60/* 61 * Keyword expansion table 62 */ 63#define RCS_KW_AUTHOR 0x1000 64#define RCS_KW_DATE 0x2000 65#define RCS_KW_LOG 0x4000 66#define RCS_KW_NAME 0x8000 67#define RCS_KW_RCSFILE 0x0100 68#define RCS_KW_REVISION 0x0200 69#define RCS_KW_SOURCE 0x0400 70#define RCS_KW_STATE 0x0800 71#define RCS_KW_FULLPATH 0x0010 72#define RCS_KW_MDOCDATE 0x0020 73#define RCS_KW_LOCKER 0x10000 74 75#define RCS_KW_ID \ 76 (RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \ 77 | RCS_KW_AUTHOR | RCS_KW_STATE | RCS_KW_LOCKER) 78 79#define RCS_KW_HEADER (RCS_KW_ID | RCS_KW_FULLPATH) 80 81/* RCS keyword expansion modes (kflags) */ 82#define RCS_KWEXP_NONE 0x00 83#define RCS_KWEXP_NAME 0x01 /* include keyword name */ 84#define RCS_KWEXP_VAL 0x02 /* include keyword value */ 85#define RCS_KWEXP_LKR 0x04 /* include name of locker */ 86#define RCS_KWEXP_OLD 0x08 /* generate old keyword string */ 87#define RCS_KWEXP_ERR 0x10 /* mode has an error */ 88 89#define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL) 90#define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR) 91 92#define RCS_KWEXP_INVAL(k) \ 93 ((k & RCS_KWEXP_ERR) || \ 94 ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD))) 95 96struct rcs_kw { 97 char kw_str[16]; 98 int kw_type; 99}; 100 101#define RCS_NKWORDS (sizeof(rcs_expkw)/sizeof(rcs_expkw[0])) 102 103#define RCSNUM_MAXNUM USHRT_MAX 104#define RCSNUM_MAXLEN 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#define RCSNUM_NO_MAGIC (1<<0) 109 110/* file flags */ 111#define RCS_READ (1<<0) 112#define RCS_WRITE (1<<1) 113#define RCS_RDWR (RCS_READ|RCS_WRITE) 114#define RCS_CREATE (1<<2) /* create the file */ 115#define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */ 116 117/* internal flags */ 118#define RCS_PARSED (1<<4) /* file has been parsed */ 119#define RCS_SYNCED (1<<5) /* in-mem copy is sync with disk copy */ 120#define RCS_SLOCK (1<<6) /* strict lock */ 121 122/* parser flags */ 123#define PARSED_DELTAS (1<<7) /* all deltas are parsed */ 124#define PARSED_DESC (1<<8) /* the description is parsed */ 125#define PARSED_DELTATEXTS (1<<9) /* all delta texts are parsed */ 126 127/* delta flags */ 128#define RCS_RD_DEAD 0x01 /* dead */ 129#define RCS_RD_SELECT 0x02 /* select for operation */ 130 131/* RCS error codes */ 132#define RCS_ERR_NOERR 0 133#define RCS_ERR_NOENT 1 134#define RCS_ERR_DUPENT 2 135#define RCS_ERR_BADNUM 3 136#define RCS_ERR_BADSYM 4 137#define RCS_ERR_PARSE 5 138#define RCS_ERR_ERRNO 255 139 140/* used for rcs_checkout_rev */ 141#define CHECKOUT_REV_CREATED 1 142#define CHECKOUT_REV_MERGED 2 143#define CHECKOUT_REV_REMOVED 3 144#define CHECKOUT_REV_UPDATED 4 145 146/* commitids in cvs/cvsnt can be up to 64 bytes */ 147#define RCS_COMMITID_MAXLEN 64 148 149typedef struct rcs_num { 150 u_int rn_len; 151 u_int16_t *rn_id; 152} RCSNUM; 153 154struct rcs_access { 155 char *ra_name; 156 TAILQ_ENTRY(rcs_access) ra_list; 157}; 158 159struct rcs_sym { 160 char *rs_name; 161 RCSNUM *rs_num; 162 TAILQ_ENTRY(rcs_sym) rs_list; 163}; 164 165struct rcs_lock { 166 char *rl_name; 167 RCSNUM *rl_num; 168 169 TAILQ_ENTRY(rcs_lock) rl_list; 170}; 171 172struct rcs_branch { 173 RCSNUM *rb_num; 174 TAILQ_ENTRY(rcs_branch) rb_list; 175}; 176 177TAILQ_HEAD(rcs_dlist, rcs_delta); 178 179struct rcs_delta { 180 RCSNUM *rd_num; 181 RCSNUM *rd_next; 182 u_int rd_flags; 183 struct tm rd_date; 184 char *rd_author; 185 char *rd_state; 186 char *rd_commitid; 187 char *rd_log; 188 char *rd_locker; 189 u_char *rd_text; 190 size_t rd_tlen; 191 192 TAILQ_HEAD(, rcs_branch) rd_branches; 193 TAILQ_ENTRY(rcs_delta) rd_list; 194}; 195 196 197typedef struct rcs_file { 198 FILE *rf_file; 199 char *rf_path; 200 mode_t rf_mode; 201 u_int rf_flags; 202 203 RCSNUM *rf_head; 204 RCSNUM *rf_branch; 205 char *rf_comment; 206 char *rf_expand; 207 char *rf_desc; 208 209 u_int rf_ndelta; 210 struct rcs_dlist rf_delta; 211 TAILQ_HEAD(rcs_alist, rcs_access) rf_access; 212 TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols; 213 TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks; 214 215 void *rf_pdata; 216} RCSFILE; 217 218extern int rcs_errno; 219 220RCSFILE *rcs_open(const char *, int, int, ...); 221void rcs_close(RCSFILE *); 222int rcs_head_set(RCSFILE *, RCSNUM *); 223const RCSNUM *rcs_branch_get(RCSFILE *); 224int rcs_access_add(RCSFILE *, const char *); 225int rcs_access_remove(RCSFILE *, const char *); 226int rcs_access_check(RCSFILE *, const char *); 227struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *); 228int rcs_sym_add(RCSFILE *, const char *, RCSNUM *); 229int rcs_sym_remove(RCSFILE *, const char *); 230RCSNUM *rcs_sym_getrev(RCSFILE *, const char *); 231int rcs_sym_check(const char *); 232int rcs_lock_getmode(RCSFILE *); 233int rcs_lock_setmode(RCSFILE *, int); 234int rcs_lock_add(RCSFILE *, const char *, RCSNUM *); 235int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *); 236BUF *rcs_getrev(RCSFILE *, RCSNUM *); 237int rcs_deltatext_set(RCSFILE *, RCSNUM *, BUF *); 238void rcs_desc_set(RCSFILE *, const char *); 239void rcs_comment_set(RCSFILE *, const char *); 240BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *); 241void rcs_kwexp_set(RCSFILE *, int); 242int rcs_kwexp_get(RCSFILE *); 243int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t, 244 const char *); 245time_t rcs_rev_getdate(RCSFILE *, RCSNUM *); 246int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *); 247int rcs_rev_remove(RCSFILE *, RCSNUM *); 248int rcs_state_set(RCSFILE *, RCSNUM *, const char *); 249int rcs_state_check(const char *); 250void rcs_write(RCSFILE *); 251void rcs_delta_stats(struct rcs_delta *, int *, int *); 252 253int rcs_kflag_get(const char *); 254void rcs_kflag_usage(void); 255int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *); 256 257RCSNUM *rcsnum_alloc(void); 258RCSNUM *rcsnum_parse(const char *); 259RCSNUM *rcsnum_brtorev(const RCSNUM *); 260RCSNUM *rcsnum_revtobr(const RCSNUM *); 261RCSNUM *rcsnum_inc(RCSNUM *); 262void rcsnum_free(RCSNUM *); 263int rcsnum_addmagic(RCSNUM *); 264int rcsnum_aton(const char *, char **, RCSNUM *); 265char *rcsnum_tostr(const RCSNUM *, char *, size_t); 266void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int); 267int rcsnum_cmp(const RCSNUM *, const RCSNUM *, u_int); 268 269/* rcstime.c */ 270void rcs_set_tz(char *, struct rcs_delta *, struct tm *); 271extern char *timezone_flag; 272extern int rcsnum_flags; 273 274#endif /* RCS_H */ 275