X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fmembuf.h;h=fa969985dbc06822db18853dc7c347482cba7c9e;hb=0a9daddc2e20d9ff5053a9faf3e1ec11fd600c73;hp=0e9d81afcf0fdd4ba13573d95d94bde1af509295;hpb=1793150091a813e5de4552fc17dd5baf1a474829;p=openocd.git
diff --git a/src/helper/membuf.h b/src/helper/membuf.h
index 0e9d81afcf..fa969985db 100644
--- a/src/helper/membuf.h
+++ b/src/helper/membuf.h
@@ -1,9 +1,27 @@
+/***************************************************************************
+ * 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 */
-
-/** @page MEMBUF - an auto-growing string buffer
+/** @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,
@@ -12,14 +30,14 @@
* This is a simple 'string buffer' that auto-grows.
*
* More correctly put, this is a "memory buffer"
- * it may contain binary data
- *
+ * 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"
@@ -30,23 +48,23 @@ struct membuf *membuf_new(void);
/** delete (destroy) the mem buffer
* @param pBuf - buffer to release
*/
-void membuf_delete(struct membuf *pBuf );
+void membuf_delete(struct membuf *pBuf);
/** grow/shrink a membuf by specified amount.
- * @param pBuf - the buffer
+ * @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 );
+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 );
+size_t membuf_len(struct membuf *pBuf);
/** reset an membuf to zero length.
@@ -54,7 +72,7 @@ size_t membuf_len(struct membuf *pBuf );
*
* Note this does not 'release' the memory buffer
*/
-void membuf_reset(struct membuf *pBuf );
+void membuf_reset(struct membuf *pBuf);
/** sprintf() to the string buffer
@@ -64,7 +82,7 @@ void membuf_reset(struct membuf *pBuf );
* Returns 0 on success
* Returns non-zero on failure
*/
-int membuf_sprintf(struct membuf *pBuf , const char *fmt, ... );
+int membuf_sprintf(struct membuf *pBuf , const char *fmt, ...);
/** vsprintf() to the string buffer
* @param pBuf - buffer to capture sprintf() data into
@@ -76,22 +94,23 @@ int membuf_sprintf(struct membuf *pBuf , const char *fmt, ... );
*/
int membuf_vsprintf(struct membuf *pBuf , const char *fmt, va_list ap);
-/** Tokenize lines using strtok()
+/** 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 );
+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 );
+const void *membuf_datapointer(struct membuf *pBuf);
/** Append data to the buffer
@@ -102,7 +121,7 @@ const void *membuf_datapointer(struct membuf *pBuf );
* 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 );
+struct membuf *membuf_append(struct membuf *pBuf, const void *pData, size_t len);
/** Append string to the buffer
@@ -112,7 +131,7 @@ struct membuf *membuf_append(struct membuf *pBuf, const void *pData, size_t len
* 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 *s );
+struct membuf *membuf_strcat(struct membuf *pBuf, const char *str);
#endif