2 * buf.c: memory buffers for libxml2
4 * new buffer structures and entry points to simplify the maintainance
5 * of libxml2 and ensure we keep good control over memory allocations
6 * and stay 64 bits clean.
7 * The new entry point use the xmlBufPtr opaque structure and
8 * xmlBuf...() counterparts to the old xmlBuf...() functions
10 * See Copyright for the status of this software.
18 #include <string.h> /* for memset() only ! */
27 #include <libxml/tree.h>
28 #include <libxml/globals.h>
29 #include <libxml/tree.h>
30 #include <libxml/parserInternals.h> /* for XML_MAX_TEXT_LENGTH */
33 #define WITH_BUFFER_COMPAT
38 * A buffer structure. The base of the structure is somehow compatible
39 * with struct _xmlBuffer to limit risks on application which accessed
40 * directly the input->buf->buffer structures.
44 xmlChar *content; /* The buffer content UTF8 */
45 unsigned int compat_use; /* for binary compatibility */
46 unsigned int compat_size; /* for binary compatibility */
47 xmlBufferAllocationScheme alloc; /* The realloc method */
48 xmlChar *contentIO; /* in IO mode we may have a different base */
49 size_t use; /* The buffer size used */
50 size_t size; /* The buffer size */
51 xmlBufferPtr buffer; /* wrapper for an old buffer */
52 int error; /* an error code if a failure occurred */
55 #ifdef WITH_BUFFER_COMPAT
57 * Macro for compatibility with xmlBuffer to be used after an xmlBuf
58 * is updated. This makes sure the compat fields are updated too.
60 #define UPDATE_COMPAT(buf) \
61 if (buf->size < INT_MAX) buf->compat_size = buf->size; \
62 else buf->compat_size = INT_MAX; \
63 if (buf->use < INT_MAX) buf->compat_use = buf->use; \
64 else buf->compat_use = INT_MAX;
67 * Macro for compatibility with xmlBuffer to be used in all the xmlBuf
68 * entry points, it checks that the compat fields have not been modified
69 * by direct call to xmlBuffer function from code compiled before 2.9.0 .
71 #define CHECK_COMPAT(buf) \
72 if (buf->size != (size_t) buf->compat_size) \
73 if (buf->compat_size < INT_MAX) \
74 buf->size = buf->compat_size; \
75 if (buf->use != (size_t) buf->compat_use) \
76 if (buf->compat_use < INT_MAX) \
77 buf->use = buf->compat_use;
79 #else /* ! WITH_BUFFER_COMPAT */
80 #define UPDATE_COMPAT(buf)
81 #define CHECK_COMPAT(buf)
82 #endif /* WITH_BUFFER_COMPAT */
86 * @extra: extra informations
88 * Handle an out of memory condition
92 xmlBufMemoryError(xmlBufPtr buf, const char *extra)
94 __xmlSimpleError(XML_FROM_BUFFER, XML_ERR_NO_MEMORY, NULL, NULL, extra);
95 if ((buf) && (buf->error == 0))
96 buf->error = XML_ERR_NO_MEMORY;
100 * xmlBufOverflowError:
101 * @extra: extra informations
103 * Handle a buffer overflow error
107 xmlBufOverflowError(xmlBufPtr buf, const char *extra)
109 __xmlSimpleError(XML_FROM_BUFFER, XML_BUF_OVERFLOW, NULL, NULL, extra);
110 if ((buf) && (buf->error == 0))
111 buf->error = XML_BUF_OVERFLOW;
118 * routine to create an XML buffer.
119 * returns the new structure.
125 ret = (xmlBufPtr) xmlMalloc(sizeof(xmlBuf));
127 xmlBufMemoryError(NULL, "creating buffer");
134 ret->size = xmlDefaultBufferSize;
135 ret->compat_size = xmlDefaultBufferSize;
136 ret->alloc = xmlBufferAllocScheme;
137 ret->content = (xmlChar *) xmlMallocAtomic(ret->size * sizeof(xmlChar));
138 if (ret->content == NULL) {
139 xmlBufMemoryError(ret, "creating buffer");
144 ret->contentIO = NULL;
150 * @size: initial size of buffer
152 * routine to create an XML buffer.
153 * returns the new structure.
156 xmlBufCreateSize(size_t size) {
159 ret = (xmlBufPtr) xmlMalloc(sizeof(xmlBuf));
161 xmlBufMemoryError(NULL, "creating buffer");
168 ret->alloc = xmlBufferAllocScheme;
169 ret->size = (size ? size+2 : 0); /* +1 for ending null */
170 ret->compat_size = (int) ret->size;
172 ret->content = (xmlChar *) xmlMallocAtomic(ret->size * sizeof(xmlChar));
173 if (ret->content == NULL) {
174 xmlBufMemoryError(ret, "creating buffer");
181 ret->contentIO = NULL;
189 * Remove the string contained in a buffer and give it back to the
190 * caller. The buffer is reset to an empty content.
191 * This doesn't work with immutable buffers as they can't be reset.
193 * Returns the previous string contained by the buffer.
196 xmlBufDetach(xmlBufPtr buf) {
201 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE)
203 if (buf->buffer != NULL)
213 buf->compat_size = 0;
220 * xmlBufCreateStatic:
221 * @mem: the memory area
222 * @size: the size in byte
224 * routine to create an XML buffer from an immutable memory area.
225 * The area won't be modified nor copied, and is expected to be
226 * present until the end of the buffer lifetime.
228 * returns the new structure.
231 xmlBufCreateStatic(void *mem, size_t size) {
237 ret = (xmlBufPtr) xmlMalloc(sizeof(xmlBuf));
239 xmlBufMemoryError(NULL, "creating buffer");
242 if (size < INT_MAX) {
243 ret->compat_use = size;
244 ret->compat_size = size;
246 ret->compat_use = INT_MAX;
247 ret->compat_size = INT_MAX;
251 ret->alloc = XML_BUFFER_ALLOC_IMMUTABLE;
252 ret->content = (xmlChar *) mem;
259 * xmlBufGetAllocationScheme:
262 * Get the buffer allocation scheme
264 * Returns the scheme or -1 in case of error
267 xmlBufGetAllocationScheme(xmlBufPtr buf) {
270 xmlGenericError(xmlGenericErrorContext,
271 "xmlBufGetAllocationScheme: buf == NULL\n");
279 * xmlBufSetAllocationScheme:
280 * @buf: the buffer to tune
281 * @scheme: allocation scheme to use
283 * Sets the allocation scheme for this buffer
285 * returns 0 in case of success and -1 in case of failure
288 xmlBufSetAllocationScheme(xmlBufPtr buf,
289 xmlBufferAllocationScheme scheme) {
290 if ((buf == NULL) || (buf->error != 0)) {
292 xmlGenericError(xmlGenericErrorContext,
293 "xmlBufSetAllocationScheme: buf == NULL or in error\n");
297 if ((buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) ||
298 (buf->alloc == XML_BUFFER_ALLOC_IO))
300 if ((scheme == XML_BUFFER_ALLOC_DOUBLEIT) ||
301 (scheme == XML_BUFFER_ALLOC_EXACT) ||
302 (scheme == XML_BUFFER_ALLOC_HYBRID) ||
303 (scheme == XML_BUFFER_ALLOC_IMMUTABLE) ||
304 (scheme == XML_BUFFER_ALLOC_BOUNDED)) {
307 buf->buffer->alloc = scheme;
311 * Switching a buffer ALLOC_IO has the side effect of initializing
312 * the contentIO field with the current content
314 if (scheme == XML_BUFFER_ALLOC_IO) {
315 buf->alloc = XML_BUFFER_ALLOC_IO;
316 buf->contentIO = buf->content;
323 * @buf: the buffer to free
325 * Frees an XML buffer. It frees both the content and the structure which
329 xmlBufFree(xmlBufPtr buf) {
332 xmlGenericError(xmlGenericErrorContext,
333 "xmlBufFree: buf == NULL\n");
338 if ((buf->alloc == XML_BUFFER_ALLOC_IO) &&
339 (buf->contentIO != NULL)) {
340 xmlFree(buf->contentIO);
341 } else if ((buf->content != NULL) &&
342 (buf->alloc != XML_BUFFER_ALLOC_IMMUTABLE)) {
343 xmlFree(buf->content);
355 xmlBufEmpty(xmlBufPtr buf) {
356 if ((buf == NULL) || (buf->error != 0)) return;
357 if (buf->content == NULL) return;
360 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) {
361 buf->content = BAD_CAST "";
362 } else if ((buf->alloc == XML_BUFFER_ALLOC_IO) &&
363 (buf->contentIO != NULL)) {
364 size_t start_buf = buf->content - buf->contentIO;
366 buf->size += start_buf;
367 buf->content = buf->contentIO;
377 * @buf: the buffer to dump
378 * @len: the number of xmlChar to remove
380 * Remove the beginning of an XML buffer.
381 * NOTE that this routine behaviour differs from xmlBufferShrink()
382 * as it will return 0 on error instead of -1 due to size_t being
383 * used as the return type.
385 * Returns the number of byte removed or 0 in case of failure
388 xmlBufShrink(xmlBufPtr buf, size_t len) {
389 if ((buf == NULL) || (buf->error != 0)) return(0);
391 if (len == 0) return(0);
392 if (len > buf->use) return(0);
395 if ((buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) ||
396 ((buf->alloc == XML_BUFFER_ALLOC_IO) && (buf->contentIO != NULL))) {
398 * we just move the content pointer, but also make sure
399 * the perceived buffer size has shrinked accordingly
405 * sometimes though it maybe be better to really shrink
408 if ((buf->alloc == XML_BUFFER_ALLOC_IO) && (buf->contentIO != NULL)) {
409 size_t start_buf = buf->content - buf->contentIO;
410 if (start_buf >= buf->size) {
411 memmove(buf->contentIO, &buf->content[0], buf->use);
412 buf->content = buf->contentIO;
413 buf->content[buf->use] = 0;
414 buf->size += start_buf;
418 memmove(buf->content, &buf->content[len], buf->use);
419 buf->content[buf->use] = 0;
426 * xmlBufGrowInternal:
428 * @len: the minimum free size to allocate
430 * Grow the available space of an XML buffer, @len is the target value
431 * Error checking should be done on buf->error since using the return
432 * value doesn't work that well
434 * Returns 0 in case of error or the length made available otherwise
437 xmlBufGrowInternal(xmlBufPtr buf, size_t len) {
441 if ((buf == NULL) || (buf->error != 0)) return(0);
444 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) return(0);
445 if (buf->use + len < buf->size)
446 return(buf->size - buf->use);
449 * Windows has a BIG problem on realloc timing, so we try to double
450 * the buffer size (if that's enough) (bug 146697)
451 * Apparently BSD too, and it's probably best for linux too
452 * On an embedded system this may be something to change
455 if (buf->size > (size_t) len)
456 size = buf->size * 2;
458 size = buf->use + len + 100;
460 size = buf->use + len + 100;
463 if (buf->alloc == XML_BUFFER_ALLOC_BOUNDED) {
465 * Used to provide parsing limits
467 if ((buf->use + len >= XML_MAX_TEXT_LENGTH) ||
468 (buf->size >= XML_MAX_TEXT_LENGTH)) {
469 xmlBufMemoryError(buf, "buffer error: text too long\n");
472 if (size >= XML_MAX_TEXT_LENGTH)
473 size = XML_MAX_TEXT_LENGTH;
475 if ((buf->alloc == XML_BUFFER_ALLOC_IO) && (buf->contentIO != NULL)) {
476 size_t start_buf = buf->content - buf->contentIO;
478 newbuf = (xmlChar *) xmlRealloc(buf->contentIO, start_buf + size);
479 if (newbuf == NULL) {
480 xmlBufMemoryError(buf, "growing buffer");
483 buf->contentIO = newbuf;
484 buf->content = newbuf + start_buf;
486 newbuf = (xmlChar *) xmlRealloc(buf->content, size);
487 if (newbuf == NULL) {
488 xmlBufMemoryError(buf, "growing buffer");
491 buf->content = newbuf;
495 return(buf->size - buf->use);
501 * @len: the minimum free size to allocate
503 * Grow the available space of an XML buffer, @len is the target value
504 * This is been kept compatible with xmlBufferGrow() as much as possible
506 * Returns -1 in case of error or the length made available otherwise
509 xmlBufGrow(xmlBufPtr buf, int len) {
512 if ((buf == NULL) || (len < 0)) return(-1);
515 ret = xmlBufGrowInternal(buf, len);
524 * @len: the minimum extra free size to allocate
526 * Grow the available space of an XML buffer, adding at least @len bytes
528 * Returns 0 if successful or -1 in case of error
531 xmlBufInflate(xmlBufPtr buf, size_t len) {
532 if (buf == NULL) return(-1);
533 xmlBufGrowInternal(buf, len + buf->size);
541 * @file: the file output
542 * @buf: the buffer to dump
544 * Dumps an XML buffer to a FILE *.
545 * Returns the number of #xmlChar written
548 xmlBufDump(FILE *file, xmlBufPtr buf) {
551 if ((buf == NULL) || (buf->error != 0)) {
553 xmlGenericError(xmlGenericErrorContext,
554 "xmlBufDump: buf == NULL or in error\n");
558 if (buf->content == NULL) {
560 xmlGenericError(xmlGenericErrorContext,
561 "xmlBufDump: buf->content == NULL\n");
568 ret = fwrite(buf->content, sizeof(xmlChar), buf->use, file);
576 * Function to extract the content of a buffer
578 * Returns the internal content
582 xmlBufContent(const xmlBuf *buf)
584 if ((!buf) || (buf->error))
587 return(buf->content);
594 * Function to extract the end of the content of a buffer
596 * Returns the end of the internal content or NULL in case of error
600 xmlBufEnd(xmlBufPtr buf)
602 if ((!buf) || (buf->error))
606 return(&buf->content[buf->use]);
612 * @len: the size which were added at the end
614 * Sometime data may be added at the end of the buffer without
615 * using the xmlBuf APIs that is used to expand the used space
616 * and set the zero terminating at the end of the buffer
618 * Returns -1 in case of error and 0 otherwise
621 xmlBufAddLen(xmlBufPtr buf, size_t len) {
622 if ((buf == NULL) || (buf->error))
625 if (len > (buf->size - buf->use))
629 if (buf->size > buf->use)
630 buf->content[buf->use] = 0;
639 * @len: the size to erase at the end
641 * Sometime data need to be erased at the end of the buffer
643 * Returns -1 in case of error and 0 otherwise
646 xmlBufErase(xmlBufPtr buf, size_t len) {
647 if ((buf == NULL) || (buf->error))
653 buf->content[buf->use] = 0;
662 * Function to get the length of a buffer
664 * Returns the length of data in the internal content
668 xmlBufLength(const xmlBufPtr buf)
670 if ((!buf) || (buf->error))
681 * Function to get the length of a buffer
683 * Returns the length of data in the internal content
687 xmlBufUse(const xmlBufPtr buf)
689 if ((!buf) || (buf->error))
700 * Function to find how much free space is allocated but not
701 * used in the buffer. It does not account for the terminating zero
704 * Returns the amount or 0 if none or an error occurred
708 xmlBufAvail(const xmlBufPtr buf)
710 if ((!buf) || (buf->error))
714 return(buf->size - buf->use);
721 * Tell if a buffer is empty
723 * Returns 0 if no, 1 if yes and -1 in case of error
726 xmlBufIsEmpty(const xmlBufPtr buf)
728 if ((!buf) || (buf->error))
732 return(buf->use == 0);
737 * @buf: the buffer to resize
738 * @size: the desired size
740 * Resize a buffer to accommodate minimum size of @size.
742 * Returns 0 in case of problems, 1 otherwise
745 xmlBufResize(xmlBufPtr buf, size_t size)
747 unsigned int newSize;
748 xmlChar* rebuf = NULL;
751 if ((buf == NULL) || (buf->error))
755 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) return(0);
756 if (buf->alloc == XML_BUFFER_ALLOC_BOUNDED) {
758 * Used to provide parsing limits
760 if (size >= XML_MAX_TEXT_LENGTH) {
761 xmlBufMemoryError(buf, "buffer error: text too long\n");
766 /* Don't resize if we don't have to */
767 if (size < buf->size)
770 /* figure out new size */
772 case XML_BUFFER_ALLOC_IO:
773 case XML_BUFFER_ALLOC_DOUBLEIT:
774 /*take care of empty case*/
775 newSize = (buf->size ? buf->size*2 : size + 10);
776 while (size > newSize) {
777 if (newSize > UINT_MAX / 2) {
778 xmlBufMemoryError(buf, "growing buffer");
784 case XML_BUFFER_ALLOC_EXACT:
787 case XML_BUFFER_ALLOC_HYBRID:
788 if (buf->use < BASE_BUFFER_SIZE)
791 newSize = buf->size * 2;
792 while (size > newSize) {
793 if (newSize > UINT_MAX / 2) {
794 xmlBufMemoryError(buf, "growing buffer");
807 if ((buf->alloc == XML_BUFFER_ALLOC_IO) && (buf->contentIO != NULL)) {
808 start_buf = buf->content - buf->contentIO;
810 if (start_buf > newSize) {
811 /* move data back to start */
812 memmove(buf->contentIO, buf->content, buf->use);
813 buf->content = buf->contentIO;
814 buf->content[buf->use] = 0;
815 buf->size += start_buf;
817 rebuf = (xmlChar *) xmlRealloc(buf->contentIO, start_buf + newSize);
819 xmlBufMemoryError(buf, "growing buffer");
822 buf->contentIO = rebuf;
823 buf->content = rebuf + start_buf;
826 if (buf->content == NULL) {
827 rebuf = (xmlChar *) xmlMallocAtomic(newSize);
828 } else if (buf->size - buf->use < 100) {
829 rebuf = (xmlChar *) xmlRealloc(buf->content, newSize);
832 * if we are reallocating a buffer far from being full, it's
833 * better to make a new allocation and copy only the used range
834 * and free the old one.
836 rebuf = (xmlChar *) xmlMallocAtomic(newSize);
838 memcpy(rebuf, buf->content, buf->use);
839 xmlFree(buf->content);
844 xmlBufMemoryError(buf, "growing buffer");
847 buf->content = rebuf;
857 * @buf: the buffer to dump
858 * @str: the #xmlChar string
859 * @len: the number of #xmlChar to add
861 * Add a string range to an XML buffer. if len == -1, the length of
864 * Returns 0 successful, a positive error code number otherwise
865 * and -1 in case of internal or API error.
868 xmlBufAdd(xmlBufPtr buf, const xmlChar *str, int len) {
869 unsigned int needSize;
871 if ((str == NULL) || (buf == NULL) || (buf->error))
875 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) return -1;
878 xmlGenericError(xmlGenericErrorContext,
879 "xmlBufAdd: len < 0\n");
883 if (len == 0) return 0;
886 len = xmlStrlen(str);
888 if (len < 0) return -1;
889 if (len == 0) return 0;
891 needSize = buf->use + len + 2;
892 if (needSize > buf->size){
893 if (buf->alloc == XML_BUFFER_ALLOC_BOUNDED) {
895 * Used to provide parsing limits
897 if (needSize >= XML_MAX_TEXT_LENGTH) {
898 xmlBufMemoryError(buf, "buffer error: text too long\n");
902 if (!xmlBufResize(buf, needSize)){
903 xmlBufMemoryError(buf, "growing buffer");
904 return XML_ERR_NO_MEMORY;
908 memmove(&buf->content[buf->use], str, len*sizeof(xmlChar));
910 buf->content[buf->use] = 0;
918 * @str: the #xmlChar string
919 * @len: the number of #xmlChar to add
921 * Add a string range to the beginning of an XML buffer.
922 * if len == -1, the length of @str is recomputed.
924 * Returns 0 successful, a positive error code number otherwise
925 * and -1 in case of internal or API error.
928 xmlBufAddHead(xmlBufPtr buf, const xmlChar *str, int len) {
929 unsigned int needSize;
931 if ((buf == NULL) || (buf->error))
934 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) return -1;
937 xmlGenericError(xmlGenericErrorContext,
938 "xmlBufAddHead: str == NULL\n");
944 xmlGenericError(xmlGenericErrorContext,
945 "xmlBufAddHead: len < 0\n");
949 if (len == 0) return 0;
952 len = xmlStrlen(str);
954 if (len <= 0) return -1;
956 if ((buf->alloc == XML_BUFFER_ALLOC_IO) && (buf->contentIO != NULL)) {
957 size_t start_buf = buf->content - buf->contentIO;
959 if (start_buf > (unsigned int) len) {
961 * We can add it in the space previously shrinked
964 memmove(&buf->content[0], str, len);
971 needSize = buf->use + len + 2;
972 if (needSize > buf->size){
973 if (buf->alloc == XML_BUFFER_ALLOC_BOUNDED) {
975 * Used to provide parsing limits
977 if (needSize >= XML_MAX_TEXT_LENGTH) {
978 xmlBufMemoryError(buf, "buffer error: text too long\n");
982 if (!xmlBufResize(buf, needSize)){
983 xmlBufMemoryError(buf, "growing buffer");
984 return XML_ERR_NO_MEMORY;
988 memmove(&buf->content[len], &buf->content[0], buf->use);
989 memmove(&buf->content[0], str, len);
991 buf->content[buf->use] = 0;
998 * @buf: the buffer to add to
999 * @str: the #xmlChar string
1001 * Append a zero terminated string to an XML buffer.
1003 * Returns 0 successful, a positive error code number otherwise
1004 * and -1 in case of internal or API error.
1007 xmlBufCat(xmlBufPtr buf, const xmlChar *str) {
1008 if ((buf == NULL) || (buf->error))
1011 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) return -1;
1012 if (str == NULL) return -1;
1013 return xmlBufAdd(buf, str, -1);
1018 * @buf: the buffer to dump
1019 * @str: the C char string
1021 * Append a zero terminated C string to an XML buffer.
1023 * Returns 0 successful, a positive error code number otherwise
1024 * and -1 in case of internal or API error.
1027 xmlBufCCat(xmlBufPtr buf, const char *str) {
1030 if ((buf == NULL) || (buf->error))
1033 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE) return -1;
1036 xmlGenericError(xmlGenericErrorContext,
1037 "xmlBufCCat: str == NULL\n");
1041 for (cur = str;*cur != 0;cur++) {
1042 if (buf->use + 10 >= buf->size) {
1043 if (!xmlBufResize(buf, buf->use+10)){
1044 xmlBufMemoryError(buf, "growing buffer");
1045 return XML_ERR_NO_MEMORY;
1048 buf->content[buf->use++] = *cur;
1050 buf->content[buf->use] = 0;
1057 * @buf: the XML buffer
1058 * @string: the string to add
1060 * routine which manages and grows an output buffer. This one adds
1061 * xmlChars at the end of the buffer.
1063 * Returns 0 if successful, a positive error code number otherwise
1064 * and -1 in case of internal or API error.
1067 xmlBufWriteCHAR(xmlBufPtr buf, const xmlChar *string) {
1068 if ((buf == NULL) || (buf->error))
1071 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE)
1073 return(xmlBufCat(buf, string));
1078 * @buf: the XML buffer output
1079 * @string: the string to add
1081 * routine which manage and grows an output buffer. This one add
1082 * C chars at the end of the array.
1084 * Returns 0 if successful, a positive error code number otherwise
1085 * and -1 in case of internal or API error.
1088 xmlBufWriteChar(xmlBufPtr buf, const char *string) {
1089 if ((buf == NULL) || (buf->error))
1092 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE)
1094 return(xmlBufCCat(buf, string));
1099 * xmlBufWriteQuotedString:
1100 * @buf: the XML buffer output
1101 * @string: the string to add
1103 * routine which manage and grows an output buffer. This one writes
1104 * a quoted or double quoted #xmlChar string, checking first if it holds
1105 * quote or double-quotes internally
1107 * Returns 0 if successful, a positive error code number otherwise
1108 * and -1 in case of internal or API error.
1111 xmlBufWriteQuotedString(xmlBufPtr buf, const xmlChar *string) {
1112 const xmlChar *cur, *base;
1113 if ((buf == NULL) || (buf->error))
1116 if (buf->alloc == XML_BUFFER_ALLOC_IMMUTABLE)
1118 if (xmlStrchr(string, '\"')) {
1119 if (xmlStrchr(string, '\'')) {
1121 xmlGenericError(xmlGenericErrorContext,
1122 "xmlBufWriteQuotedString: string contains quote and double-quotes !\n");
1124 xmlBufCCat(buf, "\"");
1125 base = cur = string;
1129 xmlBufAdd(buf, base, cur - base);
1130 xmlBufAdd(buf, BAD_CAST """, 6);
1139 xmlBufAdd(buf, base, cur - base);
1140 xmlBufCCat(buf, "\"");
1143 xmlBufCCat(buf, "\'");
1144 xmlBufCat(buf, string);
1145 xmlBufCCat(buf, "\'");
1148 xmlBufCCat(buf, "\"");
1149 xmlBufCat(buf, string);
1150 xmlBufCCat(buf, "\"");
1157 * @buffer: incoming old buffer to convert to a new one
1159 * Helper routine to switch from the old buffer structures in use
1160 * in various APIs. It creates a wrapper xmlBufPtr which will be
1161 * used for internal processing until the xmlBufBackToBuffer() is
1164 * Returns a new xmlBufPtr unless the call failed and NULL is returned
1167 xmlBufFromBuffer(xmlBufferPtr buffer) {
1173 ret = (xmlBufPtr) xmlMalloc(sizeof(xmlBuf));
1175 xmlBufMemoryError(NULL, "creating buffer");
1178 ret->use = buffer->use;
1179 ret->size = buffer->size;
1180 ret->compat_use = buffer->use;
1181 ret->compat_size = buffer->size;
1183 ret->buffer = buffer;
1184 ret->alloc = buffer->alloc;
1185 ret->content = buffer->content;
1186 ret->contentIO = buffer->contentIO;
1192 * xmlBufBackToBuffer:
1193 * @buf: new buffer wrapping the old one
1195 * Function to be called once internal processing had been done to
1196 * update back the buffer provided by the user. This can lead to
1197 * a failure in case the size accumulated in the xmlBuf is larger
1198 * than what an xmlBuffer can support on 64 bits (INT_MAX)
1199 * The xmlBufPtr @buf wrapper is deallocated by this call in any case.
1201 * Returns the old xmlBufferPtr unless the call failed and NULL is returned
1204 xmlBufBackToBuffer(xmlBufPtr buf) {
1207 if ((buf == NULL) || (buf->error))
1210 if (buf->buffer == NULL) {
1217 * What to do in case of error in the buffer ???
1219 if (buf->use > INT_MAX) {
1221 * Worse case, we really allocated and used more than the
1222 * maximum allowed memory for an xmlBuffer on this architecture.
1223 * Keep the buffer but provide a truncated size value.
1225 xmlBufOverflowError(buf, "Used size too big for xmlBuffer");
1227 ret->size = INT_MAX;
1228 } else if (buf->size > INT_MAX) {
1230 * milder case, we allocated more than the maximum allowed memory
1231 * for an xmlBuffer on this architecture, but used less than the
1233 * Keep the buffer but provide a truncated size value.
1235 xmlBufOverflowError(buf, "Allocated size too big for xmlBuffer");
1236 ret->size = INT_MAX;
1238 ret->use = (int) buf->use;
1239 ret->size = (int) buf->size;
1240 ret->alloc = buf->alloc;
1241 ret->content = buf->content;
1242 ret->contentIO = buf->contentIO;
1248 * xmlBufMergeBuffer:
1249 * @buf: an xmlBufPtr
1250 * @buffer: the buffer to consume into @buf
1252 * The content of @buffer is appended to @buf and @buffer is freed
1254 * Returns -1 in case of error, 0 otherwise, in any case @buffer is freed
1257 xmlBufMergeBuffer(xmlBufPtr buf, xmlBufferPtr buffer) {
1260 if ((buf == NULL) || (buf->error)) {
1261 xmlBufferFree(buffer);
1265 if ((buffer != NULL) && (buffer->content != NULL) &&
1266 (buffer->use > 0)) {
1267 ret = xmlBufAdd(buf, buffer->content, buffer->use);
1269 xmlBufferFree(buffer);
1275 * @buf: an xmlBufPtr
1276 * @input: an xmlParserInputPtr
1278 * Update the input to use the current set of pointers from the buffer.
1280 * Returns -1 in case of error, 0 otherwise
1283 xmlBufResetInput(xmlBufPtr buf, xmlParserInputPtr input) {
1284 if ((input == NULL) || (buf == NULL) || (buf->error))
1287 input->base = input->cur = buf->content;
1288 input->end = &buf->content[buf->use];
1293 * xmlBufGetInputBase:
1294 * @buf: an xmlBufPtr
1295 * @input: an xmlParserInputPtr
1297 * Get the base of the @input relative to the beginning of the buffer
1299 * Returns the size_t corresponding to the displacement
1302 xmlBufGetInputBase(xmlBufPtr buf, xmlParserInputPtr input) {
1305 if ((input == NULL) || (buf == NULL) || (buf->error))
1308 base = input->base - buf->content;
1310 * We could do some pointer arythmetic checks but that's probably
1313 if (base > buf->size) {
1314 xmlBufOverflowError(buf, "Input reference outside of the buffer");
1321 * xmlBufSetInputBaseCur:
1322 * @buf: an xmlBufPtr
1323 * @input: an xmlParserInputPtr
1324 * @base: the base value relative to the beginning of the buffer
1325 * @cur: the cur value relative to the beginning of the buffer
1327 * Update the input to use the base and cur relative to the buffer
1328 * after a possible reallocation of its content
1330 * Returns -1 in case of error, 0 otherwise
1333 xmlBufSetInputBaseCur(xmlBufPtr buf, xmlParserInputPtr input,
1334 size_t base, size_t cur) {
1335 if ((input == NULL) || (buf == NULL) || (buf->error))
1338 input->base = &buf->content[base];
1339 input->cur = input->base + cur;
1340 input->end = &buf->content[buf->use];
1345 #include "elfgcchack.h"