Sni

Sni models a Subject Navigation Identifier formatted as:

/provider/tail?params#frag

Decode the full view state from a Dict produced by encode.

Default is same as home

Encode the full view state -- string plus spilled values -- to a Dict for history state, server requests, and favorites. The sni tag holds the string (with "$key" placeholders); the spills tag holds the spilled values when present. Reverse with decode.

Equality based on string and spills. Spill keys must match exactly. For string-only comparison use a.toStr == b.toStr.

Equality ignoring fragment

Fragment identifier for location within the subject. Null if no fragment.

/files/lib.xeto#L10 => "L10"
/files/lib.xeto#L10,5-L20,3 => "L10,5-L20,3"

Construct Sni from a Ref identity (reverse of id). If norm is true, relativize the ref via UiSpace if available.

Create "/db?sel=id1,id2,..." sni from multiple refs. If norm is true, relativize ids via UiSpace if available. More than 8 ids will spill to the $a key (e.g. "?sel=$a").

Parse from string formatted as "/provider/tail?params#frag"

Get a single param value by name, or null if not present.

Hash code based on string

Home root "/"

Get Ref identity for this Sni. For /db/{id} where id is a valid bare Ref, returns Ref(id). For all others returns sni:{provider}:{tail-encoded}. Params and fragment are never part of identity.

Parse fragment as start location, or null if no fragment. Returns FileLoc with line and optional column.

#L10 => FileLoc("", 10)
#L10,5 => FileLoc("", 10, 5)
#L10,5-L20,3 => FileLoc("", 10, 5)

Parse fragment as end location for a range, or null if no range. Returns FileLoc with line and optional column.

#L10 => null
#L10-L20 => FileLoc("", 20)
#L10,5-L20,3 => FileLoc("", 20, 3)

Last named part in path of tail or provider

/files/lib/doc.xeto/Specs.md => "Specs.md"

Return Sni with fragment stripped. Returns this if no fragment.

Query parameters parsed as key-value map. Returns empty map if no params.

Append a name to the tail path, dropping any params.

/dev/a/b?view=xxx plusName("c.txt") => /dev/a/b/c.txt

Append a trailing slash, dropping any params

/dev/a/b?view=xxx plusSlash => /dev/a/b/

Provider is the first path segment identifying the subject provider. Empty string only for root "/".

/db/ph::Equip/abc-123 => "db"
/files/lib/doc.xeto/Specs.md => "file"

Selection ids parsed from the "sel" param, or null if not present. A selection is a view of its base collection, never identity - see id. Returns null if the param was spilled and the spill values are not available (string-only reparse). See setSel.

Return new Sni with the given param set. If val is null, the param is removed. Returns this if unchanged.

Return new Sni with given fragment, or remove if null.

Return new Sni with given params.

Return new Sni with the "sel" param set to the given selection ids, or removed if null. More than 8 ids spill to a "$key" placeholder carried by the spills Dict. See sel.

Return new Sni with given tail.

Set view name

Spilled values keyed by spill key "a", "b", "c"... These are the typed values (e.g. Ref[]) referenced by "$key" placeholders in the string (so "$a" maps to spills->a). Keys are valid tag names. Empty Dict if no values spilled. See encode.

Tail as list of path segments after the provider. Returns empty list if no tail.

/db/ph::Equip/abc-123 => ["ph::Equip", "abc-123"]
/files/lib/doc.xeto/Specs.md => ["lib", "doc.xeto", "Specs.md"]

Tail as the full string after the provider. Returns empty string if no tail.

/db/ph::Equip/abc-123 => "ph::Equip/abc-123"
/files/lib/doc.xeto/Specs.md => "lib/doc.xeto/Specs.md"

To item

Full string representation. This is the URL form which carries spill placeholders such as "$0" but not the spilled values themselves. Use encode/decode to round-trip the full state including spills.

Convert to a URI

Get the "view" parameter