xref: /FreeRTOS-Plus-TCP-v4.0.0/test/unit-test/FreeRTOS_Stream_Buffer/list_macros.h (revision 1ab6eb88857cf1011bf1f8349b43a1c34c7ced0f) 
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 #ifndef LIST_MACRO_H
29 #define LIST_MACRO_H
30 
31 #include <FreeRTOS.h>
32 #include <portmacro.h>
33 #include <list.h>
34 
35 #undef listSET_LIST_ITEM_OWNER
36 void listSET_LIST_ITEM_OWNER( ListItem_t * pxListItem,
37                               void * owner );
38 
39 #undef listGET_END_MARKER
40 ListItem_t * listGET_END_MARKER( List_t * pxList );
41 
42 #undef listGET_NEXT
43 ListItem_t * listGET_NEXT( const ListItem_t * pxListItem );
44 
45 #undef  listLIST_IS_EMPTY
46 BaseType_t listLIST_IS_EMPTY( const List_t * pxList );
47 
48 #undef  listGET_OWNER_OF_HEAD_ENTRY
49 void * listGET_OWNER_OF_HEAD_ENTRY( const List_t * pxList );
50 
51 #undef listIS_CONTAINED_WITHIN
52 BaseType_t listIS_CONTAINED_WITHIN( List_t * list,
53                                     const ListItem_t * listItem );
54 
55 #undef listGET_LIST_ITEM_VALUE
56 TickType_t listGET_LIST_ITEM_VALUE( const ListItem_t * listItem );
57 
58 #undef listSET_LIST_ITEM_VALUE
59 void listSET_LIST_ITEM_VALUE( ListItem_t * listItem,
60                               TickType_t itemValue );
61 
62 
63 #undef listLIST_ITEM_CONTAINER
64 List_t * listLIST_ITEM_CONTAINER( const ListItem_t * listItem );
65 
66 #undef listCURRENT_LIST_LENGTH
67 UBaseType_t listCURRENT_LIST_LENGTH( List_t * list );
68 
69 #undef listGET_ITEM_VALUE_OF_HEAD_ENTRY
70 TickType_t listGET_ITEM_VALUE_OF_HEAD_ENTRY( List_t * list );
71 
72 #undef listGET_LIST_ITEM_OWNER
73 void * listGET_LIST_ITEM_OWNER( const ListItem_t * listItem );
74 
75 #endif /* ifndef LIST_MACRO_H */
76