Logos.Symbol (Logos v0.2.0)

A Logos symbol: x, my-fn, ns/x, +, /.

name is the bare symbol text (never includes a namespace qualifier); ns is nil for an unqualified symbol, or the text before the / for a qualified one. meta holds reader-attached metadata (from ^meta sym sugar in the grammar) -- an ordinary map, defaulting to %{}.

Symbols are reader/macro-level data (Logos.Form.t()), not values that get "looked up" by the reader itself -- symbol resolution against a lexical environment or namespace happens later, in Logos.Eval, when the symbol is evaluated as an expression. This struct only carries the parsed shape.

Summary

Types

t()

Functions

new(name, ns \\ nil, meta \\ %{})

Builds a symbol directly from an already-split name/ns, bypassing text parsing.

parse(text)

Parses raw symbol text (as it appeared in source, e.g. "ns/x" or "/") into a %Logos.Symbol{}.

to_string(symbol)

The full printed form of a symbol: name alone, or ns/name when qualified.

Types

t()

@type t() :: %Logos.Symbol{meta: map(), name: String.t(), ns: String.t() | nil}

Functions

new(name, ns \\ nil, meta \\ %{})

@spec new(String.t(), String.t() | nil, map()) :: t()

Builds a symbol directly from an already-split name/ns, bypassing text parsing.

parse(text)

@spec parse(String.t()) :: t()

Parses raw symbol text (as it appeared in source, e.g. "ns/x" or "/") into a %Logos.Symbol{}.

Edge case: the grammar's SYMBOL_START/SYMBOL_CHAR character classes both include /, so / is itself a perfectly ordinary symbol (the division function) as well as the namespace separator. A symbol whose entire text is "/" is therefore special-cased to ns: nil, name: "/" before the general split -- otherwise splitting "/" on / would produce a bogus {ns: "", name: ""}. For any other text containing a /, everything before the first / becomes ns and everything after (which could itself contain further /s, e.g. a symbol naming a path-like value) becomes name -- Logos doesn't otherwise validate namespace segments at read time, that's a job for symbol resolution in Logos.Eval/Logos.Namespace later.

to_string(symbol)

@spec to_string(t()) :: String.t()

The full printed form of a symbol: name alone, or ns/name when qualified.