avutil/bprint:├Ždd io.h, try to fix msvc build
[ffmpeg.git] / libavutil / bprint.c
1 /*
2  * Copyright (c) 2012 Nicolas George
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include <stdarg.h>
22 #include <stdio.h>
23 #include <string.h>
24 #include <time.h>
25 #include "avassert.h"
26 #include "avstring.h"
27 #include "bprint.h"
28 #include "common.h"
29 #include "compat/va_copy.h"
30 #include "error.h"
31 #include "mem.h"
32
33 #if HAVE_IO_H
34 #include <io.h>
35 #endif
36 #if HAVE_UNISTD_H
37 #include <unistd.h>
38 #endif
39
40
41 #define av_bprint_room(buf) ((buf)->size - FFMIN((buf)->len, (buf)->size))
42 #define av_bprint_is_allocated(buf) ((buf)->str != (buf)->reserved_internal_buffer)
43
44 static int av_bprint_alloc(AVBPrint *buf, unsigned room)
45 {
46     char *old_str, *new_str;
47     unsigned min_size, new_size;
48
49     if (buf->size == buf->size_max)
50         return AVERROR(EIO);
51     if (!av_bprint_is_complete(buf))
52         return AVERROR_INVALIDDATA; /* it is already truncated anyway */
53     min_size = buf->len + 1 + FFMIN(UINT_MAX - buf->len - 1, room);
54     new_size = buf->size > buf->size_max / 2 ? buf->size_max : buf->size * 2;
55     if (new_size < min_size)
56         new_size = FFMIN(buf->size_max, min_size);
57     old_str = av_bprint_is_allocated(buf) ? buf->str : NULL;
58     new_str = av_realloc(old_str, new_size);
59     if (!new_str)
60         return AVERROR(ENOMEM);
61     if (!old_str)
62         memcpy(new_str, buf->str, buf->len + 1);
63     buf->str  = new_str;
64     buf->size = new_size;
65     return 0;
66 }
67
68 static void av_bprint_grow(AVBPrint *buf, unsigned extra_len)
69 {
70     /* arbitrary margin to avoid small overflows */
71     extra_len = FFMIN(extra_len, UINT_MAX - 5 - buf->len);
72     buf->len += extra_len;
73     if (buf->size)
74         buf->str[FFMIN(buf->len, buf->size - 1)] = 0;
75 }
76
77 void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
78 {
79     unsigned size_auto = (char *)buf + sizeof(*buf) -
80                          buf->reserved_internal_buffer;
81
82     if (size_max == 1)
83         size_max = size_auto;
84     buf->str      = buf->reserved_internal_buffer;
85     buf->len      = 0;
86     buf->size     = FFMIN(size_auto, size_max);
87     buf->size_max = size_max;
88     *buf->str = 0;
89     if (size_init > buf->size)
90         av_bprint_alloc(buf, size_init - 1);
91 }
92
93 void av_bprint_init_for_buffer(AVBPrint *buf, char *buffer, unsigned size)
94 {
95     buf->str      = buffer;
96     buf->len      = 0;
97     buf->size     = size;
98     buf->size_max = size;
99     *buf->str = 0;
100 }
101
102 void av_bprintf(AVBPrint *buf, const char *fmt, ...)
103 {
104     unsigned room;
105     char *dst;
106     va_list vl;
107     int extra_len;
108
109     while (1) {
110         room = av_bprint_room(buf);
111         dst = room ? buf->str + buf->len : NULL;
112         va_start(vl, fmt);
113         extra_len = vsnprintf(dst, room, fmt, vl);
114         va_end(vl);
115         if (extra_len <= 0)
116             return;
117         if (extra_len < room)
118             break;
119         if (av_bprint_alloc(buf, extra_len))
120             break;
121     }
122     av_bprint_grow(buf, extra_len);
123 }
124
125 void av_vbprintf(AVBPrint *buf, const char *fmt, va_list vl_arg)
126 {
127     unsigned room;
128     char *dst;
129     int extra_len;
130     va_list vl;
131
132     while (1) {
133         room = av_bprint_room(buf);
134         dst = room ? buf->str + buf->len : NULL;
135         va_copy(vl, vl_arg);
136         extra_len = vsnprintf(dst, room, fmt, vl);
137         va_end(vl);
138         if (extra_len <= 0)
139             return;
140         if (extra_len < room)
141             break;
142         if (av_bprint_alloc(buf, extra_len))
143             break;
144     }
145     av_bprint_grow(buf, extra_len);
146 }
147
148 void av_bprint_chars(AVBPrint *buf, char c, unsigned n)
149 {
150     unsigned room, real_n;
151
152     while (1) {
153         room = av_bprint_room(buf);
154         if (n < room)
155             break;
156         if (av_bprint_alloc(buf, n))
157             break;
158     }
159     if (room) {
160         real_n = FFMIN(n, room - 1);
161         memset(buf->str + buf->len, c, real_n);
162     }
163     av_bprint_grow(buf, n);
164 }
165
166 void av_bprint_append_data(AVBPrint *buf, const char *data, unsigned size)
167 {
168     unsigned room, real_n;
169
170     while (1) {
171         room = av_bprint_room(buf);
172         if (size < room)
173             break;
174         if (av_bprint_alloc(buf, size))
175             break;
176     }
177     if (room) {
178         real_n = FFMIN(size, room - 1);
179         memcpy(buf->str + buf->len, data, real_n);
180     }
181     av_bprint_grow(buf, size);
182 }
183
184 void av_bprint_strftime(AVBPrint *buf, const char *fmt, const struct tm *tm)
185 {
186     unsigned room;
187     size_t l;
188
189     if (!*fmt)
190         return;
191     while (1) {
192         room = av_bprint_room(buf);
193         if (room && (l = strftime(buf->str + buf->len, room, fmt, tm)))
194             break;
195         /* strftime does not tell us how much room it would need: let us
196            retry with twice as much until the buffer is large enough */
197         room = !room ? strlen(fmt) + 1 :
198                room <= INT_MAX / 2 ? room * 2 : INT_MAX;
199         if (av_bprint_alloc(buf, room)) {
200             /* impossible to grow, try to manage something useful anyway */
201             room = av_bprint_room(buf);
202             if (room < 1024) {
203                 /* if strftime fails because the buffer has (almost) reached
204                    its maximum size, let us try in a local buffer; 1k should
205                    be enough to format any real date+time string */
206                 char buf2[1024];
207                 if ((l = strftime(buf2, sizeof(buf2), fmt, tm))) {
208                     av_bprintf(buf, "%s", buf2);
209                     return;
210                 }
211             }
212             if (room) {
213                 /* if anything else failed and the buffer is not already
214                    truncated, let us add a stock string and force truncation */
215                 static const char txt[] = "[truncated strftime output]";
216                 memset(buf->str + buf->len, '!', room);
217                 memcpy(buf->str + buf->len, txt, FFMIN(sizeof(txt) - 1, room));
218                 av_bprint_grow(buf, room); /* force truncation */
219             }
220             return;
221         }
222     }
223     av_bprint_grow(buf, l);
224 }
225
226 void av_bprint_get_buffer(AVBPrint *buf, unsigned size,
227                           unsigned char **mem, unsigned *actual_size)
228 {
229     if (size > av_bprint_room(buf))
230         av_bprint_alloc(buf, size);
231     *actual_size = av_bprint_room(buf);
232     *mem = *actual_size ? buf->str + buf->len : NULL;
233 }
234
235 void av_bprint_clear(AVBPrint *buf)
236 {
237     if (buf->len) {
238         *buf->str = 0;
239         buf->len  = 0;
240     }
241 }
242
243 int av_bprint_finalize(AVBPrint *buf, char **ret_str)
244 {
245     unsigned real_size = FFMIN(buf->len + 1, buf->size);
246     char *str;
247     int ret = 0;
248
249     if (ret_str) {
250         if (av_bprint_is_allocated(buf)) {
251             str = av_realloc(buf->str, real_size);
252             if (!str)
253                 str = buf->str;
254             buf->str = NULL;
255         } else {
256             str = av_malloc(real_size);
257             if (str)
258                 memcpy(str, buf->str, real_size);
259             else
260                 ret = AVERROR(ENOMEM);
261         }
262         *ret_str = str;
263     } else {
264         if (av_bprint_is_allocated(buf))
265             av_freep(&buf->str);
266     }
267     buf->size = real_size;
268     return ret;
269 }
270
271 #define WHITESPACES " \n\t"
272
273 void av_bprint_escape(AVBPrint *dstbuf, const char *src, const char *special_chars,
274                       enum AVEscapeMode mode, int flags)
275 {
276     const char *src0 = src;
277
278     if (mode == AV_ESCAPE_MODE_AUTO)
279         mode = AV_ESCAPE_MODE_BACKSLASH; /* TODO: implement a heuristic */
280
281     switch (mode) {
282     case AV_ESCAPE_MODE_QUOTE:
283         /* enclose the string between '' */
284         av_bprint_chars(dstbuf, '\'', 1);
285         for (; *src; src++) {
286             if (*src == '\'')
287                 av_bprintf(dstbuf, "'\\''");
288             else
289                 av_bprint_chars(dstbuf, *src, 1);
290         }
291         av_bprint_chars(dstbuf, '\'', 1);
292         break;
293
294     /* case AV_ESCAPE_MODE_BACKSLASH or unknown mode */
295     default:
296         /* \-escape characters */
297         for (; *src; src++) {
298             int is_first_last       = src == src0 || !*(src+1);
299             int is_ws               = !!strchr(WHITESPACES, *src);
300             int is_strictly_special = special_chars && strchr(special_chars, *src);
301             int is_special          =
302                 is_strictly_special || strchr("'\\", *src) ||
303                 (is_ws && (flags & AV_ESCAPE_FLAG_WHITESPACE));
304
305             if (is_strictly_special ||
306                 (!(flags & AV_ESCAPE_FLAG_STRICT) &&
307                  (is_special || (is_ws && is_first_last))))
308                 av_bprint_chars(dstbuf, '\\', 1);
309             av_bprint_chars(dstbuf, *src, 1);
310         }
311         break;
312     }
313 }
314
315 int av_bprint_fd_contents(AVBPrint *pb, int fd)
316 {
317     int ret;
318     char buf[1024];
319     while (1) {
320         ret = read(fd, buf, sizeof(buf));
321         if (!ret)
322             return 0;
323         else if (ret < 0)
324             return AVERROR(errno);
325         av_bprint_append_data(pb, buf, ret);
326         if (!av_bprint_is_complete(pb))
327             return AVERROR(ENOMEM);
328     }
329 }
330
331 #ifdef TEST
332
333 #undef printf
334
335 static void bprint_pascal(AVBPrint *b, unsigned size)
336 {
337     unsigned i, j;
338     unsigned p[42];
339
340     av_assert0(size < FF_ARRAY_ELEMS(p));
341
342     p[0] = 1;
343     av_bprintf(b, "%8d\n", 1);
344     for (i = 1; i <= size; i++) {
345         p[i] = 1;
346         for (j = i - 1; j > 0; j--)
347             p[j] = p[j] + p[j - 1];
348         for (j = 0; j <= i; j++)
349             av_bprintf(b, "%8d", p[j]);
350         av_bprintf(b, "\n");
351     }
352 }
353
354 int main(void)
355 {
356     AVBPrint b;
357     char buf[256];
358     struct tm testtime = { .tm_year = 100, .tm_mon = 11, .tm_mday = 20 };
359
360     av_bprint_init(&b, 0, -1);
361     bprint_pascal(&b, 5);
362     printf("Short text in unlimited buffer: %u/%u\n", (unsigned)strlen(b.str), b.len);
363     printf("%s\n", b.str);
364     av_bprint_finalize(&b, NULL);
365
366     av_bprint_init(&b, 0, -1);
367     bprint_pascal(&b, 25);
368     printf("Long text in unlimited buffer: %u/%u\n", (unsigned)strlen(b.str), b.len);
369     av_bprint_finalize(&b, NULL);
370
371     av_bprint_init(&b, 0, 2048);
372     bprint_pascal(&b, 25);
373     printf("Long text in limited buffer: %u/%u\n", (unsigned)strlen(b.str), b.len);
374     av_bprint_finalize(&b, NULL);
375
376     av_bprint_init(&b, 0, 1);
377     bprint_pascal(&b, 5);
378     printf("Short text in automatic buffer: %u/%u\n", (unsigned)strlen(b.str), b.len);
379
380     av_bprint_init(&b, 0, 1);
381     bprint_pascal(&b, 25);
382     printf("Long text in automatic buffer: %u/%u\n", (unsigned)strlen(b.str)/8*8, b.len);
383     /* Note that the size of the automatic buffer is arch-dependent. */
384
385     av_bprint_init(&b, 0, 0);
386     bprint_pascal(&b, 25);
387     printf("Long text count only buffer: %u/%u\n", (unsigned)strlen(b.str), b.len);
388
389     av_bprint_init_for_buffer(&b, buf, sizeof(buf));
390     bprint_pascal(&b, 25);
391     printf("Long text count only buffer: %u/%u\n", (unsigned)strlen(buf), b.len);
392
393     av_bprint_init(&b, 0, -1);
394     av_bprint_strftime(&b, "%Y-%m-%d", &testtime);
395     printf("strftime full: %u/%u \"%s\"\n", (unsigned)strlen(buf), b.len, b.str);
396     av_bprint_finalize(&b, NULL);
397
398     av_bprint_init(&b, 0, 8);
399     av_bprint_strftime(&b, "%Y-%m-%d", &testtime);
400     printf("strftime truncated: %u/%u \"%s\"\n", (unsigned)strlen(buf), b.len, b.str);
401
402     return 0;
403 }
404
405 #endif