src/Pegasus/Common/Linkable.h

   1 //%2006////////////////////////////////////////////////////////////////////////
   2 //
   3 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
   4 // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
   5 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
   6 // IBM Corp.; EMC Corporation, The Open Group.
   7 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
   8 // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
   9 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
  10 // EMC Corporation; VERITAS Software Corporation; The Open Group.
  11 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
  12 // EMC Corporation; Symantec Corporation; The Open Group.
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining a copy
  15 // of this software and associated documentation files (the "Software"), to
  16 // deal in the Software without restriction, including without limitation the
  17 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  18 // sell copies of the Software, and to permit persons to whom the Software is
  19 // furnished to do so, subject to the following conditions:
  20 //
  21 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
  22 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
  23 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
  24 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  25 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  26 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  27 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30 //==============================================================================
  31 //
  32 //%/////////////////////////////////////////////////////////////////////////////
  33
  34 #ifndef _Pegasus_Common_Linkable_h
  35 #define _Pegasus_Common_Linkable_h
  36
  37 #include <Pegasus/Common/Config.h>
  38 #include <Pegasus/Common/PegasusAssert.h>
  39 #include <Pegasus/Common/Magic.h>
  40 #include <cstring>
  41
  42 PEGASUS_NAMESPACE_BEGIN
  43
  44 /** Non-virtual base class for anything that can be placed into a List.
  45 */
  46 struct Linkable
  47 {
  48     Linkable() : next(0), prev(0), list(0)
  49     {
  50     }
  51
  52     ~Linkable()
  53     {
  54         PEGASUS_DEBUG_ASSERT(magic);
  55         memset(this, 0xDD, sizeof(Linkable));
  56     }
  57
  58     // ATTN: consider making private and fixing all places that have
  59     // copy constructors.
  60     Linkable(const Linkable&) : next(0), prev(0), list(0)
  61     {
  62     }
  63
  64 #ifdef PEGASUS_DEBUG
  65     Magic<0xEB1C2781> magic;
  66 #endif
  67     Linkable* next;
  68     Linkable* prev;
  69     // Backpointer to list that contains this element.
  70     class ListRep* list;
  71 };
  72
  73 PEGASUS_NAMESPACE_END
  74
  75 #endif /* _Pegasus_Common_Linkable_h */