Annotation of src/usr.bin/cvs/rcs.h, Revision 1.34
1.34 ! joris 1: /* $OpenBSD: rcs.h,v 1.33 2005/10/10 13:06:24 joris 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 <sys/types.h>
31: #include <sys/queue.h>
32:
33: #include <time.h>
34:
35: #include "buf.h"
36:
1.30 xsa 37: #define RCS_DIFF_MAXARG 32
1.1 jfb 38: #define RCS_DIFF_DIV \
39: "==================================================================="
40:
1.30 xsa 41: #define RCSDIR "RCS"
42: #define RCS_FILE_EXT ",v"
1.1 jfb 43:
1.30 xsa 44: #define RCS_HEAD_BRANCH "HEAD"
45: #define RCS_HEAD_INIT "1.1"
46: #define RCS_HEAD_REV ((RCSNUM *)(-1))
1.23 jfb 47:
48:
1.30 xsa 49: #define RCS_SYM_INVALCHAR "$,.:;@"
1.1 jfb 50:
1.12 jfb 51:
1.31 joris 52: #define RCS_MAGIC_BRANCH ".0."
1.30 xsa 53: #define RCS_STATE_EXP "Exp"
54: #define RCS_STATE_DEAD "dead"
1.17 jfb 55:
1.12 jfb 56: /* lock types */
1.30 xsa 57: #define RCS_LOCK_INVAL (-1)
58: #define RCS_LOCK_LOOSE 0
59: #define RCS_LOCK_STRICT 1
1.12 jfb 60:
61:
1.6 jfb 62: /* RCS keyword expansion modes (kflags) */
1.30 xsa 63: #define RCS_KWEXP_NONE 0x00
64: #define RCS_KWEXP_NAME 0x01 /* include keyword name */
65: #define RCS_KWEXP_VAL 0x02 /* include keyword value */
66: #define RCS_KWEXP_LKR 0x04 /* include name of locker */
67: #define RCS_KWEXP_OLD 0x08 /* generate old keyword string */
68: #define RCS_KWEXP_ERR 0x10 /* mode has an error */
1.6 jfb 69:
1.30 xsa 70: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
71: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
1.6 jfb 72:
1.9 jfb 73: #define RCS_KWEXP_INVAL(k) \
1.13 jfb 74: ((k & RCS_KWEXP_ERR) || \
75: ((k & RCS_KWEXP_OLD) && (RCS_KWEXP_OLD & ~RCS_KWEXP_OLD)))
1.9 jfb 76:
1.6 jfb 77:
78:
1.30 xsa 79: #define RCSNUM_MAXNUM USHRT_MAX
80: #define RCSNUM_MAXLEN 64
1.6 jfb 81:
1.30 xsa 82: #define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2)
1.17 jfb 83:
1.1 jfb 84:
85: /* file flags */
1.30 xsa 86: #define RCS_READ 0x01
87: #define RCS_WRITE 0x02
88: #define RCS_RDWR (RCS_READ|RCS_WRITE)
89: #define RCS_CREATE 0x04 /* create the file */
1.9 jfb 90:
91: /* internal flags */
1.30 xsa 92: #define RCS_PARSED 0x010000 /* file has been parsed */
93: #define RCS_SYNCED 0x020000 /* in-mem copy is sync with disk copy */
94: #define RCS_SLOCK 0x040000 /* strict lock */
1.1 jfb 95:
96: /* delta flags */
1.30 xsa 97: #define RCS_RD_DEAD 0x01 /* dead */
1.5 jfb 98:
1.14 jfb 99: /* RCS error codes */
1.30 xsa 100: #define RCS_ERR_NOERR 0
101: #define RCS_ERR_NOENT 1
102: #define RCS_ERR_DUPENT 2
103: #define RCS_ERR_BADNUM 3
104: #define RCS_ERR_BADSYM 4
105: #define RCS_ERR_PARSE 5
106: #define RCS_ERR_ERRNO 255
1.5 jfb 107:
1.1 jfb 108: typedef struct rcs_num {
1.30 xsa 109: u_int rn_len;
110: u_int16_t *rn_id;
1.1 jfb 111: } RCSNUM;
112:
113:
1.11 jfb 114: struct rcs_access {
1.30 xsa 115: char *ra_name;
116: uid_t ra_uid;
117: TAILQ_ENTRY(rcs_access) ra_list;
1.11 jfb 118: };
119:
1.1 jfb 120: struct rcs_sym {
1.30 xsa 121: char *rs_name;
122: RCSNUM *rs_num;
123: TAILQ_ENTRY(rcs_sym) rs_list;
1.1 jfb 124: };
125:
126: struct rcs_lock {
1.30 xsa 127: char *rl_name;
128: RCSNUM *rl_num;
1.1 jfb 129:
1.30 xsa 130: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 jfb 131: };
132:
133:
134: struct rcs_branch {
1.30 xsa 135: RCSNUM *rb_num;
136: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 jfb 137: };
138:
139: struct rcs_dlist {
1.30 xsa 140: struct rcs_delta *tqh_first;
141: struct rcs_delta **tqh_last;
1.1 jfb 142: };
143:
144: struct rcs_delta {
1.30 xsa 145: RCSNUM *rd_num;
146: RCSNUM *rd_next;
147: u_int rd_flags;
148: struct tm rd_date;
149: char *rd_author;
150: char *rd_state;
151: char *rd_log;
152: u_char *rd_text;
153: size_t rd_tlen;
154:
155: struct rcs_dlist rd_snodes;
156: TAILQ_HEAD(, rcs_branch) rd_branches;
157: TAILQ_ENTRY(rcs_delta) rd_list;
1.1 jfb 158: };
159:
160:
161: typedef struct rcs_file {
1.30 xsa 162: char *rf_path;
163: u_int rf_ref;
164: mode_t rf_mode;
165: u_int rf_flags;
166:
167: RCSNUM *rf_head;
168: RCSNUM *rf_branch;
169: char *rf_comment;
170: char *rf_expand;
171: char *rf_desc;
172:
173: u_int rf_ndelta;
174: struct rcs_dlist rf_delta;
175: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
176: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
177: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
1.9 jfb 178:
1.30 xsa 179: void *rf_pdata;
1.1 jfb 180: } RCSFILE;
181:
182:
1.14 jfb 183: extern int rcs_errno;
184:
185:
1.30 xsa 186: RCSFILE *rcs_open(const char *, int, ...);
187: void rcs_close(RCSFILE *);
188: const RCSNUM *rcs_head_get(RCSFILE *);
189: int rcs_head_set(RCSFILE *, const RCSNUM *);
190: const RCSNUM *rcs_branch_get(RCSFILE *);
191: int rcs_branch_set(RCSFILE *, const RCSNUM *);
192: int rcs_access_add(RCSFILE *, const char *);
193: int rcs_access_remove(RCSFILE *, const char *);
194: int rcs_access_check(RCSFILE *, const char *);
195: int rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
196: int rcs_sym_remove(RCSFILE *, const char *);
197: RCSNUM *rcs_sym_getrev(RCSFILE *, const char *);
198: int rcs_sym_check(const char *);
199: int rcs_lock_getmode(RCSFILE *);
200: int rcs_lock_setmode(RCSFILE *, int);
201: int rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
202: int rcs_lock_remove(RCSFILE *, const RCSNUM *);
203: BUF *rcs_getrev(RCSFILE *, RCSNUM *);
1.32 niallo 204: int rcs_deltatext_set(RCSFILE *, RCSNUM *, const char *);
1.30 xsa 205: const char *rcs_desc_get(RCSFILE *);
206: int rcs_desc_set(RCSFILE *, const char *);
207: const char *rcs_comment_lookup(const char *);
208: const char *rcs_comment_get(RCSFILE *);
209: int rcs_comment_set(RCSFILE *, const char *);
210: int rcs_kwexp_set(RCSFILE *, int);
211: int rcs_kwexp_get(RCSFILE *);
212: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t);
1.34 ! joris 213: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
1.30 xsa 214: int rcs_rev_remove(RCSFILE *, RCSNUM *);
215: RCSNUM *rcs_tag_resolve(RCSFILE *, const char *);
216: const char *rcs_errstr(int);
217:
218:
219: int rcs_kflag_get(const char *);
220: void rcs_kflag_usage(void);
221: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
222:
223: BUF *rcs_patch(const char *, const char *);
224:
225: RCSNUM *rcsnum_alloc(void);
226: RCSNUM *rcsnum_parse(const char *);
227: RCSNUM *rcsnum_brtorev(const RCSNUM *);
228: RCSNUM *rcsnum_revtobr(const RCSNUM *);
229: RCSNUM *rcsnum_inc(RCSNUM *);
1.33 joris 230: RCSNUM *rcsnum_dec(RCSNUM *);
1.30 xsa 231: void rcsnum_free(RCSNUM *);
232: int rcsnum_aton(const char *, char **, RCSNUM *);
233: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
234: int rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
235: int rcsnum_cmp(const RCSNUM *, const RCSNUM *, u_int);
1.1 jfb 236:
1.30 xsa 237: #endif /* RCS_H */