Ditch all the DOS line breaks
This commit was SVN r714.
Этот коммит содержится в:
Jeff Squyres
родитель
ceacc4df26
Коммит
325b72631e
@ -1,243 +1,243 @@
|
||||
/*
|
||||
* $HEADER$
|
||||
*/
|
||||
|
||||
#ifndef LAM_VALUE_ARRAY_H
|
||||
#define LAM_VALUE_ARRAY_H
|
||||
|
||||
#include <string.h>
|
||||
#include "lam_config.h"
|
||||
#include "lam/constants.h"
|
||||
#include "lam/types.h"
|
||||
#include "lam/lfc/object.h"
|
||||
#if LAM_ENABLE_DEBUG
|
||||
#include "lam/util/output.h"
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* Array of elements maintained by value.
|
||||
*/
|
||||
|
||||
extern lam_class_info_t lam_value_array_t_class_info;
|
||||
|
||||
|
||||
struct lam_value_array_t
|
||||
{
|
||||
lam_object_t super;
|
||||
unsigned char* array_items;
|
||||
size_t array_item_sizeof;
|
||||
size_t array_size;
|
||||
size_t array_alloc_size;
|
||||
};
|
||||
typedef struct lam_value_array_t lam_value_array_t;
|
||||
|
||||
|
||||
#if defined(c_plusplus) || defined(__cplusplus)
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Initialize the array to hold items by value. This routine must
|
||||
* be called prior to using the array.
|
||||
*
|
||||
* @param array The array to initialize (IN).
|
||||
* @param item_size The sizeof each array element (IN).
|
||||
* @return LAM error code
|
||||
*
|
||||
* Note that there is no corresponding "finalize" function -- use
|
||||
* OBJ_DESTRUCT (for stack arrays) or OBJ_RELEASE (for heap arrays) to
|
||||
* delete it.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_init(lam_value_array_t *array, size_t item_sizeof)
|
||||
{
|
||||
array->array_item_sizeof = item_sizeof;
|
||||
array->array_alloc_size = 1;
|
||||
array->array_items = malloc(item_sizeof * array->array_alloc_size);
|
||||
return (NULL != array->array_items) ? LAM_SUCCESS : LAM_ERR_OUT_OF_RESOURCE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retreives the number of elements in the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @return The number of elements currently in use.
|
||||
*/
|
||||
|
||||
static inline size_t lam_value_array_get_size(lam_value_array_t* array)
|
||||
{
|
||||
return array->array_size;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the number of elements in the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param size The new array size.
|
||||
*
|
||||
* @return LAM error code.
|
||||
*
|
||||
* Note that resizing the array to a smaller size may not change
|
||||
* the underlying memory allocated by the array. However, setting
|
||||
* the size larger than the current allocation will grow it. In either
|
||||
* case, if the routine is successful, lam_value_array_get_size() will
|
||||
* return the new size.
|
||||
*/
|
||||
|
||||
int lam_value_array_set_size(lam_value_array_t* array, size_t size);
|
||||
|
||||
|
||||
/**
|
||||
* Macro to retrieve an item from the array by value.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item_type The C datatype of the array item (IN).
|
||||
* @param item_index The array index (IN).
|
||||
*
|
||||
* @returns item The requested item.
|
||||
*
|
||||
* Note that this does not change the size of the array - this macro is
|
||||
* strictly for performance - the user assumes the responsibility of
|
||||
* ensuring the array index is valid (0 <= item index < array size).
|
||||
*/
|
||||
|
||||
#define LAM_VALUE_ARRAY_GET_ITEM(array, item_type, item_index) \
|
||||
((item_type*)((array)->array_items))[item_index]
|
||||
|
||||
/**
|
||||
* Retrieve an item from the array by reference.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param index The array index (IN).
|
||||
*
|
||||
* @return ptr Pointer to the requested item.
|
||||
*
|
||||
* Note that if the specified index is larger than the current
|
||||
* array size, the array is grown to satisfy the request.
|
||||
*/
|
||||
|
||||
static inline void* lam_value_array_get_item(lam_value_array_t *array, size_t index)
|
||||
{
|
||||
if(index >= array->array_size && lam_value_array_set_size(array, index+1) != LAM_SUCCESS)
|
||||
return NULL;
|
||||
return array->array_items + (index * array->array_item_sizeof);
|
||||
}
|
||||
|
||||
/**
|
||||
* Macro to set an array element by value.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item_type The C datatype of the array item (IN).
|
||||
* @param item_index The array index (IN).
|
||||
* @param item_value The new value for the specified index (IN).
|
||||
*
|
||||
* Note that this does not change the size of the array - this macro is
|
||||
* strictly for performance - the user assumes the responsibility of
|
||||
* ensuring the array index is valid (0 <= item index < array size).
|
||||
*
|
||||
* It is safe to free the item after returning from this call; it is
|
||||
* copied into the array by value.
|
||||
*/
|
||||
|
||||
#define LAM_VALUE_ARRAY_SET_ITEM(array, item_type, item_index, item_value) \
|
||||
(((item_type*)((array)->array_items))[item_index] = item_value)
|
||||
|
||||
/**
|
||||
* Set an array element by value.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item_index The array index (IN).
|
||||
* @param item_value A pointer to the item, which is copied into
|
||||
* the array.
|
||||
*
|
||||
* @return LAM error code.
|
||||
*
|
||||
* It is safe to free the item after returning from this call; it is
|
||||
* copied into the array by value.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_set_item(lam_value_array_t *array, size_t index, const void* item)
|
||||
{
|
||||
int rc;
|
||||
if(index >= array->array_size &&
|
||||
(rc = lam_value_array_set_size(array, index+1)) != LAM_SUCCESS)
|
||||
return rc;
|
||||
memcpy(array->array_items + (index * array->array_item_sizeof), item, array->array_item_sizeof);
|
||||
return LAM_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Appends an item to the end of the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item A pointer to the item to append, which is copied
|
||||
* into the array.
|
||||
*
|
||||
* @return LAM error code
|
||||
*
|
||||
* This will grow the array if it is not large enough to contain the
|
||||
* item. It is safe to free the item after returning from this call;
|
||||
* it is copied by value into the array.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_append_item(lam_value_array_t *array, const void *item)
|
||||
{
|
||||
return lam_value_array_set_item(array, array->array_size, item);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Remove a specific item from the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param index The index to remove, which must be less than
|
||||
* the current array size (IN).
|
||||
*
|
||||
* @return LAM error code.
|
||||
*
|
||||
* All elements following this index are shifted down.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_remove_item(lam_value_array_t *array, size_t index)
|
||||
{
|
||||
#if LAM_ENABLE_DEBUG
|
||||
if (index >= array->array_size) {
|
||||
lam_output(0, "lam_value_array_remove_item: invalid index %d\n", index);
|
||||
return LAM_ERR_BAD_PARAM;
|
||||
}
|
||||
#endif
|
||||
memmove(array->array_items+(array->array_item_sizeof * index),
|
||||
array->array_items+(array->array_item_sizeof * (index+1)),
|
||||
array->array_item_sizeof * (array->array_size - index - 1));
|
||||
array->array_size--;
|
||||
return LAM_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the base pointer of the underlying array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param array_type The C datatype of the array (IN).
|
||||
*
|
||||
* @returns ptr Pointer to the actual array.
|
||||
*
|
||||
* This function is helpful when you need to iterate through an
|
||||
* entire array; simply get the base value of the array and use native
|
||||
* C to iterate through it manually. This can have better performance
|
||||
* than looping over LAM_VALUE_ARRAY_GET_ITEM() and
|
||||
* LAM_VALUE_ARRAY_SET_ITEM() because it will [potentially] reduce the
|
||||
* number of pointer dereferences.
|
||||
*/
|
||||
|
||||
#define LAM_VALUE_ARRAY_GET_BASE(array, item_type) \
|
||||
((item_type*) ((array)->array_items))
|
||||
|
||||
#if defined(c_plusplus) || defined(__cplusplus)
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* $HEADER$
|
||||
*/
|
||||
|
||||
#ifndef LAM_VALUE_ARRAY_H
|
||||
#define LAM_VALUE_ARRAY_H
|
||||
|
||||
#include <string.h>
|
||||
#include "lam_config.h"
|
||||
#include "lam/constants.h"
|
||||
#include "lam/types.h"
|
||||
#include "lam/lfc/object.h"
|
||||
#if LAM_ENABLE_DEBUG
|
||||
#include "lam/util/output.h"
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* Array of elements maintained by value.
|
||||
*/
|
||||
|
||||
extern lam_class_info_t lam_value_array_t_class_info;
|
||||
|
||||
|
||||
struct lam_value_array_t
|
||||
{
|
||||
lam_object_t super;
|
||||
unsigned char* array_items;
|
||||
size_t array_item_sizeof;
|
||||
size_t array_size;
|
||||
size_t array_alloc_size;
|
||||
};
|
||||
typedef struct lam_value_array_t lam_value_array_t;
|
||||
|
||||
|
||||
#if defined(c_plusplus) || defined(__cplusplus)
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Initialize the array to hold items by value. This routine must
|
||||
* be called prior to using the array.
|
||||
*
|
||||
* @param array The array to initialize (IN).
|
||||
* @param item_size The sizeof each array element (IN).
|
||||
* @return LAM error code
|
||||
*
|
||||
* Note that there is no corresponding "finalize" function -- use
|
||||
* OBJ_DESTRUCT (for stack arrays) or OBJ_RELEASE (for heap arrays) to
|
||||
* delete it.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_init(lam_value_array_t *array, size_t item_sizeof)
|
||||
{
|
||||
array->array_item_sizeof = item_sizeof;
|
||||
array->array_alloc_size = 1;
|
||||
array->array_items = malloc(item_sizeof * array->array_alloc_size);
|
||||
return (NULL != array->array_items) ? LAM_SUCCESS : LAM_ERR_OUT_OF_RESOURCE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retreives the number of elements in the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @return The number of elements currently in use.
|
||||
*/
|
||||
|
||||
static inline size_t lam_value_array_get_size(lam_value_array_t* array)
|
||||
{
|
||||
return array->array_size;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the number of elements in the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param size The new array size.
|
||||
*
|
||||
* @return LAM error code.
|
||||
*
|
||||
* Note that resizing the array to a smaller size may not change
|
||||
* the underlying memory allocated by the array. However, setting
|
||||
* the size larger than the current allocation will grow it. In either
|
||||
* case, if the routine is successful, lam_value_array_get_size() will
|
||||
* return the new size.
|
||||
*/
|
||||
|
||||
int lam_value_array_set_size(lam_value_array_t* array, size_t size);
|
||||
|
||||
|
||||
/**
|
||||
* Macro to retrieve an item from the array by value.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item_type The C datatype of the array item (IN).
|
||||
* @param item_index The array index (IN).
|
||||
*
|
||||
* @returns item The requested item.
|
||||
*
|
||||
* Note that this does not change the size of the array - this macro is
|
||||
* strictly for performance - the user assumes the responsibility of
|
||||
* ensuring the array index is valid (0 <= item index < array size).
|
||||
*/
|
||||
|
||||
#define LAM_VALUE_ARRAY_GET_ITEM(array, item_type, item_index) \
|
||||
((item_type*)((array)->array_items))[item_index]
|
||||
|
||||
/**
|
||||
* Retrieve an item from the array by reference.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param index The array index (IN).
|
||||
*
|
||||
* @return ptr Pointer to the requested item.
|
||||
*
|
||||
* Note that if the specified index is larger than the current
|
||||
* array size, the array is grown to satisfy the request.
|
||||
*/
|
||||
|
||||
static inline void* lam_value_array_get_item(lam_value_array_t *array, size_t index)
|
||||
{
|
||||
if(index >= array->array_size && lam_value_array_set_size(array, index+1) != LAM_SUCCESS)
|
||||
return NULL;
|
||||
return array->array_items + (index * array->array_item_sizeof);
|
||||
}
|
||||
|
||||
/**
|
||||
* Macro to set an array element by value.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item_type The C datatype of the array item (IN).
|
||||
* @param item_index The array index (IN).
|
||||
* @param item_value The new value for the specified index (IN).
|
||||
*
|
||||
* Note that this does not change the size of the array - this macro is
|
||||
* strictly for performance - the user assumes the responsibility of
|
||||
* ensuring the array index is valid (0 <= item index < array size).
|
||||
*
|
||||
* It is safe to free the item after returning from this call; it is
|
||||
* copied into the array by value.
|
||||
*/
|
||||
|
||||
#define LAM_VALUE_ARRAY_SET_ITEM(array, item_type, item_index, item_value) \
|
||||
(((item_type*)((array)->array_items))[item_index] = item_value)
|
||||
|
||||
/**
|
||||
* Set an array element by value.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item_index The array index (IN).
|
||||
* @param item_value A pointer to the item, which is copied into
|
||||
* the array.
|
||||
*
|
||||
* @return LAM error code.
|
||||
*
|
||||
* It is safe to free the item after returning from this call; it is
|
||||
* copied into the array by value.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_set_item(lam_value_array_t *array, size_t index, const void* item)
|
||||
{
|
||||
int rc;
|
||||
if(index >= array->array_size &&
|
||||
(rc = lam_value_array_set_size(array, index+1)) != LAM_SUCCESS)
|
||||
return rc;
|
||||
memcpy(array->array_items + (index * array->array_item_sizeof), item, array->array_item_sizeof);
|
||||
return LAM_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Appends an item to the end of the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param item A pointer to the item to append, which is copied
|
||||
* into the array.
|
||||
*
|
||||
* @return LAM error code
|
||||
*
|
||||
* This will grow the array if it is not large enough to contain the
|
||||
* item. It is safe to free the item after returning from this call;
|
||||
* it is copied by value into the array.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_append_item(lam_value_array_t *array, const void *item)
|
||||
{
|
||||
return lam_value_array_set_item(array, array->array_size, item);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Remove a specific item from the array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param index The index to remove, which must be less than
|
||||
* the current array size (IN).
|
||||
*
|
||||
* @return LAM error code.
|
||||
*
|
||||
* All elements following this index are shifted down.
|
||||
*/
|
||||
|
||||
static inline int lam_value_array_remove_item(lam_value_array_t *array, size_t index)
|
||||
{
|
||||
#if LAM_ENABLE_DEBUG
|
||||
if (index >= array->array_size) {
|
||||
lam_output(0, "lam_value_array_remove_item: invalid index %d\n", index);
|
||||
return LAM_ERR_BAD_PARAM;
|
||||
}
|
||||
#endif
|
||||
memmove(array->array_items+(array->array_item_sizeof * index),
|
||||
array->array_items+(array->array_item_sizeof * (index+1)),
|
||||
array->array_item_sizeof * (array->array_size - index - 1));
|
||||
array->array_size--;
|
||||
return LAM_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the base pointer of the underlying array.
|
||||
*
|
||||
* @param array The input array (IN).
|
||||
* @param array_type The C datatype of the array (IN).
|
||||
*
|
||||
* @returns ptr Pointer to the actual array.
|
||||
*
|
||||
* This function is helpful when you need to iterate through an
|
||||
* entire array; simply get the base value of the array and use native
|
||||
* C to iterate through it manually. This can have better performance
|
||||
* than looping over LAM_VALUE_ARRAY_GET_ITEM() and
|
||||
* LAM_VALUE_ARRAY_SET_ITEM() because it will [potentially] reduce the
|
||||
* number of pointer dereferences.
|
||||
*/
|
||||
|
||||
#define LAM_VALUE_ARRAY_GET_BASE(array, item_type) \
|
||||
((item_type*) ((array)->array_items))
|
||||
|
||||
#if defined(c_plusplus) || defined(__cplusplus)
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
|
||||
|
||||
Загрузка…
Ссылка в новой задаче
Block a user