ExpandBuf.h revision 2d63bc57d5fcbcd54f0bd3e9491e1704b98ec0bf 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16/*
17 * Expanding byte buffer, with primitives for appending basic data types.
18 */
19#ifndef _DALVIK_JDWP_EXPANDBUF
20#define _DALVIK_JDWP_EXPANDBUF
21
22#include "Common.h"     // need u1/u2/u4/u8 types
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28struct ExpandBuf;   /* private */
29typedef struct ExpandBuf ExpandBuf;
30
31/* create a new struct */
32ExpandBuf* expandBufAlloc(void);
33/* free storage */
34void expandBufFree(ExpandBuf* pBuf);
35
36/*
37 * Accessors.  The buffer pointer and length will only be valid until more
38 * data is added.
39 */
40u1* expandBufGetBuffer(ExpandBuf* pBuf);
41size_t expandBufGetLength(ExpandBuf* pBuf);
42
43/*
44 * The "add" operations allocate additional storage and append the data.
45 *
46 * There are no "get" operations included with this "class", other than
47 * GetBuffer().  If you want to get or set data from a position other
48 * than the end, get a pointer to the buffer and use the inline functions
49 * defined elsewhere.
50 *
51 * expandBufAddSpace() returns a pointer to the *start* of the region
52 * added.
53 */
54u1* expandBufAddSpace(ExpandBuf* pBuf, int gapSize);
55void expandBufAdd1(ExpandBuf* pBuf, u1 val);
56void expandBufAdd2BE(ExpandBuf* pBuf, u2 val);
57void expandBufAdd4BE(ExpandBuf* pBuf, u4 val);
58void expandBufAdd8BE(ExpandBuf* pBuf, u8 val);
59void expandBufAddUtf8String(ExpandBuf* pBuf, const u1* str);
60
61#ifdef __cplusplus
62}
63#endif
64
65#endif /*_DALVIK_JDWP_EXPANDBUF*/
66