//%LICENSE////////////////////////////////////////////////////////////////
//
// Licensed to The Open Group (TOG) under one or more contributor license
// agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
// this work for additional information regarding copyright ownership.
// Each contributor licenses this file to you under the OpenPegasus Open
// Source License; you may not use this file except in compliance with the
// License.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef _Pegasus_Common_Linkable_h
#define _Pegasus_Common_Linkable_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/PegasusAssert.h>
#include <Pegasus/Common/Magic.h>
#include <cstring>

PEGASUS_NAMESPACE_BEGIN

/** Non-virtual base class for anything that can be placed into a List.
*/
struct Linkable
{
    Linkable() : next(0), prev(0), list(0)
    {
    }

    ~Linkable()
    {
        PEGASUS_DEBUG_ASSERT(magic);
        memset(this, 0xDD, sizeof(Linkable));
    }

    // ATTN: consider making private and fixing all places that have
    // copy constructors.
    Linkable(const Linkable&) : next(0), prev(0), list(0)
    {
    }

#ifdef PEGASUS_DEBUG
    Magic<0xEB1C2781> magic;
#endif
    Linkable* next;
    Linkable* prev;
    // Backpointer to list that contains this element.
    class ListRep* list;
};

PEGASUS_NAMESPACE_END

#endif /* _Pegasus_Common_Linkable_h */