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