vos/corelibs/vos/metafactory.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001, 2002 Peter Amstutz

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <tetron@interreality.org>
*/
#ifndef _METAFACTORY_HH_
#define _METAFACTORY_HH_

#ifndef _VOS_HH_
#error Please only include "vos.hh"!
#endif

#error MetaFactory has been replaced by equivalent functionality in LocalSite and RemoteSite. Use the object creation methods there instead.



#if 0

 DEPRECATED use Site instead.

/** A macro for lazy and/or forgetful people. (like me)   -rh */
#define CLASSNAME(c)    (typeid(c).name())

typedef MetaObject* (*metaobject_extender_t)(MetaObject* superobject, const string& type);

/** The MetaFactory builds and extends MetaObjects.  Generally
    speaking you should be using this class whenever you create a new
    MetaObject to add into the Vobject tree rather than instantiating
    LocalVobject or LocalMetaObject directly.
*/
class VOS_API MetaFactory
{
public:
    static string generateUniqueName(LocalSite& localsite);

    /** Create a new local object.
        @param name Name of the new object on the site. Note that every object on a site must have a different name.
        @param localsite the site to bind the object to
        @param ac the access control policy this object starts with (or NULL to use localsite's access control)
        @param typelist a deque of string type names to extend this new object with
        @return the requested new local metaobject.   NOTE YOU MUST CALL release() WHEN DONE OR USE A pREF() BLOCK
    */
    static LocalMetaObject* createLocalObject(const string& name, LocalSite* localsite, VobjectAccessControl* ac, deque<string> &typelist);

    /** Create a new local object.
        @param name Object's name on the site. Note that every object on a site must have a different name.
        @param localsite the site to bind the object to
        @param ac the access control policy this object starts with (or 0 to use localsite's AC and use no extenders)
        @param ... a 0-terminated list of char* type names to extend this new object with,
        see extendLocalObject() for an example of how this is used.
        @return the requested new local metaobject.   NOTE YOU MUST CALL release() WHEN DONE OR USE A pREF() BLOCK
    */
    static LocalMetaObject* createLocalObject(const string& name, LocalSite* localsite,
                                              VobjectAccessControl* ac, ...);

    /** Create a new local object.  The site name will be a site-unique, randomly generated string of digits.
        @param localsite the site to bind the object to
        @param ac the access control policy this object starts with (or 0 to use localsite's AC and use no extenders)
        @param ... a 0-terminated list of char* type names to extend this new object with,
        see extendLocalObject() for an example of how this is used.
        @return the requested new local metaobject.   NOTE YOU MUST CALL release() WHEN DONE OR USE A pREF() BLOCK
    */
    static LocalMetaObject* createLocalObject(LocalSite* localsite, VobjectAccessControl* ac, ...);

    /** Create a new local object.  The
        access control policy will be same (ie pointing to the same
        object instance) as the site it is bound to.
        @param name the name on the site
        @param localsite the site to bind the object to
        @param ... a 0-terminated list of char* type names to extend this new object with,
        see extendLocalObject() for an example of how this is used.
        @return the requested new local metaobject.   NOTE YOU MUST CALL release() WHEN DONE OR USE A pREF() BLOCK
    */
    static LocalMetaObject* createLocalObject(const string& name, LocalSite* localsite, ...);

    /** Create a new local object.  The site name will be a
        site-unique, randomly generated string of digits, and the
        access control policy will be same (eg a pointing to the same
        object instance) as the site it is bound to.
        @param localsite the site to bind the object to
        @param ... a 0-terminated list of char* type names to extend this new object with,
        see extendLocalObject() for an example of how this is used.
        @return the requested new local metaobject.   NOTE YOU MUST CALL release() WHEN DONE OR USE A pREF() BLOCK
    */
    static LocalMetaObject* createLocalObject(LocalSite* localsite, ...);

    /** Extend an existing local metaobject.  @note The 0-terminated
        list should be a list of char* type names.  This should look
        like:
        @code
        extendLocalObject(foo, "property", typeid(World).name(), 0);
        @endcode
        This will extend the object "foo" to support the "property"
        and World types.  Note the use of the native C++ type; you can
        simply ask for a particular interface without needing to know
        the MOS type name and it will be found for you, if the
        appropriate plugin exists.  See also
        MetaObject::meta_cast(MetaObject*,bool) for
        another example.
        @param obj the object to be extended
        @param ... a 0-terminated list of char* type names to extend
        this new object with @return the requested new local
        metaobject.
        @returns the object passed as the first parameter
    */
    static LocalMetaObject* extendLocalObject(LocalMetaObject* obj, ...);

    /** Extend and existing remote metaobject.
        @param obj the object
        @param ... a 0-terminated list of char* type names to extend this new object with,
        see extendLocalObject() for an example of how this is used.
        @returns the object passed as the first parameter
    */
    static RemoteMetaObject* extendRemoteObject(RemoteMetaObject* obj, ...);

    /** Register a new object extension that will be available with
        createLocalObject() and extendLocalObject().
        @param type a type string that matches this extension
        @param newmethod the method that will be called to perform the
        extension operation on an object
    */
    static void addLocalObjectExtension(const char* type, metaobject_extender_t newmethod);

    /** Register a new object extension that will be available with
        extendRemoteObject().
        @param type a type string that matches this extension
        @param newmethod the method that will be called to perform the
        extension operation on an object
    */
    static void addRemoteObjectExtension(const char* type, metaobject_extender_t newmethod);

    /** Remove an existing local object extension
        @param type a type string that matches this extension
        @param oldmethod the specific extension method to remove
    */
    static void removeLocalObjectExtension(const char* type, metaobject_extender_t oldmethod);

    /** Remove an existing remote object extension
        @param type a type string that matches this extension
        @param oldmethod the specific extension method to remove
    */
    static void removeRemoteObjectExtension(const char* type, metaobject_extender_t oldmethod);
};

#endif 

#endif

---