MemCP - User contributions [en]

Sync

2025-08-25T16:53:06Z

Aiagent: Created page with "= Sync = The '''Sync''' module provides synchronization and concurrency functionality for the SCM programming language. This module includes: * '''Session management''': Functions to create threadsafe key-value stores (newsession) * '''Context handling''': Context management with session support (context) * '''Timing control''': Functions to pause execution (sleep) * '''Function caching''': One-time execution wrappers with result caching (once) * '''Thread synchronizat..."

= Sync =

The '''Sync''' module provides synchronization and concurrency functionality for the SCM programming language. This module includes:

* '''Session management''': Functions to create threadsafe key-value stores (newsession)
* '''Context handling''': Context management with session support (context)
* '''Timing control''': Functions to pause execution (sleep)
* '''Function caching''': One-time execution wrappers with result caching (once)
* '''Thread synchronization''': Mutex creation for serialized access (mutex)

These functions provide essential tools for managing concurrent operations, shared state, and synchronization in multi-threaded SCM programs.

← Back to [[Full SCM API documentation]]

== newsession ==

Creates a new session which is a threadsafe key-value store represented as a function that can be either called as a getter (session key) or setter (session key value) or list all keys with (session)

'''Allowed number of parameters:''' 0–0

'''Parameters:'''

''This function has no parameters.''

'''Returns:''' <code>func</code>

== context ==

Context helper function. Each context also contains a session. (context func args) creates a new context and runs func in that context, (context "session") reads the session variable, (context "check") will check the liveliness of the context and otherwise throw an error

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''args...''' (<code>any</code>): depends on the usage

'''Returns:''' <code>any</code>

== sleep ==

sleeps the amount of seconds

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''duration''' (<code>number</code>): number of seconds to sleep

'''Returns:''' <code>bool</code>

== once ==

Creates a function wrapper that you can call multiple times but only gets executed once. The result value is cached and returned on a second call. You can add parameters to that resulting function that will be passed to the first run of the wrapped function.

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''f''' (<code>func</code>): function that produces the result value

'''Returns:''' <code>func</code>

== mutex ==

Creates a mutex. The return value is a function that takes one parameter which is a parameterless function. The mutex is guaranteed that all calls to that mutex get serialized.

'''Allowed number of parameters:''' 1–1

'''Parameters:'''

''This function has no parameters.''

'''Returns:''' <code>func</code>

Parsers

2025-08-25T16:51:54Z

Aiagent: Created page with "= Parsers = The '''Parsers''' module provides parsing functionality for the SCM programming language. This module includes: * '''Parser creation''': Functions to create custom parsers using grammar syntax (parser) * '''Grammar support''': Support for various parser types including AtomParser, RegexParser, AndParser, OrParser, KleeneParser, ManyParser, MaybeParser, and more * '''Packrat parsing''': Implementation of packrat parsing algorithms for efficient parsing * '''..."

= Parsers =

The '''Parsers''' module provides parsing functionality for the SCM programming language. This module includes:

* '''Parser creation''': Functions to create custom parsers using grammar syntax (parser)
* '''Grammar support''': Support for various parser types including AtomParser, RegexParser, AndParser, OrParser, KleeneParser, ManyParser, MaybeParser, and more
* '''Packrat parsing''': Implementation of packrat parsing algorithms for efficient parsing
* '''Whitespace handling''': Configurable whitespace skipping mechanisms

These functions provide essential tools for creating custom parsers and processing structured text data in SCM programs.

← Back to [[Full SCM API documentation]]

== parser ==

creates a parser

SCM parsers work this way:
<code>(parser syntax scmerresult) -> func</code>

syntax can be one of:
* <code>(parser syntax scmerresult)</code> will execute scmerresult after parsing syntax
* <code>(parser syntax scmerresult "skipper")</code> will add a different whitespace skipper regex to the root parser
* <code>(define var syntax)</code> valid inside <code>(parser...)</code>, stores the result of syntax into var for use in scmerresult
* <code>"str"</code> AtomParser
* <code>(atom "str" caseinsensitive skipws)</code> AtomParser
* <code>(regex "asdf" caseinsensitive skipws)</code> RegexParser
* <code>'(a b c)</code> AndParser
* <code>(or a b c)</code> OrParser
* <code>(* sub separator)</code> KleeneParser
* <code>(+ sub separator)</code> ManyParser
* <code>(? xyz)</code> MaybeParser (if >1 AndParser)
* <code>(not mainparser parser1 parser2 parser3 ...)</code> a parser that matches mainparser but not parser1...
* <code>$</code> EndParser
* <code>empty</code> EmptyParser
* <code>symbol</code> -> use other parser defined in env

For further details on packrat parsers, take a look at https://github.com/launix-de/go-packrat

'''Allowed number of parameters:''' 1–3

'''Parameters:'''
* '''syntax''' (<code>any</code>): syntax of the grammar (see docs)
* '''generator''' (<code>any</code>): (optional) expressions to evaluate. All captured variables are available in the scope.
* '''skipper''' (<code>string</code>): (optional) string that defines the skip mechanism for whitespaces as regexp

'''Returns:''' <code>func</code>

Vectors

2025-08-25T16:50:41Z

Aiagent: Created page with "= Vectors = The '''Vectors''' module provides vector mathematics functionality for the SCM programming language. This module includes: * '''Vector operations''': Functions to perform mathematical operations on vectors (dot) * '''Distance calculations''': Support for different distance metrics including DOT, COSINE, and EUCLIDEAN These functions provide essential tools for working with vectors in mathematical computations, enabling vector analysis and similarity calcul..."

= Vectors =

The '''Vectors''' module provides vector mathematics functionality for the SCM programming language. This module includes:

* '''Vector operations''': Functions to perform mathematical operations on vectors (dot)
* '''Distance calculations''': Support for different distance metrics including DOT, COSINE, and EUCLIDEAN

These functions provide essential tools for working with vectors in mathematical computations, enabling vector analysis and similarity calculations in SCM programs.

← Back to [[Full SCM API documentation]]

== dot ==

produced the dot product

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''v1''' (<code>list</code>): vector1
* '''v2''' (<code>list</code>): vector2
* '''mode''' (<code>string</code>): DOT, COSINE, EUCLIDEAN, default is DOT

'''Returns:''' <code>number</code>

Date

2025-08-25T16:49:35Z

Aiagent: Created page with "= Date = The '''Date''' module provides date and time functionality for the SCM programming language. This module includes: * '''Current time''': Functions to get the current Unix timestamp (now) * '''Date parsing''': Functions to parse date strings into Unix timestamps (parse_date) These functions provide essential tools for working with dates and timestamps in SCM programs, enabling time-based operations and date string processing. ← Back to Full SCM API docume..."

= Date =

The '''Date''' module provides date and time functionality for the SCM programming language. This module includes:

* '''Current time''': Functions to get the current Unix timestamp (now)
* '''Date parsing''': Functions to parse date strings into Unix timestamps (parse_date)

These functions provide essential tools for working with dates and timestamps in SCM programs, enabling time-based operations and date string processing.

← Back to [[Full SCM API documentation]]

== now ==

returns the unix timestamp

'''Allowed number of parameters:''' 0–0

'''Parameters:'''

''This function has no parameters.''

'''Returns:''' <code>int</code>

== parse_date ==

parses unix date from a string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): values to parse

'''Returns:''' <code>int</code>

Associative Lists / Dictionaries

2025-08-25T16:48:26Z

Aiagent: Created page with "= Associative Lists / Dictionaries = The '''Associative Lists / Dictionaries''' module provides key-value data structure operations for the SCM programming language. This module includes: * '''Dictionary filtering''': Functions to filter dictionaries based on key-value conditions (filter_assoc) * '''Dictionary mapping''': Transform dictionary values while preserving keys (map_assoc) * '''Dictionary reduction''': Aggregate dictionary data into single values (reduce_asso..."

= Associative Lists / Dictionaries =

The '''Associative Lists / Dictionaries''' module provides key-value data structure operations for the SCM programming language. This module includes:

* '''Dictionary filtering''': Functions to filter dictionaries based on key-value conditions (filter_assoc)
* '''Dictionary mapping''': Transform dictionary values while preserving keys (map_assoc)
* '''Dictionary reduction''': Aggregate dictionary data into single values (reduce_assoc)
* '''Dictionary queries''': Check for key existence and extract data (has_assoc?, extract_assoc)
* '''Dictionary modification''': Set individual values and merge dictionaries (set_assoc, merge_assoc)

These functions provide essential tools for working with associative data structures, enabling efficient key-value operations and dictionary manipulation in SCM programs.

← Back to [[Full SCM API documentation]]

== filter_assoc ==

returns a filtered dictionary according to a filter function

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''dict''' (<code>list</code>): dictionary that has to be filtered
* '''condition''' (<code>func</code>): filter function func(string any)->bool where the first parameter is the key, the second is the value

'''Returns:''' <code>list</code>

== map_assoc ==

returns a mapped dictionary according to a map function. Keys will stay the same but values are mapped.

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''dict''' (<code>list</code>): dictionary that has to be mapped
* '''map''' (<code>func</code>): map function func(string any)->any where the first parameter is the key, the second is the value. It must return the new value.

'''Returns:''' <code>list</code>

== reduce_assoc ==

reduces a dictionary according to a reduce function

'''Allowed number of parameters:''' 3–3

'''Parameters:'''
* '''dict''' (<code>list</code>): dictionary that has to be reduced
* '''reduce''' (<code>func</code>): reduce function func(any string any)->any where the first parameter is the accumulator, second is key, third is value. It must return the new accumulator.
* '''neutral''' (<code>any</code>): initial value for the accumulator

'''Returns:''' <code>any</code>

== has_assoc? ==

checks if a dictionary has a key present

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''dict''' (<code>list</code>): dictionary that has to be checked
* '''key''' (<code>string</code>): key to test

'''Returns:''' <code>bool</code>

== extract_assoc ==

applies a function (key value) on the dictionary and returns the results as a flat list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''dict''' (<code>list</code>): dictionary that has to be checked
* '''map''' (<code>func</code>): func(string any)->any that flattens down each element

'''Returns:''' <code>list</code>

== set_assoc ==

returns a dictionary where a single value has been changed. This function may destroy the input value for the sake of performance. You must not use the input value again.

'''Allowed number of parameters:''' 3–4

'''Parameters:'''
* '''dict''' (<code>list</code>): input dictionary that has to be changed. You must not use this value again.
* '''key''' (<code>string</code>): key that has to be set
* '''value''' (<code>any</code>): new value to set
* '''merge''' (<code>func</code>): (optional) func(any any)->any that is called when a value is overwritten. The first parameter is the old value, the second is the new value. It must return the merged value that shall be pysically stored in the new dictionary.

'''Returns:''' <code>list</code>

== merge_assoc ==

returns a dictionary where all keys from dict1 and all keys from dict2 are present. If a key is present in both inputs, the second one will be dominant so the first value will be overwritten unless you provide a merge function

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''dict1''' (<code>list</code>): first input dictionary that has to be changed. You must not use this value again.
* '''dict2''' (<code>list</code>): input dictionary that contains the new values that have to be added
* '''merge''' (<code>func</code>): (optional) func(any any)->any that is called when a value is overwritten. The first parameter is the old value, the second is the new value from dict2. It must return the merged value that shall be pysically stored in the new dictionary.

'''Returns:''' <code>list</code>

Lists

2025-08-25T16:46:21Z

Aiagent: Created page with "= Lists = The '''Lists''' module provides comprehensive list manipulation and processing functions for the SCM programming language. This module includes: * '''List operations''': Basic operations like counting (count), accessing elements (nth), and type checking (list?) * '''List construction''': Building lists with append, cons, and unique operations (append_unique, merge_unique) * '''List deconstruction''': Extracting parts with car (head), cdr (tail), and filtering..."

= Lists =

The '''Lists''' module provides comprehensive list manipulation and processing functions for the SCM programming language. This module includes:

* '''List operations''': Basic operations like counting (count), accessing elements (nth), and type checking (list?)
* '''List construction''': Building lists with append, cons, and unique operations (append_unique, merge_unique)
* '''List deconstruction''': Extracting parts with car (head), cdr (tail), and filtering operations
* '''Functional programming''': Higher-order functions like map, filter, reduce, and produce for advanced list processing
* '''List utilities''': Searching (has?, contains?), merging, zipping, and flattening operations
* '''List generation''': Creating sequences and ranges with produce and produceN functions

These functions provide the essential tools for working with lists as the primary data structure in functional programming with SCM.

← Back to [[Full SCM API documentation]]

== count ==

counts the number of elements in the list

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''list''' (<code>list</code>): base list

'''Returns:''' <code>int</code>

== nth ==

get the nth item of a list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''list''' (<code>list</code>): base list
* '''index''' (<code>number</code>): index beginning from 0

'''Returns:''' <code>any</code>

== append ==

appends items to a list and return the extended list. The original list stays unharmed.

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''list''' (<code>list</code>): base list
* '''item...''' (<code>any</code>): items to add

'''Returns:''' <code>list</code>

== append_unique ==

appends items to a list but only if they are new. The original list stays unharmed.

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''list''' (<code>list</code>): base list
* '''item...''' (<code>any</code>): items to add

'''Returns:''' <code>list</code>

== cons ==

constructs a list from a head and a tail list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''car''' (<code>any</code>): new head element
* '''cdr''' (<code>list</code>): tail that is appended after car

'''Returns:''' <code>list</code>

== car ==

extracts the head of a list

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''list''' (<code>list</code>): list

'''Returns:''' <code>any</code>

== cdr ==

extracts the tail of a list. The tail of a list is a list with all items except the head.

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''list''' (<code>list</code>): list

'''Returns:''' <code>any</code>

== zip ==

swaps the dimension of a list of lists. If one parameter is given, it is a list of lists that is flattened. If multiple parameters are given, they are treated as the components that will be zipped into the sub list

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''list''' (<code>list</code>): list of lists of items

'''Returns:''' <code>list</code>

== merge ==

flattens a list of lists into a list containing all the subitems. If one parameter is given, it is a list of lists that is flattened. If multiple parameters are given, they are treated as lists that will be merged into one

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''list''' (<code>list</code>): list of lists of items

'''Returns:''' <code>list</code>

== merge_unique ==

flattens a list of lists into a list containing all the subitems. Duplicates are filtered out.

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''list''' (<code>list</code>): list of lists of items

'''Returns:''' <code>list</code>

== has? ==

checks if a list has a certain item (equal?)

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''haystack''' (<code>list</code>): list to search in
* '''needle''' (<code>any</code>): item to search for

'''Returns:''' <code>bool</code>

== filter ==

returns a list that only contains elements that pass the filter function

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''list''' (<code>list</code>): list that has to be filtered
* '''condition''' (<code>func</code>): filter condition func(any)->bool

'''Returns:''' <code>list</code>

== map ==

returns a list that contains the results of a map function that is applied to the list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''list''' (<code>list</code>): list that has to be mapped
* '''map''' (<code>func</code>): map function func(any)->any that is applied to each item

'''Returns:''' <code>list</code>

== mapIndex ==

returns a list that contains the results of a map function that is applied to the list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''list''' (<code>list</code>): list that has to be mapped
* '''map''' (<code>func</code>): map function func(i, any)->any that is applied to each item

'''Returns:''' <code>list</code>

== reduce ==

returns a list that contains the result of a map function

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''list''' (<code>list</code>): list that has to be reduced
* '''reduce''' (<code>func</code>): reduce function func(any any)->any where the first parameter is the accumulator, the second is a list item
* '''neutral''' (<code>any</code>): (optional) initial value of the accumulator, defaults to nil

'''Returns:''' <code>any</code>

== produce ==

returns a list that contains produced items - it works like for(state = startstate, condition(state), state = iterator(state)) {yield state}

'''Allowed number of parameters:''' 3–3

'''Parameters:'''
* '''startstate''' (<code>any</code>): start state to begin with
* '''condition''' (<code>func</code>): func that returns true whether the state will be inserted into the result or the loop is stopped
* '''iterator''' (<code>func</code>): func that produces the next state

'''Returns:''' <code>list</code>

== produceN ==

returns a list with numbers from 0..n-1

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''n''' (<code>number</code>): number of elements to produce

'''Returns:''' <code>list</code>

== list? ==

checks if a value is a list

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value to check

'''Returns:''' <code>bool</code>

== contains? ==

checks if a value is in a list; uses the equal?? operator

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''list''' (<code>list</code>): list to check
* '''value''' (<code>any</code>): value to check

'''Returns:''' <code>bool</code>

Streams

2025-08-25T16:43:42Z

Aiagent: Created page with "= Streams = The '''Streams''' module provides stream processing and compression functionality for the SCM programming language. This module includes: * '''Stream creation''': Functions to create streams from string content (streamString) * '''Compression''': Stream compression using gzip and xz algorithms * '''Decompression''': Stream decompression using zcat (gzip) and xzcat (xz) functions These functions enable efficient handling of data streams, file compression, a..."

= Streams =

The '''Streams''' module provides stream processing and compression functionality for the SCM programming language. This module includes:

* '''Stream creation''': Functions to create streams from string content (streamString)
* '''Compression''': Stream compression using gzip and xz algorithms
* '''Decompression''': Stream decompression using zcat (gzip) and xzcat (xz) functions

These functions enable efficient handling of data streams, file compression, and decompression operations in SCM programs, particularly useful for processing large datasets and file I/O operations.

← Back to [[Full SCM API documentation]]

== streamString ==

creates a stream that contains a string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''content''' (<code>string</code>): content to put into the stream

'''Returns:''' <code>stream</code>

== gzip ==

compresses a stream with gzip. Create streams with (stream filename)

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''stream''' (<code>stream</code>): input stream

'''Returns:''' <code>stream</code>

== xz ==

compresses a stream with xz. Create streams with (stream filename)

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''stream''' (<code>stream</code>): input stream

'''Returns:''' <code>stream</code>

== zcat ==

turns a compressed gzip stream into a stream of uncompressed data. Create streams with (stream filename)

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''stream''' (<code>stream</code>): input stream

'''Returns:''' <code>stream</code>

== xzcat ==

turns a compressed xz stream into a stream of uncompressed data. Create streams with (stream filename)

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''stream''' (<code>stream</code>): input stream

'''Returns:''' <code>stream</code>

Strings

2025-08-25T16:35:52Z

Aiagent: Created page with "= Strings = The '''Strings''' module provides comprehensive string manipulation and processing functions for the SCM programming language. This module includes: * '''String validation''': Functions to check string types and properties (string?, strlen) * '''String manipulation''': Concatenation (concat), substring extraction (substr), and case conversion (toLower, toUpper) * '''Pattern matching''': Wildcard pattern matching (strlike) and string replacement (replace) *..."

= Strings =

The '''Strings''' module provides comprehensive string manipulation and processing functions for the SCM programming language. This module includes:

* '''String validation''': Functions to check string types and properties (string?, strlen)
* '''String manipulation''': Concatenation (concat), substring extraction (substr), and case conversion (toLower, toUpper)
* '''Pattern matching''': Wildcard pattern matching (strlike) and string replacement (replace)
* '''String parsing''': Splitting strings (split) and data type simplification (simplify)
* '''Encoding/Decoding''': URL encoding/decoding, HTML entities, JSON processing, and binary conversion
* '''Internationalization''': Collation support for natural sorting and language-specific comparisons

These functions provide the essential tools for text processing, data formatting, and string-based operations in SCM programs.

← Back to [[Full SCM API documentation]]

== string? ==

tells if the value is a string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value

'''Returns:''' <code>bool</code>

== concat ==

concatenates stringable values and returns a string

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value...''' (<code>any</code>): values to concat

'''Returns:''' <code>string</code>

== substr ==

returns a substring

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''value''' (<code>string</code>): string to cut
* '''start''' (<code>number</code>): first character index
* '''len''' (<code>number</code>): optional length

'''Returns:''' <code>string</code>

== simplify ==

turns a stringable input value in the easiest-most value (e.g. turn strings into numbers if they are numeric

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value to simplify

'''Returns:''' <code>any</code>

== strlen ==

returns the length of a string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): input string

'''Returns:''' <code>int</code>

== strlike ==

matches the string against a wildcard pattern (SQL compliant)

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''value''' (<code>string</code>): input string
* '''pattern''' (<code>string</code>): pattern with % and _ in them
* '''collation''' (<code>string</code>): collation in which to compare them

'''Returns:''' <code>bool</code>

== toLower ==

turns a string into lower case

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): input string

'''Returns:''' <code>string</code>

== toUpper ==

turns a string into upper case

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): input string

'''Returns:''' <code>string</code>

== replace ==

replaces all occurances in a string with another string

'''Allowed number of parameters:''' 3–3

'''Parameters:'''
* '''s''' (<code>string</code>): input string
* '''find''' (<code>string</code>): search string
* '''replace''' (<code>string</code>): replace string

'''Returns:''' <code>string</code>

== split ==

splits a string using a separator or space

'''Allowed number of parameters:''' 1–2

'''Parameters:'''
* '''value''' (<code>string</code>): input string
* '''separator''' (<code>string</code>): (optional) parameter, defaults to " "

'''Returns:''' <code>list</code>

== collate ==

returns the <code><</code> operator for a given collation. MemCP allows natural sorting of numeric literals.

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''collation''' (<code>string</code>): collation string of the form LANG or LANG_cs or LANG_ci where LANG is a BCP 47 code, for compatibility to MySQL, a CHARSET_ prefix is allowed and ignored as well as the aliases bin, danish, general, german1, german2, spanish and swedish are allowed for language codes
* '''reverse''' (<code>bool</code>): whether to reverse the order like in ORDER BY DESC

'''Returns:''' <code>func</code>

== htmlentities ==

escapes the string for use in HTML

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): input string

'''Returns:''' <code>string</code>

== urlencode ==

encodes a string according to URI coding schema

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string to encode

'''Returns:''' <code>string</code>

== urldecode ==

decodes a string according to URI coding schema

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string to decode

'''Returns:''' <code>string</code>

== json_encode ==

encodes a value in JSON, treats lists as lists

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value to encode

'''Returns:''' <code>string</code>

== json_encode_assoc ==

encodes a value in JSON, treats lists as associative arrays

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value to encode

'''Returns:''' <code>string</code>

== json_decode ==

parses JSON into a map

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string to decode

'''Returns:''' <code>any</code>

== sql_unescape ==

unescapes the inner part of a sql string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string to decode

'''Returns:''' <code>string</code>

== bin2hex ==

turns binary data into hex with lowercase letters

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string to decode

'''Returns:''' <code>string</code>

Arithmetic / Logic

2025-08-25T16:30:00Z

Aiagent: Created page with "= Arithmetic / Logic = The '''Arithmetic / Logic''' module provides essential mathematical operations and logical comparisons for the SCM programming language. This module includes: * '''Type checking''': Functions to verify data types (int?, number?, nil?) * '''Basic arithmetic''': Addition (+), subtraction (-), multiplication (*), and division (/) * '''Comparison operations''': All standard comparison operators (>, <, >=, <=, equal?) * '''Logical operations''': Boole..."

= Arithmetic / Logic =

The '''Arithmetic / Logic''' module provides essential mathematical operations and logical comparisons for the SCM programming language. This module includes:

* '''Type checking''': Functions to verify data types (int?, number?, nil?)
* '''Basic arithmetic''': Addition (+), subtraction (-), multiplication (*), and division (/)
* '''Comparison operations''': All standard comparison operators (>, <, >=, <=, equal?)
* '''Logical operations''': Boolean negation (!, not) and advanced equality checks
* '''Mathematical functions''': Min/max operations and rounding functions (floor, ceil, round)

These functions form the mathematical foundation for calculations and logical decision-making in SCM programs.

← Back to [[Full SCM API documentation]]

== int? ==

tells if the value is a integer

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value

'''Returns:''' <code>bool</code>

== number? ==

tells if the value is a number

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value

'''Returns:''' <code>bool</code>

== + ==

adds two or more numbers

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''value...''' (<code>number</code>): values to add

'''Returns:''' <code>number</code>

== - ==

subtracts two or more numbers from the first one

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''value...''' (<code>number</code>): values

'''Returns:''' <code>number</code>

== * ==

multiplies two or more numbers

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''value...''' (<code>number</code>): values

'''Returns:''' <code>number</code>

== / ==

divides two or more numbers from the first one

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''value...''' (<code>number</code>): values

'''Returns:''' <code>number</code>

== <= ==

compares two numbers or strings

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''value...''' (<code>any</code>): values

'''Returns:''' <code>bool</code>

== < ==

compares two numbers or strings

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''value...''' (<code>any</code>): values

'''Returns:''' <code>bool</code>

== > ==

compares two numbers or strings

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''value...''' (<code>any</code>): values

'''Returns:''' <code>bool</code>

== >= ==

compares two numbers or strings

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''value...''' (<code>any</code>): values

'''Returns:''' <code>bool</code>

== equal? ==

compares two values of the same type, (equal? nil nil) is true

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''value...''' (<code>any</code>): values

'''Returns:''' <code>bool</code>

== equal?? ==

performs a SQL compliant sloppy equality check on primitive values (number, int, string, bool. nil), strings are compared case insensitive, (equal? nil nil) is nil

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''value...''' (<code>any</code>): values

'''Returns:''' <code>bool</code>

== ! ==

negates the boolean value

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>bool</code>): value

'''Returns:''' <code>bool</code>

== not ==

negates the boolean value

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>bool</code>): value

'''Returns:''' <code>bool</code>

== nil? ==

returns true if value is nil

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value

'''Returns:''' <code>bool</code>

== min ==

returns the smallest value

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value...''' (<code>number|string</code>): value

'''Returns:''' <code>number|string</code>

== max ==

returns the highest value

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value...''' (<code>number|string</code>): value

'''Returns:''' <code>number|string</code>

== floor ==

rounds the number down

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>number</code>): value

'''Returns:''' <code>number</code>

== ceil ==

rounds the number up

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>number</code>): value

'''Returns:''' <code>number</code>

== round ==

rounds the number

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>number</code>): value

'''Returns:''' <code>number</code>

SCM Builtins

2025-08-25T16:27:51Z

Aiagent:

= SCM Builtins =

The '''SCM Builtins''' module provides the core foundational functions for the SCM (Scheme) programming language implementation. These built-in functions handle essential operations including:

* '''Language constructs''': Control flow (if, and, or), variable management (define, set), and code evaluation (eval, quote)
* '''Function operations''': Lambda creation, function application, and error handling (try, error)
* '''Data manipulation''': Type conversion (string, symbol), list operations, and pattern matching
* '''Development tools''': Code optimization, timing measurements, and debugging support
* '''Execution control''': Parallel processing, variable scoping, and source code annotation

This module forms the foundation upon which all other SCM functionality is built, providing the essential primitives needed for Scheme programming.

← Back to [[Full SCM API documentation]]

== quote ==

returns a symbol or list without evaluating it

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''symbol''' (<code>symbol</code>): symbol to quote

'''Returns:''' <code>symbol</code>

== eval ==

executes the given scheme program in the current environment

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''code''' (<code>list</code>): list with head and optional parameters

'''Returns:''' <code>any</code>

== size ==

compute the memory size of a value

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value to examine

'''Returns:''' <code>int</code>

== optimize ==

optimize the given scheme program

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''code''' (<code>list</code>): list with head and optional parameters

'''Returns:''' <code>any</code>

== time ==

measures the time it takes to compute the first argument

'''Allowed number of parameters:''' 1–2

'''Parameters:'''
* '''code''' (<code>any</code>): code to execute
* '''label''' (<code>string</code>): label to print in the log or trace

'''Returns:''' <code>any</code>

== if ==

checks a condition and then conditionally evaluates code branches; there might be multiple condition+true-branch clauses

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''condition...''' (<code>bool</code>): condition to evaluate
* '''true-branch...''' (<code>returntype</code>): code to evaluate if condition is true
* '''false-branch''' (<code>returntype</code>): code to evaluate if condition is false

'''Returns:''' <code>returntype</code>

== and ==

returns true if all conditions evaluate to true

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''condition''' (<code>bool</code>): condition to evaluate

'''Returns:''' <code>bool</code>

== or ==

returns true if at least one condition evaluates to true

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''condition''' (<code>any</code>): condition to evaluate

'''Returns:''' <code>bool</code>

== coalesce ==

returns the first value that has a non-zero value

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value''' (<code>returntype</code>): value to examine

'''Returns:''' <code>returntype</code>

== coalesceNil ==

returns the first value that has a non-nil value

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value''' (<code>returntype</code>): value to examine

'''Returns:''' <code>returntype</code>

== define ==

defines or sets a variable in the current environment

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''variable''' (<code>symbol</code>): variable to set
* '''value''' (<code>returntype</code>): value to set the variable to

'''Returns:''' <code>bool</code>

== set ==

defines or sets a variable in the current environment

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''variable''' (<code>symbol</code>): variable to set
* '''value''' (<code>returntype</code>): value to set the variable to

'''Returns:''' <code>bool</code>

== error ==

halts the whole execution thread and throws an error message

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value...''' (<code>any</code>): value or message to throw

'''Returns:''' <code>string</code>

== try ==

tries to execute a function and returns its result. In case of a failure, the error is fed to the second function and its result value will be used

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''func''' (<code>func</code>): function with no parameters that will be called
* '''errorhandler''' (<code>func</code>): function that takes the error as parameter

'''Returns:''' <code>any</code>

== apply ==

runs the function with its arguments

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''function''' (<code>func</code>): function to execute
* '''arguments''' (<code>list</code>): list of arguments to apply

'''Returns:''' <code>any</code>

== apply_assoc ==

runs the function with its arguments but arguments is a assoc list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''function''' (<code>func</code>): function to execute (must be a lambda)
* '''arguments''' (<code>list</code>): assoc list of arguments to apply

'''Returns:''' <code>symbol</code>

== symbol ==

returns a symbol built from that string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string value that will be converted into a symbol

'''Returns:''' <code>symbol</code>

== list ==

returns a list containing the parameters as alements

'''Allowed number of parameters:''' 0–10000

'''Parameters:'''
* '''value...''' (<code>any</code>): value for the list

'''Returns:''' <code>list</code>

== string ==

converts the given value into string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): any value

'''Returns:''' <code>string</code>

== match ==

takes a value evaluates the branch that first matches the given pattern

Patterns can be any of:
* symbol matches any value and stores is into a variable
* "string" (matches only this string)
* number (matches only this value)
* (symbol "something") will only match the symbol 'something'
* '(subpattern subpattern...) matches a list with exactly these subpatterns
* (concat str1 str2 str3) will decompose a string into one of the following patterns: "prefix" variable, variable "postfix", variable "infix" variable
* (cons a b) will reverse the cons function, so it will match the head of the list with a and the rest with b
* (regex "pattern" text var1 var2...) will match the given regex pattern, store the whole string into text and all capture groups into var1, var2...

'''Allowed number of parameters:''' 3–10000

'''Parameters:'''
* '''value''' (<code>any</code>): value to evaluate
* '''pattern...''' (<code>any</code>): pattern
* '''result...''' (<code>returntype</code>): result value when the pattern matches; this code can use the variables matched in the pattern
* '''default''' (<code>any</code>): (optional) value that is returned when no pattern matches

'''Returns:''' <code>any</code>

== lambda ==

returns a function (func) constructed from the given code

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''parameters''' (<code>symbol|list|nil</code>): if you provide a parameter list, you will have named parameters. If you provide a single symbol, the list of parameters will be provided in that symbol
* '''code''' (<code>any</code>): value that is evaluated when the lambda is called. code can use the parameters provided in the declaration as well es the scope above
* '''numvars''' (<code>number</code>): number of unnamed variables that can be accessed via (var 0) (var 1) etc.

'''Returns:''' <code>func</code>

== begin ==

creates a own variable scope, evaluates all sub expressions and returns the result of the last one

'''Allowed number of parameters:''' 0–10000

'''Parameters:'''
* '''expression...''' (<code>any</code>): expressions to evaluate

'''Returns:''' <code>any</code>

== parallel ==

executes all parameters in parallel and returns nil if they are finished

'''Allowed number of parameters:''' 1–10000

'''Parameters:'''
* '''expression...''' (<code>any</code>): expressions to evaluate in parallel

'''Returns:''' <code>any</code>

== source ==

annotates the node with filename and line information for better backtraces

'''Allowed number of parameters:''' 4–4

'''Parameters:'''
* '''filename''' (<code>string</code>): Filename of the code
* '''line''' (<code>number</code>): Line of the code
* '''column''' (<code>number</code>): Column of the code
* '''code''' (<code>returntype</code>): code

'''Returns:''' <code>returntype</code>

== scheme ==

parses a scheme expression into a list

'''Allowed number of parameters:''' 1–2

'''Parameters:'''
* '''code''' (<code>string</code>): Scheme code
* '''filename''' (<code>string</code>): optional filename

'''Returns:''' <code>any</code>

== serialize ==

serializes a piece of code into a (hopefully) reparsable string; you shall be able to send that code over network and reparse with (scheme)

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''code''' (<code>list</code>): Scheme code

'''Returns:''' <code>string</code>

SCM Builtins

2025-08-25T16:24:34Z

Aiagent:

= SCM Builtins =

== quote ==

returns a symbol or list without evaluating it

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''symbol''' (<code>symbol</code>): symbol to quote

'''Returns:''' <code>symbol</code>

== eval ==

executes the given scheme program in the current environment

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''code''' (<code>list</code>): list with head and optional parameters

'''Returns:''' <code>any</code>

== size ==

compute the memory size of a value

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): value to examine

'''Returns:''' <code>int</code>

== optimize ==

optimize the given scheme program

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''code''' (<code>list</code>): list with head and optional parameters

'''Returns:''' <code>any</code>

== time ==

measures the time it takes to compute the first argument

'''Allowed number of parameters:''' 1–2

'''Parameters:'''
* '''code''' (<code>any</code>): code to execute
* '''label''' (<code>string</code>): label to print in the log or trace

'''Returns:''' <code>any</code>

== if ==

checks a condition and then conditionally evaluates code branches; there might be multiple condition+true-branch clauses

'''Allowed number of parameters:''' 2–1000

'''Parameters:'''
* '''condition...''' (<code>bool</code>): condition to evaluate
* '''true-branch...''' (<code>returntype</code>): code to evaluate if condition is true
* '''false-branch''' (<code>returntype</code>): code to evaluate if condition is false

'''Returns:''' <code>returntype</code>

== and ==

returns true if all conditions evaluate to true

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''condition''' (<code>bool</code>): condition to evaluate

'''Returns:''' <code>bool</code>

== or ==

returns true if at least one condition evaluates to true

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''condition''' (<code>any</code>): condition to evaluate

'''Returns:''' <code>bool</code>

== coalesce ==

returns the first value that has a non-zero value

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value''' (<code>returntype</code>): value to examine

'''Returns:''' <code>returntype</code>

== coalesceNil ==

returns the first value that has a non-nil value

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value''' (<code>returntype</code>): value to examine

'''Returns:''' <code>returntype</code>

== define ==

defines or sets a variable in the current environment

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''variable''' (<code>symbol</code>): variable to set
* '''value''' (<code>returntype</code>): value to set the variable to

'''Returns:''' <code>bool</code>

== set ==

defines or sets a variable in the current environment

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''variable''' (<code>symbol</code>): variable to set
* '''value''' (<code>returntype</code>): value to set the variable to

'''Returns:''' <code>bool</code>

== error ==

halts the whole execution thread and throws an error message

'''Allowed number of parameters:''' 1–1000

'''Parameters:'''
* '''value...''' (<code>any</code>): value or message to throw

'''Returns:''' <code>string</code>

== try ==

tries to execute a function and returns its result. In case of a failure, the error is fed to the second function and its result value will be used

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''func''' (<code>func</code>): function with no parameters that will be called
* '''errorhandler''' (<code>func</code>): function that takes the error as parameter

'''Returns:''' <code>any</code>

== apply ==

runs the function with its arguments

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''function''' (<code>func</code>): function to execute
* '''arguments''' (<code>list</code>): list of arguments to apply

'''Returns:''' <code>any</code>

== apply_assoc ==

runs the function with its arguments but arguments is a assoc list

'''Allowed number of parameters:''' 2–2

'''Parameters:'''
* '''function''' (<code>func</code>): function to execute (must be a lambda)
* '''arguments''' (<code>list</code>): assoc list of arguments to apply

'''Returns:''' <code>symbol</code>

== symbol ==

returns a symbol built from that string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>string</code>): string value that will be converted into a symbol

'''Returns:''' <code>symbol</code>

== list ==

returns a list containing the parameters as alements

'''Allowed number of parameters:''' 0–10000

'''Parameters:'''
* '''value...''' (<code>any</code>): value for the list

'''Returns:''' <code>list</code>

== string ==

converts the given value into string

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''value''' (<code>any</code>): any value

'''Returns:''' <code>string</code>

== match ==

takes a value evaluates the branch that first matches the given pattern

Patterns can be any of:
* symbol matches any value and stores is into a variable
* "string" (matches only this string)
* number (matches only this value)
* (symbol "something") will only match the symbol 'something'
* '(subpattern subpattern...) matches a list with exactly these subpatterns
* (concat str1 str2 str3) will decompose a string into one of the following patterns: "prefix" variable, variable "postfix", variable "infix" variable
* (cons a b) will reverse the cons function, so it will match the head of the list with a and the rest with b
* (regex "pattern" text var1 var2...) will match the given regex pattern, store the whole string into text and all capture groups into var1, var2...

'''Allowed number of parameters:''' 3–10000

'''Parameters:'''
* '''value''' (<code>any</code>): value to evaluate
* '''pattern...''' (<code>any</code>): pattern
* '''result...''' (<code>returntype</code>): result value when the pattern matches; this code can use the variables matched in the pattern
* '''default''' (<code>any</code>): (optional) value that is returned when no pattern matches

'''Returns:''' <code>any</code>

== lambda ==

returns a function (func) constructed from the given code

'''Allowed number of parameters:''' 2–3

'''Parameters:'''
* '''parameters''' (<code>symbol|list|nil</code>): if you provide a parameter list, you will have named parameters. If you provide a single symbol, the list of parameters will be provided in that symbol
* '''code''' (<code>any</code>): value that is evaluated when the lambda is called. code can use the parameters provided in the declaration as well es the scope above
* '''numvars''' (<code>number</code>): number of unnamed variables that can be accessed via (var 0) (var 1) etc.

'''Returns:''' <code>func</code>

== begin ==

creates a own variable scope, evaluates all sub expressions and returns the result of the last one

'''Allowed number of parameters:''' 0–10000

'''Parameters:'''
* '''expression...''' (<code>any</code>): expressions to evaluate

'''Returns:''' <code>any</code>

== parallel ==

executes all parameters in parallel and returns nil if they are finished

'''Allowed number of parameters:''' 1–10000

'''Parameters:'''
* '''expression...''' (<code>any</code>): expressions to evaluate in parallel

'''Returns:''' <code>any</code>

== source ==

annotates the node with filename and line information for better backtraces

'''Allowed number of parameters:''' 4–4

'''Parameters:'''
* '''filename''' (<code>string</code>): Filename of the code
* '''line''' (<code>number</code>): Line of the code
* '''column''' (<code>number</code>): Column of the code
* '''code''' (<code>returntype</code>): code

'''Returns:''' <code>returntype</code>

== scheme ==

parses a scheme expression into a list

'''Allowed number of parameters:''' 1–2

'''Parameters:'''
* '''code''' (<code>string</code>): Scheme code
* '''filename''' (<code>string</code>): optional filename

'''Returns:''' <code>any</code>

== serialize ==

serializes a piece of code into a (hopefully) reparsable string; you shall be able to send that code over network and reparse with (scheme)

'''Allowed number of parameters:''' 1–1

'''Parameters:'''
* '''code''' (<code>list</code>): Scheme code

'''Returns:''' <code>string</code>

SCM Builtins

2025-08-25T16:21:56Z

Aiagent:

= SCM Builtins =

== quote ==

returns a symbol or list without evaluating it

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''symbol''' (<code>symbol</code>): symbol to quote

=== Returns ===

<code>symbol</code>

== eval ==

executes the given scheme program in the current environment

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''code''' (<code>list</code>): list with head and optional parameters

=== Returns ===

<code>any</code>

== size ==

compute the memory size of a value

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''value''' (<code>any</code>): value to examine

=== Returns ===

<code>int</code>

== optimize ==

optimize the given scheme program

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''code''' (<code>list</code>): list with head and optional parameters

=== Returns ===

<code>any</code>

== time ==

measures the time it takes to compute the first argument

'''Allowed number of parameters:''' 1–2

=== Parameters ===

* '''code''' (<code>any</code>): code to execute
* '''label''' (<code>string</code>): label to print in the log or trace

=== Returns ===

<code>any</code>

== if ==

checks a condition and then conditionally evaluates code branches; there might be multiple condition+true-branch clauses

'''Allowed number of parameters:''' 2–1000

=== Parameters ===

* '''condition...''' (<code>bool</code>): condition to evaluate
* '''true-branch...''' (<code>returntype</code>): code to evaluate if condition is true
* '''false-branch''' (<code>returntype</code>): code to evaluate if condition is false

=== Returns ===

<code>returntype</code>

== and ==

returns true if all conditions evaluate to true

'''Allowed number of parameters:''' 1–1000

=== Parameters ===

* '''condition''' (<code>bool</code>): condition to evaluate

=== Returns ===

<code>bool</code>

== or ==

returns true if at least one condition evaluates to true

'''Allowed number of parameters:''' 1–1000

=== Parameters ===

* '''condition''' (<code>any</code>): condition to evaluate

=== Returns ===

<code>bool</code>

== coalesce ==

returns the first value that has a non-zero value

'''Allowed number of parameters:''' 1–1000

=== Parameters ===

* '''value''' (<code>returntype</code>): value to examine

=== Returns ===

<code>returntype</code>

== coalesceNil ==

returns the first value that has a non-nil value

'''Allowed number of parameters:''' 1–1000

=== Parameters ===

* '''value''' (<code>returntype</code>): value to examine

=== Returns ===

<code>returntype</code>

== define ==

defines or sets a variable in the current environment

'''Allowed number of parameters:''' 2–2

=== Parameters ===

* '''variable''' (<code>symbol</code>): variable to set
* '''value''' (<code>returntype</code>): value to set the variable to

=== Returns ===

<code>bool</code>

== set ==

defines or sets a variable in the current environment

'''Allowed number of parameters:''' 2–2

=== Parameters ===

* '''variable''' (<code>symbol</code>): variable to set
* '''value''' (<code>returntype</code>): value to set the variable to

=== Returns ===

<code>bool</code>

== error ==

halts the whole execution thread and throws an error message

'''Allowed number of parameters:''' 1–1000

=== Parameters ===

* '''value...''' (<code>any</code>): value or message to throw

=== Returns ===

<code>string</code>

== try ==

tries to execute a function and returns its result. In case of a failure, the error is fed to the second function and its result value will be used

'''Allowed number of parameters:''' 2–2

=== Parameters ===

* '''func''' (<code>func</code>): function with no parameters that will be called
* '''errorhandler''' (<code>func</code>): function that takes the error as parameter

=== Returns ===

<code>any</code>

== apply ==

runs the function with its arguments

'''Allowed number of parameters:''' 2–2

=== Parameters ===

* '''function''' (<code>func</code>): function to execute
* '''arguments''' (<code>list</code>): list of arguments to apply

=== Returns ===

<code>any</code>

== apply_assoc ==

runs the function with its arguments but arguments is a assoc list

'''Allowed number of parameters:''' 2–2

=== Parameters ===

* '''function''' (<code>func</code>): function to execute (must be a lambda)
* '''arguments''' (<code>list</code>): assoc list of arguments to apply

=== Returns ===

<code>symbol</code>

== symbol ==

returns a symbol built from that string

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''value''' (<code>string</code>): string value that will be converted into a symbol

=== Returns ===

<code>symbol</code>

== list ==

returns a list containing the parameters as alements

'''Allowed number of parameters:''' 0–10000

=== Parameters ===

* '''value...''' (<code>any</code>): value for the list

=== Returns ===

<code>list</code>

== string ==

converts the given value into string

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''value''' (<code>any</code>): any value

=== Returns ===

<code>string</code>

== match ==

takes a value evaluates the branch that first matches the given pattern

Patterns can be any of:
* symbol matches any value and stores is into a variable
* "string" (matches only this string)
* number (matches only this value)
* (symbol "something") will only match the symbol 'something'
* '(subpattern subpattern...) matches a list with exactly these subpatterns
* (concat str1 str2 str3) will decompose a string into one of the following patterns: "prefix" variable, variable "postfix", variable "infix" variable
* (cons a b) will reverse the cons function, so it will match the head of the list with a and the rest with b
* (regex "pattern" text var1 var2...) will match the given regex pattern, store the whole string into text and all capture groups into var1, var2...

'''Allowed number of parameters:''' 3–10000

=== Parameters ===

* '''value''' (<code>any</code>): value to evaluate
* '''pattern...''' (<code>any</code>): pattern
* '''result...''' (<code>returntype</code>): result value when the pattern matches; this code can use the variables matched in the pattern
* '''default''' (<code>any</code>): (optional) value that is returned when no pattern matches

=== Returns ===

<code>any</code>

== lambda ==

returns a function (func) constructed from the given code

'''Allowed number of parameters:''' 2–3

=== Parameters ===

* '''parameters''' (<code>symbol|list|nil</code>): if you provide a parameter list, you will have named parameters. If you provide a single symbol, the list of parameters will be provided in that symbol
* '''code''' (<code>any</code>): value that is evaluated when the lambda is called. code can use the parameters provided in the declaration as well es the scope above
* '''numvars''' (<code>number</code>): number of unnamed variables that can be accessed via (var 0) (var 1) etc.

=== Returns ===

<code>func</code>

== begin ==

creates a own variable scope, evaluates all sub expressions and returns the result of the last one

'''Allowed number of parameters:''' 0–10000

=== Parameters ===

* '''expression...''' (<code>any</code>): expressions to evaluate

=== Returns ===

<code>any</code>

== parallel ==

executes all parameters in parallel and returns nil if they are finished

'''Allowed number of parameters:''' 1–10000

=== Parameters ===

* '''expression...''' (<code>any</code>): expressions to evaluate in parallel

=== Returns ===

<code>any</code>

== source ==

annotates the node with filename and line information for better backtraces

'''Allowed number of parameters:''' 4–4

=== Parameters ===

* '''filename''' (<code>string</code>): Filename of the code
* '''line''' (<code>number</code>): Line of the code
* '''column''' (<code>number</code>): Column of the code
* '''code''' (<code>returntype</code>): code

=== Returns ===

<code>returntype</code>

== scheme ==

parses a scheme expression into a list

'''Allowed number of parameters:''' 1–2

=== Parameters ===

* '''code''' (<code>string</code>): Scheme code
* '''filename''' (<code>string</code>): optional filename

=== Returns ===

<code>any</code>

== serialize ==

serializes a piece of code into a (hopefully) reparsable string; you shall be able to send that code over network and reparse with (scheme)

'''Allowed number of parameters:''' 1–1

=== Parameters ===

* '''code''' (<code>list</code>): Scheme code

=== Returns ===

<code>string</code>

SCM Builtins

2025-08-25T16:16:45Z

Aiagent: Created page with "# SCM Builtins ## quote returns a symbol or list without evaluating it **Allowed number of parameters:** 1–1 ### Parameters - **symbol** (`symbol`): symbol to quote ### Returns `symbol` ## eval executes the given scheme program in the current environment **Allowed number of parameters:** 1–1 ### Parameters - **code** (`list`): list with head and optional parameters ### Returns `any` ## size compute the memory size of a value **Allowed number of param..."

# SCM Builtins

## quote

returns a symbol or list without evaluating it

**Allowed number of parameters:** 1–1

### Parameters

- **symbol** (`symbol`): symbol to quote

### Returns

`symbol`

## eval

executes the given scheme program in the current environment

**Allowed number of parameters:** 1–1

### Parameters

- **code** (`list`): list with head and optional parameters

### Returns

`any`

## size

compute the memory size of a value

**Allowed number of parameters:** 1–1

### Parameters

- **value** (`any`): value to examine

### Returns

`int`

## optimize

optimize the given scheme program

**Allowed number of parameters:** 1–1

### Parameters

- **code** (`list`): list with head and optional parameters

### Returns

`any`

## time

measures the time it takes to compute the first argument

**Allowed number of parameters:** 1–2

### Parameters

- **code** (`any`): code to execute
- **label** (`string`): label to print in the log or trace

### Returns

`any`

## if

checks a condition and then conditionally evaluates code branches; there might be multiple condition+true-branch clauses

**Allowed number of parameters:** 2–1000

### Parameters

- **condition...** (`bool`): condition to evaluate
- **true-branch...** (`returntype`): code to evaluate if condition is true
- **false-branch** (`returntype`): code to evaluate if condition is false

### Returns

`returntype`

## and

returns true if all conditions evaluate to true

**Allowed number of parameters:** 1–1000

### Parameters

- **condition** (`bool`): condition to evaluate

### Returns

`bool`

## or

returns true if at least one condition evaluates to true

**Allowed number of parameters:** 1–1000

### Parameters

- **condition** (`any`): condition to evaluate

### Returns

`bool`

## coalesce

returns the first value that has a non-zero value

**Allowed number of parameters:** 1–1000

### Parameters

- **value** (`returntype`): value to examine

### Returns

`returntype`

## coalesceNil

returns the first value that has a non-nil value

**Allowed number of parameters:** 1–1000

### Parameters

- **value** (`returntype`): value to examine

### Returns

`returntype`

## define

defines or sets a variable in the current environment

**Allowed number of parameters:** 2–2

### Parameters

- **variable** (`symbol`): variable to set
- **value** (`returntype`): value to set the variable to

### Returns

`bool`

## set

defines or sets a variable in the current environment

**Allowed number of parameters:** 2–2

### Parameters

- **variable** (`symbol`): variable to set
- **value** (`returntype`): value to set the variable to

### Returns

`bool`

## error

halts the whole execution thread and throws an error message

**Allowed number of parameters:** 1–1000

### Parameters

- **value...** (`any`): value or message to throw

### Returns

`string`

## try

tries to execute a function and returns its result. In case of a failure, the error is fed to the second function and its result value will be used

**Allowed number of parameters:** 2–2

### Parameters

- **func** (`func`): function with no parameters that will be called
- **errorhandler** (`func`): function that takes the error as parameter

### Returns

`any`

## apply

runs the function with its arguments

**Allowed number of parameters:** 2–2

### Parameters

- **function** (`func`): function to execute
- **arguments** (`list`): list of arguments to apply

### Returns

`any`

## apply_assoc

runs the function with its arguments but arguments is a assoc list

**Allowed number of parameters:** 2–2

### Parameters

- **function** (`func`): function to execute (must be a lambda)
- **arguments** (`list`): assoc list of arguments to apply

### Returns

`symbol`

## symbol

returns a symbol built from that string

**Allowed number of parameters:** 1–1

### Parameters

- **value** (`string`): string value that will be converted into a symbol

### Returns

`symbol`

## list

returns a list containing the parameters as alements

**Allowed number of parameters:** 0–10000

### Parameters

- **value...** (`any`): value for the list

### Returns

`list`

## string

converts the given value into string

**Allowed number of parameters:** 1–1

### Parameters

- **value** (`any`): any value

### Returns

`string`

## match

takes a value evaluates the branch that first matches the given pattern
Patterns can be any of:
- symbol matches any value and stores is into a variable
- "string" (matches only this string)
- number (matches only this value)
- (symbol "something") will only match the symbol 'something'
- '(subpattern subpattern...) matches a list with exactly these subpatterns
- (concat str1 str2 str3) will decompose a string into one of the following patterns: "prefix" variable, variable "postfix", variable "infix" variable
- (cons a b) will reverse the cons function, so it will match the head of the list with a and the rest with b
- (regex "pattern" text var1 var2...) will match the given regex pattern, store the whole string into text and all capture groups into var1, var2...

**Allowed number of parameters:** 3–10000

### Parameters

- **value** (`any`): value to evaluate
- **pattern...** (`any`): pattern
- **result...** (`returntype`): result value when the pattern matches; this code can use the variables matched in the pattern
- **default** (`any`): (optional) value that is returned when no pattern matches

### Returns

`any`

## lambda

returns a function (func) constructed from the given code

**Allowed number of parameters:** 2–3

### Parameters

- **parameters** (`symbol|list|nil`): if you provide a parameter list, you will have named parameters. If you provide a single symbol, the list of parameters will be provided in that symbol
- **code** (`any`): value that is evaluated when the lambda is called. code can use the parameters provided in the declaration as well es the scope above
- **numvars** (`number`): number of unnamed variables that can be accessed via (var 0) (var 1) etc.

### Returns

`func`

## begin

creates a own variable scope, evaluates all sub expressions and returns the result of the last one

**Allowed number of parameters:** 0–10000

### Parameters

- **expression...** (`any`): expressions to evaluate

### Returns

`any`

## parallel

executes all parameters in parallel and returns nil if they are finished

**Allowed number of parameters:** 1–10000

### Parameters

- **expression...** (`any`): expressions to evaluate in parallel

### Returns

`any`

## source

annotates the node with filename and line information for better backtraces

**Allowed number of parameters:** 4–4

### Parameters

- **filename** (`string`): Filename of the code
- **line** (`number`): Line of the code
- **column** (`number`): Column of the code
- **code** (`returntype`): code

### Returns

`returntype`

## scheme

parses a scheme expression into a list

**Allowed number of parameters:** 1–2

### Parameters

- **code** (`string`): Scheme code
- **filename** (`string`): optional filename

### Returns

`any`

## serialize

serializes a piece of code into a (hopefully) reparsable string; you shall be able to send that code over network and reparse with (scheme)

**Allowed number of parameters:** 1–1

### Parameters

- **code** (`list`): Scheme code

### Returns

`string`