bbuffer.h 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. /*====================================================================*
  2. - Copyright (C) 2001 Leptonica. All rights reserved.
  3. -
  4. - Redistribution and use in source and binary forms, with or without
  5. - modification, are permitted provided that the following conditions
  6. - are met:
  7. - 1. Redistributions of source code must retain the above copyright
  8. - notice, this list of conditions and the following disclaimer.
  9. - 2. Redistributions in binary form must reproduce the above
  10. - copyright notice, this list of conditions and the following
  11. - disclaimer in the documentation and/or other materials
  12. - provided with the distribution.
  13. -
  14. - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15. - ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16. - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17. - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANY
  18. - CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19. - EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20. - PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21. - PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22. - OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  23. - NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  24. - SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. *====================================================================*/
  26. #ifndef LEPTONICA_BBUFFER_H
  27. #define LEPTONICA_BBUFFER_H
  28. /*
  29. * bbuffer.h
  30. *
  31. * Expandable byte buffer for reading data in from memory and
  32. * writing data out to other memory.
  33. *
  34. * This implements a queue of bytes, so data read in is put
  35. * on the "back" of the queue (i.e., the end of the byte array)
  36. * and data written out is taken from the "front" of the queue
  37. * (i.e., from an index marker "nwritten" that is initially set at
  38. * the beginning of the array.) As usual with expandable
  39. * arrays, we keep the size of the allocated array and the
  40. * number of bytes that have been read into the array.
  41. *
  42. * For implementation details, see bbuffer.c.
  43. */
  44. struct ByteBuffer
  45. {
  46. l_int32 nalloc; /* size of allocated byte array */
  47. l_int32 n; /* number of bytes read into to the array */
  48. l_int32 nwritten; /* number of bytes written from the array */
  49. l_uint8 *array; /* byte array */
  50. };
  51. typedef struct ByteBuffer BBUFFER;
  52. #endif /* LEPTONICA_BBUFFER_H */