[BACK]Return to rcsnum.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / rcs

Annotation of src/usr.bin/rcs/rcsnum.c, Revision 1.4

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