Annotation of src/usr.bin/cvs/rcs.h, Revision 1.73
1.73 ! joris 1: /* $OpenBSD: rcs.h,v 1.72 2007/01/13 04:18:50 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: #include "buf.h"
30:
1.30 xsa 31: #define RCS_DIFF_MAXARG 32
1.1 jfb 32: #define RCS_DIFF_DIV \
33: "==================================================================="
34:
1.30 xsa 35: #define RCSDIR "RCS"
36: #define RCS_FILE_EXT ",v"
1.1 jfb 37:
1.30 xsa 38: #define RCS_HEAD_BRANCH "HEAD"
39: #define RCS_HEAD_INIT "1.1"
40: #define RCS_HEAD_REV ((RCSNUM *)(-1))
1.23 jfb 41:
1.63 joris 42: #define RCS_CONFLICT_MARKER1 "<<<<<<< "
43: #define RCS_CONFLICT_MARKER2 ">>>>>>> "
44: #define RCS_CONFLICT_MARKER3 "=======\n"
1.23 jfb 45:
1.30 xsa 46: #define RCS_SYM_INVALCHAR "$,.:;@"
1.1 jfb 47:
1.12 jfb 48:
1.31 joris 49: #define RCS_MAGIC_BRANCH ".0."
1.30 xsa 50: #define RCS_STATE_EXP "Exp"
51: #define RCS_STATE_DEAD "dead"
1.17 jfb 52:
1.12 jfb 53: /* lock types */
1.30 xsa 54: #define RCS_LOCK_INVAL (-1)
55: #define RCS_LOCK_LOOSE 0
56: #define RCS_LOCK_STRICT 1
1.12 jfb 57:
58:
1.46 niallo 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:
72: #define RCS_KW_ID \
73: (RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \
74: | RCS_KW_AUTHOR | RCS_KW_STATE)
75:
76: #define RCS_KW_HEADER (RCS_KW_ID | RCS_KW_FULLPATH)
77:
1.6 jfb 78: /* RCS keyword expansion modes (kflags) */
1.30 xsa 79: #define RCS_KWEXP_NONE 0x00
80: #define RCS_KWEXP_NAME 0x01 /* include keyword name */
81: #define RCS_KWEXP_VAL 0x02 /* include keyword value */
82: #define RCS_KWEXP_LKR 0x04 /* include name of locker */
83: #define RCS_KWEXP_OLD 0x08 /* generate old keyword string */
84: #define RCS_KWEXP_ERR 0x10 /* mode has an error */
1.6 jfb 85:
1.30 xsa 86: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
87: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
1.6 jfb 88:
1.9 jfb 89: #define RCS_KWEXP_INVAL(k) \
1.13 jfb 90: ((k & RCS_KWEXP_ERR) || \
1.51 ray 91: ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD)))
1.9 jfb 92:
1.6 jfb 93:
1.46 niallo 94: struct rcs_kw {
95: char kw_str[16];
96: int kw_type;
97: };
98:
99: #define RCS_NKWORDS (sizeof(rcs_expkw)/sizeof(rcs_expkw[0]))
1.6 jfb 100:
1.30 xsa 101: #define RCSNUM_MAXNUM USHRT_MAX
102: #define RCSNUM_MAXLEN 64
1.6 jfb 103:
1.30 xsa 104: #define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2)
1.57 joris 105: #define RCSNUM_ISBRANCHREV(n) (!((n)->rn_len % 2) && ((n)->rn_len >= 4))
1.61 niallo 106: #define RCSNUM_NO_MAGIC (1<<0)
1.1 jfb 107:
108: /* file flags */
1.43 niallo 109: #define RCS_READ (1<<0)
110: #define RCS_WRITE (1<<1)
111: #define RCS_RDWR (RCS_READ|RCS_WRITE)
112: #define RCS_CREATE (1<<2) /* create the file */
113: #define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */
1.9 jfb 114:
115: /* internal flags */
1.43 niallo 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 */
1.1 jfb 124:
125: /* delta flags */
1.30 xsa 126: #define RCS_RD_DEAD 0x01 /* dead */
1.56 ray 127: #define RCS_RD_SELECT 0x02 /* select for operation */
1.5 jfb 128:
1.14 jfb 129: /* RCS error codes */
1.30 xsa 130: #define RCS_ERR_NOERR 0
131: #define RCS_ERR_NOENT 1
132: #define RCS_ERR_DUPENT 2
133: #define RCS_ERR_BADNUM 3
134: #define RCS_ERR_BADSYM 4
135: #define RCS_ERR_PARSE 5
136: #define RCS_ERR_ERRNO 255
1.40 joris 137:
1.62 joris 138: /* used for rcs_checkout_rev */
1.40 joris 139: #define CHECKOUT_REV_CREATED 1
140: #define CHECKOUT_REV_MERGED 2
141: #define CHECKOUT_REV_REMOVED 3
1.41 joris 142: #define CHECKOUT_REV_UPDATED 4
1.5 jfb 143:
1.1 jfb 144: typedef struct rcs_num {
1.30 xsa 145: u_int rn_len;
146: u_int16_t *rn_id;
1.1 jfb 147: } RCSNUM;
148:
149:
1.11 jfb 150: struct rcs_access {
1.30 xsa 151: char *ra_name;
152: uid_t ra_uid;
153: TAILQ_ENTRY(rcs_access) ra_list;
1.11 jfb 154: };
155:
1.1 jfb 156: struct rcs_sym {
1.30 xsa 157: char *rs_name;
158: RCSNUM *rs_num;
159: TAILQ_ENTRY(rcs_sym) rs_list;
1.1 jfb 160: };
161:
162: struct rcs_lock {
1.30 xsa 163: char *rl_name;
164: RCSNUM *rl_num;
1.1 jfb 165:
1.30 xsa 166: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 jfb 167: };
168:
169:
170: struct rcs_branch {
1.30 xsa 171: RCSNUM *rb_num;
172: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 jfb 173: };
174:
1.50 ray 175: TAILQ_HEAD(rcs_dlist, rcs_delta);
1.1 jfb 176:
177: struct rcs_delta {
1.30 xsa 178: RCSNUM *rd_num;
179: RCSNUM *rd_next;
180: u_int rd_flags;
181: struct tm rd_date;
182: char *rd_author;
183: char *rd_state;
184: char *rd_log;
1.42 joris 185: char *rd_locker;
1.30 xsa 186: u_char *rd_text;
187: size_t rd_tlen;
188:
189: TAILQ_HEAD(, rcs_branch) rd_branches;
190: TAILQ_ENTRY(rcs_delta) rd_list;
1.1 jfb 191: };
192:
193:
194: typedef struct rcs_file {
1.62 joris 195: int fd;
1.64 joris 196: int rf_dead;
1.66 joris 197: int rf_inattic;
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;
1.71 niallo 218: struct cvs_lines;
1.14 jfb 219:
1.62 joris 220: RCSFILE *rcs_open(const char *, int, int, ...);
1.39 xsa 221: void rcs_close(RCSFILE *);
1.68 joris 222: RCSNUM *rcs_head_get(RCSFILE *);
1.43 niallo 223: int rcs_head_set(RCSFILE *, RCSNUM *);
1.39 xsa 224: const RCSNUM *rcs_branch_get(RCSFILE *);
225: int rcs_branch_set(RCSFILE *, const RCSNUM *);
226: int rcs_access_add(RCSFILE *, const char *);
227: int rcs_access_remove(RCSFILE *, const char *);
228: int rcs_access_check(RCSFILE *, const char *);
1.43 niallo 229: struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *);
1.39 xsa 230: int rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
1.69 xsa 231: int rcs_sym_check(const char *);
232: struct rcs_sym *rcs_sym_get(RCSFILE *, const char *);
1.39 xsa 233: int rcs_sym_remove(RCSFILE *, const char *);
234: RCSNUM *rcs_sym_getrev(RCSFILE *, const char *);
1.65 joris 235: RCSNUM *rcs_translate_tag(const char *, RCSFILE *);
1.39 xsa 236: int rcs_lock_getmode(RCSFILE *);
237: int rcs_lock_setmode(RCSFILE *, int);
238: int rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
1.42 joris 239: int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *);
1.39 xsa 240: BUF *rcs_getrev(RCSFILE *, RCSNUM *);
1.70 joris 241: int rcs_deltatext_set(RCSFILE *, RCSNUM *, BUF *);
1.39 xsa 242: const char *rcs_desc_get(RCSFILE *);
1.52 xsa 243: void rcs_desc_set(RCSFILE *, const char *);
1.39 xsa 244: const char *rcs_comment_lookup(const char *);
245: const char *rcs_comment_get(RCSFILE *);
1.53 xsa 246: void rcs_comment_set(RCSFILE *, const char *);
1.47 niallo 247: BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
1.58 xsa 248: void rcs_kwexp_set(RCSFILE *, int);
1.39 xsa 249: int rcs_kwexp_get(RCSFILE *);
250: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
251: const char *);
252: time_t rcs_rev_getdate(RCSFILE *, RCSNUM *);
253: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
254: int rcs_rev_remove(RCSFILE *, RCSNUM *);
255: int rcs_state_set(RCSFILE *, RCSNUM *, const char *);
256: const char *rcs_state_get(RCSFILE *, RCSNUM *);
257: int rcs_state_check(const char *);
258: RCSNUM *rcs_tag_resolve(RCSFILE *, const char *);
259: const char *rcs_errstr(int);
1.62 joris 260: void rcs_write(RCSFILE *);
1.72 joris 261: void rcs_rev_write_stmp(RCSFILE *, RCSNUM *, char *, int);
262: void rcs_rev_write_fd(RCSFILE *, RCSNUM *, int, int);
263: struct cvs_lines *rcs_rev_getlines(RCSFILE *, RCSNUM *);
1.73 ! joris 264: BUF *rcs_rev_getbuf(RCSFILE *, RCSNUM *, int);
1.30 xsa 265:
266: int rcs_kflag_get(const char *);
267: void rcs_kflag_usage(void);
268: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
269:
270: RCSNUM *rcsnum_alloc(void);
271: RCSNUM *rcsnum_parse(const char *);
272: RCSNUM *rcsnum_brtorev(const RCSNUM *);
273: RCSNUM *rcsnum_revtobr(const RCSNUM *);
274: RCSNUM *rcsnum_inc(RCSNUM *);
1.33 joris 275: RCSNUM *rcsnum_dec(RCSNUM *);
1.30 xsa 276: void rcsnum_free(RCSNUM *);
277: int rcsnum_aton(const char *, char **, RCSNUM *);
278: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
1.55 ray 279: void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
1.67 joris 280: int rcsnum_cmp(RCSNUM *, RCSNUM *, u_int);
281: int rcsnum_differ(RCSNUM *, RCSNUM *);
1.49 xsa 282:
283: /* rcstime.c */
1.59 joris 284: void rcs_set_tz(char *, struct rcs_delta *, struct tm *);
1.48 joris 285: extern char *timezone_flag;
1.61 niallo 286: extern int rcsnum_flags;
1.1 jfb 287:
1.30 xsa 288: #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