Annotation of src/usr.bin/cvs/rcs.h, Revision 1.59
1.59 ! joris 1: /* $OpenBSD: rcs.h,v 1.58 2006/04/10 08:08:00 xsa Exp $ */
1.1 jfb 2: /*
3: * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.2 tedu 4: * All rights reserved.
1.1 jfb 5: *
1.2 tedu 6: * Redistribution and use in source and binary forms, with or without
7: * modification, are permitted provided that the following conditions
8: * are met:
1.1 jfb 9: *
1.2 tedu 10: * 1. Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
1.1 jfb 12: * 2. The name of the author may not be used to endorse or promote products
1.2 tedu 13: * derived from this software without specific prior written permission.
1.1 jfb 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
1.2 tedu 24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 jfb 25: */
26:
27: #ifndef RCS_H
28: #define RCS_H
29:
30: #include "buf.h"
31:
1.30 xsa 32: #define RCS_DIFF_MAXARG 32
1.1 jfb 33: #define RCS_DIFF_DIV \
34: "==================================================================="
35:
1.30 xsa 36: #define RCSDIR "RCS"
37: #define RCS_FILE_EXT ",v"
1.1 jfb 38:
1.30 xsa 39: #define RCS_HEAD_BRANCH "HEAD"
40: #define RCS_HEAD_INIT "1.1"
41: #define RCS_HEAD_REV ((RCSNUM *)(-1))
1.23 jfb 42:
43:
1.30 xsa 44: #define RCS_SYM_INVALCHAR "$,.:;@"
1.1 jfb 45:
1.12 jfb 46:
1.31 joris 47: #define RCS_MAGIC_BRANCH ".0."
1.30 xsa 48: #define RCS_STATE_EXP "Exp"
49: #define RCS_STATE_DEAD "dead"
1.17 jfb 50:
1.12 jfb 51: /* lock types */
1.30 xsa 52: #define RCS_LOCK_INVAL (-1)
53: #define RCS_LOCK_LOOSE 0
54: #define RCS_LOCK_STRICT 1
1.12 jfb 55:
56:
1.46 niallo 57: /*
58: * Keyword expansion table
59: */
60: #define RCS_KW_AUTHOR 0x1000
61: #define RCS_KW_DATE 0x2000
62: #define RCS_KW_LOG 0x4000
63: #define RCS_KW_NAME 0x8000
64: #define RCS_KW_RCSFILE 0x0100
65: #define RCS_KW_REVISION 0x0200
66: #define RCS_KW_SOURCE 0x0400
67: #define RCS_KW_STATE 0x0800
68: #define RCS_KW_FULLPATH 0x0010
69:
70: #define RCS_KW_ID \
71: (RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \
72: | RCS_KW_AUTHOR | RCS_KW_STATE)
73:
74: #define RCS_KW_HEADER (RCS_KW_ID | RCS_KW_FULLPATH)
75:
1.6 jfb 76: /* RCS keyword expansion modes (kflags) */
1.30 xsa 77: #define RCS_KWEXP_NONE 0x00
78: #define RCS_KWEXP_NAME 0x01 /* include keyword name */
79: #define RCS_KWEXP_VAL 0x02 /* include keyword value */
80: #define RCS_KWEXP_LKR 0x04 /* include name of locker */
81: #define RCS_KWEXP_OLD 0x08 /* generate old keyword string */
82: #define RCS_KWEXP_ERR 0x10 /* mode has an error */
1.6 jfb 83:
1.30 xsa 84: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
85: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
1.6 jfb 86:
1.9 jfb 87: #define RCS_KWEXP_INVAL(k) \
1.13 jfb 88: ((k & RCS_KWEXP_ERR) || \
1.51 ray 89: ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD)))
1.9 jfb 90:
1.6 jfb 91:
1.46 niallo 92: struct rcs_kw {
93: char kw_str[16];
94: int kw_type;
95: };
96:
97: #define RCS_NKWORDS (sizeof(rcs_expkw)/sizeof(rcs_expkw[0]))
1.6 jfb 98:
1.30 xsa 99: #define RCSNUM_MAXNUM USHRT_MAX
100: #define RCSNUM_MAXLEN 64
1.6 jfb 101:
1.30 xsa 102: #define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2)
1.57 joris 103: #define RCSNUM_ISBRANCHREV(n) (!((n)->rn_len % 2) && ((n)->rn_len >= 4))
1.1 jfb 104:
105: /* file flags */
1.43 niallo 106: #define RCS_READ (1<<0)
107: #define RCS_WRITE (1<<1)
108: #define RCS_RDWR (RCS_READ|RCS_WRITE)
109: #define RCS_CREATE (1<<2) /* create the file */
110: #define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */
1.9 jfb 111:
112: /* internal flags */
1.43 niallo 113: #define RCS_PARSED (1<<4) /* file has been parsed */
114: #define RCS_SYNCED (1<<5) /* in-mem copy is sync with disk copy */
115: #define RCS_SLOCK (1<<6) /* strict lock */
116:
117: /* parser flags */
118: #define PARSED_DELTAS (1<<7) /* all deltas are parsed */
119: #define PARSED_DESC (1<<8) /* the description is parsed */
120: #define PARSED_DELTATEXTS (1<<9) /* all delta texts are parsed */
1.1 jfb 121:
122: /* delta flags */
1.30 xsa 123: #define RCS_RD_DEAD 0x01 /* dead */
1.56 ray 124: #define RCS_RD_SELECT 0x02 /* select for operation */
1.5 jfb 125:
1.14 jfb 126: /* RCS error codes */
1.30 xsa 127: #define RCS_ERR_NOERR 0
128: #define RCS_ERR_NOENT 1
129: #define RCS_ERR_DUPENT 2
130: #define RCS_ERR_BADNUM 3
131: #define RCS_ERR_BADSYM 4
132: #define RCS_ERR_PARSE 5
133: #define RCS_ERR_ERRNO 255
1.40 joris 134:
135: /* used for cvs_checkout_rev */
136: #define CHECKOUT_REV_CREATED 1
137: #define CHECKOUT_REV_MERGED 2
138: #define CHECKOUT_REV_REMOVED 3
1.41 joris 139: #define CHECKOUT_REV_UPDATED 4
1.5 jfb 140:
1.1 jfb 141: typedef struct rcs_num {
1.30 xsa 142: u_int rn_len;
143: u_int16_t *rn_id;
1.1 jfb 144: } RCSNUM;
145:
146:
1.11 jfb 147: struct rcs_access {
1.30 xsa 148: char *ra_name;
149: uid_t ra_uid;
150: TAILQ_ENTRY(rcs_access) ra_list;
1.11 jfb 151: };
152:
1.1 jfb 153: struct rcs_sym {
1.30 xsa 154: char *rs_name;
155: RCSNUM *rs_num;
156: TAILQ_ENTRY(rcs_sym) rs_list;
1.1 jfb 157: };
158:
159: struct rcs_lock {
1.30 xsa 160: char *rl_name;
161: RCSNUM *rl_num;
1.1 jfb 162:
1.30 xsa 163: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 jfb 164: };
165:
166:
167: struct rcs_branch {
1.30 xsa 168: RCSNUM *rb_num;
169: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 jfb 170: };
171:
1.50 ray 172: TAILQ_HEAD(rcs_dlist, rcs_delta);
1.1 jfb 173:
174: struct rcs_delta {
1.30 xsa 175: RCSNUM *rd_num;
176: RCSNUM *rd_next;
177: u_int rd_flags;
178: struct tm rd_date;
179: char *rd_author;
180: char *rd_state;
181: char *rd_log;
1.42 joris 182: char *rd_locker;
1.30 xsa 183: u_char *rd_text;
184: size_t rd_tlen;
185:
186: TAILQ_HEAD(, rcs_branch) rd_branches;
187: TAILQ_ENTRY(rcs_delta) rd_list;
1.1 jfb 188: };
189:
190:
191: typedef struct rcs_file {
1.30 xsa 192: char *rf_path;
193: mode_t rf_mode;
194: u_int rf_flags;
195:
196: RCSNUM *rf_head;
197: RCSNUM *rf_branch;
198: char *rf_comment;
199: char *rf_expand;
200: char *rf_desc;
201:
202: u_int rf_ndelta;
203: struct rcs_dlist rf_delta;
204: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
205: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
206: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
1.9 jfb 207:
1.30 xsa 208: void *rf_pdata;
1.1 jfb 209: } RCSFILE;
210:
211:
1.14 jfb 212: extern int rcs_errno;
213:
214:
1.39 xsa 215: RCSFILE *rcs_open(const char *, int, ...);
216: void rcs_close(RCSFILE *);
217: const RCSNUM *rcs_head_get(RCSFILE *);
1.43 niallo 218: int rcs_head_set(RCSFILE *, RCSNUM *);
1.39 xsa 219: const RCSNUM *rcs_branch_get(RCSFILE *);
220: int rcs_branch_set(RCSFILE *, const RCSNUM *);
221: int rcs_access_add(RCSFILE *, const char *);
222: int rcs_access_remove(RCSFILE *, const char *);
223: int rcs_access_check(RCSFILE *, const char *);
1.43 niallo 224: struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *);
1.39 xsa 225: int rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
226: int rcs_sym_remove(RCSFILE *, const char *);
227: RCSNUM *rcs_sym_getrev(RCSFILE *, const char *);
228: int rcs_sym_check(const char *);
229: int rcs_lock_getmode(RCSFILE *);
230: int rcs_lock_setmode(RCSFILE *, int);
231: int rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
1.42 joris 232: int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *);
1.39 xsa 233: BUF *rcs_getrev(RCSFILE *, RCSNUM *);
234: int rcs_deltatext_set(RCSFILE *, RCSNUM *, const char *);
235: const char *rcs_desc_get(RCSFILE *);
1.52 xsa 236: void rcs_desc_set(RCSFILE *, const char *);
1.39 xsa 237: const char *rcs_comment_lookup(const char *);
238: const char *rcs_comment_get(RCSFILE *);
1.53 xsa 239: void rcs_comment_set(RCSFILE *, const char *);
1.47 niallo 240: BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
1.58 xsa 241: void rcs_kwexp_set(RCSFILE *, int);
1.39 xsa 242: int rcs_kwexp_get(RCSFILE *);
243: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
244: const char *);
245: time_t rcs_rev_getdate(RCSFILE *, RCSNUM *);
246: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
247: int rcs_rev_remove(RCSFILE *, RCSNUM *);
248: int rcs_state_set(RCSFILE *, RCSNUM *, const char *);
249: const char *rcs_state_get(RCSFILE *, RCSNUM *);
250: int rcs_state_check(const char *);
251: RCSNUM *rcs_tag_resolve(RCSFILE *, const char *);
252: const char *rcs_errstr(int);
1.54 niallo 253: int rcs_write(RCSFILE *);
1.30 xsa 254:
255:
256: int rcs_kflag_get(const char *);
257: void rcs_kflag_usage(void);
258: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
259:
260: RCSNUM *rcsnum_alloc(void);
261: RCSNUM *rcsnum_parse(const char *);
262: RCSNUM *rcsnum_brtorev(const RCSNUM *);
263: RCSNUM *rcsnum_revtobr(const RCSNUM *);
264: RCSNUM *rcsnum_inc(RCSNUM *);
1.33 joris 265: RCSNUM *rcsnum_dec(RCSNUM *);
1.30 xsa 266: void rcsnum_free(RCSNUM *);
267: int rcsnum_aton(const char *, char **, RCSNUM *);
268: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
1.55 ray 269: void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
1.30 xsa 270: int rcsnum_cmp(const RCSNUM *, const RCSNUM *, u_int);
1.49 xsa 271:
272: /* rcstime.c */
1.59 ! joris 273: void rcs_set_tz(char *, struct rcs_delta *, struct tm *);
1.48 joris 274:
275: extern char *timezone_flag;
1.1 jfb 276:
1.30 xsa 277: #endif /* RCS_H */