Annotation of src/usr.bin/rcs/rcs.h, Revision 1.14
1.14 ! nicm 1: /* $OpenBSD: rcs.h,v 1.13 2010/10/20 19:53:53 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:
1.13 tobias 32: #include <stdio.h>
33:
1.1 joris 34: #include "buf.h"
35:
36: #define RCS_DIFF_MAXARG 32
37: #define RCS_DIFF_DIV \
38: "==================================================================="
39:
40: #define RCSDIR "RCS"
41: #define RCS_FILE_EXT ",v"
42:
43: #define RCS_HEAD_BRANCH "HEAD"
44: #define RCS_HEAD_INIT "1.1"
45: #define RCS_HEAD_REV ((RCSNUM *)(-1))
46:
47:
1.11 tobias 48: #define RCS_STATE_INVALCHAR "$,:;@"
1.1 joris 49: #define RCS_SYM_INVALCHAR "$,.:;@"
50:
51: #define RCS_MAGIC_BRANCH ".0."
52: #define RCS_STATE_EXP "Exp"
53: #define RCS_STATE_DEAD "dead"
54:
55: /* lock types */
56: #define RCS_LOCK_INVAL (-1)
57: #define RCS_LOCK_LOOSE 0
58: #define RCS_LOCK_STRICT 1
59:
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:
79: /* RCS keyword expansion modes (kflags) */
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 */
86:
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)
89:
90: #define RCS_KWEXP_INVAL(k) \
91: ((k & RCS_KWEXP_ERR) || \
92: ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD)))
93:
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]))
100:
101: #define RCSNUM_MAXNUM USHRT_MAX
102: #define RCSNUM_MAXLEN 64
103:
104: #define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2)
105: #define RCSNUM_ISBRANCHREV(n) (!((n)->rn_len % 2) && ((n)->rn_len >= 4))
106: #define RCSNUM_NO_MAGIC (1<<0)
107:
108: /* file flags */
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 */
114:
115: /* internal flags */
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 */
124:
125: /* delta flags */
126: #define RCS_RD_DEAD 0x01 /* dead */
127: #define RCS_RD_SELECT 0x02 /* select for operation */
128:
129: /* RCS error codes */
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
137:
138: /* used for rcs_checkout_rev */
139: #define CHECKOUT_REV_CREATED 1
140: #define CHECKOUT_REV_MERGED 2
141: #define CHECKOUT_REV_REMOVED 3
142: #define CHECKOUT_REV_UPDATED 4
143:
144: typedef struct rcs_num {
145: u_int rn_len;
146: u_int16_t *rn_id;
147: } RCSNUM;
148:
149: struct rcs_access {
150: char *ra_name;
151: TAILQ_ENTRY(rcs_access) ra_list;
152: };
153:
154: struct rcs_sym {
155: char *rs_name;
156: RCSNUM *rs_num;
157: TAILQ_ENTRY(rcs_sym) rs_list;
158: };
159:
160: struct rcs_lock {
161: char *rl_name;
162: RCSNUM *rl_num;
163:
1.4 ray 164: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 joris 165: };
166:
167: struct rcs_branch {
168: RCSNUM *rb_num;
1.4 ray 169: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 joris 170: };
171:
172: TAILQ_HEAD(rcs_dlist, rcs_delta);
173:
174: struct rcs_delta {
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;
182: char *rd_locker;
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;
188: };
189:
190:
191: typedef struct rcs_file {
1.13 tobias 192: FILE *rf_file;
1.1 joris 193: char *rf_path;
194: mode_t rf_mode;
195: u_int rf_flags;
196:
197: RCSNUM *rf_head;
198: RCSNUM *rf_branch;
199: char *rf_comment;
200: char *rf_expand;
201: char *rf_desc;
202:
203: u_int rf_ndelta;
204: struct rcs_dlist rf_delta;
205: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
206: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
207: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
208:
209: void *rf_pdata;
210: } RCSFILE;
211:
212: extern int rcs_errno;
213:
1.2 joris 214: RCSFILE *rcs_open(const char *, int, int, ...);
1.1 joris 215: void rcs_close(RCSFILE *);
216: int rcs_head_set(RCSFILE *, RCSNUM *);
217: const RCSNUM *rcs_branch_get(RCSFILE *);
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: void rcs_desc_set(RCSFILE *, const char *);
233: void rcs_comment_set(RCSFILE *, const char *);
234: BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
235: void rcs_kwexp_set(RCSFILE *, int);
236: int rcs_kwexp_get(RCSFILE *);
237: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
238: const char *);
239: time_t rcs_rev_getdate(RCSFILE *, RCSNUM *);
240: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
241: int rcs_rev_remove(RCSFILE *, RCSNUM *);
242: int rcs_state_set(RCSFILE *, RCSNUM *, const char *);
243: int rcs_state_check(const char *);
1.3 xsa 244: void rcs_write(RCSFILE *);
1.8 xsa 245: void rcs_delta_stats(struct rcs_delta *, int *, int *);
1.1 joris 246:
247: int rcs_kflag_get(const char *);
248: void rcs_kflag_usage(void);
249: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
250:
251: RCSNUM *rcsnum_alloc(void);
252: RCSNUM *rcsnum_parse(const char *);
253: RCSNUM *rcsnum_brtorev(const RCSNUM *);
254: RCSNUM *rcsnum_revtobr(const RCSNUM *);
255: RCSNUM *rcsnum_inc(RCSNUM *);
256: void rcsnum_free(RCSNUM *);
1.7 tobias 257: int rcsnum_addmagic(RCSNUM *);
1.1 joris 258: int rcsnum_aton(const char *, char **, RCSNUM *);
259: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
260: void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
261: int rcsnum_cmp(const RCSNUM *, const RCSNUM *, u_int);
262:
263: /* rcstime.c */
264: void rcs_set_tz(char *, struct rcs_delta *, struct tm *);
265: extern char *timezone_flag;
266: extern int rcsnum_flags;
267:
268: #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