Reference — YCP Language


Table of Contents

I. WFM Builtins
Args - Returns the arguments with which the module was called.
Execute - Special interface to the system agent. Not for general use.
GetEncoding - Returns the current encoding code
GetEnvironmentEncoding - Returns the encoding code of the environment where YaST is started
GetLanguage - Returns the current language code (without modifiers !)
Read - Special interface to the system agent. Not for general use.
SCRClose - Closes a scr instance.
SCRGetDefault - Gets the default scr instance.
SCRGetName - Get the name of a scr instance.
SCROpen - Create a new scr instance.
SCRSetDefault - Sets the default scr instance.
SetLanguage - Selects the language for translate()
Write - Special interface to the system agent. Not for general use.
call - Executes a YCP client or a Y2 client component.
II. YCP Byteblock Builtins
size - Returns a size of a byteblock in bytes.
tobyteblock - Converts a value to a byteblock.
III. YCP Float Builtins
tofloat - Converts a value to a floating point number.
tostring - Converts a floating point number to a string
IV. YCP Integer Builtins
tointeger - Converts a value to an integer.
V. YCP List Builtins
add - Create a new list with a new element
change - Changes a list
contains - Checks if a list contains an element
filter - Filters a List
find - Searches for the first occurence of a certain element in a list
flatten - Flattens List
foreach - Processes the content of a list
listmap - Maps an operation onto all elements of a list and thus creates a map.
lsort - Sort A List respecting locale
maplist - Maps an operation onto all elements of a list and thus creates a new list.
merge - Merges two lists into one
prepend - Prepends a list with a new element
remove - Removes element from a list
select - Selects a list element (deprecated, use LIST[INDEX]:DEFAULT)
setcontains - Checks if a sorted list contains an element
size - Returns size of list
sort - Sorts a List according to the YCP builtin predicate
sort - Sort list using an expression
splitstring - Split a string by delimiter
tolist - Converts a value to a list (deprecated, use (list)VAR).
toset - Sorts list and removes duplicates
union - Unions of lists
VI. Map Builtins
add - Add a key/value pair to a map
change - Change element pair in a map
filter - Filter a Map
foreach - Process the content of a map
haskey - Check if map has a certain key
lookup - Select a map element (deprecated, use MAP[KEY]:DEFAULT)
maplist - Maps an operation onto all elements key/value and create a list
mapmap - Maps an operation onto all key/value pairs of a map
remove - Remove key/value pair from a map
size - Size of a map
tomap - Converts a value to a map.
union - Union of 2 maps
VII. Miscellaneous YCP Builtins
eval - Evaluate a YCP value.
random - Random number generator.
sformat - Format a String
sleep - Sleeps a number of milliseconds.
srandom - Initialize random number generator
srandom - Initialize random number generator.
time - Return the number of seconds since 1.1.1970.
y2debug - Log a message to the y2log.
y2error - Log an error to the y2log.
y2internal - Log an internal message to the y2log.
y2milestone - Log a milestone to the y2log.
y2security - Log a security message to the y2log.
y2warning - Log a warning to the y2log.
VIII. YCP Path Builtins
add - Add a path element to existing path
size - Returns the number of path elements
topath - Converts a value to a path.
IX. YCP String Builtins
crypt - Encrypts a string
cryptbigcrypt - Encrypts a string using bigcrypt
cryptblowfish - Encrypts a string with blowfish
cryptmd5 - Encrypts a string using md5
deletechars - Removes all characters from a string
dgettext - Translates the text using the given text domain
dngettext - Translates the text using a locale-aware plural form handling
filterchars - Filters characters out of a String
find - Returns position of a substring
findfirstnotof - Searches string for the first non matching chars
findfirstof - Finds position of the first matching characters in string
findlastnotof - Searches the last element of string that doesn't match
findlastof - Searches string for the last match
issubstring - searches for a specific string within another string
mergestring - Joins list elements with a string
regexpmatch - Searches a string for a POSIX Extended Regular Expression match.
regexppos - Returns a pair with position and length of the first match.
regexpsub - Regex Substitution
regexptokenize - Regex tokenize
search - Returns position of a substring
size - Returns the number of characters of the string s
substring - Returns part of a string
substring - Extracts a substring
timestring - Returns time string
toascii - Returns characters below 0x7F included in STRING
tohexstring - Converts an integer to a hexadecimal string.
tolower - Makes a string lowercase
tostring - Converts a value to a string.
toupper - Makes a string uppercase
X. YCP Term Builtins
add - Add value to term
argsof - Returns the arguments of a term.
remove - Remove item from term
select - Select item from term
size - Returns the number of arguments of the term TERM.
symbolof - Returns the symbol of the term TERM.
toterm - Converts a value to a term.