Source/System/NodeCores/Groups/Light/OSGLightReferenceCountTest.cpp

   1 /*---------------------------------------------------------------------------*\
   2  *                                Opensg                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                       Copyright 2007 by OpenSG Forum                      *
   6  *                                                                           *
   7  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
   8  *                                                                           *
   9 \*---------------------------------------------------------------------------*/
  10 /*---------------------------------------------------------------------------*\
  11  *                                License                                    *
  12  *                                                                           *
  13  * This library is free software; you can redistribute it and/or modify it   *
  14  * under the terms of the GNU Library General Public License as published    *
  15  * by the Free Software Foundation, version 2.                               *
  16  *                                                                           *
  17  * This library is distributed in the hope that it will be useful, but       *
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  20  * Library General Public License for more details.                          *
  21  *                                                                           *
  22  * You should have received a copy of the GNU Library General Public         *
  23  * License along with this library; if not, write to the Free Software       *
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  25  *                                                                           *
  26 \*---------------------------------------------------------------------------*/
  27 /*---------------------------------------------------------------------------*\
  28  *                                Changes                                    *
  29  *                                                                           *
  30  *                                                                           *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35 \*---------------------------------------------------------------------------*/
  36
  37 #include <UnitTest++.h>
  38
  39 #include "OSGFieldContainer.h"
  40 #include "OSGNode.h"
  41 #include "OSGNodeCore.h"
  42 #include "OSGGroup.h"
  43 #include "OSGDirectionalLight.h"
  44
  45 #include <iostream>
  46 #include <string>
  47 #include <vector>
  48
  49 SUITE(LightReferenceCountTests)
  50 {
  51
  52 TEST(ChildLinkingCleanup)
  53 {
  54     // Test lights, as their beacons can introduce loops in the pointer
  55     // structures (not really a problem, because the beacons ptrs are weak)
  56     //
  57     // np0[gp0] <------------+
  58     //  +----------+         |
  59     // np1[gp1]   np2[gp2]   | beacon
  60     //  |                    |
  61     // np3[lp0]--------------+
  62
  63     // create objects
  64
  65     OSG::NodeRecPtr  nrcp0(OSG::Node ::create());
  66     OSG::NodeRecPtr  nrcp1(OSG::Node ::create());
  67     OSG::NodeRecPtr  nrcp2(OSG::Node ::create());
  68     OSG::NodeRecPtr  nrcp3(OSG::Node ::create());
  69     OSG::GroupRecPtr grcp0(OSG::Group::create());
  70     OSG::GroupRecPtr grcp1(OSG::Group::create());
  71     OSG::GroupRecPtr grcp2(OSG::Group::create());
  72     OSG::LightRecPtr lrcp0(OSG::DirectionalLight::create());
  73
  74     OSG::Node  *np0 = nrcp0;
  75     OSG::Node  *np1 = nrcp1;
  76     OSG::Node  *np2 = nrcp2;
  77     OSG::Node  *np3 = nrcp3;
  78     OSG::Group *gp0 = grcp0;
  79     OSG::Group *gp1 = grcp1;
  80     OSG::Group *gp2 = grcp2;
  81     OSG::Light *lp0 = lrcp0;
  82
  83     OSG::UInt32 ni0 = nrcp0->getId();
  84     OSG::UInt32 ni1 = nrcp1->getId();
  85     OSG::UInt32 ni2 = nrcp2->getId();
  86     OSG::UInt32 ni3 = nrcp3->getId();
  87     OSG::UInt32 gi0 = grcp0->getId();
  88     OSG::UInt32 gi1 = grcp1->getId();
  89     OSG::UInt32 gi2 = grcp2->getId();
  90     OSG::UInt32 li0 = lrcp0->getId();
  91
  92     nrcp0->addChild(nrcp1);
  93     nrcp0->addChild(nrcp2);
  94     nrcp1->addChild(nrcp3);
  95
  96     nrcp0->setCore(grcp0);
  97     nrcp1->setCore(grcp1);
  98     nrcp2->setCore(grcp2);
  99     nrcp3->setCore(lrcp0);
 100
 101     lrcp0->setBeacon(nrcp0);
 102
 103     CHECK_EQUAL(1, nrcp0->getRefCount()    );
 104     CHECK_EQUAL(1, nrcp0->getWeakRefCount());
 105
 106     CHECK_EQUAL(2, nrcp1->getRefCount()    );
 107     CHECK_EQUAL(0, nrcp1->getWeakRefCount());
 108
 109     CHECK_EQUAL(2, nrcp2->getRefCount()    );
 110     CHECK_EQUAL(0, nrcp2->getWeakRefCount());
 111
 112     CHECK_EQUAL(2, grcp0->getRefCount()    );
 113     CHECK_EQUAL(0, grcp0->getWeakRefCount());
 114
 115     CHECK_EQUAL(2, grcp1->getRefCount()    );
 116     CHECK_EQUAL(0, grcp1->getWeakRefCount());
 117
 118     CHECK_EQUAL(2, grcp2->getRefCount()    );
 119     CHECK_EQUAL(0, grcp2->getWeakRefCount());
 120
 121     CHECK_EQUAL(2, lrcp0->getRefCount()    );
 122     CHECK_EQUAL(0, lrcp0->getWeakRefCount());
 123
 124     // remove all ref pointers (i.e. all application refs) except nrcp0
 125
 126     nrcp1 = NULL;
 127     nrcp2 = NULL;
 128     nrcp3 = NULL;
 129     grcp0 = NULL;
 130     grcp1 = NULL;
 131     grcp2 = NULL;
 132     lrcp0 = NULL;
 133
 134     OSG::commitChanges();
 135
 136     // only nrcp0 is still here, check everything is still alive and has
 137     // the expected ref counts
 138
 139     CHECK_EQUAL(np0, OSG::FieldContainerFactory::the()->getContainer(ni0));
 140     CHECK_EQUAL(np1, OSG::FieldContainerFactory::the()->getContainer(ni1));
 141     CHECK_EQUAL(np2, OSG::FieldContainerFactory::the()->getContainer(ni2));
 142     CHECK_EQUAL(np3, OSG::FieldContainerFactory::the()->getContainer(ni3));
 143     CHECK_EQUAL(gp0, OSG::FieldContainerFactory::the()->getContainer(gi0));
 144     CHECK_EQUAL(gp1, OSG::FieldContainerFactory::the()->getContainer(gi1));
 145     CHECK_EQUAL(gp2, OSG::FieldContainerFactory::the()->getContainer(gi2));
 146     CHECK_EQUAL(lp0, OSG::FieldContainerFactory::the()->getContainer(li0));
 147
 148     CHECK_EQUAL(1, np0->getRefCount()    );
 149     CHECK_EQUAL(2, np0->getWeakRefCount()); // light chunk keeps additional weak ref
 150
 151     CHECK_EQUAL(1, np1->getRefCount()    );
 152     CHECK_EQUAL(0, np1->getWeakRefCount());
 153
 154     CHECK_EQUAL(1, np2->getRefCount()    );
 155     CHECK_EQUAL(0, np2->getWeakRefCount());
 156
 157     CHECK_EQUAL(1, np3->getRefCount()    );
 158     CHECK_EQUAL(0, np3->getWeakRefCount());
 159
 160     // remove nrcp0 as well, everything should clean up
 161
 162     nrcp0 = NULL;
 163
 164     OSG::commitChanges();
 165
 166     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(ni0));
 167     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(ni1));
 168     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(ni2));
 169     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(ni3));
 170     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(gi0));
 171     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(gi1));
 172     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(gi2));
 173     CHECK_EQUAL(static_cast<OSG::FieldContainer *>(NULL), OSG::FieldContainerFactory::the()->getContainer(li0));
 174 }
 175
 176 } // SUITE(LightReferenceCountTests)