AngelScript

Template types

A template type in AngelScript works similarly to how templates work in C++. The scripts will be able to instanciate different forms of the template type by specifying which subtype that should be used. The methods for the instance will then be adapted to this subtype, so that the correct handling of parameters and return types will be applied.

The implementation of the template type is not a C++ template though, instead it must be implemented as a generic class that can determine what to do dynamically at runtime based on the subtype for which it was instanciated. This is obviously a lot less efficient than having specific implementations for each type, and for that reason AngelScript permits the application to register a template specialization where the extra performance is needed.

This gives the best of both worlds, performance where the subtype is known before hand, and support for all other types that cannot be pre-determined.

## Registering the template type

The template registration is registered similarly to normal reference types, with a few differences. The name of the type is formed by the name of the template type plus the name of the subtype with angle brackets. The type flag asOBJ_TEMPLATE must also be used.

    // Register the template type
    r = engine->RegisterObjectType("myTemplate<class T>", 0, asOBJ_REF | asOBJ_GC | asOBJ_TEMPLATE); assert( r >= 0 );

The template type doesn't have to be garbage collected, but since you may not know which subtypes it will be instanciated for, it is usually best to implement that support.

When registering the behaviours, methods, and properties for the template type the type is identified with the name and subtype within angle brackets, but without the class token, e.g. `myTemplate<T>`. The sub type is identified by just the name of the subtype as it was declared in the call to RegisterObjectType.

The factory behaviour for the template type is also different. In order for the implementation to know which subtype it is instanciated for the factory receives the asIObjectType of the template instance as a hidden first parameter. When registering the factory this hidden parameter is reflected in the declaration, for example as `int &in`.

    // Register the factory behaviour
    r = engine->RegisterObjectBehaviour("myTemplate<T>", asBEHAVE_FACTORY, "myTemplate<T>@ f(int&in)", asFUNCTIONPR(myTemplateFactory, (asIObjectType*), myTemplate*), asCALL_CDECL); assert( r >= 0 );

The list factory, used to instanciate objects with initialization lists, is registered in the same way, i.e.:

    // Register the list factory behaviour
    r = engine->RegisterObjectBehaviour("myTemplate<T>", asBEHAVE_LIST_FACTORY, "myTemplate<T>@ f(int&in, uint)", asFUNCTIONPR(myTemplateListFactory, (asIObjectType*, unsigned int), myTemplate*), asCALL_CDECL); assert( r >= 0 );

Remember that since the subtype must be determined dynamically at runtime, it is not possible to declare functions to receive the subtype by value, nor to return it by value. Instead you'll have to design the methods and behaviours to take the type by reference. It is possible to use object handles, but then the script engine won't be able to instanciate the template type for primitives and other values types.

See also:
  array template object

## Validating template instantiations at compile time

In order to avoid unnecessary runtime validations of invalid template instantiations, the application should preferably register the asBEHAVE_TEMPLATE_CALLBACK behaviour. This is a special behaviour function that the script engine will invoke everytime a new template instance type is generated. The callback function can then perform necessary validations to verify if the type can be handled, and if not tell the engine that the instance isn't supported.

The callback function must be a global function that receives an asIObjectType pointer, and should return a boolean. If the template instance is valid the return value should be true.

The function should also take a second parameter with an output reference to a boolean. This parameter should be set to true by the function if the template instance should not be garbage collected, which will make AngelScript clear the asOBJ_GC flag for the object type. If the template instance cannot form any circular references, then it doesn't need to be garbage collected, which reduces the work that has to be done by the garbage collector. When the callback tells AngelScript that the template instance is not garbage collected, AngelScript will clear the asOBJ_GC flag for the object type.

    // Register the template callback
    // Observe that the asIObjectType pointer argument is represented by the int reference
    r = engine->RegisterObjectBehaviour("myTemplate<T>", asBEHAVE_TEMPLATE_CALLBACK, "bool f(int &in, bool&out)", asFUNCTION(myTemplateCallback), asCALL_CDECL); assert( r >= 0 );

Here's an example callback function:

    bool myTemplateCallback(asIObjectType *ot, bool &dontGarbageCollect)
    {
      // This template will only support primitive types
      int typeId = ot->GetSubTypeId();
      if( typeId & asTYPEID_MASK_OBJECT )
      {
        // The script is attempting to instantiate the
        // template with an object type, this is not allowed.
        return false;
      }

      // Tell AngelScript that this instance doesn't require garbage collection
      dontGarbageCollect = true;

      // Primitive types are allowed
      return true;
    }

## Template specializations

When registering a template specialization you override the template instance that AngelScript would normally do when compiling a declaration with the template type. This allow the application to register a completely different object with its own implementation for template specializations. Obviously it is recommended that the template specialization is registered so that to the script writer it is transparent, i.e. try to avoid having different method names or behaviours for the template type and template specializations.

With the exception of the type name, a template specialization is registered exactly like a normal type.

    // Register a template specialization for the float subtype
    r = engine->RegisterObjectType("myTemplate<float>", 0, asOBJ_REF); assert( r >= 0 );

    // Register the factory (there are no hidden parameters for specializations)
    r = engine->RegisterObjectBehaviour("myTemplate<float>", asBEHAVE_FACTORY, "myTemplate<float>@ f()", asFUNCTION(myTemplateFloatFactory, (), myTemplateFloat*), asCALL_CDECL); assert( r >= 0 );

## Current limitations

- Template types are currently limited to reference types only, i.e. it must be registered with a factory and addref and release behaviours.

- Only one template subtype can be used at the moment.