/***************************************************************************
* Copyright (C) 2009 By Duane Ellis *
* openocd@duaneellis.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* 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. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
#ifndef HELPER_MEMBUF_H
#define HELPER_MEMBUF_H
/** @file
* MEMBUF - an auto-growing string buffer
*
* With OpenOCD often, one must write code that sends text to
* different places.. the historical command_ctx, or JIM output,
* and/or other places.
*
* This is a simple 'string buffer' that auto-grows.
*
* More correctly put, this is a "memory buffer"
* it may contain binary data
*
* Note: Internally the buffer always has a 'null terminator'
*/
/* contents of this structure are 'opaque' */
struct membuf;
/** Create a new membuf
* By default the memory buffer has "some non-zero-size"
* (couple hundred bytes, exact amount is opaque)
*/
struct membuf *membuf_new(void);
/** delete (destroy) the mem buffer
* @param pBuf - buffer to release
*/
void membuf_delete(struct membuf *pBuf);
/** grow/shrink a membuf by specified amount.
* @param pBuf - the buffer
* @param amount - the amount to grow or shrink by.
*
* Symantics of 'realloc()' return NULL on failure
*/
struct membuf *membuf_grow(struct membuf *pBuf, int amount);
/** how long is this buffer (memlen(), strlen())
* @param pBuf - the buffer
*
* @returns: length of current buffer.
*/
size_t membuf_len(struct membuf *pBuf);
/** reset an membuf to zero length.
* @param pBuf - buffer to reset
*
* Note this does not 'release' the memory buffer
*/
void membuf_reset(struct membuf *pBuf);
/** sprintf() to the string buffer
* @param pBuf - buffer to capture sprintf() data into
* @param fmt - printf format
*
* Returns 0 on success
* Returns non-zero on failure
*/
int membuf_sprintf(struct membuf *pBuf , const char *fmt, ...);
/** vsprintf() to the string buffer
* @param pBuf - buffer to capture sprintf() data into
* @param fmt - printf format
* @param ap - va_list for fmt
*
* Returns 0 on success
* Returns non-zero on failure
*/
int membuf_vsprintf(struct membuf *pBuf , const char *fmt, va_list ap);
/** Tokenize lines using strtok()
* @param pBuf - buffer to tokenize
* @param delim - delimiter parameter for strtok_r()
* @param pSave - pointer to string context for tokenization
*
* Identical to "strtok()" - pass "pBuff = NULL" on second call
*
* NOTE: This call is destructive to the buffer.
*/
const char *membuf_strtok(struct membuf *pBuf, const char *delim, void **pSave);
/** Return pointer to the memory in the buffer
* @param pBuf - buffer
*
* NOTE: Thou shall not modify this pointer, it is CONST
*/
const void *membuf_datapointer(struct membuf *pBuf);
/** Append data to the buffer
* @param pBuf - buffer to append
* @param pData - pointer to data to append
* @param len - length of data to append
*
* Modified symantics of "memcpy()". On memory allocation failure
* returns NULL. On success, returns pointer to orginal membuf.
*/
struct membuf *membuf_append(struct membuf *pBuf, const void *pData, size_t len);
/** Append string to the buffer
* @param pBuf - buffer to append
* @param str - string to append
*
* Modified symantics of "strcat()". On memory allocation failure
* returns NULL. On success, returns pointer to orginal membuf.
*/
struct membuf *membuf_strcat(struct membuf *pBuf, const char *str);
#endif
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|