Annotation of src/usr.bin/cvs/rcsnum.c, Revision 1.36
1.36 ! niallo 1: /* $OpenBSD: rcsnum.c,v 1.35 2006/04/14 02:49:44 deraadt Exp $ */
1.1 jfb 2: /*
3: * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.4 tedu 4: * All rights reserved.
1.1 jfb 5: *
1.4 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.4 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.4 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.4 tedu 24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 jfb 25: */
26:
1.22 xsa 27: #include "includes.h"
1.1 jfb 28:
1.15 joris 29: #include "cvs.h"
1.12 xsa 30: #include "log.h"
1.1 jfb 31: #include "rcs.h"
32:
33:
1.33 xsa 34: static void rcsnum_setsize(RCSNUM *, u_int);
1.23 xsa 35: static char *rcsnum_itoa(u_int16_t, char *, size_t);
1.11 jfb 36:
1.36 ! niallo 37: int rcsnum_flags;
1.1 jfb 38:
39: /*
40: * rcsnum_alloc()
41: *
1.30 ray 42: * Allocate an RCS number structure and return a pointer to it.
1.1 jfb 43: */
1.14 xsa 44: RCSNUM *
1.1 jfb 45: rcsnum_alloc(void)
46: {
47: RCSNUM *rnp;
48:
1.32 ray 49: rnp = xmalloc(sizeof(*rnp));
1.1 jfb 50: rnp->rn_len = 0;
51: rnp->rn_id = NULL;
52:
53: return (rnp);
54: }
55:
56: /*
1.7 jfb 57: * rcsnum_parse()
58: *
59: * Parse a string specifying an RCS number and return the corresponding RCSNUM.
60: */
1.14 xsa 61: RCSNUM *
1.7 jfb 62: rcsnum_parse(const char *str)
63: {
64: char *ep;
65: RCSNUM *num;
66:
1.19 joris 67: num = rcsnum_alloc();
1.34 deraadt 68: if (rcsnum_aton(str, &ep, num) < 0 || *ep != '\0') {
1.7 jfb 69: rcsnum_free(num);
1.9 jfb 70: num = NULL;
71: if (*ep != '\0')
72: rcs_errno = RCS_ERR_BADNUM;
1.7 jfb 73: }
74:
75: return (num);
76: }
77:
78: /*
1.1 jfb 79: * rcsnum_free()
80: *
81: * Free an RCSNUM structure previously allocated with rcsnum_alloc().
82: */
83: void
84: rcsnum_free(RCSNUM *rn)
85: {
86: if (rn->rn_id != NULL)
1.18 joris 87: xfree(rn->rn_id);
88: xfree(rn);
1.1 jfb 89: }
90:
91: /*
92: * rcsnum_tostr()
1.10 jfb 93: *
94: * Format the RCS number <nump> into a human-readable dot-separated
95: * representation and store the resulting string in <buf>, which is of size
96: * <blen>.
1.25 ray 97: * Returns a pointer to the start of <buf>. On failure <buf> is set to
98: * an empty string.
1.1 jfb 99: */
1.13 xsa 100: char *
1.1 jfb 101: rcsnum_tostr(const RCSNUM *nump, char *buf, size_t blen)
102: {
103: u_int i;
104: char tmp[8];
105:
1.34 deraadt 106: if (nump == NULL || nump->rn_len == 0) {
1.1 jfb 107: buf[0] = '\0';
108: return (buf);
109: }
110:
1.20 niallo 111: strlcpy(buf, rcsnum_itoa(nump->rn_id[0], buf, blen), blen);
1.1 jfb 112: for (i = 1; i < nump->rn_len; i++) {
1.20 niallo 113: strlcat(buf, ".", blen);
114: strlcat(buf, rcsnum_itoa(nump->rn_id[i], tmp, sizeof(tmp)),
115: blen);
1.1 jfb 116: }
117:
118: return (buf);
1.20 niallo 119: }
120:
121: static char *
122: rcsnum_itoa(u_int16_t num, char *buf, size_t len)
123: {
1.21 reyk 124: u_int16_t i;
125: char *p;
1.20 niallo 126:
1.26 niallo 127: if (num == 0)
128: return "0";
1.35 deraadt 129:
1.21 reyk 130: p = buf + len - 1;
131: i = num;
1.20 niallo 132: bzero(buf, len);
1.21 reyk 133: while (i) {
134: *--p = '0' + (i % 10);
135: i /= 10;
136: }
137: return (p);
1.1 jfb 138: }
139:
140: /*
141: * rcsnum_cpy()
142: *
143: * Copy the number stored in <nsrc> in the destination <ndst> up to <depth>
1.30 ray 144: * numbers deep. If <depth> is 0, there is no depth limit.
1.1 jfb 145: */
1.30 ray 146: void
1.1 jfb 147: rcsnum_cpy(const RCSNUM *nsrc, RCSNUM *ndst, u_int depth)
148: {
149: u_int len;
150: void *tmp;
151:
152: len = nsrc->rn_len;
1.34 deraadt 153: if (depth != 0 && len > depth)
1.1 jfb 154: len = depth;
155:
1.30 ray 156: tmp = xrealloc(ndst->rn_id, len, sizeof(len));
1.32 ray 157: ndst->rn_id = tmp;
1.1 jfb 158: ndst->rn_len = len;
1.30 ray 159: /* Overflow checked in xrealloc(). */
1.32 ray 160: (void)memcpy(ndst->rn_id, nsrc->rn_id, len * sizeof(len));
1.1 jfb 161: }
162:
163: /*
164: * rcsnum_cmp()
165: *
166: * Compare the two numbers <n1> and <n2>. Returns -1 if <n1> is larger than
167: * <n2>, 0 if they are both the same, and 1 if <n2> is larger than <n1>.
168: * The <depth> argument specifies how many numbers deep should be checked for
169: * the result. A value of 0 means that the depth will be the minimum of the
170: * two numbers.
171: */
172: int
173: rcsnum_cmp(const RCSNUM *n1, const RCSNUM *n2, u_int depth)
174: {
175: int res;
176: u_int i;
177: size_t slen;
178:
179: slen = MIN(n1->rn_len, n2->rn_len);
1.34 deraadt 180: if (depth != 0 && slen > depth)
1.1 jfb 181: slen = depth;
1.4 tedu 182:
1.1 jfb 183: for (i = 0; i < slen; i++) {
184: res = n1->rn_id[i] - n2->rn_id[i];
185: if (res < 0)
186: return (1);
187: else if (res > 0)
188: return (-1);
189: }
190:
191: if (n1->rn_len > n2->rn_len)
192: return (-1);
193: else if (n2->rn_len > n1->rn_len)
194: return (1);
195:
196: return (0);
197: }
198:
199: /*
200: * rcsnum_aton()
201: *
202: * Translate the string <str> containing a sequence of digits and periods into
203: * its binary representation, which is stored in <nump>. The address of the
204: * first byte not part of the number is stored in <ep> on return, if it is not
205: * NULL.
206: * Returns 0 on success, or -1 on failure.
207: */
208: int
209: rcsnum_aton(const char *str, char **ep, RCSNUM *nump)
210: {
1.6 jfb 211: u_int32_t val;
1.1 jfb 212: const char *sp;
213: void *tmp;
1.15 joris 214: char *s;
1.1 jfb 215:
1.18 joris 216: if (nump->rn_id == NULL)
1.32 ray 217: nump->rn_id = xmalloc(sizeof(*(nump->rn_id)));
1.1 jfb 218:
219: nump->rn_len = 0;
1.6 jfb 220: nump->rn_id[0] = 0;
1.1 jfb 221:
1.3 jfb 222: for (sp = str;; sp++) {
223: if (!isdigit(*sp) && (*sp != '.'))
1.1 jfb 224: break;
225:
226: if (*sp == '.') {
1.6 jfb 227: if (nump->rn_len >= RCSNUM_MAXLEN - 1) {
1.11 jfb 228: rcs_errno = RCS_ERR_BADNUM;
1.6 jfb 229: goto rcsnum_aton_failed;
230: }
231:
1.1 jfb 232: nump->rn_len++;
1.18 joris 233: tmp = xrealloc(nump->rn_id,
1.32 ray 234: nump->rn_len + 1, sizeof(*(nump->rn_id)));
235: nump->rn_id = tmp;
1.2 vincent 236: nump->rn_id[nump->rn_len] = 0;
1.1 jfb 237: continue;
238: }
239:
1.6 jfb 240: val = (nump->rn_id[nump->rn_len] * 10) + (*sp - 0x30);
1.24 niallo 241: if (val > RCSNUM_MAXNUM)
242: fatal("RCSNUM overflow!");
1.6 jfb 243:
244: nump->rn_id[nump->rn_len] = val;
1.1 jfb 245: }
246:
247: if (ep != NULL)
1.5 jfb 248: *(const char **)ep = sp;
1.15 joris 249:
250: /*
251: * Handle "magic" RCS branch numbers.
252: *
253: * What are they?
254: *
255: * Magic branch numbers have an extra .0. at the second farmost
256: * rightside of the branch number, so instead of having an odd
257: * number of dot-separated decimals, it will have an even number.
258: *
259: * Now, according to all the documentation i've found on the net
260: * about this, cvs does this for "efficiency reasons", i'd like
261: * to hear one.
262: *
263: * We just make sure we remove the .0. from in the branch number.
264: *
265: * XXX - for compatibility reasons with GNU cvs we _need_
266: * to skip this part for the 'log' command, apparently it does
267: * show the magic branches for an unknown and probably
268: * completely insane and not understandable reason in that output.
269: *
270: */
1.36 ! niallo 271: if (nump->rn_len > 2 && nump->rn_id[nump->rn_len - 1] == 0
! 272: && !(rcsnum_flags & RCSNUM_NO_MAGIC)) {
1.15 joris 273: /*
274: * Look for ".0.x" at the end of the branch number.
275: */
276: if ((s = strrchr(str, '.')) != NULL) {
1.27 deraadt 277: s--;
1.15 joris 278: while (*s != '.')
1.27 deraadt 279: s--;
1.15 joris 280:
281: /*
282: * If we have a "magic" branch, adjust it
283: * so the .0. is removed.
284: */
285: if (!strncmp(s, RCS_MAGIC_BRANCH,
286: strlen(RCS_MAGIC_BRANCH))) {
287: nump->rn_id[nump->rn_len - 1] =
288: nump->rn_id[nump->rn_len];
289: nump->rn_len--;
290: }
291: }
292: }
1.1 jfb 293:
1.26 niallo 294: /* We can't have a single-digit rcs number. */
295: if (nump->rn_len == 0) {
296: tmp = xrealloc(nump->rn_id,
1.32 ray 297: nump->rn_len + 1, sizeof(*(nump->rn_id)));
298: nump->rn_id = tmp;
1.26 niallo 299: nump->rn_id[nump->rn_len + 1] = 0;
300: nump->rn_len++;
301: }
1.31 joris 302:
1.1 jfb 303: nump->rn_len++;
304: return (nump->rn_len);
1.6 jfb 305:
306: rcsnum_aton_failed:
307: nump->rn_len = 0;
1.18 joris 308: xfree(nump->rn_id);
1.6 jfb 309: nump->rn_id = NULL;
310: return (-1);
1.11 jfb 311: }
312:
313: /*
314: * rcsnum_inc()
315: *
316: * Increment the revision number specified in <num>.
317: * Returns a pointer to the <num> on success, or NULL on failure.
318: */
1.14 xsa 319: RCSNUM *
1.11 jfb 320: rcsnum_inc(RCSNUM *num)
321: {
322: if (num->rn_id[num->rn_len - 1] == RCSNUM_MAXNUM)
323: return (NULL);
324: num->rn_id[num->rn_len - 1]++;
1.17 joris 325: return (num);
326: }
327:
328: /*
329: * rcsnum_dec()
330: *
1.26 niallo 331: * Decreases the revision number specified in <num>, if doing so will not
332: * result in an ending value below 1. E.g. 4.2 will go to 4.1 but 4.1 will
333: * be returned as 4.1.
1.17 joris 334: */
335: RCSNUM *
336: rcsnum_dec(RCSNUM *num)
337: {
1.28 ray 338: /* XXX - Is it an error for the number to be 0? */
339: if (num->rn_id[num->rn_len - 1] <= 1)
1.26 niallo 340: return (num);
1.17 joris 341: num->rn_id[num->rn_len - 1]--;
1.11 jfb 342: return (num);
343: }
344:
345: /*
346: * rcsnum_revtobr()
347: *
348: * Retrieve the branch number associated with the revision number <num>.
349: * If <num> is a branch revision, the returned value will be the same
350: * number as the argument.
351: */
1.14 xsa 352: RCSNUM *
1.11 jfb 353: rcsnum_revtobr(const RCSNUM *num)
354: {
355: RCSNUM *brnum;
356:
357: if (num->rn_len < 2)
358: return (NULL);
359:
1.19 joris 360: brnum = rcsnum_alloc();
1.11 jfb 361: rcsnum_cpy(num, brnum, 0);
362:
363: if (!RCSNUM_ISBRANCH(brnum))
364: brnum->rn_len--;
365:
366: return (brnum);
367: }
368:
369: /*
370: * rcsnum_brtorev()
371: *
372: * Retrieve the initial revision number associated with the branch number <num>.
373: * If <num> is a revision number, an error will be returned.
374: */
1.14 xsa 375: RCSNUM *
1.11 jfb 376: rcsnum_brtorev(const RCSNUM *brnum)
377: {
378: RCSNUM *num;
379:
380: if (!RCSNUM_ISBRANCH(brnum)) {
381: return (NULL);
382: }
383:
1.19 joris 384: num = rcsnum_alloc();
1.33 xsa 385: rcsnum_setsize(num, brnum->rn_len + 1);
1.11 jfb 386: rcsnum_cpy(brnum, num, brnum->rn_len);
387: num->rn_id[num->rn_len++] = 1;
388:
389: return (num);
390: }
391:
1.33 xsa 392: static void
1.11 jfb 393: rcsnum_setsize(RCSNUM *num, u_int len)
394: {
395: void *tmp;
396:
1.32 ray 397: tmp = xrealloc(num->rn_id, len, sizeof(*(num->rn_id)));
398: num->rn_id = tmp;
1.11 jfb 399: num->rn_len = len;
1.1 jfb 400: }