stbllist.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _STBLLIST_H

#define _STBLLIST_H

#include "techtype.h"

//---Constant and macro definitions for public use-----------------------------

#define CREATE_LINK_LIST_HEADER(list) static LINK_LIST_HEADER list = {NULL, &list, &list}

//---Enumerations for public use-----------------------------------------------

//---Global type defs for public use-------------------------------------------

typedef struct
{
   void *next;
   void *prev;
} LINK_LIST_PTR_BLK;


typedef struct
{
   void *null_next;  // this MUST be in the same position as the next field in LINK_LIST_PTR_BLK. It
                     // is used to identify the header from an real block
   void *first;
   void *last;
} LINK_LIST_HEADER;

//---Global Function prototypes for public use---------------------------------
// Initialise the header variables of the linked list
// Note: Header space defined (NOT static) but not initlaised.
void STB_LLInitialiseHeader(LINK_LIST_HEADER *hdr);

void STB_LLAddBlockToEnd(LINK_LIST_HEADER *hdr, LINK_LIST_PTR_BLK *new_blk);
void STB_LLAddBlockToStart(LINK_LIST_HEADER *hdr, LINK_LIST_PTR_BLK *new_blk);
void STB_LLAddBlockBefore(LINK_LIST_PTR_BLK *blk, LINK_LIST_PTR_BLK *new_blk);
void STB_LLAddBlockAfter(LINK_LIST_PTR_BLK *blk, LINK_LIST_PTR_BLK *new_blk);

void STB_LLRemoveBlock(LINK_LIST_PTR_BLK *blk);

LINK_LIST_PTR_BLK* STB_LLGetNextBlock(LINK_LIST_PTR_BLK *blk);
LINK_LIST_PTR_BLK* STB_LLGetPrevBlock(LINK_LIST_PTR_BLK *blk);
LINK_LIST_PTR_BLK* STB_LLGetFirstBlock(LINK_LIST_HEADER *hdr);
LINK_LIST_PTR_BLK* STB_LLGetLastBlock(LINK_LIST_HEADER *hdr);
LINK_LIST_PTR_BLK* STB_LLGetBlock(LINK_LIST_HEADER *hdr, U16BIT num);
U16BIT STB_LLGetNumBlocks(LINK_LIST_HEADER *hdr);

BOOLEAN STB_LLCheckBlockInList(LINK_LIST_HEADER *hdr, LINK_LIST_PTR_BLK *blk);

BOOLEAN STB_LLSort(LINK_LIST_HEADER * ll_hdr, S16BIT (*cmp_func)(LINK_LIST_PTR_BLK **, LINK_LIST_PTR_BLK **));

#endif //  _STBLLIST_H

//*****************************************************************************
// End of file
//*****************************************************************************