105 lines
6 KiB
Haxe
105 lines
6 KiB
Haxe
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 Leon van Kammen/NLNET
|
|
package xrfragment;
|
|
|
|
import xrfragment.XRF;
|
|
|
|
@:expose // <- makes the class reachable from plain JavaScript
|
|
@:keep // <- avoids accidental removal by dead code elimination
|
|
class Parser {
|
|
public static var error:String = "";
|
|
public static var debug:Bool = false;
|
|
|
|
@:keep
|
|
public static function parse(key:String,value:String,store:haxe.DynamicAccess<Dynamic>):Bool {
|
|
// here we define allowed characteristics & datatypes for each fragment (stored as bitmasked int for performance purposes)
|
|
var Frag:Map<String, Int> = new Map<String, Int>();
|
|
|
|
Frag.set("#", XRF.ASSET | XRF.T_PREDEFINED_VIEW | XRF.PV_EXECUTE );
|
|
Frag.set("prio", XRF.ASSET | XRF.T_INT );
|
|
Frag.set("src", XRF.ASSET | XRF.T_URL );
|
|
|
|
// category: href navigation / portals / teleporting
|
|
Frag.set("href", XRF.ASSET | XRF.T_URL | XRF.T_PREDEFINED_VIEW );
|
|
Frag.set("class", XRF.ASSET | XRF.T_STRING );
|
|
|
|
// category: query selector / object manipulation
|
|
Frag.set("pos", XRF.PV_OVERRIDE | XRF.ROUNDROBIN | XRF.T_VECTOR3 | XRF.T_STRING_OBJ | XRF.METADATA | XRF.NAVIGATOR );
|
|
Frag.set("q", XRF.PV_OVERRIDE | XRF.T_STRING | XRF.METADATA );
|
|
Frag.set("scale", XRF.QUERY_OPERATOR | XRF.PV_OVERRIDE | XRF.ROUNDROBIN | XRF.T_VECTOR3 | XRF.METADATA );
|
|
Frag.set("rot", XRF.QUERY_OPERATOR | XRF.PV_OVERRIDE | XRF.ROUNDROBIN | XRF.T_VECTOR3 | XRF.METADATA | XRF.NAVIGATOR );
|
|
Frag.set("mov", XRF.QUERY_OPERATOR | XRF.PV_OVERRIDE | XRF.ROUNDROBIN | XRF.T_VECTOR3 | XRF.METADATA );
|
|
Frag.set("show", XRF.QUERY_OPERATOR | XRF.PV_OVERRIDE | XRF.ROUNDROBIN | XRF.T_INT | XRF.METADATA );
|
|
Frag.set("env", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_STRING | XRF.METADATA );
|
|
|
|
// category: animation
|
|
Frag.set("t", XRF.ASSET | XRF.PV_OVERRIDE | XRF.ROUNDROBIN | XRF.T_VECTOR2 | XRF.NAVIGATOR | XRF.METADATA);
|
|
Frag.set("gravity", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_VECTOR3 | XRF.METADATA );
|
|
Frag.set("physics", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_VECTOR3 | XRF.METADATA );
|
|
|
|
// category: device / viewport settings
|
|
Frag.set("fov", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_INT | XRF.NAVIGATOR | XRF.METADATA );
|
|
Frag.set("clip", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_VECTOR2 | XRF.NAVIGATOR | XRF.METADATA );
|
|
Frag.set("fog", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_VECTOR2 | XRF.NAVIGATOR | XRF.METADATA );
|
|
Frag.set("bg", XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_VECTOR3 | XRF.NAVIGATOR | XRF.METADATA );
|
|
|
|
// category: author / metadata
|
|
Frag.set("namespace", XRF.ASSET | XRF.T_STRING );
|
|
Frag.set("SPDX", XRF.ASSET | XRF.T_STRING );
|
|
Frag.set("unit", XRF.ASSET | XRF.T_STRING );
|
|
Frag.set("description", XRF.ASSET | XRF.T_STRING );
|
|
|
|
// category: multiparty
|
|
Frag.set("session", XRF.ASSET | XRF.T_URL | XRF.PV_OVERRIDE | XRF.NAVIGATOR | XRF.METADATA | XRF.PROMPT );
|
|
|
|
/**
|
|
* # Spec
|
|
*
|
|
* > version 1.0.0 [](https://github.com/coderofsalvation/xrfragment/actions) generated by `make doc` @ $(date +"%Y-%m-%dT%H:%M:%S%z")
|
|
*
|
|
* In case your programming language has no parser ([check here](https://github.com/coderofsalvation/xrfragment/tree/main/dist)) you can [crosscompile it](https://github.com/coderofsalvation/xrfragment/blob/main/build.hxml), or roll your own `Parser.parse(k,v,store)` using the spec:
|
|
*/
|
|
|
|
// 1. requirement: receive arguments: key (string), value (string), store (writable associative array/object)
|
|
|
|
// dynamic fragments cases: predefined views & assign/binds
|
|
var isPVDynamic:Bool = value.length == 0 && key.length > 0 && !Frag.exists(key);
|
|
var isPVDefault:Bool = value.length == 0 && key.length > 0 && key == "#";
|
|
if( isPVDynamic ){ //|| isPVDefault ){ // 1. add keys without values to store as [predefined view](predefined_view)
|
|
var v:XRF = new XRF(key, XRF.PV_EXECUTE | XRF.NAVIGATOR );
|
|
v.validate(key); // will fail but will parse multiple args for us (separated by |)
|
|
store.set(key, v );
|
|
return true;
|
|
}
|
|
if( key.split(".").length > 1 && value.split(".").length > 1 ){
|
|
store.set(key, new XRF(key, XRF.ASSET | XRF.PV_OVERRIDE | XRF.T_STRING | XRF.PROP_BIND ) );
|
|
return true;
|
|
}
|
|
|
|
// regular fragments:
|
|
var v:XRF = new XRF(key, Frag.get(key));
|
|
if( Frag.exists(key) ){ // 1. check if fragment is official XR Fragment
|
|
if( !v.validate(value) ){ // 1. guess the type of the value (string,int,float,x,y,z,color,args,query)
|
|
trace("⚠ fragment '"+key+"' has incompatible value ("+value+")");// 1. don't add to store if value-type is incorrect
|
|
return false;
|
|
}
|
|
store.set(key, v ); // 1. if valid, add to store
|
|
if( debug ) trace("✔ "+key+": "+v.string);
|
|
}else{ // 1. prefix non-offical fragment key's with underscore (and add to store)
|
|
if( Std.isOfType(value, String) ) v.guessType(v,value);
|
|
store.set("_"+key,v);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* > icanhazcode? yes, see [Parser.hx](https://github.com/coderofsalvation/xrfragment/blob/main/src/xrfragment/Parser.hx)
|
|
*
|
|
* # Tests
|
|
*
|
|
* the spec is tested with [JSON unittests](./../src/spec) consumed by [Test.hx](./../src/Test.hx) to cross-test all languages.
|
|
*/
|
|
|