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