aboutsummaryrefslogtreecommitdiff
path: root/src/buffer.h
blob: 875cf8c448886ecf481da7b6b2178f83747c9426 (plain)
  1. #ifndef CMARK_BUFFER_H
  2. #define CMARK_BUFFER_H
  3. #include <stddef.h>
  4. #include <stdarg.h>
  5. #include "config.h"
  6. #ifdef __cplusplus
  7. extern "C" {
  8. #endif
  9. typedef struct {
  10. unsigned char *ptr;
  11. int asize, size;
  12. } cmark_strbuf;
  13. extern unsigned char cmark_strbuf__initbuf[];
  14. extern unsigned char cmark_strbuf__oom[];
  15. #define GH_BUF_INIT { cmark_strbuf__initbuf, 0, 0 }
  16. /**
  17. * Initialize a cmark_strbuf structure.
  18. *
  19. * For the cases where GH_BUF_INIT cannot be used to do static
  20. * initialization.
  21. */
  22. void cmark_strbuf_init(cmark_strbuf *buf, int initial_size);
  23. /**
  24. * Attempt to grow the buffer to hold at least `target_size` bytes.
  25. *
  26. * If the allocation fails, this will return an error. If mark_oom is true,
  27. * this will mark the buffer as invalid for future operations; if false,
  28. * existing buffer content will be preserved, but calling code must handle
  29. * that buffer was not expanded.
  30. */
  31. int cmark_strbuf_try_grow(cmark_strbuf *buf, int target_size, bool mark_oom);
  32. /**
  33. * Grow the buffer to hold at least `target_size` bytes.
  34. *
  35. * If the allocation fails, this will return an error and the buffer will be
  36. * marked as invalid for future operations, invaliding contents.
  37. *
  38. * @return 0 on success or -1 on failure
  39. */
  40. int cmark_strbuf_grow(cmark_strbuf *buf, int target_size);
  41. void cmark_strbuf_free(cmark_strbuf *buf);
  42. void cmark_strbuf_swap(cmark_strbuf *buf_a, cmark_strbuf *buf_b);
  43. /**
  44. * Test if there have been any reallocation failures with this cmark_strbuf.
  45. *
  46. * Any function that writes to a cmark_strbuf can fail due to memory allocation
  47. * issues. If one fails, the cmark_strbuf will be marked with an OOM error and
  48. * further calls to modify the buffer will fail. Check cmark_strbuf_oom() at the
  49. * end of your sequence and it will be true if you ran out of memory at any
  50. * point with that buffer.
  51. *
  52. * @return false if no error, true if allocation error
  53. */
  54. bool cmark_strbuf_oom(const cmark_strbuf *buf);
  55. size_t cmark_strbuf_len(const cmark_strbuf *buf);
  56. int cmark_strbuf_cmp(const cmark_strbuf *a, const cmark_strbuf *b);
  57. void cmark_strbuf_attach(cmark_strbuf *buf, unsigned char *ptr, int asize);
  58. unsigned char *cmark_strbuf_detach(cmark_strbuf *buf);
  59. void cmark_strbuf_copy_cstr(char *data, int datasize, const cmark_strbuf *buf);
  60. static inline const char *cmark_strbuf_cstr(const cmark_strbuf *buf)
  61. {
  62. return (char *)buf->ptr;
  63. }
  64. #define cmark_strbuf_at(buf, n) ((buf)->ptr[n])
  65. /*
  66. * Functions below that return int value error codes will return 0 on
  67. * success or -1 on failure (which generally means an allocation failed).
  68. * Using a cmark_strbuf where the allocation has failed with result in -1 from
  69. * all further calls using that buffer. As a result, you can ignore the
  70. * return code of these functions and call them in a series then just call
  71. * cmark_strbuf_oom at the end.
  72. */
  73. int cmark_strbuf_set(cmark_strbuf *buf, const unsigned char *data, int len);
  74. int cmark_strbuf_sets(cmark_strbuf *buf, const char *string);
  75. int cmark_strbuf_putc(cmark_strbuf *buf, int c);
  76. int cmark_strbuf_put(cmark_strbuf *buf, const unsigned char *data, int len);
  77. int cmark_strbuf_puts(cmark_strbuf *buf, const char *string);
  78. int cmark_strbuf_printf(cmark_strbuf *buf, const char *format, ...)
  79. CMARK_ATTRIBUTE((format (printf, 2, 3)));
  80. int cmark_strbuf_vprintf(cmark_strbuf *buf, const char *format, va_list ap);
  81. void cmark_strbuf_clear(cmark_strbuf *buf);
  82. int cmark_strbuf_strchr(const cmark_strbuf *buf, int c, int pos);
  83. int cmark_strbuf_strrchr(const cmark_strbuf *buf, int c, int pos);
  84. void cmark_strbuf_drop(cmark_strbuf *buf, int n);
  85. void cmark_strbuf_truncate(cmark_strbuf *buf, int len);
  86. void cmark_strbuf_rtrim(cmark_strbuf *buf);
  87. void cmark_strbuf_trim(cmark_strbuf *buf);
  88. void cmark_strbuf_normalize_whitespace(cmark_strbuf *s);
  89. void cmark_strbuf_unescape(cmark_strbuf *s);
  90. #ifdef __cplusplus
  91. }
  92. #endif
  93. #endif