BrowserInformation

hypertex.spad line 12 [edit on github]

This package makes available information about Spad constructors and operations.

all_constructors: () -> Record(categories: List Symbol, domains: List Symbol, packages: List Symbol)

all_constructors() gives list of all constructor names, split into categories, domains and packages.

ancestors: (SExpression, Boolean) -> List Record(form: SExpression, condition: SExpression)

ancestors(c, use_args?) computes ancestors of a constructor.

constructor_documentation: Symbol -> String

constructor_documentation(n) gives documentation string for constructor with name s. Returns empty string for undocumented constructors.

constructor_form: Symbol -> SExpression

constructor_form(n) gives constructor form, that is S-expression (list) with constructor name and argument names for constructor with name s.

constructor_kind: Symbol -> Symbol

constructor_kind(s) gives constructor kind, that is one of category, domain, package.

constructor_name?: Symbol -> Boolean

constructor_name?(s) returns true if and only if s is a name of existing constructor.

constructor_signature: (Symbol, List SExpression) -> SExpression

constructor_signature(s) gives constructor signature, that is S-expression (list) giving type of constructor and types of arguments.

convert_pattern: String -> Union(SExpression, ErrorIndicator)

convert_pattern(n) converts search pattern n to an internal form used by do_match.

default_name?: Symbol -> Boolean

default_name?(s) returns true if and only if s has format of name of a default package, that is name of s ends in an ampersand.

do_match: (SExpression, String) -> Boolean

do_match(p, s) returns true if and only if s matches to pattern p.

downcase: String -> String

downcase(s) converts s to lower case.

exports: SExpression -> Record(cats: List Record(form: SExpression, condition: SExpression), ops: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)))

exports(c) gives explicit exports of a constructor.

exposed_constructor?: Symbol -> Boolean

exposed_constructor?(s) returns true if and only if s is a name of an exposed constructor.

filter_ops: (SExpression, List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))) -> List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))

filter_ops(p, ol) gives list of operations from ol with names matching p.

filter_symbols: (SExpression, List Symbol) -> List Symbol

filter_symbols(p, sl) gives list of symbols from sl with names matching p.

group_by_condition: List Record(form: SExpression, condition: SExpression) -> List Record(grp_tag: SExpression, constrs: List Record(form: SExpression, condition: SExpression))

group_by_condition(ol) splits list of constructors with conditions depending on their conditions.

group_by_condition: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)) -> List Record(grp_tag: SExpression, ops: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)))

group_by_condition(ol) splits list of operations depending on their conditions.

group_by_implementation: (List SExpression, SExpression, List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))) -> List Record(grp_tag: SExpression, ops: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)))

group_by_condition(al, df, ol) splits list of operations ol depending on their implementation. ol must be a list of operations from a domain with form df, al must fully specify operations of the domain.

group_by_origin: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)) -> List Record(grp_tag: SExpression, ops: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)))

group_by_origin(ol) splits list of operations depending on their origin.

operations: (SExpression, Boolean) -> List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))

operations(c, use_args?) computes operation list of a constructor.

ops_from_exports: () -> List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))

ops_from_exports() gives list of all exported operations computed from constructor exports.

ops_from_libdb: () -> List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))

ops_from_libdb() gives list of all exported operations from libdb. This operation is present only to check compatibility with old code and will be removed in the future.

parents: SExpression -> List Record(form: SExpression, condition: SExpression)

parents(c) gives parents (that is direct ancestors) of a constructor.

search_constructors: (String, Symbol) -> Union(Record(categories: List Symbol, domains: List Symbol, packages: List Symbol), ErrorIndicator)

search_constructors(n, t) searches for constructors with name matching n. t may be k (meaning all constructors), c, d or p meaning only categories, domains or packages are returned.

search_documentation: String -> Union(Record(con_info: Record(categories: List Symbol, domains: List Symbol, packages: List Symbol), op_info: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))), ErrorIndicator)

search_documentation(n) searches for constructors and operations with documentation string matching n.

search_general: String -> Union(Record(con_info: Record(categories: List Symbol, domains: List Symbol, packages: List Symbol), op_info: List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))), ErrorIndicator)

search_general(n) searches constructors and operations with name matching n.

search_operations: String -> Union(List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)), ErrorIndicator)

search_operations(n) searches for operations with name matching n.

search_operations_libdb: String -> Union(List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)), ErrorIndicator)

search_operations_libdb(n) searches for all operations with name matching n using old code. This operation is present only to check compatibility with old code and will be removed in the future.

search_opl: (String, List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))) -> Union(List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)), ErrorIndicator)

search_opl(n, ol) gives list of operations from ol with names matching n.

simp_ops_conditions: (List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String)), SExpression, SExpression) -> List Record(name: Symbol, sdl: List Record(signature: SExpression, condition: SExpression, origin: SExpression, documentation: String))

simp_ops_conditions(ol, cf, df) simplifies conditions of operations in ol after arguments in df are substituded for arguments in cf.

sublis_formal: (List SExpression, SExpression) -> SExpression

sublis_formal(args, expr) replaces formal variable symbols in expr by corresponding elements of args.