SoCacheElement.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_CACHE_ELEMENT_
#define  _SO_CACHE_ELEMENT_
 
#include <Inventor/SbBasic.h>
#include <Inventor/elements/SoSubElement.h>
#include <Inventor/threads/SbThreadLocalStorage.h>
#include <Inventor/misc/SoRef.h>
#include <Inventor/caches/SoCache.h>
#include <Inventor/SoDB.h>
#include <unordered_map>
#include <bitset>
#include <stack>
 
class SoCache;
 
SoEXTENDER_Documented class  SoCacheElement : public SoElement {
 
  SO_ELEMENT_HEADER(SoCacheElement);
 
 public:
  static void         set(SoState *state, SoCache *cache);
 
  SoCache *           getCache() const { return cache.ptr(); }
 
  static SbBool       anyOpen(SoState *state);
 
  static void         closeAnyOpen(SoState* state);
 
  static void         invalidate(SoState *state);
 
  virtual void        pop(SoState *state, const SoElement *prevTopElement);
 
  SoCacheElement *    getNextCacheElement() const
    { return (SoCacheElement *) getNextInStack(); }
 
  virtual void push(SoState *state);
 
private:
 
  virtual void init(SoState *state);
 
  virtual SbBool matches(const SoElement* elt) const;
 
  virtual SoElement* copyMatchInfo() const;
 
 private:
  // Initializes the SoCacheElement class
  static void initClass();
  static void exitClass();
  
  typedef std::bitset<SO_ELEMENT_MAX_KEY> ElementBitList;
 
  void invalidate() const;
 
  static void pushElementSetters(SoState* state, SoElementKeyType keyToPush);
  static void popElementSetters(SoState* state, SoElementKeyType keyToPop);
 
  static void addNodeTraversalStart(SoState* state);
 
  static void trackDependencies(SoState *state, const SoElement *elt);
 
  static void trackGetterDependencies(SoState *state, const SoElement *elt);
 
  static void clearGettersSetters(SoState* state);
 
  // Adds the given element to the elements used lists of all
  // currently open caches in the state
  static void         addElement(SoState *state, const SoElement *elt);
 
  // Adds a dependency on the given cache to all currently open
  // caches in the state
  static void         addCacheDependency(SoState *state, SoCache *cache);
 
  // Sets invalidated bit, and returns its old value.  Used by
  // SoGLCacheList so auto-caching doesn't cache too much.
  static SbBool       setInvalid(SbBool newValue);
 
  // returns the current cache, from the top of the stack.  Does not
  // cause a cache dependence like getConstElement().
  static SoCache *    getCurrentCache(SoState *state)
  {return state->getElementNoPush<SoCacheElement>()->cache.ptr();}
 
  static void flagDelayedPath(SoState* state);
 
  static SbBool listIsOpen(SoState* state);
 
  SoRef<SoGroup> getDependencies(const ElementBitList& elementKeys, std::vector<SoNode*>& dependencies) const;
 
  enum LazyEvaluationPolicy
  {
    DISABLED  = (0),      // Lazy evaluation is disabled
    ENABLED   = (1<<0),   // Lazy evaluation is enabled
    INHERITED = (1<<1)    // Lazy evaluation policy is propagated to children
  };
 
  inline void setLazyEvaluationPolicy(int32_t flag)
  {
    m_lazyEvaluationPolicy = flag;
    if (!hasLazyEvaluation())
      m_lazyEvaluationPolicy = DISABLED;
    if (!isLazyEvaluationEnabled())
      invalidate();
  }
 
  inline bool isLazyEvaluationEnabled() const
  {
    return (m_lazyEvaluationPolicy & ENABLED) > 0;
  }
 
  inline bool isLazyEvaluationInherited() const
  {
    return (m_lazyEvaluationPolicy & INHERITED) > 0;
  }
 
  bool needLazyEval() const;
 
  static void setLazyEvaluationPolicy(SoState *state, int32_t lazyEvaluationPolicyFlag);
 
  static void set(SoState *state, SoCache *cache, int32_t lazyEvaluationPolicyFlag);
  
  static bool needTracking(SoState *state, const SoElement* elt);
 
  static bool needTracking(SoState *state);
 
  static bool hasLazyEvaluation();
 
  struct ElementInfos
  {
    enum Type { PUSH, POP, ELEMENT, NODE_TRAVERSAL_START } ;
    SoElementKeyType elementKey;
    SoNode* node;
    Type type;
 
    ElementInfos(){}
    ElementInfos(SoElementKeyType elementKey, SoNode* node, Type type)
    {
      this->elementKey = elementKey;
      this->node = node;
      this->type = type;
    }
  };
 
  template<typename Data>
  struct ListContainer : public SoRefCounter
  {
    ListContainer()
    {}
 
    void push()
    {
      m_lastSize.push( m_list.size() );
    }
 
    void pop()
    {
      size_t lastSize = m_lastSize.top();
      m_list.resize( lastSize );
      m_lastSize.pop();
    }
 
    std::stack<size_t> m_lastSize;
    std::vector<Data> m_list;
  };
 
  typedef ListContainer<ElementInfos> ElementInfosListContainer;
 
  typedef std::vector<ElementInfos> ElementInfosList;
 
  const ElementInfosList& getElementSetters() const { return m_elementSetters->m_list; }
 
  typedef ListContainer<SoNode*> LazyEvalNodesListContainer;
 
  static const std::vector<uint64_t>& getLazyEvalNodesHashes( const SoState* state );
 
  struct MTstruct
  {
    bool invalidated;
  };
 
  SB_THREAD_TLS_HEADER();
 
 private:
  virtual ~SoCacheElement();
 
 private:
 
  static SoNode* getSetterGetterNode(SoState *state, const SoElement *elt);
  
  SoRef<SoCache> cache; // Stores pointer to cache
 
  SoRef<ElementInfosListContainer> m_elementSetters;
 
  std::vector<SoRef<LazyEvalNodesListContainer> > m_lazyEvalNodesLists;
 
  std::vector<uint64_t> m_lazyEvalNodesHashes;
 
  int32_t m_lazyEvaluationPolicy;
 
  friend class SoElement;
};
 
#endif /* _SO_CACHE_ELEMENT_ */