1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/* Copyright (C) 2007-2008 The Android Open Source Project
**
** This software is licensed under the terms of the GNU General Public
** License version 2, as published by the Free Software Foundation, and
** may be copied, distributed, and modified under those terms.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
*/
#ifndef _ANDROID_UTILS_BUFPRINT_H
#define _ANDROID_UTILS_BUFPRINT_H
#include <stdarg.h>
/** FORMATTED BUFFER PRINTING
**
** bufprint() allows your to easily and safely append formatted string
** content to a given bounded character buffer, in a way that is easier
** to use than raw snprintf()
**
** 'buffer' is the start position in the buffer,
** 'buffend' is the end of the buffer, the function assumes (buffer <= buffend)
** 'format' is a standard printf-style format string, followed by any number
** of formatting arguments
**
** the function returns the next position in the buffer if everything fits
** in it. in case of overflow or formatting error, it will always return "buffend"
**
** this allows you to chain several calls to bufprint() and only check for
** overflow at the end, for exemple:
**
** char buffer[1024];
** char* p = buffer;
** char* end = p + sizeof(buffer);
**
** p = bufprint(p, end, "%s/%s", first, second);
** p = bufprint(p, end, "/%s", third);
** if (p >= end) ---> overflow
**
** as a convenience, the appended string is zero-terminated if there is no overflow.
** (this means that even if p >= end, the content of "buffer" is zero-terminated)
**
** vbufprint() is a variant that accepts a va_list argument
**/
extern char* vbufprint(char* buffer, char* buffend, const char* fmt, va_list args );
extern char* bufprint (char* buffer, char* buffend, const char* fmt, ... );
/** USEFUL DIRECTORY SUPPORT
**
** bufprint_add_dir() appends the application's directory to a given bounded buffer
**
** bufprint_config_path() appends the applications' user-specific configuration directory
** to a bounded buffer. on Unix this is usually ~/.android, and something a bit more
** complex on Windows
**
** bufprint_config_file() appends the name of a file or directory relative to the
** user-specific configuration directory to a bounded buffer. this really is equivalent
** to concat-ing the config path + path separator + 'suffix'
**
** bufprint_temp_dir() appends the temporary directory's path to a given bounded buffer
**
** bufprint_temp_file() appens the name of a file or directory relative to the
** temporary directory. equivalent to concat-ing the temp path + path separator + 'suffix'
**/
extern char* bufprint_app_dir (char* buffer, char* buffend);
extern char* bufprint_config_path(char* buffer, char* buffend);
extern char* bufprint_config_file(char* buffer, char* buffend, const char* suffix);
extern char* bufprint_temp_dir (char* buffer, char* buffend);
extern char* bufprint_temp_file (char* buffer, char* buffend, const char* suffix);
#endif /* _ANDROID_UTILS_BUFPRINT_H */
|
