List.h

Go to the documentation of this file.

/* 
 *  ============================================================================
 *
 *  Copyright (c) 2008-2012, Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *  *  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  
 *  *  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  
 *  *  Neither the name of Texas Instruments Incorporated nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  Contact information for paper mail:
 *  Texas Instruments
 *  Post Office Box 655303
 *  Dallas, Texas 75265
 *  Contact information: 
 *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
 *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
 *  ============================================================================
 *  
 */



#ifndef LIST_H_0XB734
#define LIST_H_0XB734



#if defined (__cplusplus)
extern "C" {
#endif


/* =============================================================================
 *  Macros and types
 * =============================================================================
 */
#define List_traverse(x,y) for(x = (List_Elem *)((List_Object *)y)->elem.next; \
                               (UInt32) x != (UInt32)&((List_Object *)y)->elem;\
                                x = x->next)

typedef struct List_Elem_tag {
    struct List_Elem_tag *  next; 
    struct List_Elem_tag *  prev; 
} List_Elem;

typedef struct List_Object_tag {
    List_Elem            elem;
} List_Object;

typedef List_Object * List_Handle;

typedef struct List_Params_tag {
    UInt32        temp;
} List_Params;


/* =============================================================================
 *  APIs
 * =============================================================================
 */
Void List_Params_init (List_Params * params);

List_Handle List_create (List_Params * params, Error_Block *eb);

Void List_delete (List_Handle * handlePtr);

Void List_construct (List_Object * obj, List_Params * params);

Void List_destruct (List_Object * obj);

Void List_elemClear (List_Elem * elem);

Bool List_empty (List_Handle handle);

Ptr List_get (List_Handle handle);

Void List_put (List_Handle handle, List_Elem * elem);

Ptr List_next (List_Handle handle, List_Elem * elem);

Ptr List_prev (List_Handle handle, List_Elem * elem);

Void List_insert (List_Handle handle, List_Elem * newElem, List_Elem * curElem);

Void List_remove (List_Handle handle, List_Elem * elem);

Void List_putHead (List_Handle handle, List_Elem * elem);

Ptr List_dequeue (List_Handle handle);

Void List_enqueue (List_Handle handle, List_Elem * elem);

Void List_enqueueHead (List_Handle handle, List_Elem * elem);


#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */


#endif /* LIST_H_0XB734 */