/**
 * XML Security Library (http://www.aleksey.com/xmlsec).
 *
 * This is free software; see the Copyright file in the source distribution for precise wording.
 *
 * Copyright (C) 2002-2026 Aleksey Sanin <aleksey@aleksey.com>. All Rights Reserved.
 */
#ifndef __XMLSEC_BUFFER_H__
#define __XMLSEC_BUFFER_H__

/**
 * @defgroup xmlsec_core_buffer Dynamic Buffer
 * @ingroup xmlsec_core
 * @brief Dynamic binary buffer implementation.
 * @{
 */

#include <libxml/tree.h>

#include <xmlsec/exports.h>
#include <xmlsec/xmlsec.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct _xmlSecBuffer                                    xmlSecBuffer,
                                                                *xmlSecBufferPtr;


/**
 * @brief The memory allocation mode.
 * @details The memory allocation mode (used by xmlSecBuffer and xmlSecList).
 */
typedef enum {
    xmlSecAllocModeExact = 0,  /**< the memory allocation mode that minimizes total allocated memory size. */
    xmlSecAllocModeDouble  /**< the memory allocation mode that tries to minimize the number of malloc calls. */
} xmlSecAllocMode;

/******************************************************************************
 *
 * xmlSecBuffer
 *
  *****************************************************************************/

/**
 * @brief Binary data buffer.
 */
struct _xmlSecBuffer {
    xmlSecByte*         data;  /**< the pointer to buffer data. */
    xmlSecSize          size;  /**< the current data size. */
    xmlSecSize          maxSize;  /**< the max data size (allocated buffer size). */
    xmlSecAllocMode     allocMode;  /**< the buffer memory allocation mode. */
};

XMLSEC_EXPORT void              xmlSecBufferSetDefaultAllocMode (xmlSecAllocMode defAllocMode,
                                                                 xmlSecSize defInitialSize);

XMLSEC_EXPORT xmlSecBufferPtr   xmlSecBufferCreate              (xmlSecSize size);
XMLSEC_EXPORT void              xmlSecBufferDestroy             (xmlSecBufferPtr buf);
XMLSEC_EXPORT int               xmlSecBufferInitialize          (xmlSecBufferPtr buf,
                                                                 xmlSecSize size);
XMLSEC_EXPORT void              xmlSecBufferFinalize            (xmlSecBufferPtr buf);
XMLSEC_EXPORT int               xmlSecBufferIsEmpty             (xmlSecBufferPtr buf);
XMLSEC_EXPORT xmlSecByte*       xmlSecBufferGetData             (xmlSecBufferPtr buf);
XMLSEC_EXPORT int               xmlSecBufferSetData             (xmlSecBufferPtr buf,
                                                                 const xmlSecByte* data,
                                                                 xmlSecSize size);
XMLSEC_EXPORT xmlSecSize        xmlSecBufferGetSize             (xmlSecBufferPtr buf);
XMLSEC_EXPORT int               xmlSecBufferSetSize             (xmlSecBufferPtr buf,
                                                                 xmlSecSize size);
XMLSEC_EXPORT xmlSecSize        xmlSecBufferGetMaxSize          (xmlSecBufferPtr buf);
XMLSEC_EXPORT int               xmlSecBufferSetMaxSize          (xmlSecBufferPtr buf,
                                                                 xmlSecSize size);
XMLSEC_EXPORT void              xmlSecBufferEmpty               (xmlSecBufferPtr buf);
XMLSEC_EXPORT void              xmlSecBufferSwap                (xmlSecBufferPtr buf1,
                                                                 xmlSecBufferPtr buf2);
XMLSEC_EXPORT int               xmlSecBufferAppend              (xmlSecBufferPtr buf,
                                                                 const xmlSecByte* data,
                                                                 xmlSecSize size);
XMLSEC_EXPORT int               xmlSecBufferPrepend             (xmlSecBufferPtr buf,
                                                                 const xmlSecByte* data,
                                                                 xmlSecSize size);
XMLSEC_EXPORT int               xmlSecBufferRemoveHead          (xmlSecBufferPtr buf,
                                                                 xmlSecSize size);
XMLSEC_EXPORT int               xmlSecBufferRemoveTail          (xmlSecBufferPtr buf,
                                                                 xmlSecSize size);
XMLSEC_EXPORT int               xmlSecBufferReverse             (xmlSecBufferPtr buf);
XMLSEC_EXPORT int               xmlSecBufferReadFile            (xmlSecBufferPtr buf,
                                                                 const char* filename);
XMLSEC_EXPORT int               xmlSecBufferBase64NodeContentRead(xmlSecBufferPtr buf,
                                                                 xmlNodePtr node);
XMLSEC_EXPORT int               xmlSecBufferBase64NodeContentWrite(xmlSecBufferPtr buf,
                                                                 xmlNodePtr node,
                                                                 int columns);
XMLSEC_EXPORT int               xmlSecBufferHexRead             (xmlSecBufferPtr buf,
                                                                 const xmlChar* hexStr);

XMLSEC_EXPORT void              xmlSecBufferDebugHexDump        (xmlSecBufferPtr buf,
                                                                 FILE* output);

XMLSEC_EXPORT xmlOutputBufferPtr xmlSecBufferCreateOutputBuffer (xmlSecBufferPtr buf);


/**
 * Helpers
 */
XMLSEC_EXPORT int               xmlSecMemEqual                  (const xmlSecByte* buf1,
																 const xmlSecByte* buf2,
																 xmlSecSize size);

#ifdef __cplusplus
}
#endif /* __cplusplus */

/** @} */ /** xmlsec_core_buffer */

#endif /* __XMLSEC_BUFFER_H__ */