Source

Coin / src / elements / SoCacheElement.cpp

Morten Eriksen 08431c9 
Marius Kintel 3ba6b41 




























Morten Eriksen 08431c9 



Morten Eriksen 09145b8 
Morten Eriksen f2417c6 
Morten Eriksen 08431c9 

Morten Eriksen 09145b8 



Tom Fredrik Blen… c56c6a7 

Morten Eriksen 09145b8 
Morten Eriksen ce36d00 


Peder Blekken a2596fb 
Lars J. Aas 92263e4 



Peder Blekken 6b9317e 
Peder Blekken a2596fb 
Peder Blekken 6b9317e 
Peder Blekken a2596fb 
Lars J. Aas 92263e4 
Tom Fredrik Blen… c56c6a7 

Lars J. Aas 92263e4 
Morten Eriksen 09145b8 
Morten Eriksen 08431c9 
Morten Eriksen 99ffb52 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 
Peder Blekken a2596fb 
Peder Blekken 6b9317e 
Morten Eriksen 09145b8 
Morten Eriksen ce36d00 
Peder Blekken a2596fb 






Peder Blekken 6b9317e 
Peder Blekken a2596fb 
Morten Eriksen 09145b8 

Morten Eriksen 84ccf60 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 
Morten Eriksen 08431c9 
Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Morten Eriksen 84ccf60 
Marius Kintel 7081bb2 
Peder Blekken a2596fb 
Peder Blekken 6b9317e 
Peder Blekken a2596fb 

Morten Eriksen d216776 
Peder Blekken 6b9317e 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 




Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 
Morten Eriksen 08431c9 
Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Morten Eriksen 99ffb52 

Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 

Morten Eriksen 03ff79a 
Morten Eriksen 8bb7997 
Morten Eriksen 6d849de 


Morten Eriksen 8bb7997 
Morten Eriksen 6d849de 

Morten Eriksen 03ff79a 

Morten Eriksen 08431c9 
Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 


Tom Fredrik Blen… f22c88e 

Tom Fredrik Blen… c56c6a7 
Morten Eriksen 8bb7997 


Morten Eriksen 6d849de 
Morten Eriksen a59180e 
Morten Eriksen b53e9c9 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 

Morten Eriksen 99ffb52 


Morten Eriksen 08431c9 
Morten Eriksen 99ffb52 
Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 




Peder Blekken 4804c13 






Morten Eriksen b53e9c9 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 





Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Morten Eriksen 99ffb52 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 





Morten Eriksen 99ffb52 
Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 



Morten Eriksen b53e9c9 

Tom Fredrik Blen… c56c6a7 
Morten Eriksen b53e9c9 

Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 
Morten Eriksen 6d849de 
Morten Eriksen b53e9c9 
Morten Eriksen 6d849de 
Morten Eriksen 08431c9 

Morten Eriksen 99ffb52 
Morten Eriksen 08431c9 
Morten Eriksen 6d849de 



Peder Blekken a2596fb 
Peder Blekken 6b9317e 
Peder Blekken a2596fb 
Peder Blekken 6b9317e 
Morten Eriksen 99ffb52 
Peder Blekken 6b9317e 
Peder Blekken a2596fb 
Tom Fredrik Blen… c56c6a7 




Peder Blekken 6ce7cec 
Peder Blekken 5329016 

Tom Fredrik Blen… c56c6a7 
Morten Eriksen b53e9c9 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 





Tom Fredrik Blen… b26596a 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 
Morten Eriksen a59180e 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 



Morten Eriksen 4216fef 
Morten Eriksen f710f1c 
Morten Eriksen 08431c9 

Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Morten Eriksen 09145b8 
Morten Eriksen a59180e 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 

Morten Eriksen 4216fef 
Tom Fredrik Blen… c56c6a7 
Morten Eriksen 08431c9 

Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 



Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 






Morten Eriksen 99ffb52 

Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 





Morten Eriksen 99ffb52 

Lars J. Aas 6af0ab1 
Morten Eriksen 99ffb52 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 






Morten Eriksen 99ffb52 

Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 



Peder Blekken 5329016 

Tom Fredrik Blen… c56c6a7 
Morten Eriksen 99ffb52 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 


Morten Eriksen 99ffb52 
Morten Eriksen 08431c9 


Morten Eriksen 99ffb52 
Morten Eriksen 08431c9 
Peder Blekken 6b9317e 
Peder Blekken a2596fb 


Peder Blekken 6b9317e 
Morten Eriksen 99ffb52 

Peder Blekken 6b9317e 
Morten Eriksen 99ffb52 
Morten Eriksen 364a3ff 
Morten Eriksen 08431c9 





Morten Eriksen f710f1c 
Morten Eriksen 08431c9 
Tom Fredrik Blen… c56c6a7 
Morten Eriksen 364a3ff 
/**************************************************************************\
 * Copyright (c) Kongsberg Oil & Gas Technologies AS
 * All rights reserved.
 * 
 * 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 the copyright holder 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS 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.
\**************************************************************************/

/*!
  \class SoCacheElement Inventor/elements/SoCacheElement.h
  \brief The SoCacheElement class stores and manages the open caches.
  \ingroup elements
*/

// *************************************************************************

#include <Inventor/elements/SoCacheElement.h>

#include <cassert>
#include <cstdlib>

#include <Inventor/caches/SoCache.h>
#include <Inventor/errors/SoDebugError.h>
#include <Inventor/misc/SoState.h>

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif // HAVE_CONFIG_H

#ifdef COIN_THREADSAFE
#include <Inventor/threads/SbTypedStorage.h>
#endif // COIN_THREADSAFE

#include "tidbitsp.h"
#include "SbBasicP.h"
#include "coindefs.h"

// *************************************************************************

SbBool SoCacheElement::invalidated = FALSE;

// *************************************************************************

#ifdef COIN_THREADSAFE

static SbTypedStorage <SbBool*> * invalidated_storage = NULL;

static void
cacheelement_cleanup(void)
{
  delete invalidated_storage;
}

#endif // COIN_THREADSAFE

// *************************************************************************

SO_ELEMENT_SOURCE(SoCacheElement);

// *************************************************************************

// Doc in superclass.
void
SoCacheElement::initClass(void)
{
  SO_ELEMENT_INIT_CLASS(SoCacheElement, inherited);
  SoCacheElement::invalidated = FALSE;

#ifdef COIN_THREADSAFE
  invalidated_storage = new SbTypedStorage <SbBool*> (sizeof(SbBool));
  *(invalidated_storage->get()) = FALSE;
  coin_atexit((coin_atexit_f*) cacheelement_cleanup, CC_ATEXIT_NORMAL);
#endif // COIN_THREADSAFE
}

/*!
  The destructor.
*/

SoCacheElement::~SoCacheElement(void)
{
}

// Doc in superclass.
void
SoCacheElement::init(SoState * state)
{
  inherited::init(state);
  this->cache = NULL;
}

// *************************************************************************

// Documented in superclass. Overridden to initialize element.
void
SoCacheElement::push(SoState * state)
{
  inherited::push(state);
  this->cache = NULL;
}

// Documented in superclass. Overridden to unref the cache, since the
// cache is ref'ed in set().
void
SoCacheElement::pop(SoState * state, const SoElement * prevTopElement)
{
  SoCacheElement * prev =
    const_cast<SoCacheElement *>
    ( coin_assert_cast<const SoCacheElement *>(
                                          prevTopElement
                                         )
     );
  if (prev->cache) {
    prev->cache->unref();
    prev->cache = NULL;
  }
  inherited::pop(state, prevTopElement);
  if (!this->anyOpen(state)) state->setCacheOpen(FALSE);
}


/*!
  Sets the current cache. The cache is ref'ed before returning.
*/
void
SoCacheElement::set(SoState * const state, SoCache * const cache)
{
  SoCacheElement * elem = coin_assert_cast<SoCacheElement *>
    (
     SoElement::getElement(state, classStackIndex)
     );

  if (elem) {
    if (elem->cache) elem->cache->unref();
    elem->cache = cache;
    if (elem->cache) {
      elem->cache->ref();
      state->setCacheOpen(TRUE);
    }
  }
}

/*!
  This method returns the cache, or NULL if there is no cache.
*/

SoCache *
SoCacheElement::getCache(void) const
{
  return this->cache;
}

/*!
  This method returns TRUE if a cache is currently open.
*/

SbBool
SoCacheElement::anyOpen(SoState * const state)
{
  const SoCacheElement * elem = coin_assert_cast<const SoCacheElement *>
     (
      state->getElementNoPush(classStackIndex)
      );
  while (elem) {
    if (elem->cache) return TRUE;
    elem = coin_safe_cast<const SoCacheElement*>(elem->getNextInStack());
  }
  return FALSE;
}

/*!
  This method invalidates open caches. It should be called by
  uncacheable nodes.
*/
void
SoCacheElement::invalidate(SoState * const state)
{
#if COIN_DEBUG && 0 // debug
  SoDebugError::postInfo("SoCacheElement::invalidate",
                         "Invalidate all caches");
#endif // debug

#ifdef COIN_THREADSAFE
  *(invalidated_storage->get()) = TRUE;
#else // COIN_THREADSAFE
  SoCacheElement::invalidated = TRUE;
#endif // ! COIN_THREADSAFE

  const SoCacheElement * elem =
    coin_assert_cast<const SoCacheElement *>
    (
     state->getElementNoPush(classStackIndex)
     );

  while (elem && elem->cache) {
    elem->cache->invalidate();
    elem = coin_safe_cast<const SoCacheElement *>(elem->getNextInStack());
  }
}

/*!
  SoCacheElement objects should not be compared because you obviously don't
  cache them in the cache.
*/
SbBool
SoCacheElement::matches(const SoElement * COIN_UNUSED_ARG(element)) const
{
  assert(FALSE && "this method should not be called for this element");
  return FALSE;
}

/*!
  SoCacheElement objects should not be "copied" because you obviously don't
  cache them in the cache.

  \sa SbBool SoCacheElement::matches(const SoElement * element) const
*/
SoElement *
SoCacheElement::copyMatchInfo(void) const
{
  assert(FALSE && "this method should not be called for this element");
  return NULL;
}

/*!
  This method returns the next cache element. That is the next cache
  element pointing towards the bottom of the state.
*/
SoCacheElement *
SoCacheElement::getNextCacheElement(void) const
{
  return coin_safe_cast<SoCacheElement *>
    (
     this->getNextInStack()
     );
}

/*!
  This method adds \a element to the elements used lists of all the open
  caches in \a state.
*/

void
SoCacheElement::addElement(SoState * const state,
                           const SoElement * const element)
{
  SoCacheElement * elem =
    coin_assert_cast<SoCacheElement *>
    (
     state->getElementNoPush(classStackIndex)
     );

  while (elem) {
    if (elem->cache) elem->cache->addElement(element);
    elem = coin_safe_cast<SoCacheElement *>(elem->getNextInStack());
  }
}

/*!
  This method creates dependencies on \a cache for all the open caches
  in \a state.
*/

void
SoCacheElement::addCacheDependency(SoState * const state,
                                   SoCache * const cache)
{
  SoCacheElement * elem = coin_assert_cast<SoCacheElement *>
    (
     state->getElementNoPush(classStackIndex)
     );
  while (elem && elem->cache) {
    elem->cache->addCacheDependency(state, cache);
    elem = coin_assert_cast<SoCacheElement *>(elem->getNextInStack());
  }
}

/*!
  This method returns the old invalidated bit value, and sets it to
  \a newvalue.
*/

SbBool
SoCacheElement::setInvalid(const SbBool newvalue)
{
#ifdef COIN_THREADSAFE
  SbBool * ptr = invalidated_storage->get();
  SbBool oldval = *ptr;
  *ptr = newvalue;
#else // COIN_THREADSAFE
  SbBool oldval = SoCacheElement::invalidated;
  SoCacheElement::invalidated = newvalue;
#endif // ! COIN_THREADSAFE
  return oldval;
}

/*!
  This method returns the current cache.  No cache dependencies are honored.
*/

SoCache *
SoCacheElement::getCurrentCache(SoState * const state)
{
  return (coin_assert_cast<const SoCacheElement *>(state->getElementNoPush(classStackIndex)))->cache;
}