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