这可以自定义printf吗?

时间:2012-02-13 12:02:16

标签: c linux customization glibc

我有一些需要经常打印的结构。现在,我正在使用这个结构的经典打印包装器:

void printf_mystruct(struct* my_struct)
{
   if (my_struct==NULL) return;
   printf("[value1:%d value2:%d]", struct->value1, struct->value2);
}

这个功能很方便,但也非常有限。我不能在不制作新包装的情况下预先添加或附加一些文本。我知道我可以使用 va_arg 系列来预装或推出一些文字,但我觉得我会重新实现这个轮子。

我想知道是否可以为printf编写自定义功能。我希望能够写出这样的东西:

register2printf("%mys", &printf_mystruct); 
...
if (incorrect)
  printf("[%l] Struct is incorrect : %mys\n", log_level, my_struct);

这可能吗?我怎么能这样做?

注意:我在Ubuntu Linux 10.04下使用gcc。

6 个答案:

答案 0 :(得分:12)

很抱歉,但在使用Glibc的Linux上有些答案是错误的

在使用GNU Glibc的Linux上,您可以customize printf:您可以致电 例如register_printf_function%Y格式字符串中定义printf的含义。

然而,这种行为是Glibc特有的,甚至可能已经过时......我不确定我会推荐这种方法!

如果用C ++编码,C ++流库中有你可以扩展的操纵符,你也可以为你的类型重载operator <<等。

于2018年2月增加

您可以考虑编写GCC plugin帮助(以及改进某些扩展printf的类型检查)。这可能并不容易(可能是几周或几个月的工作),而且它将是GCC版本特定的(GCC 7和GCC 8的插件代码不一样)。您可以添加一些特定的#pragma来通知您的插件有关额外控制字符串说明符,例如%Y以及它们所需的类型。您的插件应更改format属性的处理(可能在gcc/tree.c

答案 1 :(得分:3)

这在标准C中是不可能的。您无法扩展printf以添加自定义格式字符串。你的辅助函数方法可能与你在C的约束下得到的一样好。

答案 2 :(得分:1)

不幸的是,这是不可能的。

最简单的解决方案可能是采用小printf实施(例如从嵌入式系统的libc)并扩展它以适应您的目的。

答案 3 :(得分:1)

不,这是不可能的。另一种方法是在printf()周围创建自己的包装器。它会解析格式字符串和处理转换,如printf()。如果转化是您的自定义转化之一,它会打印您需要的任何内容,如果没有,它会调用系统的*printf()函数之一让它为您执行转换。

请注意,这是一项非常重要的任务,您必须小心解析格式字符串,就像printf()一样。见man 3 printf。您可以使用<stdarg.h>中的函数读取变量参数列表。

一旦有了这样的包装器,就可以通过使用函数指针使其可扩展(自定义转换不必硬编码到包装器中)。

答案 4 :(得分:1)

您可以使用sprintf函数获取结构的字符串表示形式:

char* repr_mystruct(char* buffer, struct* my_struct)
{
    sprintf(buffer, "[string:%s value1:%d value2:%d]", struct->value1, struct->value2);
    return buffer;
}

然后将数据打印到输出流

char buffer[512]; //However large you need it to be
printf("My struct is: %s", repr_mystruct(buffer, &my_struct))

编辑:修改了允许传递缓冲区的函数(参见下面的讨论)。

注2:格式字符串需要三个参数,但在示例中只传递了两个参数。

答案 5 :(得分:0)

假设您需要可移植代码,那么glibc扩展已经完成了。但即使遵守C99和POSIX标准也是如此,我只写了一篇。

您不必重新实现printf,遗憾的是,您需要使代码足够智能以解析printf格式字符串,并从中推断出可变参数的C类型。

当可变参数放在堆栈上时,不包含任何类型或大小调整信息。

void my_variadic_func(fmt, ...)
{

}

my_variadic_func("%i %s %i", 1, "2", 3);

在64位系统的上述示例中,使用48位寻址编译器可能最终会分配4bytes + 6bytes + 4byte = 14bytes的堆栈内存,并将值打包到其中。我说可能,因为如何分配内存并且打包的参数是特定于实现的。

这意味着,为了访问上面字符串中%s的指针值,您需要知道第一个参数是int类型,因此您可以将va_list游标推进到对了。

获取该类型信息的唯一方法是查看格式字符串,并查看用户指定的类型(在本例中为%i)。

因此,为了实现@ AmbrozBizjak的建议,将subfmt字符串传递给printf,您需要解析fmt字符串,并在每个完整的非自定义fmt说明符之后,将fa_list推进(无论多宽字节)fmt类型是。

当你点击自定义fmt说明符时,你的va_list就是解压参数的正确点。然后,您可以使用va_arg()获取自定义参数(传递正确的类型),并使用它来运行您需要的任何代码,以生成自定义fmt说明符的输出。

您连接先前printf调用的输出和自定义fmt说明符的输出,并继续处理,直到结束,此时再次调用printf来处理格式字符串的其余部分。

代码更复杂(因此我将其包含在下面),但这可以让您基本了解自己需要做什么。

我的代码也使用了talloc ...但你可以使用标准的内存函数来完成它,只需要更多的字符串争用。

char *custom_vasprintf(TALLOC_CTX *ctx, char const *fmt, va_list ap)
{
    char const  *p = fmt, *end = p + strlen(fmt), *fmt_p = p, *fmt_q = p;
    char        *out = NULL, *out_tmp;
    va_list     ap_p, ap_q;

    out = talloc_strdup(ctx, "");
    va_copy(ap_p, ap);
    va_copy(ap_q, ap_p);

    do {

        char        *q;
        char        *custom;
        char        len[2] = { '\0', '\0' };
        long        width = 0, group = 0, precision = 0, tmp;

        if ((*p != '%') || (*++p == '%')) {
            fmt_q = p + 1;
            continue;   /* literal char */
        }

        /*
         *  Check for parameter field
         */
        tmp = strtoul(p, &q, 10);
        if ((q != p) && (*q == '$')) {
            group = tmp;
            p = q + 1;
        }

        /*
         *  Check for flags
         */
        do {
            switch (*p) {
            case '-':
                continue;

            case '+':
                continue;

            case ' ':
                continue;

            case '0':
                continue;

            case '#':
                continue;

            default:
                goto done_flags;
            }
        } while (++p < end);
    done_flags:

        /*
         *  Check for width field
         */
        if (*p == '*') {
            width = va_arg(ap_q, int);
            p++;
        } else {
            width = strtoul(p, &q, 10);
            p = q;
        }

        /*
         *  Check for precision field
         */
        if (*p == '.') {
            p++;
            precision = strtoul(p, &q, 10);
            p = q;
        }

        /*
         *  Length modifiers
         */
        switch (*p) {
        case 'h':
        case 'l':
            len[0] = *p++;
            if ((*p == 'h') || (*p == 'l')) len[1] = *p++;
            break;

        case 'L':
        case 'z':
        case 'j':
        case 't':
            len[0] = *p++;
            break;
        }

        /*
         *  Types
         */
        switch (*p) {
        case 'i':                               /* int */
        case 'd':                               /* int */
        case 'u':                               /* unsigned int */
        case 'x':                               /* unsigned int */
        case 'X':                               /* unsigned int */
        case 'o':                               /* unsigned int */
            switch (len[0]) {
            case 'h':
                if (len[1] == 'h') {                    /* char (promoted to int) */
                    (void) va_arg(ap_q, int);
                } else {
                    (void) va_arg(ap_q, int);           /* short (promoted to int) */
                }
                break;

            case 'L':
                if ((*p == 'i') || (*p == 'd')) {
                    if (len [1] == 'L') {
                        (void) va_arg(ap_q, long);      /* long */
                    } else {
                        (void) va_arg(ap_q, long long);     /* long long */
                    }
                } else {
                    if (len [1] == 'L') {
                        (void) va_arg(ap_q, unsigned long); /* unsigned long */
                    } else {
                        (void) va_arg(ap_q, unsigned long long);/* unsigned long long */
                    }
                }
                break;

            case 'z':
                (void) va_arg(ap_q, size_t);                /* size_t */
                break;

            case 'j':
                (void) va_arg(ap_q, intmax_t);              /* intmax_t */
                break;

            case 't':
                (void) va_arg(ap_q, ptrdiff_t);             /* ptrdiff_t */
                break;

            case '\0':  /* no length modifier */
                if ((*p == 'i') || (*p == 'd')) {
                    (void) va_arg(ap_q, int);           /* int */
                } else {
                    (void) va_arg(ap_q, unsigned int);      /* unsigned int */
                }
            }
            break;

        case 'f':                               /* double */
        case 'F':                               /* double */
        case 'e':                               /* double */
        case 'E':                               /* double */
        case 'g':                               /* double */
        case 'G':                               /* double */
        case 'a':                               /* double */
        case 'A':                               /* double */
            switch (len[0]) {
            case 'L':
                (void) va_arg(ap_q, long double);           /* long double */
                break;

            case 'l':   /* does nothing */
            default:    /* no length modifier */
                (void) va_arg(ap_q, double);                /* double */
            }
            break;

        case 's':
            (void) va_arg(ap_q, char *);                    /* char * */
            break;

        case 'c':
            (void) va_arg(ap_q, int);                   /* char (promoted to int) */
            break;

        case 'p':
            (void) va_arg(ap_q, void *);                    /* void * */
            break;

        case 'n':
            (void) va_arg(ap_q, int *);                 /* int * */
            break;

        /*
         *  Custom types
         */
        case 'v':
        {
            value_box_t const *value = va_arg(ap_q, value_box_t const *);

            /*
             *  Allocations that are not part of the output
             *  string need to occur in the NULL ctx so we don't fragment
             *  any pool associated with it.
             */
            custom = value_box_asprint(NULL, value->type, value->datum.enumv, value, '"');
            if (!custom) {
                talloc_free(out);
                return NULL;
            }

        do_splice:
            /*
             *  Pass part of a format string to printf
             */
            if (fmt_q != fmt_p) {
                char *sub_fmt;

                sub_fmt = talloc_strndup(NULL, fmt_p, fmt_q - fmt_p);
                out_tmp = talloc_vasprintf_append_buffer(out, sub_fmt, ap_p);
                talloc_free(sub_fmt);
                if (!out_tmp) {
                oom:
                    fr_strerror_printf("Out of memory");
                    talloc_free(out);
                    talloc_free(custom);
                    va_end(ap_p);
                    va_end(ap_q);
                    return NULL;
                }
                out = out_tmp;

                out_tmp = talloc_strdup_append_buffer(out, custom);
                TALLOC_FREE(custom);
                if (!out_tmp) goto oom;
                out = out_tmp;

                va_end(ap_p);       /* one time use only */
                va_copy(ap_p, ap_q);    /* already advanced to the next argument */
            }

            fmt_p = p + 1;
        }
            break;

        case 'b':
        {
            uint8_t const *bin = va_arg(ap_q, uint8_t *);

            /*
             *  Only automagically figure out the length
             *  if it's not specified.
             *
             *  This allows %b to be used with stack buffers,
             *  so long as the length is specified in the format string.
             */
            if (precision == 0) precision = talloc_array_length(bin);

            custom = talloc_array(NULL, char, (precision * 2) + 1);
            if (!custom) goto oom;
            fr_bin2hex(custom, bin, precision);

            goto do_splice;
        }

        default:
            break;
        }
        fmt_q = p + 1;
    } while (++p < end);

    /*
     *  Print out the rest of the format string.
     */
    if (*fmt_p) {
        out_tmp = talloc_vasprintf_append_buffer(out, fmt_p, ap_p);
        if (!out_tmp) goto oom;
        out = out_tmp;
    }

    va_end(ap_p);
    va_end(ap_q);

    return out;
}

编辑:

这可能值得做Linux人员所做的事情并且重载%p来制作新的格式说明符,即%pA%pB。这意味着静态printf格式检查不会抱怨。