Annotation of src/usr.bin/cvs/rcs.h, Revision 1.64
1.64 ! joris 1: /* $OpenBSD: rcs.h,v 1.63 2006/05/28 01:24:28 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 "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:
1.63 joris 43: #define RCS_CONFLICT_MARKER1 "<<<<<<< "
44: #define RCS_CONFLICT_MARKER2 ">>>>>>> "
45: #define RCS_CONFLICT_MARKER3 "=======\n"
1.23 jfb 46:
1.30 xsa 47: #define RCS_SYM_INVALCHAR "$,.:;@"
1.1 jfb 48:
1.12 jfb 49:
1.31 joris 50: #define RCS_MAGIC_BRANCH ".0."
1.30 xsa 51: #define RCS_STATE_EXP "Exp"
52: #define RCS_STATE_DEAD "dead"
1.17 jfb 53:
1.12 jfb 54: /* lock types */
1.30 xsa 55: #define RCS_LOCK_INVAL (-1)
56: #define RCS_LOCK_LOOSE 0
57: #define RCS_LOCK_STRICT 1
1.12 jfb 58:
59:
1.46 niallo 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:
73: #define RCS_KW_ID \
74: (RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \
75: | RCS_KW_AUTHOR | RCS_KW_STATE)
76:
77: #define RCS_KW_HEADER (RCS_KW_ID | RCS_KW_FULLPATH)
78:
1.6 jfb 79: /* RCS keyword expansion modes (kflags) */
1.30 xsa 80: #define RCS_KWEXP_NONE 0x00
81: #define RCS_KWEXP_NAME 0x01 /* include keyword name */
82: #define RCS_KWEXP_VAL 0x02 /* include keyword value */
83: #define RCS_KWEXP_LKR 0x04 /* include name of locker */
84: #define RCS_KWEXP_OLD 0x08 /* generate old keyword string */
85: #define RCS_KWEXP_ERR 0x10 /* mode has an error */
1.6 jfb 86:
1.30 xsa 87: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
88: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
1.6 jfb 89:
1.9 jfb 90: #define RCS_KWEXP_INVAL(k) \
1.13 jfb 91: ((k & RCS_KWEXP_ERR) || \
1.51 ray 92: ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD)))
1.9 jfb 93:
1.6 jfb 94:
1.46 niallo 95: struct rcs_kw {
96: char kw_str[16];
97: int kw_type;
98: };
99:
100: #define RCS_NKWORDS (sizeof(rcs_expkw)/sizeof(rcs_expkw[0]))
1.6 jfb 101:
1.30 xsa 102: #define RCSNUM_MAXNUM USHRT_MAX
103: #define RCSNUM_MAXLEN 64
1.6 jfb 104:
1.30 xsa 105: #define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2)
1.57 joris 106: #define RCSNUM_ISBRANCHREV(n) (!((n)->rn_len % 2) && ((n)->rn_len >= 4))
1.61 niallo 107: #define RCSNUM_NO_MAGIC (1<<0)
1.1 jfb 108:
109: /* file flags */
1.43 niallo 110: #define RCS_READ (1<<0)
111: #define RCS_WRITE (1<<1)
112: #define RCS_RDWR (RCS_READ|RCS_WRITE)
113: #define RCS_CREATE (1<<2) /* create the file */
114: #define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */
1.9 jfb 115:
116: /* internal flags */
1.43 niallo 117: #define RCS_PARSED (1<<4) /* file has been parsed */
118: #define RCS_SYNCED (1<<5) /* in-mem copy is sync with disk copy */
119: #define RCS_SLOCK (1<<6) /* strict lock */
120:
121: /* parser flags */
122: #define PARSED_DELTAS (1<<7) /* all deltas are parsed */
123: #define PARSED_DESC (1<<8) /* the description is parsed */
124: #define PARSED_DELTATEXTS (1<<9) /* all delta texts are parsed */
1.1 jfb 125:
126: /* delta flags */
1.30 xsa 127: #define RCS_RD_DEAD 0x01 /* dead */
1.56 ray 128: #define RCS_RD_SELECT 0x02 /* select for operation */
1.5 jfb 129:
1.14 jfb 130: /* RCS error codes */
1.30 xsa 131: #define RCS_ERR_NOERR 0
132: #define RCS_ERR_NOENT 1
133: #define RCS_ERR_DUPENT 2
134: #define RCS_ERR_BADNUM 3
135: #define RCS_ERR_BADSYM 4
136: #define RCS_ERR_PARSE 5
137: #define RCS_ERR_ERRNO 255
1.40 joris 138:
1.62 joris 139: /* used for rcs_checkout_rev */
1.40 joris 140: #define CHECKOUT_REV_CREATED 1
141: #define CHECKOUT_REV_MERGED 2
142: #define CHECKOUT_REV_REMOVED 3
1.41 joris 143: #define CHECKOUT_REV_UPDATED 4
1.5 jfb 144:
1.1 jfb 145: typedef struct rcs_num {
1.30 xsa 146: u_int rn_len;
147: u_int16_t *rn_id;
1.1 jfb 148: } RCSNUM;
149:
150:
1.11 jfb 151: struct rcs_access {
1.30 xsa 152: char *ra_name;
153: uid_t ra_uid;
154: TAILQ_ENTRY(rcs_access) ra_list;
1.11 jfb 155: };
156:
1.1 jfb 157: struct rcs_sym {
1.30 xsa 158: char *rs_name;
159: RCSNUM *rs_num;
160: TAILQ_ENTRY(rcs_sym) rs_list;
1.1 jfb 161: };
162:
163: struct rcs_lock {
1.30 xsa 164: char *rl_name;
165: RCSNUM *rl_num;
1.1 jfb 166:
1.30 xsa 167: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 jfb 168: };
169:
170:
171: struct rcs_branch {
1.30 xsa 172: RCSNUM *rb_num;
173: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 jfb 174: };
175:
1.50 ray 176: TAILQ_HEAD(rcs_dlist, rcs_delta);
1.1 jfb 177:
178: struct rcs_delta {
1.30 xsa 179: RCSNUM *rd_num;
180: RCSNUM *rd_next;
181: u_int rd_flags;
182: struct tm rd_date;
183: char *rd_author;
184: char *rd_state;
185: char *rd_log;
1.42 joris 186: char *rd_locker;
1.30 xsa 187: u_char *rd_text;
188: size_t rd_tlen;
189:
190: TAILQ_HEAD(, rcs_branch) rd_branches;
191: TAILQ_ENTRY(rcs_delta) rd_list;
1.1 jfb 192: };
193:
194:
195: typedef struct rcs_file {
1.62 joris 196: int fd;
1.64 ! joris 197: int rf_dead;
1.30 xsa 198: char *rf_path;
199: mode_t rf_mode;
200: u_int rf_flags;
201:
202: RCSNUM *rf_head;
203: RCSNUM *rf_branch;
204: char *rf_comment;
205: char *rf_expand;
206: char *rf_desc;
207:
208: u_int rf_ndelta;
209: struct rcs_dlist rf_delta;
210: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
211: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
212: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
1.9 jfb 213:
1.30 xsa 214: void *rf_pdata;
1.1 jfb 215: } RCSFILE;
216:
1.14 jfb 217: extern int rcs_errno;
218:
1.62 joris 219: RCSFILE *rcs_open(const char *, int, int, ...);
1.39 xsa 220: void rcs_close(RCSFILE *);
221: const RCSNUM *rcs_head_get(RCSFILE *);
1.43 niallo 222: int rcs_head_set(RCSFILE *, RCSNUM *);
1.39 xsa 223: const RCSNUM *rcs_branch_get(RCSFILE *);
224: int rcs_branch_set(RCSFILE *, const RCSNUM *);
225: int rcs_access_add(RCSFILE *, const char *);
226: int rcs_access_remove(RCSFILE *, const char *);
227: int rcs_access_check(RCSFILE *, const char *);
1.43 niallo 228: struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *);
1.39 xsa 229: int rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
230: int rcs_sym_remove(RCSFILE *, const char *);
231: RCSNUM *rcs_sym_getrev(RCSFILE *, const char *);
232: int rcs_sym_check(const char *);
233: int rcs_lock_getmode(RCSFILE *);
234: int rcs_lock_setmode(RCSFILE *, int);
235: int rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
1.42 joris 236: int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *);
1.39 xsa 237: BUF *rcs_getrev(RCSFILE *, RCSNUM *);
238: int rcs_deltatext_set(RCSFILE *, RCSNUM *, const char *);
239: const char *rcs_desc_get(RCSFILE *);
1.52 xsa 240: void rcs_desc_set(RCSFILE *, const char *);
1.39 xsa 241: const char *rcs_comment_lookup(const char *);
242: const char *rcs_comment_get(RCSFILE *);
1.53 xsa 243: void rcs_comment_set(RCSFILE *, const char *);
1.47 niallo 244: BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
1.58 xsa 245: void rcs_kwexp_set(RCSFILE *, int);
1.39 xsa 246: int rcs_kwexp_get(RCSFILE *);
247: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
248: const char *);
249: time_t rcs_rev_getdate(RCSFILE *, RCSNUM *);
250: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
251: int rcs_rev_remove(RCSFILE *, RCSNUM *);
252: int rcs_state_set(RCSFILE *, RCSNUM *, const char *);
253: const char *rcs_state_get(RCSFILE *, RCSNUM *);
254: int rcs_state_check(const char *);
255: RCSNUM *rcs_tag_resolve(RCSFILE *, const char *);
256: const char *rcs_errstr(int);
1.62 joris 257: void rcs_write(RCSFILE *);
1.30 xsa 258:
259: int rcs_kflag_get(const char *);
260: void rcs_kflag_usage(void);
261: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
262:
263: RCSNUM *rcsnum_alloc(void);
264: RCSNUM *rcsnum_parse(const char *);
265: RCSNUM *rcsnum_brtorev(const RCSNUM *);
266: RCSNUM *rcsnum_revtobr(const RCSNUM *);
267: RCSNUM *rcsnum_inc(RCSNUM *);
1.33 joris 268: RCSNUM *rcsnum_dec(RCSNUM *);
1.30 xsa 269: void rcsnum_free(RCSNUM *);
270: int rcsnum_aton(const char *, char **, RCSNUM *);
271: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
1.55 ray 272: void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
1.30 xsa 273: int rcsnum_cmp(const RCSNUM *, const RCSNUM *, u_int);
1.49 xsa 274:
275: /* rcstime.c */
1.59 joris 276: void rcs_set_tz(char *, struct rcs_delta *, struct tm *);
1.48 joris 277: extern char *timezone_flag;
1.61 niallo 278: extern int rcsnum_flags;
1.1 jfb 279:
1.30 xsa 280: #endif /* RCS_H */
![[BACK]](/icons/back.gif){kind=icon}
Return to rcs.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / cvs