Core/System/E3Extension.c

/*  NAME:
        E3Extension.c

    DESCRIPTION:
        Implementation of Quesa API calls.

    COPYRIGHT:
        Copyright (c) 1999-2004, Quesa Developers. All rights reserved.

        For the current release of Quesa, please see:

            <http://www.quesa.org/>

        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions
        are met:

            o Redistributions of source code must retain the above copyright
              notice, this list of conditions and the following disclaimer.

            o 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.

            o Neither the name of Quesa 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS
        "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 THE COPYRIGHT
        OWNER OR CONTRIBUTORS 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.
    ___________________________________________________________________________
*/
//=============================================================================
//      Include files
//-----------------------------------------------------------------------------
#include "E3Prefix.h"
#include "E3Extension.h"


//=============================================================================
//      Public functions
//-----------------------------------------------------------------------------
//      E3XObjectHierarchy_RegisterClass : Register a new object class.
//-----------------------------------------------------------------------------
//		Note :	The Quesa class implementation does not support virtual
//				methods, as methods are inherited from the parent metahandler.
//
//				If you are using the virtual metahandler parameter, you will
//				probably need to update the class tree to support this: please
//				contact dair@refnum.com about this.
//
//				In addition, we do not use the methodsSize parameter: if you
//				understand how this parameter is used, please let me know - the
//				comments in QD3DExtension.h seem to indicate that it's used to
//				provide class specific private data, however the routine to
//				access it (Q3ObjectClass_GetClassPrivate), does't actually
//				exist (and so we don't support it).
//-----------------------------------------------------------------------------
TQ3XObjectClass
E3XObjectHierarchy_RegisterClass(TQ3ObjectType parentType, TQ3ObjectType *objectType,
		const char *objectName, TQ3XMetaHandler metaHandler,
		TQ3XMetaHandler virtualMetaHandler, TQ3Uns32 methodsSize, TQ3Uns32 instanceSize)
{	TQ3Status			qd3dStatus;
	E3ClassInfoPtr		theClass;
#pragma unused(virtualMetaHandler)
#pragma unused(methodsSize)


	// Make sure this class hasn't been registered
	if ( E3ClassTree::GetClass ( objectName ) != NULL )
		return(NULL);


	// If parentType is kQ3ObjectTypeInvalid, use the root object as the parent
	if (parentType == kQ3ObjectTypeInvalid)
		parentType = kQ3ObjectTypeRoot;


	// Allocate a unique type for this class
	*objectType = E3ClassTree::GetNextClassType () ;


	// Register the class
	qd3dStatus = E3ClassTree::RegisterExternalClass(parentType,
											*objectType,
											objectName,
											metaHandler,
											instanceSize);
	if (qd3dStatus != kQ3Success)
		return(NULL);


	// Find the class
	theClass = E3ClassTree::GetClass ( *objectType ) ;

	return((TQ3XObjectClass) theClass);
}


//=============================================================================
//      E3XObjectHierarchy_UnregisterClass : Unregister a class.
//-----------------------------------------------------------------------------
//		Note :	We're not required to unregister the class, and so we allow
//				the call to fail if there are still instances of the object.
//-----------------------------------------------------------------------------
TQ3Status
E3XObjectHierarchy_UnregisterClass(TQ3XObjectClass objectClass)
{	E3ClassInfoPtr		theClass = (E3ClassInfoPtr) objectClass;
	TQ3Status			qd3dStatus;
	TQ3ObjectType		classType;


	// Get the type of the class, and try and unregister it
	classType  = theClass->GetType () ;
	qd3dStatus = E3ClassTree::UnregisterClass(classType, kQ3False);

	return(qd3dStatus);
}


//=============================================================================
//      E3XObjectHierarchy_NewObject : Instantiate a new object.
//-----------------------------------------------------------------------------
//		Note :	By passing true for the sharedParams parameter, we make sure
//				that parent objects of the class are instantiaed with the same
//				parameter data as the leaf class.
//
//				This is the same behaviour as QD3D, although it's different
//				from the normal Quesa scheme.
//-----------------------------------------------------------------------------
TQ3Object
E3XObjectHierarchy_NewObject(TQ3XObjectClass objectClass, void *parameters)
	{
	E3ClassInfoPtr theClass = (E3ClassInfoPtr) objectClass ;


	// Get the type of the class, and instantiate it
	return E3ClassTree::CreateInstance ( theClass->GetType (), kQ3True, parameters ) ;
	}


//=============================================================================
//      E3XObjectHierarchy_GetClassVersion : Get the version of a class.
//-----------------------------------------------------------------------------
TQ3Status
E3XObjectHierarchy_GetClassVersion(TQ3ObjectType objectClassType, TQ3XObjectClassVersion *version)
	{
	// Initialise a return value
	*version = 0 ;


	// Find the class
	E3ClassInfoPtr theClass = E3ClassTree::GetClass ( objectClassType ) ;
	if ( theClass == NULL )
		return kQ3Failure ;


	// Get the version for the class
	*version = (TQ3XObjectClassVersion) (long)theClass->GetMethod ( kQ3XMethodTypeObjectClassVersion );

	return kQ3Success ;
	}


//=============================================================================
//      E3XObjectHierarchy_FindClassByType : Find a class.
//-----------------------------------------------------------------------------
TQ3XObjectClass
E3XObjectHierarchy_FindClassByType(TQ3ObjectType theType)
	{
	// Find the class
	return (TQ3XObjectClass) E3ClassTree::GetClass ( theType ) ;
	}


//=============================================================================
//      E3XObjectClass_GetMethod : Find a method for a class.
//-----------------------------------------------------------------------------
#pragma mark -
TQ3XFunctionPointer
E3XObjectClass_GetMethod(TQ3XObjectClass objectClass, TQ3XMethodType methodType)
	{
	E3ClassInfoPtr theClass = (E3ClassInfoPtr) objectClass ;

	// Get the method for the class
	return theClass->GetMethod ( methodType ) ;
	}


//=============================================================================
//      E3XObjectClass_GetLeafType : Get the leaf type for a class.
//-----------------------------------------------------------------------------
TQ3ObjectType
E3XObjectClass_GetLeafType(TQ3XObjectClass objectClass)
	{
	E3ClassInfoPtr theClass = (E3ClassInfoPtr) objectClass ;


	// Get the type of the class
	return theClass->GetType () ;
	}


//=============================================================================
//      E3XObjectClass_GetType : Get the type for a class.
//-----------------------------------------------------------------------------
//		Note :	It's not clear how the type of a class differs from the leaf
//				type of the class (since, by definition, a class is a leaf
//				unto itself - if the class has children, which type should
//				be returned?), so we just return the type of the class.
//-----------------------------------------------------------------------------
TQ3Status
E3XObjectClass_GetType(TQ3XObjectClass objectClass, TQ3ObjectType *theType)
	{
	E3ClassInfoPtr theClass = (E3ClassInfoPtr) objectClass ;


	// Get the type of the class
	*theType  = theClass->GetType () ;

	return kQ3Success ;
	}


//=============================================================================
//      E3XObjectClass_GetPrivate : Get the instance data for an object.
//-----------------------------------------------------------------------------
void *
E3XObjectClass_GetPrivate(TQ3XObjectClass objectClass, TQ3Object targetObject)
	{
	// Return the instance data
	return targetObject->FindLeafInstanceData () ;
	}


//=============================================================================
//      E3XObject_GetClass : Get the class for an object.
//-----------------------------------------------------------------------------
TQ3XObjectClass
E3XObject_GetClass(TQ3Object object)
	{
	// Return the class
	return (TQ3XObjectClass) object->GetClass () ;
	}


//=============================================================================
//      E3XSharedLibrary_Register : Register a shared library.
//-----------------------------------------------------------------------------
//		Note :	Called during E3System_LoadPlugins, as plug-ins register their
//				shared library details with Quesa.
//
//				We simply save the library details in the global state, since
//				E3System_LoadPlugins may need to impose some order on the
//				actual plug-in registration.
//-----------------------------------------------------------------------------
#pragma mark -
TQ3Status
E3XSharedLibrary_Register(TQ3XSharedLibraryInfo *sharedLibraryInfo)
{	E3GlobalsPtr	theGlobals = E3Globals_Get();
	TQ3Status		qd3dStatus;


	// Try and allocate some space to save the library info
	qd3dStatus = Q3Memory_Reallocate(&theGlobals->sharedLibraryInfo,
									 sizeof(TQ3XSharedLibraryInfo) *
									 	(theGlobals->sharedLibraryCount+1));
	if (qd3dStatus != kQ3Success)
		return(qd3dStatus);


	// Save the library info
	theGlobals->sharedLibraryInfo[theGlobals->sharedLibraryCount] = *sharedLibraryInfo;
	theGlobals->sharedLibraryCount++;

	return(kQ3Success);
}


//=============================================================================
//      E3XSharedLibrary_Unregister : Unregister a shared library.
//-----------------------------------------------------------------------------
//		Note : Does nothing at the moment.
//-----------------------------------------------------------------------------
TQ3Status
E3XSharedLibrary_Unregister(TQ3Uns32 sharedLibrary)
{


	// Do nothing for now
	return(kQ3Success);
}


//=============================================================================
//      E3XError_Post : Post an error.
//-----------------------------------------------------------------------------
void
E3XError_Post(TQ3Error theError)
{	TQ3Boolean		isFatal;


	// Post the error
	isFatal = (TQ3Boolean) (theError == kQ3ErrorInternalError || theError == kQ3ErrorNoRecovery);
	E3ErrorManager_PostError(theError, isFatal);
}


//=============================================================================
//      E3XWarning_Post : Post a warning.
//-----------------------------------------------------------------------------
void
E3XWarning_Post(TQ3Warning theWarning)
{


	// Post the warning
	E3ErrorManager_PostWarning(theWarning);
}


//=============================================================================
//      E3XNotice_Post : Post a notice.
//-----------------------------------------------------------------------------
void
E3XNotice_Post(TQ3Notice theNotice)
{


	// Post the notice
	E3ErrorManager_PostNotice(theNotice);
}