object.h

Go to the documentation of this file.

//    sampalib.org ESL library and tools
//    Copyright (C) 2007  Thierry Grellier
//
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License version 2 as
//    published by the Free Software Foundation.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License along
//    with this program; if not, write to the Free Software Foundation, Inc.,
//    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//    contact: www.sampalib.org

#ifndef SAMPA_OBJECT_H
#define SAMPA_OBJECT_H

#include "sampa/core/parameter.h"
#include <cstdarg>

namespace Sampa {
  typedef ParameterGroupName Name;
  class HierarchyData;  
  
  class SAMPA_PERSISTENT_CLASS(Object) {
  public:
    typedef Sampa::Name Name;
    Object(const Name& nm);
    Object(const Object*); // for temporary event listener
    const char* get_name() const;        
    const char* get_full_name() const;   
    Object*     get_parent() const;      
    Object*     get_sibling() const;     
    Object*     get_first_child() const; 
    int is_debug() const 
      { return m_debug; }    
  protected:
    void debug(const char*, ...);
    enum Severity { S_INFO, S_WARNING, S_ERROR, S_FATAL };
    void error(Severity severity, const char*, ...);
    friend class HierarchyData;  
    virtual ~Object();
    HierarchyData* get_hierarchy_data() const;
    
    virtual void complete_restart();


    virtual bool check_binding();
  private:
    virtual void dump_stats();
    // disabled
    Object(const Object&);
    Object& operator=(const Object&);
    // decoration for reflection
    HierarchyData* m_hierarchy_data;
    int            m_debug;
    SAMPA_PERSISTENT(Object);  
  };

  class ContainerObject;
  
  class ContainerName : public Name {
  public:
    ContainerName(const char* nm);
    ContainerName(const std::string& nm);
    ContainerName(const ContainerName& o);
    ~ContainerName();
  protected:
    friend class ContainerObject;  
    void set_container(ContainerObject* container);
  private:
    // disabled
    ContainerName& operator=(const ContainerName&);
    // link to container to end scope
    ContainerObject* m_container;    
  };
    
  class ContainerObject : public Object {
  public:
    typedef ContainerName Name;
    ContainerObject(const Name& nm);  
  protected:
    ~ContainerObject();
    void __end_hierarchy();
    friend class ContainerName;  
    friend class HierarchyData;
  private:
    // disabled
    ContainerObject(const ContainerObject&);
    ContainerObject& operator=(const ContainerObject&);
    SAMPA_PERSISTENT(ContainerObject);  
  };
} // namespace Sampa

#if SAMPA_CONFIG_DEBUG == SAMPA_ENABLED
#  define SAMPA_DBGOUT(debug_level) if (debug_level <= is_debug()) { debug(
#  define SAMPA_DBGEND ); }
#else
#  define SAMPA_DBGOUT(debug_level) if (0) { debug(
#  define SAMPA_DBGEND ); }
#endif

#endif

---