vm/jdwp/ExpandBuf.h

   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 struct ExpandBuf;   /* private */
  25 typedef struct ExpandBuf ExpandBuf;
  26
  27 /* create a new struct */
  28 ExpandBuf* expandBufAlloc(void);
  29 /* free storage */
  30 void expandBufFree(ExpandBuf* pBuf);
  31
  32 /*
  33  * Accessors.  The buffer pointer and length will only be valid until more
  34  * data is added.
  35  */
  36 u1* expandBufGetBuffer(ExpandBuf* pBuf);
  37 size_t expandBufGetLength(ExpandBuf* pBuf);
  38
  39 /*
  40  * The "add" operations allocate additional storage and append the data.
  41  *
  42  * There are no "get" operations included with this "class", other than
  43  * GetBuffer().  If you want to get or set data from a position other
  44  * than the end, get a pointer to the buffer and use the inline functions
  45  * defined elsewhere.
  46  *
  47  * expandBufAddSpace() returns a pointer to the *start* of the region
  48  * added.
  49  */
  50 u1* expandBufAddSpace(ExpandBuf* pBuf, int gapSize);
  51 void expandBufAdd1(ExpandBuf* pBuf, u1 val);
  52 void expandBufAdd2BE(ExpandBuf* pBuf, u2 val);
  53 void expandBufAdd4BE(ExpandBuf* pBuf, u4 val);
  54 void expandBufAdd8BE(ExpandBuf* pBuf, u8 val);
  55 void expandBufAddUtf8String(ExpandBuf* pBuf, const u1* str);
  56
  57 #endif /*_DALVIK_JDWP_EXPANDBUF*/