typeinst.h

Go to the documentation of this file.

/*
 * typeinst.h
 *
 * Copyright (C) 2008,2009  Thomas A. Vaughan
 * 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 <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 * Root header for generic types and instances.
 */

#ifndef AESOP_TYPEINST_H__
#define AESOP_TYPEINST_H__

// includes --------------------------------------------------------------------
#include "aesop-base/aesop-base.h"

#include "datahash/datahash.h"
#include "datahash/datahash_util.h"
#include "geometry/placement.h"
#include "story/story.h"


namespace aesop {




class ComponentData {
public:
        // virtual destructor --------------------------------------------------
        virtual ~ComponentData(void) throw();

        // aesop::ComponentData class interface data ---------------------------

        virtual void dump(IN const char * txt) const throw();
};



class Instance {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Instance(void) throw();

        // aesop::Instance class interface methods -----------------------------

        virtual const char * getInstanceId(void) const throw() = 0;

        virtual const char * getTypeId(void) const throw() = 0;
        
        virtual placement_t& getPlacement(void) throw() = 0;

        virtual void setComponentData(IN const char * componentName,
                                IN smart_ptr<ComponentData>& data) = 0;

        virtual smart_ptr<ComponentData> getComponentData(
                                IN const char * componentName) = 0;

        virtual const Datahash * getTypeComponentData(
                                IN const char * componentName) = 0;

        virtual void setInstanceData(IN const char * componentName,
                                IN smart_ptr<Datahash>& data) = 0;

        virtual smart_ptr<Datahash> getInstanceData(
                                IN const char * componentName) = 0;

        virtual void dump(IN const char * txt) throw() = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<Instance> parse(IO std::istream& stream);
        static smart_ptr<Instance> create(IN const char * instanceId,
                                IN const char * typeId);
};



typedef std::vector<smart_ptr<Instance> > vec_instance_t;


typedef void (*instance_iteration_fn)(IN smart_ptr<Instance>& instance,
                                IN void * context);



class TypeComponentLoader {
public:
        // virtual destructor --------------------------------------------------
        virtual ~TypeComponentLoader(void) throw();

        // aesop::TypeComponentLoader class interface methods -----------------

        virtual const char * getComponentName(void) const throw() = 0;

        virtual const char * getLoaderName(void) const throw() = 0;

        virtual bool isMyFormat(IN const Datahash * componentData,
                                IN const char * path) const = 0;

        virtual smart_ptr<ComponentData> loadTS(
                                IN smart_ptr<Instance>& instance,
                                IN const Datahash * componentData,
                                IN const char * path) = 0;
};


void initializeTypeInstanceLibrary(IN smart_ptr<story::Story>& story);


void registerTypeComponentLoader(IN smart_ptr<aesop::TypeComponentLoader>& tcl);



void loadInstances(IO std::istream& stream,
                                OUT vec_instance_t& instances);



const char * getKeyWithOverrides(IN const char * keyName,
                                IN const Datahash * instanceData,
                                IN const Datahash * typeData,
                                IN const Datahash * modelData,
                                IN eDatahash_Flag flag);


};      // aesop namespace

#endif  // AESOP_TYPEINST_H__