prop-types.js

'use strict';

const JS_WIDGET_SERIALIZER = '{ deserialize: serializers.unpackThreeModel }';


function pythonify(value) {
    if (value === false) { return 'False'; }
    if (value === true) { return 'True'; }
    if (value === Infinity) { return "float('inf')"; }
    if (value === -Infinity) { return "-float('inf')"; }
    if (value === undefined || value === null) { return 'None'; }
    if (Array.isArray(value)) {
        return `[${
            value.map(function(v) { return pythonify(v); }).join(', ')
        }]`;
    }
    return JSON.stringify(value);
}

class BaseType {
    constructor(options) {
        options = options || {};
        this.options = options;
        this.nullable = options.nullable === true;
    }
    getJSPropertyValue() {
        if (this.defaultValue === Infinity || this.defaultValue === -Infinity) {
            return this.defaultValue.toString();
        }
        if (this.defaultValue === undefined) {
            return 'undefined';
        }
        return JSON.stringify(this.defaultValue);
    }
    getPropArrayName() {
        return null;
    }
    getPythonDefaultValue() {
        return pythonify(this.defaultValue);
    }
    getPropertyConverterFn() {
        return null;
    }
    getPropertyAssignmentFn() {
        return null;
    }
    getTagParts() {
        return ['sync=True'];
    }
    getTagString() {
        return `.tag(${this.getTagParts().join(', ')})`;
    }
    getNullableStr() {
        return `allow_none=${this.nullable === true ? 'True' : 'False'}`;
    }
}

function genInstanceTraitlet(typeName, nullable, args, kwargs, tagParts) {
    let traitType = 'Instance';
    const nullableStr = `allow_none=${nullable === true ? 'True' : 'False'}`;
    tagParts = tagParts.concat(['**widget_serialization']);
    const tagStr = `.tag(${tagParts.join(', ')})`;
    // allow type unions
    if (typeName instanceof Array) {
        const instances = typeName.map(function(tname) {
            return `        ${traitType}(${tname}, ${nullableStr})`;
        });
        return `Union([\n${instances.join(',\n')}\n    ], ${nullableStr})${tagStr}`;
    }

    if (typeName.toLowerCase() === 'this') {
        return `This()${tagStr}`;
    }

    let ret = `${traitType}(${typeName}`;
    if (args !== undefined) {
        ret += `, args=${args}`;
    }
    if (kwargs !== undefined) {
        ret += `, kw=${kwargs}`;
    }
    ret += `, ${nullableStr})${tagStr}`;
    return ret;
}

class ThreeType extends BaseType {
    constructor(typeName, options) {
        options = options || {};
        super(options);
        this.typeName = typeName || '';
        this.defaultValue = null;
        this.serializer = JS_WIDGET_SERIALIZER;
        this.nullable = options.nullable !== false;
        this.args = options.args;
        this.kwargs = options.kwargs;
    }
    getTraitlet() {
        let typeName = this.typeName;
        if (typeName instanceof Array) {
            typeName = typeName.map(tname => {
                return `${tname || 'ThreeWidget'}`;
            });
        } else {
            typeName = `${typeName || 'ThreeWidget'}`;
        }
        return genInstanceTraitlet(
            typeName, this.nullable, this.args, this.kwargs, this.getTagParts());
    }
    getPropArrayName() {
        return 'three_properties';
    }
    getPropertyConverterFn() {
        return 'convertThreeType';
    }
}

class ForwardDeclaredThreeType extends ThreeType {
    constructor(typeName, modulePath, options) {
        super(typeName, options);
        this.modulePath = modulePath;
    }
    forwardType() {
        return this.modulePath + '.' + this.typeName;
    }
    getTraitlet() {
        return genInstanceTraitlet(
            this.forwardType(), this.nullable, this.args, this.kwargs, this.getTagParts());
    }
}

class InitializedThreeType extends ThreeType {
    getJSPropertyValue() {
        return "'uninitialized'";
    }
    getPythonDefaultValue() {
        return 'UninitializedSentinel';
    }
    getTagParts() {
        return super.getTagParts().concat(['**unitialized_serialization']);
    }
    getTraitlet() {
        const typeName = this.typeName;
        const nullableStr = this.getNullableStr();
        let inst = `Instance(${typeName}`;
        if (this.args !== undefined) {
            inst += `, args=${this.args}`;
        }
        if (this.kwargs !== undefined) {
            inst += `, kw=${this.kwargs}`;
        }
        inst += ')';
        const uninit = 'Instance(Uninitialized)';
        let ret = `Union([\n        ${uninit},\n        ${inst},\n        ]`;
        ret += `, default_value=${this.getPythonDefaultValue()}, ${nullableStr})`;
        ret += this.getTagString();
        return ret;
    }
}

class ThreeTypeArray extends BaseType {
    constructor(typeName, options) {
        options = options || {};
        super(options);
        this.typeName = typeName;
        this.defaultValue = [];
        this.serializer = JS_WIDGET_SERIALIZER;
        this.nullable = options.nullable !== false;
        this.allow_single = options.allow_single === true;
    }
    getTagParts() {
        return super.getTagParts().concat(['**widget_serialization']);
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        let baseType = 'Instance(' + this.typeName + ')' + this.getTagString();
        if (this.typeName == 'this') {
            baseType = 'This()' + this.getTagString();
        }

        if (this.allow_single) {
            return 'Union([' + baseType + ', List(trait=' + baseType + ', default_value=[])])';
        } else {
            return 'List(trait=' + baseType + ', default_value=[])';
        }
    }
    getPropArrayName() {
        return 'three_nested_properties';
    }
    getPropertyConverterFn() {
        return 'convertThreeTypeArray';
    }
}

class ThreeTypeDict extends BaseType {
    constructor(typeName, options) {
        super(options);
        this.typeName = typeName;
        this.defaultValue = {};
        this.serializer = JS_WIDGET_SERIALIZER;
    }
    getTagParts() {
        return super.getTagParts().concat(['**widget_serialization']);
    }
    getTraitlet() {
        if (this.typeName instanceof Array) {
            const instances = this.typeName.map(function(typeName) {
                return `        Instance(${typeName})`;
            });
            return `Dict(Union([\n${
                instances.join(',\n')}\n    ]))${this.getTagString()}`;
        }
        if (this.typeName === 'this') {
            return `Dict(This())${this.getTagString()}`;
        }
        return `Dict(Instance(${this.typeName}))${this.getTagString()}`;
    }
    getPropArrayName() {
        return 'three_nested_properties';
    }
    getPropertyConverterFn() {
        return 'convertThreeTypeDict';
    }
}

class BufferMorphAttributes extends BaseType {
    constructor(options) {
        super(options);
        this.defaultValue = {};
        this.serializer = JS_WIDGET_SERIALIZER;
    }
    getTagParts() {
        return super.getTagParts().concat(['**widget_serialization']);
    }
    getTraitlet() {
        const typeNames = ['BufferAttribute', 'InterleavedBufferAttribute'];
        const instances = typeNames.map(function(typeName) {
            return `        Instance(${typeName})`;
        });
        return 'Dict(TypedTuple(Union([\n' +
            instances.join(',\n') + '\n    ])))' + this.getTagString();
    }
    getPropArrayName() {
        return 'three_nested_properties';
    }
    getPropertyConverterFn() {
        return 'convertMorphAttributes';
    }
}

class Bool extends BaseType {
    constructor(defaultValue, options) {
        super(options);
        this.defaultValue = defaultValue;
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        return `Bool(${this.getPythonDefaultValue()}, ${nullableStr})${
            this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertBool';
    }
}

class Int extends BaseType {
    constructor(defaultValue, options) {
        options = options || {};
        super(options);
        this.minValue = options.minValue;
        this.maxValue = options.maxValue;
        this.defaultValue = (defaultValue === null || defaultValue === undefined) && !this.nullable ? 0 : defaultValue ;
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        let limits = '';
        if (this.minValue !== undefined) {
            limits += `, min=${this.minValue}`;
        }
        if (this.maxValue !== undefined) {
            limits += `, max=${this.maxValue}`;
        }
        return `CInt(${this.getPythonDefaultValue()}, ${nullableStr}${limits})${this.getTagString()}`;
    }

}

class Float extends BaseType {
    constructor(defaultValue, options) {
        options = options || {};
        super(options);
        this.minValue = options.minValue;
        this.maxValue = options.maxValue;
        this.defaultValue = (defaultValue === null || defaultValue === undefined) && !this.nullable ? 0.0 : defaultValue;
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        let limits = '';
        if (this.minValue !== undefined) {
            limits += `, min=${this.minValue}`;
        }
        if (this.maxValue !== undefined) {
            limits += `, max=${this.maxValue}`;
        }
        return `CFloat(${this.getPythonDefaultValue()}, ${nullableStr}${limits})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertFloat';
    }

}

class StringType extends BaseType {
    constructor(defaultValue, options) {
        super(options);
        this.defaultValue = defaultValue;
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        return `Unicode(${this.getPythonDefaultValue()}, ${nullableStr})${this.getTagString()}`;
    }

}

class Enum extends BaseType {
    constructor(enumTypeName, defaultValue, options) {
        super(options);
        this.enumTypeName = enumTypeName;
        this.defaultValue = defaultValue;
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        return `Enum(${this.enumTypeName}, ${
            this.getPythonDefaultValue()}, ${nullableStr})${
            this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertEnum';
    }
}

class Color extends BaseType {
    constructor(defaultValue, options) {
        super(options);
        this.defaultValue = defaultValue || '#ffffff';
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        return `Color(${
            this.getPythonDefaultValue()}, ${nullableStr})${
            this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertColor';
    }
}

class ColorArray extends BaseType {
    constructor(defaultValue, options) {
        super(options);
        this.defaultValue = defaultValue || ['#ffffff'];
    }
    getTraitlet() {
        return `List(trait=Unicode(), default_value=${
            this.getPythonDefaultValue()})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertColorArray';
    }
    getPropertyAssignmentFn() {
        return 'assignArray';
    }
}

class ArrayType extends BaseType {
    constructor(defaultValue, options) {
        super(options);
        this.defaultValue = defaultValue === undefined ? [] : defaultValue;
    }
    getTraitlet() {
        return `List()${this.getTagString()}`;
    }
    getPropertyAssignmentFn() {
        return 'assignArray';
    }
}


class ArrayBufferType extends BaseType {
    constructor(arrayType, shapeConstraint, options) {
        super(options);
        this.arrayType = arrayType;
        this.shapeConstraint = shapeConstraint;
        this.defaultValue = options && options.nullable ? null : undefined;
        this.serializer = 'dataserializers.data_union_serialization';
    }
    getTraitlet() {
        const args = [];
        if (this.defaultValue !== undefined) {
            args.push(pythonify(this.defaultValue));
        }
        if (this.arrayType) {
            args.push(`dtype=${pythonify(this.arrayType)}`);
        }
        if (this.shapeConstraint) {
            args.push(`shape_constraint=shape_constraints(${
                this.shapeConstraint.map(function(v) { return pythonify(v); }).join(', ')
            })`);
        }
        if (this.nullable) {
            args.push(this.getNullableStr());
        }

        return `WebGLDataUnion(${args.join(', ')})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertArrayBuffer';
    }
    getPropArrayName() {
        return 'datawidget_properties';
    }
}

class DictType extends BaseType {
    constructor(defaultValue={}, options) {
        super(options);
        this.defaultValue = defaultValue;
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        return `Dict(default_value=${
            this.getPythonDefaultValue()}, ${nullableStr})${
            this.getTagString()}`;
    }
    getPropertyAssignmentFn() {
        return 'assignDict';
    }
}

class UniformDict extends DictType {
    constructor(defaultValue={}, options) {
        super(defaultValue, options);
        this.serializer = '{ serialize: serializers.serializeUniforms, ' +
            'deserialize: serializers.deserializeUniforms }';
    }
    getTraitlet() {
        const nullableStr = this.getNullableStr();
        return `Dict(default_value=${
            this.getPythonDefaultValue()
        }, trait=Uniform(allow_none=True), ${
            nullableStr
        })${this.getTagString()}`;
    }
    getTagParts() {
        return super.getTagParts().concat(['**uniforms_serialization']);
    }
}

class FunctionType extends BaseType {
    constructor(fn, options) {
        super(options);
        this.defaultValue = fn || function() {};
    }
    getTraitlet() {
        return `Unicode('${
            this.defaultValue.toString()}')${this.getTagString()}`;
    }
    getJSPropertyValue() {
        return this.defaultValue.toString();
    }
    getPropertyConverterFn() {
        return 'convertFunction';
    }
}

class Vector2 extends BaseType {
    constructor(x, y, options) {
        super(options);
        this.defaultValue = [ x||0, y||0 ];
    }
    getTraitlet() {
        return `Vector2(default_value=${
            pythonify(this.defaultValue)})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertVector';
    }
    getPropertyAssignmentFn() {
        return 'assignVector';
    }
}

class Vector3 extends BaseType {
    constructor(x, y, z, options) {
        super(options);
        this.defaultValue = [ x||0, y||0, z||0 ];
    }
    getTraitlet() {
        return `Vector3(default_value=${
            pythonify(this.defaultValue)})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertVector';
    }
    getPropertyAssignmentFn() {
        return 'assignVector';
    }
}

class Vector4 extends BaseType {
    constructor(x, y, z, w, options) {
        super(options);
        this.defaultValue = [ x||0, y||0, z||0, w||0 ];
    }
    getTraitlet() {
        return `Vector4(default_value=${
            pythonify(this.defaultValue)})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertVector';
    }
    getPropertyAssignmentFn() {
        return 'assignVector';
    }
}

class VectorArray extends BaseType {
    constructor(options) {
        super(options);
        this.defaultValue = [];
    }
    getTraitlet() {
        return `List(trait=List())${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertVectorArray';
    }
    getPropertyAssignmentFn() {
        return 'assignArray';
    }
}

class FaceArray extends BaseType {
    constructor(options) {
        super(options);
        this.defaultValue = [];
    }
    getTraitlet() {
        return `TypedTuple(trait=Face3())${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertFaceArray';
    }
    getPropertyAssignmentFn() {
        return 'assignArray';
    }
}

class Matrix3 extends BaseType {
    constructor(options) {
        super(options);
        this.defaultValue = [
            1, 0, 0,
            0, 1, 0,
            0, 0, 1,
        ];
    }
    getTraitlet() {
        return `Matrix3(default_value=${
            pythonify(this.defaultValue)})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertMatrix';
    }
    getPropertyAssignmentFn() {
        return 'assignMatrix';
    }
}

class Matrix4 extends BaseType {
    constructor(options) {
        super(options);
        this.defaultValue = [
            1, 0, 0, 0,
            0, 1, 0, 0,
            0, 0, 1, 0,
            0, 0, 0, 1
        ];
    }
    getTraitlet() {
        return `Matrix4(default_value=${
            pythonify(this.defaultValue)})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertMatrix';
    }
    getPropertyAssignmentFn() {
        return 'assignMatrix';
    }
}


class Euler extends BaseType {
    constructor(options) {
        super(options);
        this.defaultValue = [0, 0, 0, 'XYZ'];
    }

    getTraitlet() {
        return `Euler(default_value=${
            pythonify(this.defaultValue)})${this.getTagString()}`;
    }
    getPropertyConverterFn() {
        return 'convertEuler';
    }
    getPropertyAssignmentFn() {
        return 'assignEuler';
    }
}


module.exports = {
    ThreeType: ThreeType,
    ForwardDeclaredThreeType: ForwardDeclaredThreeType,
    InitializedThreeType: InitializedThreeType,
    ThreeTypeArray: ThreeTypeArray,
    ThreeTypeDict: ThreeTypeDict,
    BufferMorphAttributes: BufferMorphAttributes,
    Int: Int,
    Float: Float,
    String: StringType,
    Bool: Bool,
    Enum: Enum,
    Color: Color,
    ColorArray: ColorArray,
    Array: ArrayType,
    ArrayBuffer: ArrayBufferType,
    Dict: DictType,
    UniformDict: UniformDict,
    Function: FunctionType,
    Vector2: Vector2,
    Vector3: Vector3,
    Vector4: Vector4,
    VectorArray: VectorArray,
    FaceArray: FaceArray,
    Matrix3: Matrix3,
    Matrix4: Matrix4,
    Euler: Euler,
};