Akos Kiss
0d7ea70b41
* Fix "end of file while inside a group" doxygen warnings. * Fix "unknown command" doxygen warnings caused by incorrect argument references. Instead of `@foo`, `@a foo` is the proper format. * Fix "unknown command" doxygen warnings caused by incorrect parameter direction specifications. Instead of `@in`, `@out`, and `@in-out`, `[in]`, `[out]`, and `[in,out]` are the proper formats. * Wrapping special characters in quotes to avoid doxygen confusion. Raw pipe, semicolon, dot, backslash, etc. characters can drive doxygen into various misinterpretations and warnings. E.g.: ``` End of list marker found without any preceding list items Found unknown command ``` Putting quotes around such text snipets eliminates the errors. * Fix the documentation of `ecma_builtin_global_object_print`. Raw <> and \ sequences confused doxygen in various ways (it tried to interpret them as XML tags and doxygen commands). * Fix "ignoring title that does not match old title" doxygen warnings. At some places, the group titles were out of sync, at others, the group names were incorrect. * Fix "parameters are not documented" doxygen warnings. Fixing various typos in the inline parameter documentations (`/*`, `/**`, `/** <`, and `/**>` are all considered incorrect, the right format is `/**<`). JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
69 lines
2.3 KiB
C
69 lines
2.3 KiB
C
/* Copyright 2015 Samsung Electronics Co., Ltd.
|
|
*
|
|
* Licensed 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 RCS_CHUNKED_LIST_H
|
|
#define RCS_CHUNKED_LIST_H
|
|
|
|
#include "mem-allocator.h"
|
|
|
|
/** \addtogroup recordset Recordset
|
|
* @{
|
|
*
|
|
* \addtogroup chunkedlist Chunked list
|
|
*
|
|
* List of nodes with size exactly fit to one memory heap's chunk.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* List node
|
|
*/
|
|
typedef struct
|
|
{
|
|
mem_cpointer_t prev_cp; /**< prev list's node */
|
|
mem_cpointer_t next_cp; /**< next list's node */
|
|
} rcs_chunked_list_node_t;
|
|
|
|
/**
|
|
* Chunked list
|
|
*/
|
|
typedef struct
|
|
{
|
|
rcs_chunked_list_node_t *head_p; /**< head node of list */
|
|
rcs_chunked_list_node_t *tail_p; /**< tail node of list */
|
|
} rcs_chunked_list_t;
|
|
|
|
extern void rcs_chunked_list_init (rcs_chunked_list_t *);
|
|
extern void rcs_chunked_list_free (rcs_chunked_list_t *);
|
|
extern void rcs_chunked_list_cleanup (rcs_chunked_list_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_get_first (rcs_chunked_list_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_get_last (rcs_chunked_list_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_get_prev (rcs_chunked_list_node_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_get_next (rcs_chunked_list_node_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_append_new (rcs_chunked_list_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_insert_new (rcs_chunked_list_t *, rcs_chunked_list_node_t *);
|
|
extern void rcs_chunked_list_remove (rcs_chunked_list_t *, rcs_chunked_list_node_t *);
|
|
extern rcs_chunked_list_node_t *rcs_chunked_list_get_node_from_pointer (rcs_chunked_list_t *, void *);
|
|
extern uint8_t *rcs_chunked_list_get_node_data_space (rcs_chunked_list_t *, rcs_chunked_list_node_t *);
|
|
extern size_t rcs_chunked_list_get_node_data_space_size (void);
|
|
|
|
/**
|
|
* @}
|
|
* @}
|
|
*/
|
|
|
|
#endif /* RCS_CHUNKED_LIST_H */
|