coderofsalvation/xrfragment-haxe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc

Browse source
This commit is contained in:
Leon van Kammen 2023-03-31 17:35:06 +02:00
parent b54e323752
commit c026d900f1
1 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/xrfragment/Parser.hx
View file

@ -2,23 +2,22 @@ package xrfragment;
@:expose // <- makes the class reachable from plain JavaScript @:expose // <- makes the class reachable from plain JavaScript
@:keep // <- avoids accidental removal by dead code elimination @:keep // <- avoids accidental removal by dead code elimination
// [https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg](https://github.com/coderofsalvation/xrfragment)
class Parser { // # XR Fragments (key/value params) class Parser { // # XR Fragments (key/value params)
public static var error:String = ""; // public static var error:String = ""; //
// ``` // > ⛁ = supported in 3D asset-file (custom property or projection)<br>
// ⛁ = fragment in 3D asset-file (custom property) // > ⚂ = supported in navigator URI (`document.location.href` e.g.)<br>
// ⚂ = fragment in navigator URI (`document.location.href` e.g.) @:keep //
@:keep // ```
public static function parse(key:String,value:String,resultMap:haxe.DynamicAccess<Dynamic>):Bool { public static function parse(key:String,value:String,resultMap:haxe.DynamicAccess<Dynamic>):Bool {
var Frag:Map<String, EReg> = new Map<String, EReg>(); // | param | type | scope | navigator override |category | notes | var Frag:Map<String, EReg> = new Map<String, EReg>(); // | param | type | scope(s) | category | notes |
// |---------|---------------|-------|--------------------|-------------------------| // |---------|---------------|-------|--------------------|---------------------------------|
Frag.set("prio", Type.isInt); // | prio | int (-10..1) | ⛁ | Asset loading / linking | #include doc/notes/prio.md | Frag.set("prio", Type.isInt); // | prio | int (-10..1) | ⛁ | Asset loading / linking | #include doc/notes/prio.md |
Frag.set("pos", Type.isVector); // | pos | 3D vector | HREF navigation/portals | | Frag.set("pos", Type.isVector); // | pos | 3D vector | ⛁ ⚂ |HREF navigation/portals | |
// //
// # XR Fragments parser // # XR Fragments parser
if( Frag.exists(key) ){ // note: community parsers will prolly outperform this initial parser :) if( Frag.exists(key) ){ // note: community parsers will prolly outperform this initial parser :)
if( Frag.get(key).match(value) ){ // > icanhazcode? yes, see [Parser.hx](./../src/xrfragment/Parser.hx) if( Frag.get(key).match(value) ){ // > icanhazcode? yes, see [Parser.hx](https://github.com/coderofsalvation/xrfragment/blob/main/src/xrfragment/Parser.hx)
var v:Value = new Value(); // var v:Value = new Value(); //
guessType(v, value); // the gist of it: guessType(v, value); // the gist of it:
// process multiple/fallback values // 1. each key has a regex to validate its value-type (see regexes) // process multiple/fallback values // 1. each key has a regex to validate its value-type (see regexes)