ShVariableNode.hpp

// Sh: A GPU metaprogramming language.
//
// Copyright (c) 2003 University of Waterloo Computer Graphics Laboratory
// Project administrator: Michael D. McCool
// Authors: Zheng Qin, Stefanus Du Toit, Kevin Moule, Tiberiu S. Popa,
//          Michael D. McCool
// 
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
// 
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
// 
// 1. The origin of this software must not be misrepresented; you must
// not claim that you wrote the original software. If you use this
// software in a product, an acknowledgment in the product documentation
// would be appreciated but is not required.
// 
// 2. Altered source versions must be plainly marked as such, and must
// not be misrepresented as being the original software.
// 
// 3. This notice may not be removed or altered from any source
// distribution.
#ifndef SHVARIABLENODE_HPP
#define SHVARIABLENODE_HPP

#include <string>
#include <list>
#include "ShDllExport.hpp"
#include "ShRefCount.hpp"
#include "ShMeta.hpp"
#include "ShPool.hpp"

namespace SH {

enum ShBindingType {
  SH_INPUT = 0,
  SH_OUTPUT = 1,
  SH_INOUT = 2,
  SH_TEMP = 3,
  SH_CONST = 4,
  SH_TEXTURE = 5,
  SH_STREAM = 6
};

enum ShSemanticType {
  SH_ATTRIB,
  SH_POINT,
  SH_VECTOR,
  SH_NORMAL,
  SH_COLOR,
  SH_TEXCOORD,
  SH_POSITION
};

// ensure these match the BindingType and SemanticType enums
SH_DLLEXPORT extern const char* ShBindingTypeName[];
SH_DLLEXPORT extern const char* ShSemanticTypeName[];

class ShProgramNode;

// Used to hide our use of ShProgramNodePtr, since MSVC7 doesn't allow it.
struct ShVariableNodeEval;

class 
SH_DLLEXPORT ShVariableNode : public virtual ShRefCountable,
                       public virtual ShMeta {
public:
  ShVariableNode(ShBindingType kind, int size, ShSemanticType type = SH_ATTRIB);
  virtual ~ShVariableNode();

  bool uniform() const; 
  bool hasValues() const; 

  int size() const; 

  // Don't call this on uniforms!
  void size(int size);

  void lock(); 
  void unlock(); 
  

  typedef float ValueType; 

  // Metadata
  std::string name() const; 
  void name(const std::string& n); 

  void range(ShVariableNode::ValueType low, ShVariableNode::ValueType high);
  ShVariableNode::ValueType lowBound() const;
  ShVariableNode::ValueType highBound() const;

  ShBindingType kind() const;
  ShSemanticType specialType() const;
  void specialType(ShSemanticType);

  std::string nameOfType() const; 

  void setValue(int i, ValueType value);

  ValueType getValue(int i) const;

  void addValues();



  void attach(const ShPointer<ShProgramNode>& evaluator);

  void update();

  const ShPointer<ShProgramNode>& evaluator() const;
  
#ifdef SH_USE_MEMORY_POOL
  // Memory pool stuff.
  void* operator new(std::size_t size);
  void operator delete(void* d);
#endif
  
protected:

  void add_dependent(ShVariableNode* dep);
  void remove_dependent(ShVariableNode* dep);

  void update_dependents();
  void detach_dependencies();
  
  bool m_uniform;
  
  ShBindingType m_kind;
  ShSemanticType m_specialType;
  int m_size;
  int m_id;
  int m_locked;

  ValueType* m_values;

  // Metadata (range)
  ValueType m_lowBound, m_highBound;

  // Dependent uniform evaluation
  mutable ShVariableNodeEval* m_eval;
  std::list<ShVariableNode*> m_dependents;
  
  static int m_maxID;

#ifdef SH_USE_MEMORY_POOL
  static ShPool* m_pool;
#endif
};

typedef ShPointer<ShVariableNode> ShVariableNodePtr;
typedef ShPointer<const ShVariableNode> ShVariableNodeCPtr;

}

#endif

---