Annotation of src/usr.bin/cvs/rcs.h, Revision 1.98
1.98 ! nicm 1: /* $OpenBSD: rcs.h,v 1.97 2010/10/20 19:53:53 tobias 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
1.97 tobias 29:
30: #include <stdio.h>
31:
1.1 jfb 32: #include "buf.h"
33:
34: #define RCS_DIFF_DIV \
35: "==================================================================="
36:
1.30 xsa 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.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:
1.46 niallo 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
1.76 niallo 70: #define RCS_KW_MDOCDATE 0x0020
1.81 tobias 71: #define RCS_KW_LOCKER 0x0040
1.46 niallo 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.83 tobias 80: #define RCS_KWEXP_NONE 0x01 /* do not expand keywords */
81: #define RCS_KWEXP_NAME 0x02 /* include keyword name */
82: #define RCS_KWEXP_VAL 0x04 /* include keyword value */
83: #define RCS_KWEXP_LKR 0x08 /* include name of locker */
84: #define RCS_KWEXP_OLD 0x10 /* generate old keyword string */
85: #define RCS_KWEXP_ERR 0x20 /* 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.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.1 jfb 106:
107: /* file flags */
1.43 niallo 108: #define RCS_READ (1<<0)
1.98 ! nicm 109: #define RCS_WRITE (1<<1) /* flush changes on rcs_close() */
1.43 niallo 110: #define RCS_CREATE (1<<2) /* create the file */
111: #define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */
1.9 jfb 112:
113: /* internal flags */
1.43 niallo 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 */
1.1 jfb 122:
123: /* delta flags */
1.30 xsa 124: #define RCS_RD_DEAD 0x01 /* dead */
1.56 ray 125: #define RCS_RD_SELECT 0x02 /* select for operation */
1.40 joris 126:
1.1 jfb 127: typedef struct rcs_num {
1.30 xsa 128: u_int rn_len;
129: u_int16_t *rn_id;
1.1 jfb 130: } RCSNUM;
131:
1.11 jfb 132: struct rcs_access {
1.30 xsa 133: char *ra_name;
134: TAILQ_ENTRY(rcs_access) ra_list;
1.11 jfb 135: };
136:
1.1 jfb 137: struct rcs_sym {
1.30 xsa 138: char *rs_name;
139: RCSNUM *rs_num;
140: TAILQ_ENTRY(rcs_sym) rs_list;
1.1 jfb 141: };
142:
143: struct rcs_lock {
1.30 xsa 144: char *rl_name;
145: RCSNUM *rl_num;
1.1 jfb 146:
1.94 ray 147: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 jfb 148: };
149:
150: struct rcs_branch {
1.30 xsa 151: RCSNUM *rb_num;
1.94 ray 152: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 jfb 153: };
154:
1.50 ray 155: TAILQ_HEAD(rcs_dlist, rcs_delta);
1.1 jfb 156:
157: struct rcs_delta {
1.30 xsa 158: RCSNUM *rd_num;
159: RCSNUM *rd_next;
1.75 otto 160: int rd_flags;
1.30 xsa 161: struct tm rd_date;
162: char *rd_author;
163: char *rd_state;
164: char *rd_log;
1.42 joris 165: char *rd_locker;
1.30 xsa 166: u_char *rd_text;
167: size_t rd_tlen;
168:
169: TAILQ_HEAD(, rcs_branch) rd_branches;
170: TAILQ_ENTRY(rcs_delta) rd_list;
1.1 jfb 171: };
172:
173:
174: typedef struct rcs_file {
1.97 tobias 175: FILE *rf_file;
1.64 joris 176: int rf_dead;
1.30 xsa 177: char *rf_path;
178: mode_t rf_mode;
1.75 otto 179: int rf_flags;
1.30 xsa 180:
181: RCSNUM *rf_head;
182: RCSNUM *rf_branch;
183: char *rf_comment;
184: char *rf_expand;
185: char *rf_desc;
186:
187: u_int rf_ndelta;
188: struct rcs_dlist rf_delta;
189: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
190: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
191: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
1.9 jfb 192:
1.30 xsa 193: void *rf_pdata;
1.1 jfb 194: } RCSFILE;
195:
1.94 ray 196: struct rcs_line;
197: struct rcs_lines;
1.14 jfb 198:
1.62 joris 199: RCSFILE *rcs_open(const char *, int, int, ...);
1.39 xsa 200: void rcs_close(RCSFILE *);
1.68 joris 201: RCSNUM *rcs_head_get(RCSFILE *);
1.43 niallo 202: int rcs_head_set(RCSFILE *, RCSNUM *);
1.92 tobias 203: RCSNUM *rcs_branch_new(RCSFILE *, RCSNUM *);
1.39 xsa 204: const RCSNUM *rcs_branch_get(RCSFILE *);
205: int rcs_branch_set(RCSFILE *, const RCSNUM *);
206: int rcs_access_add(RCSFILE *, const char *);
207: int rcs_access_remove(RCSFILE *, const char *);
208: int rcs_access_check(RCSFILE *, const char *);
1.43 niallo 209: struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *);
1.39 xsa 210: int rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
1.69 xsa 211: int rcs_sym_check(const char *);
212: struct rcs_sym *rcs_sym_get(RCSFILE *, const char *);
1.39 xsa 213: int rcs_sym_remove(RCSFILE *, const char *);
214: RCSNUM *rcs_sym_getrev(RCSFILE *, const char *);
1.65 joris 215: RCSNUM *rcs_translate_tag(const char *, RCSFILE *);
1.39 xsa 216: int rcs_lock_getmode(RCSFILE *);
217: int rcs_lock_setmode(RCSFILE *, int);
218: int rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
1.42 joris 219: int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *);
1.70 joris 220: int rcs_deltatext_set(RCSFILE *, RCSNUM *, BUF *);
1.39 xsa 221: const char *rcs_desc_get(RCSFILE *);
1.52 xsa 222: void rcs_desc_set(RCSFILE *, const char *);
1.39 xsa 223: const char *rcs_comment_lookup(const char *);
224: const char *rcs_comment_get(RCSFILE *);
1.53 xsa 225: void rcs_comment_set(RCSFILE *, const char *);
1.47 niallo 226: BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
1.58 xsa 227: void rcs_kwexp_set(RCSFILE *, int);
1.39 xsa 228: int rcs_kwexp_get(RCSFILE *);
229: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
230: const char *);
231: time_t rcs_rev_getdate(RCSFILE *, RCSNUM *);
232: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
233: int rcs_rev_remove(RCSFILE *, RCSNUM *);
234: int rcs_state_set(RCSFILE *, RCSNUM *, const char *);
235: const char *rcs_state_get(RCSFILE *, RCSNUM *);
236: int rcs_state_check(const char *);
237: RCSNUM *rcs_tag_resolve(RCSFILE *, const char *);
1.62 joris 238: void rcs_write(RCSFILE *);
1.88 joris 239: int rcs_rev_write_stmp(RCSFILE *, RCSNUM *, char *, int);
1.72 joris 240: void rcs_rev_write_fd(RCSFILE *, RCSNUM *, int, int);
1.94 ray 241: struct rcs_lines *rcs_rev_getlines(RCSFILE *, RCSNUM *,
242: struct rcs_line ***);
1.80 tobias 243: void rcs_annotate_getlines(RCSFILE *, RCSNUM *,
1.94 ray 244: struct rcs_line ***);
1.73 joris 245: BUF *rcs_rev_getbuf(RCSFILE *, RCSNUM *, int);
1.85 joris 246: void rcs_delta_stats(struct rcs_delta *, int *, int *);
1.30 xsa 247:
248: int rcs_kflag_get(const char *);
249: void rcs_kflag_usage(void);
250: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
251:
252: RCSNUM *rcsnum_alloc(void);
253: RCSNUM *rcsnum_parse(const char *);
254: RCSNUM *rcsnum_brtorev(const RCSNUM *);
255: RCSNUM *rcsnum_revtobr(const RCSNUM *);
256: RCSNUM *rcsnum_inc(RCSNUM *);
1.33 joris 257: RCSNUM *rcsnum_dec(RCSNUM *);
1.79 joris 258: RCSNUM *rcsnum_branch_root(RCSNUM *);
1.82 tobias 259: RCSNUM *rcsnum_new_branch(RCSNUM *);
1.30 xsa 260: void rcsnum_free(RCSNUM *);
1.86 tobias 261: int rcsnum_addmagic(RCSNUM *);
1.30 xsa 262: int rcsnum_aton(const char *, char **, RCSNUM *);
263: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
1.55 ray 264: void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
1.67 joris 265: int rcsnum_cmp(RCSNUM *, RCSNUM *, u_int);
266: int rcsnum_differ(RCSNUM *, RCSNUM *);
1.1 jfb 267:
1.30 xsa 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 / cvs