/*---------------------------------------------------------------------------
    icl_cache_list.c - icl_cache_list component

    This class implements the list container for icl_cache
    Generated from icl_cache_list.icl by icl_gen using GSL/4.
    
    Copyright (c) 1996-2009 iMatix Corporation
    All rights reserved.
    
    This file is licensed under the BSD license as follows:
    
    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 iMatix Corporation 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 IMATIX CORPORATION "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 IMATIX CORPORATION 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.
 *---------------------------------------------------------------------------*/

#include "icl.h"                        //  iCL base classes
#include "icl_cache_list.h"             //  Definitions for our class

//  Shorthand for class type                                                   

#define self_t              icl_cache_list_t

//  Shorthands for class methods                                               

#define self_new            icl_cache_list_new
#define self_annihilate     icl_cache_list_annihilate
#define self_selftest       icl_cache_list_selftest
#define self_isempty        icl_cache_list_isempty
#define self_push           icl_cache_list_push
#define self_pop            icl_cache_list_pop
#define self_queue          icl_cache_list_queue
#define self_relink_before  icl_cache_list_relink_before
#define self_remove         icl_cache_list_remove
#define self_first          icl_cache_list_first
#define self_last           icl_cache_list_last
#define self_next           icl_cache_list_next
#define self_prev           icl_cache_list_prev
#define self_rehook         icl_cache_list_rehook
#define self_unhook         icl_cache_list_unhook
#define self_terminate      icl_cache_list_terminate
#define self_show           icl_cache_list_show
#define self_destroy        icl_cache_list_destroy
#define self_alloc          icl_cache_list_alloc
#define self_free           icl_cache_list_free
#define self_lock           icl_cache_list_lock
#define self_unlock         icl_cache_list_unlock
#define self_show_animation  icl_cache_list_show_animation
#define self_new_in_scope   icl_cache_list_new_in_scope

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_NEW))
static icl_stats_t *s_icl_cache_list_new_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_DESTROY))
static icl_stats_t *s_icl_cache_list_annihilate_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_SELFTEST))
static icl_stats_t *s_icl_cache_list_selftest_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_ISEMPTY))
static icl_stats_t *s_icl_cache_list_isempty_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_PUSH))
static icl_stats_t *s_icl_cache_list_push_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_POP))
static icl_stats_t *s_icl_cache_list_pop_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_QUEUE))
static icl_stats_t *s_icl_cache_list_queue_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_RELINK_BEFORE))
static icl_stats_t *s_icl_cache_list_relink_before_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_REMOVE))
static icl_stats_t *s_icl_cache_list_remove_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_FIRST))
static icl_stats_t *s_icl_cache_list_first_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_LAST))
static icl_stats_t *s_icl_cache_list_last_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_NEXT))
static icl_stats_t *s_icl_cache_list_next_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_PREV))
static icl_stats_t *s_icl_cache_list_prev_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_REHOOK))
static icl_stats_t *s_icl_cache_list_rehook_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_UNHOOK))
static icl_stats_t *s_icl_cache_list_unhook_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_TERMINATE))
static icl_stats_t *s_icl_cache_list_terminate_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_SHOW))
static icl_stats_t *s_icl_cache_list_show_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_DESTROY_PUBLIC))
static icl_stats_t *s_icl_cache_list_destroy_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_ALLOC))
static icl_stats_t *s_icl_cache_list_alloc_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_FREE))
static icl_stats_t *s_icl_cache_list_free_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_LOCK))
static icl_stats_t *s_icl_cache_list_lock_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_UNLOCK))
static icl_stats_t *s_icl_cache_list_unlock_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_SHOW_ANIMATION))
static icl_stats_t *s_icl_cache_list_show_animation_stats = NULL;
#endif
#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_NEW_IN_SCOPE))
static icl_stats_t *s_icl_cache_list_new_in_scope_stats = NULL;
#endif
static void
    icl_cache_list_annihilate (
icl_cache_list_t * ( * self_p )         //  Reference to object reference
);

static inline void
    icl_cache_list_rehook (
icl_cache_t * item,                     //  Not documented
icl_cache_t * left,                     //  Not documented
icl_cache_t * right                     //  Not documented
);

static inline icl_cache_t *
    icl_cache_list_unhook (
icl_cache_t * item                      //  Not documented
);

#define icl_cache_list_alloc()          icl_cache_list_alloc_ (__FILE__, __LINE__)
static icl_cache_list_t *
    icl_cache_list_alloc_ (
char * file,                            //  Source file for call
size_t line                             //  Line number for call
);

static void
    icl_cache_list_free (
icl_cache_list_t * self                 //  Object reference
);

Bool
    icl_cache_list_animating = TRUE;    //  Animation enabled by default

/*  -------------------------------------------------------------------------
    icl_cache_list_new

    Type: Component method
    Creates and initialises a new icl_cache_list_t object, returns a
    reference to the created object.
    -------------------------------------------------------------------------
 */

icl_cache_list_t *
    icl_cache_list_new_ (
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{
    icl_cache_list_t *
        self = NULL;                    //  Object reference

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_NEW))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_new_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_NEW))
    icl_stats_inc ("icl_cache_list_new", &s_icl_cache_list_new_stats);
#endif

    self = icl_cache_list_alloc_ (file, line);
    if (self) {
        self->object_tag   = ICL_CACHE_LIST_ALIVE;
#if (defined (BASE_THREADSAFE))
        self->mutex = icl_mutex_new ();
#endif

self->icl_cache.list_next = &self->icl_cache;
self->icl_cache.list_prev = &self->icl_cache;
self->icl_cache.list_head = self;

}
#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_NEW))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_new_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" file=\"%s\""
" line=\"%u\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, file, line, self);
#endif


    return (self);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_annihilate

    Type: Component method
    Destroys the list and unlinks all attached items.
    -------------------------------------------------------------------------
 */

static void
    icl_cache_list_annihilate (
    icl_cache_list_t * ( * self_p )     //  Reference to object reference
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif

icl_cache_t
    *item;
    icl_cache_list_t *
        self = *self_p;                 //  Dereferenced Reference to object reference

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_DESTROY))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_destroy_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, self);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_DESTROY))
    icl_stats_inc ("icl_cache_list_annihilate", &s_icl_cache_list_annihilate_stats);
#endif

    ICL_CACHE_LIST_ASSERT_SANE (self);
#if (defined (BASE_THREADSAFE))
    mutex = self->mutex;
    if (mutex)
         icl_mutex_lock (mutex);
#endif

item = (icl_cache_t *) self->icl_cache.list_next;
while (item != &self->icl_cache) {
    //  Unlink child without lock (we already have the lock)               
    icl_cache_list_unhook (item);

    icl_cache_destroy (&item);
    item = (icl_cache_t *) self->icl_cache.list_next;
}
#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_DESTROY))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_destroy_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, self);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_selftest

    Type: Component method
    -------------------------------------------------------------------------
 */

void
    icl_cache_list_selftest (
void)
{

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_SELFTEST))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_selftest_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_SELFTEST))
    icl_stats_inc ("icl_cache_list_selftest", &s_icl_cache_list_selftest_stats);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_SELFTEST))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_selftest_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_isempty

    Type: Component method
    Accepts a icl_cache_list_t reference and returns zero in case of success,
    1 in case of errors.
    Returns true if the list is empty, else returns false.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_isempty (
    icl_cache_list_t * self             //  Reference to object
)
{
    int
        rc = 0;                         //  Return code

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_ISEMPTY))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_isempty_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_ISEMPTY))
    icl_stats_inc ("icl_cache_list_isempty", &s_icl_cache_list_isempty_stats);
#endif

ICL_CACHE_LIST_ASSERT_SANE (self);

rc = (self->icl_cache.list_next == &self->icl_cache);

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_ISEMPTY))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_isempty_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" rc=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, rc);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_push

    Type: Component method
    Accepts a icl_cache_list_t reference and returns zero in case of success,
    1 in case of errors.
    Attaches the item to the start of the specified list. If the item
    was on another list, it is first detached.  After this method,
    list->next points to the item.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_push (
    icl_cache_list_t * self,            //  Reference to object
    icl_cache_t * item                  //  Not documented
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    int
        rc = 0;                         //  Return code

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_PUSH))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_push_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, item);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_PUSH))
    icl_stats_inc ("icl_cache_list_push", &s_icl_cache_list_push_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


ICL_CACHE_LIST_ASSERT_SANE (self);

//  If list_head is non-null then we are moving within the
//  list to another so don't need to adjust links. Otherwise it
//  is illegitimate to move from one list to another in one step,
//  because we don't have a lock on the other list.
if (! item->list_head) {
}
else
if (item->list_head != self) {
    icl_console_print ("E: icl_cache item inserted into multiple list containers");
    assert (item->list_head == self);
}
icl_cache_list_unhook (item);
icl_cache_list_rehook (item, &self->icl_cache, (icl_cache_t *) self->icl_cache.list_next);


#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_PUSH))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_push_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" item=\"%pp\""
" rc=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, item, rc);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_pop

    Type: Component method
    Removes the next item in the list, if any, and returns it.  If
    the list was empty, returns NULL.
    
    The number of links is unchanged; removing from the list and returning
    the value cancel each other out.
    -------------------------------------------------------------------------
 */

icl_cache_t *
    icl_cache_list_pop (
    icl_cache_list_t * self             //  The list
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    icl_cache_t *
        item = NULL;                    //  Not documented

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_POP))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_pop_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_POP))
    icl_stats_inc ("icl_cache_list_pop", &s_icl_cache_list_pop_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


ICL_CACHE_LIST_ASSERT_SANE (self);

if (self->icl_cache.list_next == &self->icl_cache)
    item = NULL;
else {
    item = icl_cache_list_unhook ((icl_cache_t *) self->icl_cache.list_next);
}


#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_POP))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_pop_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, item);
#endif


    return (item);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_queue

    Type: Component method
    Accepts a icl_cache_list_t reference and returns zero in case of success,
    1 in case of errors.
    Attaches the item to the end of the specified list.  The item may not
    be in another list of the same class.
    
    The number of links is automatically adjusted - if the item was already
    in the list, it remains unchanged; otherwise it is incremented.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_queue (
    icl_cache_list_t * self,            //  Reference to object
    icl_cache_t * item                  //  Not documented
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    int
        rc = 0;                         //  Return code

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_QUEUE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_queue_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, item);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_QUEUE))
    icl_stats_inc ("icl_cache_list_queue", &s_icl_cache_list_queue_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


ICL_CACHE_LIST_ASSERT_SANE (self);

//  If list_head is non-null then we are moving within the             
//  list to another so don't need to adjust links. Otherwise it        
//  is illegitimate to move from one list to another in one step,      
//  because we don't have a lock on the other list.                    
if (! item->list_head) {
}
else
if (item->list_head != self) {
    icl_console_print ("E: icl_cache item inserted into multiple list containers");
    assert (item->list_head == self);
}
icl_cache_list_unhook (item);
icl_cache_list_rehook (item, (icl_cache_t *) self->icl_cache.list_prev, &self->icl_cache);


#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_QUEUE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_queue_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" item=\"%pp\""
" rc=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, item, rc);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_relink_before

    Type: Component method
    Accepts a icl_cache_list_t reference and returns zero in case of success,
    1 in case of errors.
    Attaches the item before a specified item. If the item was on another list,
    it is first detached.
    
    The number of links is automatically adjusted - if the item was previously
    in a list, it remains unchanged; otherwise it is incremented.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_relink_before (
    icl_cache_t * item,                 //  Not documented
    icl_cache_t * where                 //  Not documented
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    int
        rc = 0;                         //  Return code
    icl_cache_list_t *
        self = (icl_cache_list_t *) where->list_head;  //  The list

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_RELINK_BEFORE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_relink_before_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" where=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, where);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_RELINK_BEFORE))
    icl_stats_inc ("icl_cache_list_relink_before", &s_icl_cache_list_relink_before_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


ICL_CACHE_LIST_ASSERT_SANE (self);

//  If list_head is non-null then we are moving within the             
//  list to another so don't need to adjust links. Otherwise it        
//  is illegitimate to move from one list to another in one step,      
//  because we don't have a lock on the other list.                    
if (! item->list_head) {
}
else
if (item->list_head != self) {
    icl_console_print ("E: icl_cache item inserted into multiple list containers");
    assert (item->list_head == self);
}            
icl_cache_list_unhook (item);
icl_cache_list_rehook (item, (icl_cache_t *) where->list_prev, where);


#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_RELINK_BEFORE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_relink_before_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" where=\"%pp\""
" rc=\"%i\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, where, rc, self);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_remove

    Type: Component method
    Removes the item from any list it is in.
    
    If it was in a list, the number of links is decremented.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_remove (
    icl_cache_t * item                  //  Not documented
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    icl_cache_list_t *
        self = (icl_cache_list_t *) item->list_head;  //  The list
    int
        rc = 0;                         //  Not documented

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_REMOVE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_remove_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_REMOVE))
    icl_stats_inc ("icl_cache_list_remove", &s_icl_cache_list_remove_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


if (self
&&  self == item->list_head) { //       Catch case where item moved
    icl_cache_list_unhook (item);
}

#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_REMOVE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_remove_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" self=\"%pp\""
" rc=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, self, rc);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_first

    Type: Component method
    Returns the first icl_cache item on the list.     If the list is empty,
    returns null.
    -------------------------------------------------------------------------
 */

icl_cache_t *
    icl_cache_list_first_ (
    icl_cache_list_t * self,            //  The list
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    icl_cache_t *
        item = NULL;                    //  Not documented

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_FIRST))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_first_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_FIRST))
    icl_stats_inc ("icl_cache_list_first", &s_icl_cache_list_first_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


ICL_CACHE_LIST_ASSERT_SANE (self);

item = (icl_cache_t *) self->icl_cache.list_next;
if (item == &self->icl_cache)
    item = NULL;



#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_FIRST))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_first_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, file, line, item);
#endif


    return (item);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_last

    Type: Component method
    Returns the last icl_cache item on the list.     If the list is empty,
    returns null.
    -------------------------------------------------------------------------
 */

icl_cache_t *
    icl_cache_list_last_ (
    icl_cache_list_t * self,            //  The list
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    icl_cache_t *
        item = NULL;                    //  Not documented

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_LAST))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_last_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_LAST))
    icl_stats_inc ("icl_cache_list_last", &s_icl_cache_list_last_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


ICL_CACHE_LIST_ASSERT_SANE (self);

item = (icl_cache_t *) self->icl_cache.list_prev;
if (item == &self->icl_cache)
    item = NULL;



#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_LAST))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_last_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, file, line, item);
#endif


    return (item);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_next

    Type: Component method
    Returns the following item on the icl_cache list. If the provided item
    is null, returns the first item.  If there were no (more) items, returns
    null.
    -------------------------------------------------------------------------
 */

icl_cache_t *
    icl_cache_list_next_ (
    icl_cache_t * ( * item_p ),         //  Not documented
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    icl_cache_t *
        item = *item_p;                 //  Dereferenced item
    icl_cache_t *
        next = NULL;                    //  The item to return
    icl_cache_list_t *
        self = (icl_cache_list_t *) item->list_head;  //  The list

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_NEXT))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_next_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, file, line, item);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_NEXT))
    icl_stats_inc ("icl_cache_list_next", &s_icl_cache_list_next_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


if (self
&&  self == item->list_head) { //       Catch case where item moved
    next = (icl_cache_t *) item->list_next;
    if (next == &self->icl_cache)
        next = NULL;

}


#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_NEXT))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_next_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" item=\"%pp\""
" next=\"%pp\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, file, line, item, next, self);
#endif


    return (next);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_prev

    Type: Component method
    Returns the preceding item on the icl_cache list. If the provided item
    is null, returns the last item.  If there were no (more) items, returns
    null.
    -------------------------------------------------------------------------
 */

icl_cache_t *
    icl_cache_list_prev_ (
    icl_cache_t * ( * item_p ),         //  Not documented
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{
#if (defined (BASE_THREADSAFE))
    icl_mutex_t
        *mutex;
#endif


    icl_cache_t *
        item = *item_p;                 //  Dereferenced item
    icl_cache_t *
        prev = NULL;                    //  The item to return
    icl_cache_list_t *
        self = (icl_cache_list_t *) item->list_head;  //  The list

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_PREV))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_prev_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, file, line, item);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_PREV))
    icl_stats_inc ("icl_cache_list_prev", &s_icl_cache_list_prev_stats);
#endif

#if (defined (BASE_THREADSAFE))
    mutex = self ? self->mutex : NULL;
    if (mutex)
        icl_mutex_lock (mutex);
#endif


if (self
&&  self == item->list_head) { //       Catch case where item moved
    prev = (icl_cache_t *) item->list_prev;
    if (prev == &self->icl_cache)
        prev = NULL;

}


#if (defined (BASE_THREADSAFE))
    if (mutex)
        icl_mutex_unlock (mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_PREV))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_prev_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" item=\"%pp\""
" prev=\"%pp\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, file, line, item, prev, self);
#endif


    return (prev);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_rehook

    Type: Component method
    -------------------------------------------------------------------------
 */

static inline void
    icl_cache_list_rehook (
    icl_cache_t * item,                 //  Not documented
    icl_cache_t * left,                 //  Not documented
    icl_cache_t * right                 //  Not documented
)
{
icl_cache_t
    *swap;

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_REHOOK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_rehook_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" left=\"%pp\""
" right=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, left, right);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_REHOOK))
    icl_stats_inc ("icl_cache_list_rehook", &s_icl_cache_list_rehook_stats);
#endif

swap = (icl_cache_t *) left->list_next;
left->list_next = item->list_next;
item->list_next = swap;

swap = (icl_cache_t *) item->list_prev;
item->list_prev = right->list_prev;
right->list_prev = swap;

item->list_head = left->list_head;
#if (defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_REHOOK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_rehook_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" left=\"%pp\""
" right=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, left, right);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_unhook

    Type: Component method
    -------------------------------------------------------------------------
 */

static inline icl_cache_t *
    icl_cache_list_unhook (
    icl_cache_t * item                  //  Not documented
)
{

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_UNHOOK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_unhook_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_UNHOOK))
    icl_stats_inc ("icl_cache_list_unhook", &s_icl_cache_list_unhook_stats);
#endif

icl_cache_list_rehook (item, (icl_cache_t *) item->list_prev, (icl_cache_t *) item->list_next);
item->list_head = NULL;
#if (defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_UNHOOK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_unhook_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item);
#endif


    return (item);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_terminate

    Type: Component method
    -------------------------------------------------------------------------
 */

void
    icl_cache_list_terminate (
void)
{

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_TERMINATE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_terminate_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_TERMINATE))
    icl_stats_inc ("icl_cache_list_terminate", &s_icl_cache_list_terminate_stats);
#endif


#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_TERMINATE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_terminate_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_show

    Type: Component method
    -------------------------------------------------------------------------
 */

void
    icl_cache_list_show_ (
    void * item,                        //  The opaque pointer
    int opcode,                         //  The callback opcode
    FILE * trace_file,                  //  File to print to
    char * file,                        //  Source file
    size_t line                         //  Line number
)
{
icl_cache_list_t
    *self;
int
    container_links;


#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_SHOW))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_show_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" opcode=\"%i\""
" trace_file=\"%pp\""
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, opcode, trace_file, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_SHOW))
    icl_stats_inc ("icl_cache_list_show", &s_icl_cache_list_show_stats);
#endif

self = item;
container_links = 0;
assert (opcode == ICL_CALLBACK_DUMP);

fprintf (trace_file, "    <icl_cache_list file = \"%s\" line = \"%lu\"  pointer = \"%p\" />\n", file, (unsigned long) line, self);

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_SHOW))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_show_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" item=\"%pp\""
" opcode=\"%i\""
" trace_file=\"%pp\""
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, item, opcode, trace_file, file, line);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_destroy

    Type: Component method
    Destroys a icl_cache_list_t object. Takes the address of a
    icl_cache_list_t reference (a pointer to a pointer) and nullifies the
    reference after use.  Does nothing if the reference is already
    null.
    Performs an agressive destroy of an object.  This involves:
    1. Removing the object from any containers it is in.
    2. Making the object an zombie
    3. Decrementing the object's link count
    4. If the link count is zero then freeing the object.
    -------------------------------------------------------------------------
 */

void
    icl_cache_list_destroy_ (
    icl_cache_list_t * ( * self_p ),    //  Reference to object reference
    char * file,                        //  Source fileSource file
    size_t line                         //  Line numberLine number
)
{
    icl_cache_list_t *
        self = *self_p;                 //  Dereferenced Reference to object reference

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_DESTROY_PUBLIC))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_destroy_public_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" self=\"%pp\""
" file=\"%s\""
" line=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, self, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_DESTROY_PUBLIC))
    icl_stats_inc ("icl_cache_list_destroy", &s_icl_cache_list_destroy_stats);
#endif

if (self) {
    icl_cache_list_annihilate (self_p);
    icl_cache_list_free ((icl_cache_list_t *) self);
    *self_p = NULL;
}
#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_DESTROY_PUBLIC))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_destroy_public_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" self=\"%pp\""
" file=\"%s\""
" line=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, self, file, line);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_alloc

    Type: Component method
    -------------------------------------------------------------------------
 */

static icl_cache_list_t *
    icl_cache_list_alloc_ (
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{

    icl_cache_list_t *
        self = NULL;                    //  Object reference

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_ALLOC))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_alloc_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_ALLOC))
    icl_stats_inc ("icl_cache_list_alloc", &s_icl_cache_list_alloc_stats);
#endif

self = (icl_cache_list_t *) malloc (sizeof (icl_cache_list_t));
if (self)
    memset (self, 0, sizeof (icl_cache_list_t));


#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_ALLOC))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_alloc_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" file=\"%s\""
" line=\"%u\""
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, file, line, self);
#endif


    return (self);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_free

    Type: Component method
    Freess a icl_cache_list_t object.
    -------------------------------------------------------------------------
 */

static void
    icl_cache_list_free (
    icl_cache_list_t * self             //  Object reference
)
{


#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_FREE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_free_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_FREE))
    icl_stats_inc ("icl_cache_list_free", &s_icl_cache_list_free_stats);
#endif

if (self) {

#if (defined (BASE_THREADSAFE))
    if (self->mutex)
        icl_mutex_destroy (&self->mutex);
#endif
        memset (&self->object_tag, 0, sizeof (icl_cache_list_t) - ((byte *) &self->object_tag - (byte *) self));
//        memset (self, 0, sizeof (icl_cache_list_t));
        self->object_tag = ICL_CACHE_LIST_DEAD;
        free (self);
    }
    self = NULL;
#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_FREE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_free_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_lock

    Type: Component method
    Accepts a icl_cache_list_t reference and returns zero in case of success,
    1 in case of errors.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_lock (
    icl_cache_list_t * self             //  Reference to object
)
{
    int
        rc = 0;                         //  Return code

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_LOCK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_lock_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_LOCK))
    icl_stats_inc ("icl_cache_list_lock", &s_icl_cache_list_lock_stats);
#endif

ICL_CACHE_LIST_ASSERT_SANE (self);

#if (defined (BASE_THREADSAFE))
    icl_mutex_lock (self->mutex);
#endif

#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_LOCK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_lock_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" rc=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, rc);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_unlock

    Type: Component method
    Accepts a icl_cache_list_t reference and returns zero in case of success,
    1 in case of errors.
    -------------------------------------------------------------------------
 */

int
    icl_cache_list_unlock (
    icl_cache_list_t * self             //  Reference to object
)
{
    int
        rc = 0;                         //  Return code

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_UNLOCK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_unlock_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_UNLOCK))
    icl_stats_inc ("icl_cache_list_unlock", &s_icl_cache_list_unlock_stats);
#endif

ICL_CACHE_LIST_ASSERT_SANE (self);

#if (defined (BASE_THREADSAFE))
    icl_mutex_unlock (self->mutex);
#endif


#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_UNLOCK))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_unlock_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self=\"%pp\""
" rc=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self, rc);
#endif


    return (rc);
}
/*  -------------------------------------------------------------------------
    icl_cache_list_show_animation

    Type: Component method
    Enables animation of the component. Animation is sent to stdout.
    To enable animation you must generate using the option -animate:1.
    -------------------------------------------------------------------------
 */

void
    icl_cache_list_show_animation (
    Bool enabled                        //  Are we enabling or disabling animation?
)
{

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_SHOW_ANIMATION))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_show_animation_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" enabled=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, enabled);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_SHOW_ANIMATION))
    icl_stats_inc ("icl_cache_list_show_animation", &s_icl_cache_list_show_animation_stats);
#endif

icl_cache_list_animating = enabled;
#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_SHOW_ANIMATION))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_show_animation_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" enabled=\"%i\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, enabled);
#endif

}
/*  -------------------------------------------------------------------------
    icl_cache_list_new_in_scope

    Type: Component method
    -------------------------------------------------------------------------
 */

void
    icl_cache_list_new_in_scope_ (
    icl_cache_list_t * * self_p,        //  Not documented
    icl_scope_t * _scope,               //  Not documented
    char * file,                        //  Source file for call
    size_t line                         //  Line number for call
)
{
    icl_destroy_t *
        _destroy;                       //  Not documented

#if (defined (BASE_ANIMATE)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST)  ||  defined (BASE_ANIMATE_ICL_CACHE_LIST_NEW_IN_SCOPE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_new_in_scope_start"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self_p=\"%pp\""
" _scope=\"%pp\""
" file=\"%s\""
" line=\"%u\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self_p, _scope, file, line);
#endif

#if (defined (BASE_STATS)  ||  defined (BASE_STATS_ICL_CACHE_LIST)  ||  defined (BASE_STATS_ICL_CACHE_LIST_NEW_IN_SCOPE))
    icl_stats_inc ("icl_cache_list_new_in_scope", &s_icl_cache_list_new_in_scope_stats);
#endif

*self_p = icl_cache_list_new_ (file,line);

if (*self_p) {
    _destroy = icl_destroy_new   ((void * *) self_p, (icl_destructor_fn *) icl_cache_list_destroy_);
    icl_destroy_list_queue (_scope, _destroy);
    icl_destroy_unlink (&_destroy);
}
#if (defined (BASE_ANIMATE)   || defined (BASE_ANIMATE_ICL_CACHE_LIST)   || defined (BASE_ANIMATE_ICL_CACHE_LIST_NEW_IN_SCOPE))
    if (icl_cache_list_animating)
        icl_console_print ("<icl_cache_list_new_in_scope_finish"
#if (defined (BASE_THREADSAFE))
" thread=\"%pp\""
#endif
" self_p=\"%pp\""
" _scope=\"%pp\""
" file=\"%s\""
" line=\"%u\""
" _destroy=\"%pp\""
"/>"
#if (defined (BASE_THREADSAFE))
, apr_os_thread_current ()
#endif
, self_p, _scope, file, line, _destroy);
#endif

}
//  Embed the version information in the resulting binary                      

char *icl_cache_list_version_start  = "VeRsIoNsTaRt:ipc";
char *icl_cache_list_component     = "icl_cache_list ";
char *icl_cache_list_version       = "1.0 ";
char *icl_cache_list_copyright     = "Copyright (c) 1996-2009 iMatix Corporation";
char *icl_cache_list_filename      = "icl_cache_list.icl ";
char *icl_cache_list_builddate     = "2009/02/19 ";
char *icl_cache_list_version_end   = "VeRsIoNeNd:ipc";

