Executes a process and returns a string of the output (stdout only)

string backquote(string $cmd)

nothing backquote() (RT_NOOP)

$files = backquote("ls");

Not available with PO_NO_EXTERNAL_PROCESS

Calls a builtin function and returns the return value, passing the remaining arguments after the function name to the builtin function. This function can be used to override a builtin function's functionality with a custom implementation.

any call_builtin_function(string $name, ...)

$result = call_builtin_function("func_name", $arg1, $arg2);

Calls a builtin function and returns the return value, using the optional second argument as a list of arguments for the function.

any call_builtin_function_args(string $name, list $args)

any call_builtin_function_args(string $name, any $arg)

call_builtin_function_args("func_name", $arg_list);

Calls a function, closure, or call reference and returns the return value, passing the remaining arguments after the function name to the function, closure, or call reference.

any call_function(string $name, ...)

any call_function(code $code, ...)

$result = call_function("func_name", $arg1, $arg2);

$result = call_function($call_ref, $arg1, $arg2);

Calls a function, closure, or call reference and returns the return value, using the optional second argument as a list of arguments for the function, closure, or call reference to be called.

any call_function_args(string $name, list $args)

any call_function_args(string $name, any $arg)

any call_function_args(code $code, list $args)

any call_function_args(code $code, any $arg)

call_function_args("func_name", $arg_list);

call_function_args($call_ref, $arg_list);

Calls a method of an object, passing the remainder of the arguments to the function as arguments to the method.

any callObjectMethod(object $obj, string $method, ...)

nothing callObjectMethod() (RT_NOOP)

$result = callObjectMethod($obj, "method", $arg1, $arg2);

Calls a method of an object, using the optional third argument as the argument list to the method.

any callObjectMethodArgs(object $obj, string $method, list $args)

any callObjectMethodArgs(object $obj, string $method, any $arg)

nothing callObjectMethodArgs() (RT_NOOP)

$result = callObjectMethodArgs($obj, "method", $arg_list);

Returns True if the function exists in the current program's function name space.

bool existsFunction(string $name) (CONST)

bool existsFunction(code $code) (NOOP)

nothing existsFunction() (RT_NOOP)

$bool = existsFunction("func_name");

Returns "builtin", "user", or NOTHING according to the function name passed.

*string functionType(string) (CONST)

nothing functionType() (RT_NOOP)

my *string $type = functionType("print");

Returns the byte value of the offset (starting with 0) in the object passed. Of no offset is passed, then the value of the first byte (offset 0) is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

Note that this function is identical to getByte() except that this version has no RT_NOOP variant.

*int get_byte(data $data, softint $offset $offset = 0) (CONST)

my *int $byte = get_byte($bin, 2); # returns the third byte of the binary object

Returns the 16-bit integer value at the 2-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 16-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes MSB byte order when retrieving the value from the data.

See also get_word_16_lsb().

*int get_word_16(data $data, softint $offset = 0) (CONST)

my *int $val = get_word_16($bin, 2); # returns the third 16-bit value in MSB format of the binary object

Returns the 16-bit integer value at the 2-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 16-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes LSB byte order when retrieving the value from the data.

See also get_word_16().

*int get_word_16_lsb(data $data, softint $offset = 0) (CONST)

my *int $val = get_word_16_lsb($bin, 2); # returns the third 16-bit value in LSB format of the binary object

Returns the 32-bit integer value at the 4-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 32-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes MSB byte order when retrieving the value from the data.

Note that this function is identical to getWord32() except that this version has no RT_NOOP variant.

See also get_word_32_lsb().

*int get_word_32(data $data, softint $offset = 0) (CONST)

my *int $val = get_word_32($bin, 2); # returns the third 32-bit value in MSB format of the binary object

Returns the 32-bit integer value at the 4-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 32-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes LSB byte order when retrieving the value from the data.

See also get_word_32().

*int get_word_32_lsb(data $data, softint $offset = 0) (CONST)

my *int $val = get_word_32_lsb($bin, 2); # returns the third 32-bit value in LSB format of the binary object

Returns the 64-bit integer value at the 8-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 64-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes MSB byte order when retrieving the value from the data.

See also get_word_64_lsb().

*int get_word_64(data $data, softint $offset = 0) (CONST)

my *int $val = get_word_64($bin, 2); # returns the third 64-bit value in MSB format of the binary object

Returns the 64-bit integer value at the 8-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 64-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes LSB byte order when retrieving the value from the data.

See also get_word_64().

*int get_word_64_lsb(data $data, softint $offset = 0) (CONST)

my *int $val = get_word_64_lsb($bin, 2); # returns the third 64-bit value in LSB format of the binary object

Returns a hash of library build and version info with the keys in the table Library Info Hash. For constants giving the same information, see Build and Version Constants.

hash get_qore_library_info() (CONST)

$info = get_qore_library_info();

Returns a list of hashes giving information about Qore library options for the current build. See Library Option Hash for information about the elements in the list returned. See Library Options for information about Qore library options.

list get_qore_option_list() (CONST)

$list = get_qore_option_list();

Returns the byte value of the offset (starting with 0) in the object passed. Of no offset is passed, then the value of the first byte (offset 0) is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

*int getByte(data $data, softint $offset = 0) (CONST)

nothing getByte() (RT_NOOP)

my *int $byte = getByte($bin, 2); # returns the third byte of the binary object

Returns the class name of an object.

string getClassName(object) (CONST)

nothing getClassName() (RT_NOOP)

$name = getClassName($obj);

Returns an integer representing the capabilities of a DBI driver corresponding to the driver name passed as an argument. See SQL constants for constants for names of drivers shipping with the qore distribution.

*int getDBIDriverCapabilities(string)

nothing getDBIDriverCapabilities() (RT_NOOP)

$caps = getDBIDriverCapabilities("oracle");

Returns a list of each capability supported by the given DBI driver. See SQL constants for constants giving names of drivers shipping with the Qore distribution.

*list getDBIDriverCapabilityList(string)

nothing getDBIDriverCapabilityList() (RT_NOOP)

$list = getDBIDriverCapabilityList("mysql");

Returns a list of strings of DBI drivers currently loaded.

*list getDBIDriverList()

my *list $list = getDBIDriverList();

Returns a list of strings of the builtin and module-supplied features of Qore.

list getFeatureList() (CONST)

$list = getFeatureList();

Returns a list of strings of the names of the methods of the class of the object passed as a parameter.

list getMethodList(object) (CONST)

nothing getMethodList() (RT_NOOP)

$list = getMethodList($obj);

Returns a hash of hashes describing the currently-loaded Qore modules; the top-level hash keys are the module names.

This function was added in Qore 0.8.1

hash getModuleHash() (CONST)

my hash $h = getModuleHash();

Returns a list of hashes describing the currently-loaded Qore modules.

list getModuleList() (CONST)

$list = getModuleList();

Returns the name of the default character encoding for the currently-running Qore process.

string get_default_encoding() (CONST)

$encoding = get_default_encoding();

Returns a group information hash representing the group information for the group ID passed; or, if the group ID does not exist NOTHING is returned.

For a similar function that throws an exception if the group ID is invalid, see getgrgid2().

*hash getgrgid(softint $gid) (CONST)

my *hash $hash = getgrgid(0); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a group information hash representing the group information for the group ID passed. If the group ID does not exist, an exception is raised.

For a similar function that does not throw an exception if the group ID is invalid, see getgrgid().

hash getgrgid2(softint $gid) (CONST)

my hash $hash = getgrgid2(0); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a group information hash representing the group information for the group name passed; or, if the group name does not exist NOTHING is returned.

For a similar function that throws an exception if the group ID is invalid, see getgrnam2().

*hash getgrnam(string $group_name) (CONST)

my *hash $hash = getgrnam("root"); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a group information hash representing the group information for the group name passed. If the group name does not exist, an exception is rasied.

For a similar function that does not throw an exception if the group ID is invalid, see getgrnam().

hash getgrnam2(string $group_name) (CONST)

my hash $hash = getgrnam2("root"); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a password information hash representing the user information for the user name passed; or, if the user name does not exist NOTHING is returned.

For a similar function that throws an exception if the user ID is invalid, see getpwnam2().

*hash getpwnam(string $user_name) (CONST)

my *hash $hash = getpwnam("root"); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a password information hash representing the user information for the user name passed. If the user name does not exist, an exception is rasied.

For a similar function that does not throw an exception if the user ID is invalid, see getpwnam().

hash getpwnam2(string $user_name) (CONST)

my hash $hash = getpwnam2("root"); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a password information hash representing the user information for the user ID passed; or, if the user ID does not exist NOTHING is returned.

For a similar function that throws an exception if the user ID is invalid, see getpwuid2().

*hash getpwuid(softint $uid) (CONST)

my *hash $hash = getpwuid(0); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns a password information hash representing the user information for the user ID passed. If the user ID does not exist, an exception is raised.

For a similar function that does not throw an exception if the user ID is invalid, see getpwuid().

hash getpwuid2(softint $uid) (CONST)

my hash $hash = getpwuid2(0); # returns the login information for root

HAVE_UNIX_USERMGT

Not available with PO_NO_EXTERNAL_INFO

Returns the path (directory and filename) of the current script. Returns NOTHING if unknown (i.e. no parent script, script read from stdin, etc).

*string get_script_path() (CONST)

my *string $path = get_script_path();

Returns the name of the directory from which the current script was executed. Returns NOTHING if the parent script is unknown (i.e. no parent script, script read from stdin, etc).

*string get_script_dir() (CONST)

my *string $dir = get_script_dir();

Returns the filename of the current script if known; returns NOTHING if not (i.e. no parent script, script read from stdin, etc).

*string get_script_name() (CONST)

my *string $name = get_script_name();

Returns the 32-bit integer value at the 4-byte offset (starting with 0) in the data passed. Of no offset is passed, then the value of the first 32-bit position at offset 0 is returned. Note that the [] operator provides a more efficient way to retrieve a byte from a binary object.

This function assumes MSB byte order when retrieving the value from the data.

Note that this function is identical to get_word_32() except that this version has a RT_NOOP variant.

See also get_word_32_lsb().

*int getWord32(data $data, softint $offset = 0) (CONST)

nothing getWord32() (RT_NOOP)

my *int $val = getWord32($bin, 2); # returns the third 32-bit value in MSB format of the binary object

Returns True if the given key exists in the hash or object (does not necessarily have to have a value assigned); exceptions are only raised if string encoding errors are encountered or in case of object access errors.

bool has_key(hash $hash, string $key) (RET_VALUE_ONLY)

bool has_key(object $obj, string $key) (RET_VALUE_ONLY)

my bool $b = has_key($hash, "key");

Returns a list of all the values in the hash argument passed.

list hash_values(hash) (CONST)

nothing hash_values() (RT_NOOP)

my list $l = hash_values($hash);

Returns an integer for a hexadecimal string value.

int hextoint(string)

$int = hextoint("ab3d4e0f12");

Returns a string with any HTML escape codes translated to the original characters.

string html_decode(string) (CONST)

nothing html_decode() (RT_NOOP)

html_decode("&lt;hello&gt;"); # returns "<hello>"

Returns a string with any characters that can be escaped translated to HTML escape codes.

string html_encode(string) (CONST)

nothing html_encode() (RT_NOOP)

$str = html_encode("<hello>"); # returns "&lt;hello&gt;"

Tests if the first argument is a member of the second argument list; types are converted if necessary. If the second argument is NOTHING, then False is returned unconditionally (i.e. even if the first argument is NOTHING as well), however if the second argument is not a list then the return value of the function is the comparison of the two arguments. For a version of this function that requires types to be equal for the comparison to succeed, see inlist_hard().

bool inlist(any $value, list $list)

bool inlist(any $value, any $other_value)

bool inlist() (RT_NOOP)

my $bool = inlist(123, (True, "123", False); # this will return True

Tests if the first argument is a member of the second argument list; no type conversions are performed (i.e. the comparison fails if types are not equal). If the second argument is NOTHING, then False is returned unconditionally (i.e. even if the first argument is NOTHING as well), however if the second argument is not a list then the return value of the function is the comparison of the two arguments (types must be equal). For a "soft" version of this function that performs type conversions when doing the comparison, see inlist().

bool inlist_hard(any $value, list $list)

bool inlist_hard(any $value, any $other_value)

my $bool = inlist_hard(123, (True, "123", False); # this will return False

Loads in a Qore module at run-time. If a feature with the same name already exists, then this feature's code is imported into the current Program object if necessary and no further action is taken. Note that modules providing objects resolved at parse time (classes, constants, functions, etc) must be loaded with the %requires directive instead, unless all references to the objects provided by the module will be made in code embedded in Program objects.

See also getFeatureList() for a function providing a list of available features.

nothing load_module(string $path_or_name)

nothing load_module() (RT_NOOP)

load_module("pgsql");

Returns a base64-encoded representation of a binary object or a string (see also makeHexString()).

string makeBase64String(data) (CONST)

nothing makeBase64String() (RT_NOOP)

$str = makeBase64String($bin);

Returns a hex-encoded representation of a binary object or a string (see also makeBase64String()).

string makeHexString(data) (CONST)

nothing makeHexString() (RT_NOOP)

$str = makeHexString($bin);

Returns the maximum value in a list (see also min()). Without a callback, this function will only work on basic data types. A closure or call reference can be used to find the maximum value of a list of complex data types. The closure or call reference must accept two arguments and must return -1, 0, or 1 if the first is less than, equal to, or greater than the second, respectively.

any max(...) (CONST)

any max(list $list) (CONST)

any max(list $list, string $func_name)

any max(list $list, code $code)

$max = max($complex_list, \callback_function());

$max = max(1, 2, 3, 4);

Returns the minumum value in a list (see also max()). Without a callback, this function will only work on basic data types. A closure or call reference can be used to find the minimum value of a list of complex data types. The closure or call reference must accept two arguments and must return -1, 0, or 1 if the first is less than, equal to, or greater than the second, respectively.

any min(...) (CONST)

any min(list $list) (CONST)

any min(list $list, string $func_name)

any min(list $list, code $code)

$min = min($complex_list, \callback_function());

$min = min(1, 10, 2, 3);

Adds the text passed to the current program's code.

nothing parse(string $code, string $label)

nothing parse() (RT_NOOP)

parse($code, "label");

Parses a URL string and returns a hash of the components with the following keys (if data in the URL is present): protocol, path, username, password, host, port. If the URL cannot be parsed, an exception is thrown..

For a similar function that returns NOTHING instead of throwing an exception if the URL string cannot be parsed, see parseURL().

hash parse_url(string $url)

my hash $hash = parse_url($url_string);

Parses a base64 encoded string and returns the binary object (see also parseHexString()).

binary parseBase64String(string)

nothing parseBase64String() (RT_NOOP)

$bin = parseBase64String($base64_string);

Returns a hash of the components of a datasource string.

hash parseDatasource(string)

nothing parseDatasource() (RT_NOOP)

$hash = parseDatasource($ds_string);

Parses a hex-encoded string and returns the binary object (see also parseBase64String()).

binary parseHexString(string)

nothing parseHexString() (RT_NOOP)

$bin = parseHexString($hex_string);

Parses a URL string and returns a hash of the components with the following keys (if data in the URL is present): protocol, path, username, password, host, port. If the URL cannot be parsed, no value is returned.

For a similar function that throws an exception instead of returning NOTHING if the URL string cannot be parsed, see parse_url().

*hash parseURL(string $url)

nothing parseURL() (RT_NOOP)

my *hash $hash = parseURL($url_string);

Returns a random integer number (uses the C library function random() to generate the number).

int rand()

$num = rand();

Removes a signal handler and returns the signal handling state to the default. By the time this function returns, changes to the signal handling thread have already been effected. See Signal Handling for more information.

nothing remove_signal_handler(softint)

remove_signal_handler(SIGINT);

Not available with PO_NO_PROCESS_CONTROL

Reverses a string or a list (depending on the argument) and returns the new string or list. Works properly on UTF-8 strings with multi-byte characters as well.

string reverse(string) (CONST)

list reverse(list) (CONST)

nothing reverse() (RT_NOOP)

$str = reverse("ABCDEF"); # returns "FEDCBA"

Sets or replaces a signal handler according to the signal number and closure or call reference (function or object method reference) passed. By the time this function returns, changes to the signal handling thread have already been effected. See Signal Handling for more information.

When a signal is raised and the signal handler code is called, the signal number is passed as an integer argument to the signal handling code.

nothing set_signal_handler(softint $signal, code $handler)

set_signal_handler(SIGINT, \signal_handler());

Not available with PO_NO_PROCESS_CONTROL

Performs an unstable sort in ascending order and returns the new list (for a stable version see sortStable()). Without a callback, this function will only sort basic data types. A closure or call reference can be used to sort complex data types. The closure or call reference must accept two arguments and must return -1, 0, or 1 if the first is less than the second, if the first and second are equal, or if the first is greater than the second, respectively.

list sort(list $list) (CONST)

list sort(list $list, code $code)

list sort(list $list, string $func_name)

nothing sort() (RT_NOOP)

$list = sort($complex_list, \callback());

Performs an unstable sort in descending order and returns the new list (for a stable version see sortDescendingStable()). Without a closure or call reference, this function will only sort basic data types. A closure or call reference can be used to sort complex data types. The closure or call reference must accept two arguments and must return -1, 0, or 1 if the first is less than the second, if the first and second are equal, or if the first is greater than the second, respectively.

list sortDescending(list $list) (CONST)

list sortDescending(list $list, code $code)

list sortDescending(list $list, string $func_name)

nothing sortDescending() (RT_NOOP)

$list = sortDescending($complex_list, \callback());

Performs a stable sort in descending order and returns the new list (for an unstable version see sortDescending()). Without a closure or call reference, this function will only sort basic data types. A closure or call reference can be used to sort complex data types. The closure or call reference must accept two arguments and must return -1, 0, or 1 if the first is less than the second, if the first and second are equal, or if the first is greater than the second, respectively.

list sortDescendingStable(list $list) (CONST)

list sortDescendingStable(list $list, code $code)

list sortDescendingStable(list $list, string $func_name)

nothing sortDescendingStable() (RT_NOOP)

$list = sortDescendingStable($complex_list, \callback());

Performs a stable sort in ascending order and returns the new list (for an unstable version see sort()). Without a closure or call reference, this function will only sort basic data types. A closure or call reference can be used to sort complex data types. The closure or call reference must accept two arguments and must return -1, 0, or 1 if the first is less than the second, if the first and second are equal, or if the first is greater than the second, respectively.

list sortStable(list $list) (CONST)

list sortStable(list $list, code $code)

list sortStable(list $list, string $func_name)

nothing sortStable() (RT_NOOP)

$list = sortStable($complex_list, \callback());

Seeds the random number generator with the integer passed (uses the C library function srandom()).

This function is tagged with PO_NO_PROCESS_CONTROL because it affects the process as a whole.

nothing srand(softint)

nothing srand() (RT_NOOP)

srand(now()); # seeds with current time

Not available with PO_NO_PROCESS_CONTROL

Returns an integer corresponding to the string passed with the possibility to specify the base (default base 10).

int strtoint(softstring $string, int $base = 10) (CONST)

nothing strtoint() (RT_NOOP)

$int = strtoint("41", 8);