sopc_buffer.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_BUFFER_H_
#define SOPC_BUFFER_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_enums.h"
 
typedef struct
{
    uint32_t initial_size; 
    uint32_t current_size; 
    uint32_t maximum_size; 
    uint32_t position;     
    uint32_t length;       
    uint8_t* data;         
} SOPC_Buffer;
 
SOPC_Buffer* SOPC_Buffer_Create(uint32_t size);
 
SOPC_Buffer* SOPC_Buffer_CreateResizable(uint32_t initial_size, uint32_t maximum_size);
 
SOPC_Buffer* SOPC_Buffer_Attach(uint8_t* data, uint32_t size);
 
void SOPC_Buffer_Clear(SOPC_Buffer* buffer);
 
void SOPC_Buffer_Delete(SOPC_Buffer* buffer);
 
void SOPC_Buffer_Reset(SOPC_Buffer* buffer);
 
SOPC_ReturnStatus SOPC_Buffer_ResetAfterPosition(SOPC_Buffer* buffer, uint32_t position);
 
SOPC_ReturnStatus SOPC_Buffer_GetPosition(SOPC_Buffer* buffer, uint32_t* position);
 
SOPC_ReturnStatus SOPC_Buffer_SetPosition(SOPC_Buffer* buffer, uint32_t position);
 
SOPC_ReturnStatus SOPC_Buffer_SetDataLength(SOPC_Buffer* buffer, uint32_t length);
 
SOPC_ReturnStatus SOPC_Buffer_Write(SOPC_Buffer* buffer, const uint8_t* data_src, uint32_t count);
 
SOPC_ReturnStatus SOPC_Buffer_Read(uint8_t* data_dest, SOPC_Buffer* buffer, uint32_t count);
 
SOPC_ReturnStatus SOPC_Buffer_Copy(SOPC_Buffer* dest, SOPC_Buffer* src);
 
SOPC_ReturnStatus SOPC_Buffer_CopyWithLength(SOPC_Buffer* dest, SOPC_Buffer* src, uint32_t limitedLength);
 
uint32_t SOPC_Buffer_Remaining(SOPC_Buffer* buffer);
 
int64_t SOPC_Buffer_ReadFrom(SOPC_Buffer* buffer, SOPC_Buffer* src, uint32_t n);
 
SOPC_ReturnStatus SOPC_Buffer_ReadFile(const char* path, SOPC_Buffer** buf);
 
SOPC_ReturnStatus SOPC_Buffer_PrintU32(SOPC_Buffer* buf, const uint32_t value);
 
SOPC_ReturnStatus SOPC_Buffer_PrintI32(SOPC_Buffer* buf, const int32_t value);
 
SOPC_ReturnStatus SOPC_Buffer_PrintFloatDouble(SOPC_Buffer* buf, const double value);
 
/***
 *  \brief  Print the C string value in the buffer.
 *  \param value The C-string to print. If value is NULLL "<null>" is printed.
 *  \return            SOPC_STATUS_OK if succeeded, an error code otherwise (NULL pointer, non allocated buffer
 * content, full buffer avoiding operation)
 */
SOPC_ReturnStatus SOPC_Buffer_PrintCString(SOPC_Buffer* buf, const char* value);
 
#endif /* SOPC_BUFFER_H_ */