printf的Linux C源码解析
文章目录
该笔记是我看的第一个源码所做的笔记，有些地方的解读可能不是很合理，之后有时间会继续进行优化笔记。
头文件引用及宏定义
#include <stdarg.h>
#include <stddef.h>
#include "string.h"
#include "stdio.h"
#include "ops.h"
#define ZEROPAD 1 /* pad with zero 填补0*/
#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 /0*/
#define LARGE 64 /* 用 'ABCDEF'/'abcdef' */
strnlen函数
//统计字符串中字符个数(不包括\0)，如果个数大于count，则返回count，否则返回字符个数
size_t strnlen(const char * s, size_t count)//size_t是unsigned long long的宏
{
const char *sc;
for (sc = s; count-- && *sc != '\0'; ++sc)
/* nothing */;
return sc - s;
}
__div64_32函数
uint32_t __attribute__((weak)) __div64_32(uint64_t *n, uint32_t base)
{
uint64_t rem = *n;
uint64_t b = base;
uint64_t res, d = 1;
uint32_t high = rem >> 32;
/* Reduce the thing a bit first */
res = 0;
if (high >= base) {
high /= base;
res = (uint64_t) high << 32;
rem -= (uint64_t) (high*base) << 32;
}
while ((int64_t)b > 0 && b < rem) {
b = b+b;
d = d+d;
}
do {
if (rem >= b) {
rem -= b;
res += d;
}
b >>= 1;
d >>= 1;
} while (d);
*n = res;
return rem;
}
宏- -do_div
//进制之间的相应转换
# define do_div(n,base) ({ \
unsigned int __base = (base); \
unsigned int __rem; \
//这一句的作用是为了消去警告，因为定义了n变量而没有使用到它，会报警
(void)(((typeof((n)) *)0) == ((unsigned long long *)0)); \
if (((n) >> 32) == 0) { \//32位4字节
__rem = (unsigned int)(n) % __base; \//对应的base进制位
(n) = (unsigned int)(n) / __base; \
} else \
__rem = __div64_32(&(n), __base); \//64转32
__rem; \
})
skip_atoi函数
//获得字段转化为整数，例如%12d中的字母12提出来变成整型12.
static int skip_atoi(const char **s)//二级指针，存进来的是字符串的地址
{
int i, c;
for (i = 0; '0' <= (c = **s) && c <= '9'; ++*s)
i = i*10 + c - '0';
return i;
}
number函数
//以特定的进制格式化输出字符
static char * number(char * str, unsigned long long num, int base, int size, int precision, int type)
{
char c,sign,tmp[66];
const char *digits="0123456789abcdefghijklmnopqrstuvwxyz";
int i;
if (type & LARGE)//输出大写字符，例如十六进制0XFF112233AA
digits = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
if (type & LEFT)//如果有'-'，如果出现了左对齐，就取消前面补0
type &= ~ZEROPAD;
if (base < 2 || base > 36)
return 0;
c = (type & ZEROPAD) ? '0' : ' ';//如果标志符有0则补0，否则补空格；例如%02d
sign = 0;//符号
if (type & SIGN) //有符号与无符号的转换
{
if ((signed long long)num < 0)
{
sign = '-';
num = - (signed long long)num;//取正值
size--;//字段宽度减1
} else if (type & PLUS) //显示+
{
sign = '+';
size--;
} else if (type & SPACE)//填补空格
{
sign = ' ';
size--;
}
}
//处理十六进制字宽问题
if (type & SPECIAL) //十六进制显示
{
if (base == 16)
size -= 2;//0x
else if (base == 8)
size--;//0
}
i = 0;
if (num == 0)//如果参数为0，则记录字符0
tmp[i++]='0'; //tmp中的内容会放到缓冲区中
else while (num != 0) //循环,num /= base
{
tmp[i++] = digits[do_div(num, base)];//将进制转换,低地址先进tmp？
}
//地址长度大于精度，直接按地址长度输出，如果精度大于地址位数，先补空格
//例如：printf("%18p\n",&a);-->空格空格00000000FAF27284
if (i > precision)
precision = i;
size -= precision;
if (!(type&(ZEROPAD+LEFT)))//没有'-'和补0,直接补空格
while(size-->0)
*str++ = ' ';
if (sign)//如果有符号，输出符号，符号包括：'-','+','',0
*str++ = sign;
if (type & SPECIAL) //输出8进制或16进制符号0或0x
{
if (base==8)
*str++ = '0';
else if (base==16)
{
*str++ = '0';
*str++ = digits[33];//x或X
}
}
if (!(type & LEFT))//没有-
while (size-- > 0)
*str++ = c;//c为0或空格
while (i < precision--)//i为转换后存在tmp中字符的个数
*str++ = '0';
while (i-- > 0)
*str++ = tmp[i];//tmp中存储着转换了的参数
while (size-- > 0)
*str++ = ' ';
return str;
}
printf() 格式控制符的完整形式如下：
%[flag][width][.precision]type
[ ] 表示此处的内容可有可无，是可以省略的。
- type 表示输出类型，比如 %d、%f、%c、%lf，type 就分别对应 d、f、c、lf；再如，
%-9d中 type 对应 d。
type 这一项必须有，这意味着输出时必须要知道是什么类型。
- width 表示最小输出宽度，也就是至少占用几个字符的位置；例如，
%-9d中 width 对应 9，表示输出结果最少占用 9 个字符的宽度。
当输出结果的宽度不足 width 时，以空格补齐（如果没有指定对齐方式，默认会在左边补齐空格）；当输出结果的宽度超过 width 时，width 不再起作用，按照数据本身的宽度来输出。
- precision 表示输出精度，也就是小数的位数。
- 当小数部分的位数大于 precision 时，会按照四舍五入的原则丢掉多余的数字；
- 当小数部分的位数小于 precision 时，会在后面补 0。
另外，.precision 也可以用于整数和字符串，但是功能却是相反的：- 用于整数时，.precision 表示最小输出宽度。与 width 不同的是，整数的宽度不足时会在左边补 0，而不是补空格。
- 用于字符串时，.precision 表示最大输出宽度，或者说截取字符串。当字符串的长度大于 precision 时，会截掉多余的字符；当字符串的长度小于 precision 时，.precision 就不再起作用。
-
flag 是标志字符。例如，
%#x中 flag 对应 #，%-9d中 flags 对应-。下表列出了 printf() 可以用的 flag：标志字符 含 义 - -表示左对齐。如果没有，就按照默认的对齐方式，默认一般为右对齐。+ 用于整数或者小数，表示输出符号（正负号）。如果没有，那么只有负数才会输出符号。 空格 用于整数或者小数，输出值为正时冠以空格，为负时冠以负号。 # 对于八进制（%o）和十六进制（%x / %X）整数，# 表示在输出时添加前缀；八进制的前缀是 0，十六进制的前缀是 0x / 0X。对于小数（%f / %e / %g），# 表示强迫输出小数点。如果没有小数部分，默认是不输出小数点的，加上 # 以后，即使没有小数部分也会带上小数点。
printf() 执行结束以后数据并没有直接输出到显示器上，而是放入了缓冲区，直到遇见换行符
\n才将缓冲区中的数据输出到显示器上。
vsprintf函数
int vsprintf(char *buf, const char *fmt, va_list args)
{
int len;
unsigned long long num;
int i, base;
char * str;
const char *s;
int flags; /* 用在number()函数的标志 */
int field_width; /* 输出字段的宽度 */
//精度；用在浮点数时表示输出小数点后几位；用在字符串时表示输出字符个数
int precision;
int qualifier; /* 'h', 'l', or 'L' for integer fields */
/* 'z' support added 23/7/1999 S.H. */
/* 'z' changed to 'Z' --davidm 1/25/99 */
/*将字符逐个放到输出缓冲区中，直到遇到第一个%*/
for (str=buf ; *fmt ; ++fmt)
{
if (*fmt != '%')
{ //寻找%
*str++ = *fmt;
continue;
}
//遇到%后执行下面代码
/* process flags */
flags = 0;
repeat:
++fmt; //跳过第一个 '%'
switch (*fmt) //判断%后面的字符，对格式运算符的标志的处理
{
case '-': flags |= LEFT; goto repeat;//flags=10000(二进制，下面一样)
case '+': flags |= PLUS; goto repeat;//flags=100
case ' ': flags |= SPACE; goto repeat;//flags=1000
case '#': flags |= SPECIAL; goto repeat;//flags=10 0000
case '0': flags |= ZEROPAD; goto repeat;//flags=1
}
//对字段宽度的处理
field_width = -1;
if ('0' <= *fmt && *fmt <= '9')
field_width = skip_atoi(&fmt); //得到字段宽度
else if (*fmt == '*') //*表示可变宽度
{
++fmt;
field_width = va_arg(args, int);//获得表示字段宽度的参数，
/*一般使用最后一个固定参数args来初始化这个函数，
得到的下一个参数为第一个变参,即printf("%*d",a,b);中的a,
这里a表示字段宽度。字符串为固定参数；变参函数至少要有一个固定参数。*/
if (field_width < 0) //手动输入负数，左对齐，例如printf("%*d",-2,3);
{
field_width = -field_width;
flags |= LEFT;
}
}
// 获取精度
precision = -1;
if (*fmt == '.')
{
++fmt;
if ('0' <= *fmt && *fmt <= '9')
precision = skip_atoi(&fmt);//获得精度
else if (*fmt == '*') //可变精度，printf("%.*f",2,3.1415);-->3.14
{
++fmt;
/* 获取表示精度的参数(以整数类型获取) */
precision = va_arg(args, int);
}
if (precision < 0)//精度不能小于0
precision = 0;
}
//获取转换修饰符,即%hd、%ld、%lld、%Lf...中的h、l、L、Z (ll用q代替)
qualifier = -1;
if (*fmt == 'l' && *(fmt + 1) == 'l')
{
qualifier = 'q';//即ll
fmt += 2;
} else if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L'
|| *fmt == 'Z')
{
qualifier = *fmt;
++fmt;
}
base = 10;//默认十进制
//对c、s、p、n、%、o等做处理
switch (*fmt)
{
//转换格式符为%c
case 'c':
//如果没有有‘-’，先输出字宽-1个空格再输出字符
if (!(flags & LEFT))//如果没有'-'标记符
while (--field_width > 0)
*str++ = ' ';//根据字段输出空格' '
/*获取字符参数时是先以int类型获取再强转为unsigned char，
为了获取过程中保证精度不丢失。*/
*str++ = (unsigned char) va_arg(args, int);
// 如果有'-'，先输出字符再填补空格,注意是先--的，所以实际空格会比输入的字段少1，在加 上参数就刚好够宽度；比如printf("%5d",2);输出：空格空格空格空格2。
while (--field_width > 0)
*str++ = ' ';
continue;
//转换格式符为%s
case 's':
s = va_arg(args, char *);//char*格式获取参数
if (!s) //如果字符串不存在，则返回(NULL)
s = "<NULL>";
/*如果字符串中字符个数大于精度，len为精度；
否则len为字符个数,即精度表示了字符串输出字符的个数*/
len = strnlen(s, precision);
//处理'-',即printf("%-s","hello");
if (!(flags & LEFT))
while (len < field_width--)
*str++ = ' ';
for (i = 0; i < len; ++i)
*str++ = *s++;
while (len < field_width--)
*str++ = ' ';
continue;
//处理格式符%p
case 'p':
if (field_width == -1) //如果没有设置字段宽度
{
/*字宽为8或16(根据系统而定)，因为2个位表示一个直接；
例如32位系统指针大小位4字节，oxFF FF FF FF,需要8个字宽才能存储*/
field_width = 2*sizeof(void *);
flags |= ZEROPAD; //flags = 1;会在前面补0
}
//转为16进制并存进缓冲区中
str = number(str,
(unsigned long) va_arg(args, void *), 16,
field_width, precision, flags);
continue;
//buf为1024字节空间的输出缓冲区（静态char数组）
case 'n':
if (qualifier == 'l') {
long * ip = va_arg(args, long *);
*ip = (str - buf);//获取输出缓冲数组中的个数
} else if (qualifier == 'Z') {
size_t * ip = va_arg(args, size_t *);
*ip = (str - buf);
} else {
int * ip = va_arg(args, int *);
*ip = (str - buf);
}
continue;
case '%':
*str++ = '%';
continue;
/* integer number formats - set up the flags and "break" */
case 'o':
base = 8;
break;
case 'X':
flags |= LARGE;//小写转大写
case 'x': //十六进制
base = 16;
break;
case 'd': //十进制
case 'i':
flags |= SIGN;
case 'u': //无符号
break;
default:
*str++ = '%';
if (*fmt)
*str++ = *fmt;
else
--fmt;
continue;
}
if (qualifier == 'l')
{
num = va_arg(args, unsigned long);
if (flags & SIGN)
num = (signed long) num;
} else if (qualifier == 'q')
{
num = va_arg(args, unsigned long long);
if (flags & SIGN)
num = (signed long long) num;
} else if (qualifier == 'Z')
{
num = va_arg(args, size_t);
} else if (qualifier == 'h')
{
//输出短整型时是先以整数来获取参数，再转为短整型输出，保证获取过程中精度不丢失
num = (unsigned short) va_arg(args, int);
if (flags & SIGN)
num = (signed short) num;
} else
{
//没有特殊标志的格式符，一律先以无符号整型获取，再转为有符号整型
num = va_arg(args, unsigned int);
if (flags & SIGN)
num = (signed int) num;
}
//转换为对应的个数再存到缓冲区中
str = number(str, num, base, field_width, precision, flags);
}
*str = '\0';//最后以'\0'结束
return str-buf;
}
sprintf函数
//该函数没有设置缓冲区，而是将内容输出到使用着提供的容器中
int sprintf(char * buf, const char *fmt, ...)
{
va_list args;
int i;
va_start(args, fmt);
i=vsprintf(buf,fmt,args);
va_end(args);
return i;
}
printf函数
//设置输出缓冲区，为1024字节大小
static char sprint_buf[1024];
/*可变函数在内部实现的过程中是从右向左压入堆栈，从而保证了可变参数的第一个参数始终位于栈顶*/
int printf(const char *fmt, ...)//可以有一个或多个固定参数
{
va_list args; //用于存放参数列表的数据结构
int n;
/*根据最后一个fmt来初始化参数列表，至于为什么是最后一个参数，是与va_start有关，感兴趣的朋友可以先去了解一下变参函数和里面用到的相关宏的作用。*/
va_start(args, fmt);
n = vsprintf(sprint_buf, fmt, args);
va_end(args);//执行清理参数列表的工作
if (console_ops.write)
console_ops.write(sprint_buf, n);
return n;
}
通过阅读代码可以注意到很多小细节，其中在之前的笔记《格式化标准输出函数printf()与格式化标准输入函数scanf()》中有相关总结。
至于printf函数中出现的va_list、va_start等这些内容属于变参函数的内容，会在之后的笔记中出现。
参考文字：C语言数据输出大汇总以及轻量进阶
其它笔记：
>>变参函数及相关宏解读
>>Markdown学习笔记
>>数据在内存中的存储
>>标准输入输出函数
1594
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
