《linux 内核完全剖析》 vsprintf.c 代码笔记

vsprintf.c 代码笔记

 

/*
 *  linux/kernel/vsprintf.c
 *
 *  (C) 1991  Linus Torvalds
 */

/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
/*
 * Wirzenius wrote this portably, Torvalds fucked it up :-) 我只能说注释处处是亮点
 */

#include <stdarg.h>
#include <string.h>

/* we use this so that we can do without the ctype library */
#define is_digit(c)    ((c) >= '0' && (c) <= '9') //判读一个字符是否在0~9范围内

static int skip_atoi(const char **s) //将数字字符串转换成数值
{
    int i=0;

    while (is_digit(**s))
        i = i*10 + *((*s)++) - '0';
    return i;
}

#define ZEROPAD    1        /* pad with zero */
#define SIGN    2        /* unsigned/signed long */
#define PLUS    4        /* show plus */
#define SPACE    8        /* space if plus */
#define LEFT    16        /* left justified */
#define SPECIAL    32        /* 0x */
#define SMALL    64        /* use 'abcdef' instead of 'ABCDEF' */

#define do_div(n,base) ({ \
int __res; \
__asm__("divl %4":"=a" (n),"=d" (__res):"0" (n),"1" (0),"r" (base)); \
__res; })

static char * number(char * str, int num, int base, int size, int precision
    ,int type)
{
    char c,sign,tmp[36];
    const char *digits="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
    int i;

    if (type&SMALL) digits="0123456789abcdefghijklmnopqrstuvwxyz";
    if (type&LEFT) type &= ~ZEROPAD;
    if (base<2 || base>36) //机制基数必须在2~36之间
        return 0;
    c = (type & ZEROPAD) ? '0' : ' ' ; //是补0还是补空格
    if (type&SIGN && num<0) { //是否是有符号输出，并且是个负数
        sign='-';
        num = -num; //取相反数
    } else
        sign=(type&PLUS) ? '+' : ((type&SPACE) ? ' ' : 0); //如果是个正数，对于符号打印描述的处理
    if (sign) size--;
    if (type&SPECIAL)
        if (base==16) size -= 2;
        else if (base==8) size--;
    i=0;
    if (num==0) //如果要打印的数字是0，直接把0写入tmp就可以了
        tmp[i++]='0';
    else while (num!=0) //否则不停的对num进行除法运算，索引digits字符串。写入tmp
        tmp[i++]=digits[do_div(num,base)];
    if (i>precision) precision=i;
    size -= precision;
    if (!(type&(ZEROPAD+LEFT))) //没有左对齐并且补0的话，就补空格
        while(size-->0)
            *str++ = ' ';
    if (sign) //是否有符号字符输出，就有写入str指向的buffer
        *str++ = sign;
    if (type&SPECIAL) //是否对数据输出的进制有要求
        if (base==8)
            *str++ = '0';
        else if (base==16) {//十六进制输出一个0x digits[33]是x
            *str++ = '0';
            *str++ = digits[33];
        }
    if (!(type&LEFT)) //如果没有要求左对齐就可以直接补上0或者空格了
        while(size-->0)
            *str++ = c;
    while(i<precision--)
        *str++ = '0';
    while(i-->0) //把转换好的进制输出tmp，写入到str中
        *str++ = tmp[i];
    while(size-->0)
        *str++ = ' ';
    return str; //返回转换后的str指针
}

int vsprintf(char *buf, const char *fmt, va_list args) //fmt是格式说明符号，buf是待写入数据的buffer
{
    int len;
    int i;
    char * str;
    char *s;
    int *ip;

    int flags;        /* flags to number() */

    int field_width;    /* width of output field */
    int precision;        /* min. # of digits for integers; max
                   number of chars for from string */
    int qualifier;        /* 'h', 'l', or 'L' for integer fields */

    for (str=buf ; *fmt ; ++fmt) { //扫描格式说明符
        if (*fmt != '%') { //如果没有格式说明符，说明是普通的字符，直接写入str指向的buffer即可
            *str++ = *fmt;
            continue;
        }
        
        //到这一步，说明遇到了格式说明符
        /* process flags */
        flags = 0;
        repeat:
            ++fmt;        /* this also skips first '%' */
            switch (*fmt) { //取格式说明符%后面的一个字符，如果是 + - 空格 # 0
                case '-': flags |= LEFT; goto repeat;  //左对齐
                case '+': flags |= PLUS; goto repeat;  // 右对齐
                case ' ': flags |= SPACE; goto repeat; //空格
                case '#': flags |= SPECIAL; goto repeat; //我printf的时候。。。。这些都用的少。。。。
                case '0': flags |= ZEROPAD; goto repeat;
                }
        
        /* get field width */
        field_width = -1; //格式输出宽度
        if (is_digit(*fmt)) //如果是个数字
            field_width = skip_atoi(&fmt); //把格式输出宽度由字符转换成数字
        else if (*fmt == '*') { //如果是个*号
            /* it's the next argument */
            field_width = va_arg(args, int);
            if (field_width < 0) { //如果参数是个负数，那么左对齐
                field_width = -field_width;
                flags |= LEFT;
            }
        }

        /* get the precision */
        precision = -1;
        if (*fmt == '.') { //如果格式说明符号后面跟了'.' ,说明对输出的精度有要求
            ++fmt;    
            if (is_digit(*fmt))
                precision = skip_atoi(&fmt);
            else if (*fmt == '*') { //如果是*，取args参数做为进度要求
                /* it's the next argument */
                precision = va_arg(args, int);
            }
            if (precision < 0) //精度必须大于0
                precision = 0;
        }

        /* get the conversion qualifier */
        qualifier = -1;
        if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L') {
            qualifier = *fmt;
            ++fmt;
        }

        switch (*fmt) {
        case 'c': //如果格式说明符是个c,把此时的参数当作ASCII码对待,说明将参数以字符的形式打印
            if (!(flags & LEFT)) //没有左对齐进入if
                while (--field_width > 0)
                    *str++ = ' ';
            *str++ = (unsigned char) va_arg(args, int); //把对应参数写入str指定的buffer
            while (--field_width > 0) //对格式输出宽度有要求的时候，输出补齐空格
                *str++ = ' ';
            break;

        case 's'://说明是个字符串
            s = va_arg(args, char *);
            len = strlen(s);
            if (precision < 0)  //其实我也没搞明白这个精度在字符串输出的时候，有啥用
                precision = len;
            else if (len > precision)
                len = precision;

            if (!(flags & LEFT)) //没有要求左对齐，就进入if
                while (len < field_width--)
                    *str++ = ' ';
            for (i = 0; i < len; ++i) //这里把s指向的字符串的字符一个个的copy到str指向的buffer
                *str++ = *s++;
            while (len < field_width--)
                *str++ = ' ';
            break;

        case 'o': //八进制输出数
            str = number(str, va_arg(args, unsigned long), 8,
                field_width, precision, flags);
            break;

        case 'p': //指针输出
            if (field_width == -1) {
                field_width = 8;
                flags |= ZEROPAD;
            }
            str = number(str,
                (unsigned long) va_arg(args, void *), 16,
                field_width, precision, flags);
            break;

        case 'x': //十六进制输出
            flags |= SMALL;
        case 'X':
            str = number(str, va_arg(args, unsigned long), 16,
                field_width, precision, flags);
            break;

        case 'd': //有符号整形输出
        case 'i':
            flags |= SIGN;
        case 'u': //无符号整形输出
            str = number(str, va_arg(args, unsigned long), 10,
                field_width, precision, flags);
            break;

        case 'n': //这个我真没用过。。。把到目前位置转换输出字符串数字保存到对应参数指针指定的位置
            ip = va_arg(args, int *);
            *ip = (str - buf);
            break;

        default:
            if (*fmt != '%') //这里我觉得有问题，if判断条件，不应该是！= 而应该是 ==
                *str++ = '%';
            if (*fmt)
                *str++ = *fmt;
            else
                --fmt;
            break;
        }
    }
    *str = '\0'; //最后填上空字符
    return str-buf;
}