ubrick.hpp

/* ==================================================== ======== ======= *
 *
 *  ubrick.hpp: base class for objects that can be added to the 
 *  scene graph and UBrick smart pointers
 *  Ubit Project
 *  Author: Eric Lecolinet
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 / EricLecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU 
 * GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION; 
 * EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _ubrick_hpp_
#define _ubrick_hpp_
//pragma ident  "@(#)ubrick.hpp         ubit:05.05.00"
#include <stdlib.h>  // for size_t, new(), delete()
#include <ubit/udefs.hpp>
#include <ubit/uobject.hpp>
#include <ubit/uclass.hpp>
#include <ubit/ugeom.hpp>
#include <ubit/uchild.hpp>
#include <ubit/uparent.hpp>

namespace ubit {

/* ==================================================== [Elc] ======= */
/* ==================================================== ===== ======= */
class UBrick : public UObject {
public:
  enum {
    ELEMENT_NODE                   = 1,
    ATTRIBUTE_NODE                 = 2,
    TEXT_NODE                      = 3,
    CDATA_SECTION_NODE             = 4,
    ENTITY_REFERENCE_NODE          = 5,
    ENTITY_NODE                    = 6,
    PROCESSING_INSTRUCTION_NODE    = 7,
    COMMENT_NODE                   = 8,
    DOCUMENT_NODE                  = 9,
    DOCUMENT_TYPE_NODE             = 10,
    DOCUMENT_FRAGMENT_NODE         = 11,
    NOTATION_NODE                  = 12
  };
    
  UBIT_ABSTRACT_CLASS(UBrick, UObject)
    
  virtual unsigned short getNodeType() const {return 0;}
  
  virtual const UStr* getNodeName() const {return null;}

  virtual const UStr* getNodeValue() const {return null;}

  virtual UBrick* brickCast() {return this;}

   // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // parents.

  virtual bool isChildOf(const UGroup& parent, bool indirect = true) const;
  UParentIter pbegin() const {return parents().begin();}
  UParentIter pend() const {return parents().end();}

  virtual UParents& parents() const {return _parents;}

  virtual bool hasFullParent() const;
  virtual bool hasOnlyPseudoParents() const;
    
  virtual UGroup* getParent(int pos = 0) const;
  template <class CC>
    CC* findParent() const {
      for (UParentIter p = pbegin(); p != pend(); ++p) {
        if (dynamic_cast<CC*>(*p)) {return (CC*)*p;}
        else return ((UBrick*)(*p))->findParent<CC>();
      }
      return null;
    }

  virtual int getBoxParents(std::vector<UBox*>& parvect) const;

  virtual UBox* getParent(const UView*) const;
  virtual UView* getParentView(const UView*) const;
  virtual UBox*  getParent(const UEvent&) const;
  virtual UView* getParentView(const UEvent&) const;
  virtual void removeFromParents(bool update_parents = true);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // attributes.
  
  UChildIter abegin() const {return attributes().begin();}
  UChildIter aend() const {return attributes().end();}

  virtual UChildren& attributes() const {return _attributes;}

  virtual void addAttr(const UChild& attribute);
    
  //virtual void removeAttr(UBrick&);
  //to be added!

  virtual void removeAllAttrs(bool autodel = true);
    
  friend UChild operator/(const UCond&, UBrick&);
  friend UChild operator/(const UCond&, UBrick*);
  virtual bool fire(UEvent&, const UOn& condition) const;

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      
  virtual void update() {}

  UBrick& autoUpdate(bool state);
  bool isAutoUpdate() const;
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  bool isConst() const;
    
  void setConst();
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    
  UMask getBModes() const {return bmodes;}

  bool hasBMode(UMask modes) const {return (bmodes & modes) != 0;}
  
  void addBModes(UMask modes) {bmodes |= modes;}
  
  void removeBModes(UMask modes) {bmodes &= ~modes;}

  // - - - Impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

private:
  UBrick(const UBrick&); 
  
  UBrick& operator=(const UBrick&); 
  
protected:
  explicit UBrick();
  
  explicit UBrick(UMask b_modes);
  
  virtual ~UBrick() {destructs();}
  virtual void addingTo(UChild* self, UGroup* parent) {}
  
  virtual void removingFrom(UChild* self, UGroup* parent) {}
  virtual void destructs();

  virtual bool canPtrDelete() const;  
  
#ifndef NO_DOC 
public:
  void* operator new(size_t);
  void  operator delete(void*);
  // [impl] internal memory management.
  
  bool checkConst() const;
  // [impl] generates a (non fatal) error if this object is logically constant (see setConst()).

  void fireParents(UEvent& e, const UOn& on) const {_parents.fireParents(e, on);}
  //void updateAutoParents() {_parents.updateAutoParents();}
  void updateAutoParents(const UUpdate& m) {_parents.updateAutoParents(m);}
    
  virtual void addChangeCall(UCall&);
  virtual UGroup* getSubGroup() {return null;}

protected:
  friend class UChild;
  friend class UArgs;
  friend class UGroup;
  friend class UBox;
  friend class UParents;
  mutable UParents _parents;
  mutable UChildren _attributes;  // (including callbacks)
  mutable UMask bmodes;
  void _setBmodes(UMask bmodes, bool on_off) const;
#endif
};

}
#endif 
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---