vsprintf函数的实现

大家好，欢迎来到IT知识分享网。

printk

输出格式

格式指示串的形式如下：

%[flags][width][.prec][h|l|L][type]

其中：

• %：格式引入字符
• flags：可选的标志字符序列
• width：可选的宽度指示符
• .prec：可选的精度指示符
• h|l|L：可选的长度修饰符
• type：转换类型

flags

flags 控制输出对齐方式、数值符号、小数点、尾零、二进制、八进制或十六进制等，具体格式如下：

• -：左对齐，默认为右对齐
• +：输出 + 号
• ：如果带符号的转换不以符号开头则添加空格，如果存在 + 则忽略
• #：特殊转换：
  • 八进制，转换后字符串首位必须是 0
  • 十六进制，转换后必须以 0x 或 0X 开头
• 0：使用 0 代替空格

变量解释

width 指定了输出字符串宽度，即指定了字段的最小宽度值。如果被转换的结果要比指定的宽度小，则在其左边（或者右边，如果给出了左调整标志）需要填充空格或零（由 flags 标志确定）的个数等。

除了使用数值来指定宽度域以外，也可以使用 * 来指出字段的宽度由下一个整型参数给出。当转换值宽度大于 width 指定的宽度时，在任何情况下小宽度值都不会截断结果。字段宽度会扩充以包含完整结果。

precision 是说明输出数字起码的个数

• 对于 d,i,o,u,x 和 X 转换，精度值指出了起码出现数字的个数
• 对于 e,E,f 和 F，该值指出在小数点之后出现的数字的个数
• 对于 g 或 G，指出最大有效数字个数
• 对于 s 或 S 转换，精度值说明输出字符串的最大字符数

qualifier 长度修饰指示符说明了整型数转换后的输出类型形式。

• hh 说明后面的整型数转换对应于一个带符号字符或无符号字符参数
• h 说明后面的整型数转换对应于一个带符号整数或无符号短整数参数
• l 说明后面的整型数转换对应于一个长整数或无符号长整数参数
• ll 说明后面的整型数转换对应于一个长长整数或无符号长长整数参数
• L 说明 e,E,f,F,g 或 G 转换结果对应于一个长双精度参数

type 是说明接受的输入参数类型和输出的格式。各个转换指示符的含义如下：

• d,i 整数型参数将被转换为带符号整数。如果有精度(precision)的话，则给出了需要输出的最少数字个数。如果被转换的值数字个数较少，就会在其左边添零。默认的精度值是 1
• o,u,x,X 会将无符号的整数转换为无符号八进制(o)、无符号十进制(u)或者是无符号十六进制(x 或 X)表示方式输出。x 表示要使用小写字母 abcdef 来表示十六进制数，X 表示用大写字母 ABCDEF 表示十六进制数。如果存在精度域的话，说明需要输出的最少数字个数。如果被转换的值数字个数较少，就会在其左边添零。默认的精度值是 1
• e,E 这两个转换字符用于经四舍五入将参数转换成 [-]d.ddde+dd 的形式。小数点之后的数字个数等于精度；如果没有精度域，就取默认值 6。如果精度是 0，则没有小数出现。E 表示用大写字母 E 来表示指数。指数部分总是用 2 位数字表示。如果数值为 0，那么指数就是 00。
• f,F 这两个转换字符用于经四舍五入将参数转换成[-]ddd.ddd 的形式；小数点之后的数字个数等于精度。如果没有精度域，就取默认值 6；如果精度是 0，则没有小数出现。如果有小数点，那么后面起码会有 1 位数字
• g,G 这两个转换字符将参数转换为 f 或 e 的格式（如果是 G，则是 F 或 E 格式）。精度值指定了整数的个数。如果没有精度域，则其默认值为 6。如果精度为 0，则作为 1 来对待。如果转换时指数小于 -4 或大于等于精度，则采用 e 格式。小数部分后拖的零将被删除。仅当起码有一位小数时才会出现小数点
• c 参数将被转换成无符号字符并输出转换结果
• s 要求输入为指向字符串的指针，并且该字符串要以 NULL 结尾；如果有精度域，则只输出精度所要求的字符个数，并且字符串无须以 NULL 结尾
• p 以指针形式输出十六进制数
• n 用于把到目前为止转换输出的字符个数保存到由对应输入指针指定的位置中，不对参数进行转换
• % 输出一个百分号 %，不进行转换。也即此时整个转换指示为 %%

#define ZEROPAD 0x01 // 填充零 #define SIGN 0x02 // unsigned/signed long #define PLUS 0x04 // 显示加 #define SPACE 0x08 // 如是加，则置空格 #define LEFT 0x10 // 左调整 #define SPECIAL 0x20 // 0x #define SMALL 0x40 // 使用小写字母 #define DOUBLE 0x80 // 浮点数 #define is_digit(c) ((c) >= '0' && (c) <= '9') // 将字符数字串转换成整数，并将指针前移 static int skip_atoi(const char **s) { 
       int i = 0; while (is_digit(**s)) i = i * 10 + *((*s)++) - '0'; return i; } // 将整数转换为指定进制的字符串 // str - 输出字符串指针 // num - 整数 // base - 进制基数 // size - 字符串长度 // precision - 数字长度(精度) // flags - 选项 static char *number(char *str, u32 *num, int base, int size, int precision, int flags) { 
       char pad, sign, tmp[36]; const char *digits = "0ABCDEFGHIJKLMNOPQRSTUVWXYZ"; int i; int index; char *ptr = str; // 如果 flags 指出用小写字母，则定义小写字母集 if (flags & SMALL) digits = "0abcdefghijklmnopqrstuvwxyz"; // 如果 flags 指出要左对齐，则屏蔽类型中的填零标志 if (flags & LEFT) flags &= ~ZEROPAD; // 如果进制基数小于 2 或大于 36，则退出处理 // 也即本程序只能处理基数在 2-32 之间的数 if (base < 2 || base > 36) return 0; // 如果 flags 指出要填零，则置字符变量 c='0'，否则 c 等于空格字符 pad = (flags & ZEROPAD) ? '0' : ' '; // 如果 flags 指出是带符号数并且数值 num 小于 0，则置符号变量 sign=负号，并使 num 取绝对值 if (flags & DOUBLE && (*(double *)(num)) < 0) { 
       sign = '-'; *(double *)(num) = -(*(double *)(num)); } else if (flags & SIGN && !(flags & DOUBLE) && ((int)(*num)) < 0) { 
       sign = '-'; (*num) = -(int)(*num); } else // 否则如果 flags 指出是加号，则置 sign=加号，否则若类型带空格标志则 sign=空格，否则置 0 sign = (flags & PLUS) ? '+' : ((flags & SPACE) ? ' ' : 0); // 若带符号，则宽度值减 1 if (sign) size--; // 若 flags 指出是特殊转换，则对于十六进制宽度再减少 2 位(用于0x) if (flags & SPECIAL) { 
       if (base == 16) size -= 2; // 对于八进制宽度减 1（用于八进制转换结果前放一个零） else if (base == 8) size--; } i = 0; // 如果数值 num 为 0，则临时字符串='0'；否则根据给定的基数将数值 num 转换成字符形式 if (flags & DOUBLE) { 
       u32 ival = (u32)(*(double *)num); u32 fval = (u32)(((*(double *)num) - ival) * ); do { 
       index = (fval) % base; (fval) /= base; tmp[i++] = digits[index]; } while (fval); tmp[i++] = '.'; do { 
       index = (ival) % base; (ival) /= base; tmp[i++] = digits[index]; } while (ival); } else if ((*num) == 0) { 
       tmp[i++] = '0'; } else { 
       while ((*num) != 0) { 
       index = (*num) % base; (*num) /= base; tmp[i++] = digits[index]; } } // 若数值字符个数大于精度值，则精度值扩展为数字个数值 if (i > precision) precision = i; // 宽度值 size 减去用于存放数值字符的个数 size -= precision; // 从这里真正开始形成所需要的转换结果，并暂时放在字符串 str 中 // 若 flags 中没有填零(ZEROPAD) 和左对齐（左调整）标志 // 则在 str 中首先填放剩余宽度值指出的空格数 if (!(flags & (ZEROPAD + LEFT))) while (size-- > 0) *str++ = ' '; // 若需带符号位，则存入符号 if (sign) *str++ = sign; // 若 flags 指出是特殊转换 if (flags & SPECIAL) { 
       // 则对于八进制转换结果头一位放置一个'0' if (base == 8) *str++ = '0'; // 对于十六进制则存放'0x' else if (base == 16) { 
       *str++ = '0'; *str++ = digits[33]; } } // 若 flags 中没有左调整（左对齐）标志, 则在剩余宽度中存放 c 字符（'0'或空格） if (!(flags & LEFT)) while (size-- > 0) *str++ = pad; // 此时 i 存有数值 num 的数字个数 // 若数字个数小于精度值，则 str 中放入（精度值-i）个'0' while (i < precision--) *str++ = '0'; // 将转数值换好的数字字符填入 str 中，共 i 个 while (i-- > 0) *str++ = tmp[i]; // 若宽度值仍大于零 // 则表示 flags 标志中有左对齐标志标志 // 则在剩余宽度中放入空格 while (size-- > 0) *str++ = ' '; return str; } int vsprintf(char *buf, const char *fmt, va_list args) { 
       int len; int i; // 用于存放转换过程中的字符串 char *str; char *s; int *ip; // number() 函数使用的标志 int flags; int field_width; // 输出字段宽度 int precision; // min 整数数字个数；max 字符串中字符个数 int qualifier; // 'h', 'l' 或 'L' 用于整数字段 u32 num; u8 *ptr; // 首先将字符指针指向 buf // 然后扫描格式字符串， // 对各个格式转换指示进行相应的处理 for (str = buf; *fmt; ++fmt) { 
       // 格式转换指示字符串均以 '%' 开始 // 这里从 fmt 格式字符串中扫描 '%'，寻找格式转换字符串的开始 // 不是格式指示的一般字符均被依次存入 str if (*fmt != '%') { 
       *str++ = *fmt; continue; } // 下面取得格式指示字符串中的标志域，并将标志常量放入 flags 变量中 flags = 0; repeat: // 掉过第一个 % ++fmt; switch (*fmt) { 
       // 左对齐调整 case '-': flags |= LEFT; goto repeat; // 放加号 case '+': flags |= PLUS; goto repeat; // 放空格 case ' ': flags |= SPACE; goto repeat; // 是特殊转换 case '#': flags |= SPECIAL; goto repeat; // 要填零(即'0')，否则是空格 case '0': flags |= ZEROPAD; goto repeat; } // 取当前参数字段宽度域值，放入 field_width 变量中 field_width = -1; // 如果宽度域中是数值则直接取其为宽度值 if (is_digit(*fmt)) field_width = skip_atoi(&fmt); // 如果宽度域中是字符 '*'，表示下一个参数指定宽度 else if (*fmt == '*') { 
       ++fmt; // 因此调用 va_arg 取宽度值 field_width = va_arg(args, int); // 若此时宽度值小于 0，则该负数表示其带有标志域 '-' 标志（左对齐） if (field_width < 0) { 
       // 因此还需在标志变量中添入该标志，并将字段宽度值取为其绝对值 field_width = -field_width; flags |= LEFT; } } // 取格式转换串的精度域，并放入 precision 变量中 precision = -1; // 精度域开始的标志是'.' 其处理过程与上面宽度域的类似 if (*fmt == '.') { 
       ++fmt; // 如果精度域中是数值则直接取其为精度值 if (is_digit(*fmt)) precision = skip_atoi(&fmt); // 如果精度域中是字符'*'，表示下一个参数指定精度 else if (*fmt == '*') { 
       // 因此调用 va_arg 取精度值 precision = va_arg(args, int); } // 若此时宽度值小于 0，则将字段精度值取为其绝对值 if (precision < 0) precision = 0; } // 下面这段代码分析长度修饰符，并将其存入 qualifer 变量 qualifier = -1; if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L') { 
       qualifier = *fmt; ++fmt; } // 下面分析转换指示符 switch (*fmt) { 
       // 如果转换指示符是'c'，则表示对应参数应是字符 case 'c': // 此时如果标志域表明不是左对齐， if (!(flags & LEFT)) // 则该字段前面放入 (宽度域值 - 1) 个空格字符，然后再放入参数字符 while (--field_width > 0) *str++ = ' '; *str++ = (unsigned char)va_arg(args, int); // 如果宽度域还大于 0，则表示为左对齐 // 则在参数字符后面添加 (宽度值-1) 个空格字符 while (--field_width > 0) *str++ = ' '; break; // 如果转换指示符是 's'，则表示对应参数是字符串 case 's': s = va_arg(args, char *); // 首先取参数字符串的长度 len = strlen(s); // 若其超过了精度域值, 则扩展精度域=字符串长度 if (precision < 0) precision = len; else if (len > precision) len = precision; // 此时如果标志域表明不是左对齐 if (!(flags & LEFT)) // 则该字段前放入 (宽度值-字符串长度) 个空格字符 while (len < field_width--) *str++ = ' '; // 然后再放入参数字符串 for (i = 0; i < len; ++i) *str++ = *s++; // 如果宽度域还大于 0，则表示为左对齐 // 则在参数字符串后面，添加(宽度值-字符串长度)个空格字符 while (len < field_width--) *str++ = ' '; break; // 如果格式转换符是'o'，表示需将对应的参数转换成八进制数的字符串 case 'o': num = va_arg(args, unsigned long); str = number(str, &num, 8, field_width, precision, flags); break; // 如果格式转换符是'p'，表示对应参数的一个指针类型 case 'p': // 此时若该参数没有设置宽度域，则默认宽度为 8，并且需要添零 if (field_width == -1) { 
       field_width = 8; flags |= ZEROPAD; } num = va_arg(args, unsigned long); str = number(str, &num, 16, field_width, precision, flags); break; // 若格式转换指示是 'x' 或 'X' // 则表示对应参数需要打印成十六进制数输出 case 'x': // 'x'表示用小写字母表示 flags |= SMALL; case 'X': num = va_arg(args, unsigned long); str = number(str, &num, 16, field_width, precision, flags); break; // 如果格式转换字符是'd', 'i' 或 'u'，则表示对应参数是整数 case 'd': case 'i': // 'd', 'i'代表符号整数，因此需要加上带符号标志 flags |= SIGN; // 'u'代表无符号整数 case 'u': num = va_arg(args, unsigned long); str = number(str, &num, 10, field_width, precision, flags); break; // 若格式转换指示符是 'n' // 表示要把到目前为止转换输出的字符数保存到对应参数指针指定的位置中 case 'n': // 首先利用 va_arg() 取得该参数指针 ip = va_arg(args, int *); // 然后将已经转换好的字符数存入该指针所指的位置 *ip = (str - buf); break; case 'f': flags |= SIGN; flags |= DOUBLE; double dnum = va_arg(args, double); str = number(str, (u32 *)&dnum, 10, field_width, precision, flags); break; case 'b': // binary num = va_arg(args, unsigned long); str = number(str, &num, 2, field_width, precision, flags); break; case 'm': // mac address flags |= SMALL | ZEROPAD; ptr = va_arg(args, char *); for (size_t t = 0; t < 6; t++, ptr++) { 
       int num = *ptr; str = number(str, &num, 16, 2, precision, flags); *str = ':'; str++; } str--; break; case 'r': // ip address flags |= SMALL; ptr = va_arg(args, u8 *); for (size_t t = 0; t < 4; t++, ptr++) { 
       int num = *ptr; str = number(str, &num, 10, field_width, precision, flags); *str = '.'; str++; } str--; break; default: // 若格式转换符不是 '%'，则表示格式字符串有错 if (*fmt != '%') // 直接将一个 '%' 写入输出串中 *str++ = '%'; // 如果格式转换符的位置处还有字符，则也直接将该字符写入输出串中 // 然后继续循环处理格式字符串 if (*fmt) *str++ = *fmt; else // 否则表示已经处理到格式字符串的结尾处，则退出循环 --fmt; break; } } // 最后在转换好的字符串结尾处添上字符串结束标志 *str = '\0'; // 返回转换好的字符串长度值 i = str - buf; assert(i < 1024); return i; } // 结果按格式输出字符串到 buf int sprintf(char *buf, const char *fmt, ...) { 
       va_list args; va_start(args, fmt); int i = vsprintf(buf, fmt, args); va_end(args); return i; }