YaST2 Developers Documentation: yast2



functions
files
intro

yast2

modules/String.ycp
String manipulation routines

Global Functions

global Quote (string var) -> string

Quote a string with 's

Parameters:
var unquoted string
Return value:
quoted string
Example:
  quote("a'b") -> "a'\''b"

global UnQuote (string var) -> string

Unquote a string with 's (quoted with quote)

Parameters:
var quoted string
Return value:
unquoted string
See:
quote

global FormatSizeWithPrecision (integer bytes, integer precision, boolean omit_zeroes) -> string

Return a pretty description of a byte count, with required precision and using KB, MB or GB as unit as appropriate.

Parameters:
bytes size (e.g. free diskspace, memory size) in Bytes
precision number of fraction digits in output
omit_zeroes if true then do not add zeroes (usefull for memory size - 128 MB RAM looks better than 128.00 MB RAM)
Return value:
formatted string
Example:
  FormatSizeWithPrecision(4096, 2, true) -> "4 KB"
  FormatSizeWithPrecision(4096, 2, false) -> "4.00 KB"

global FormatSize (integer bytes) -> string

Return a pretty description of a byte count, with two fraction digits and using KB, MB or GB as unit as appropriate.

Parameters:
bytes size (e.g. free diskspace) in Bytes
Return value:
formatted string
Example:
  FormatSize(23456767890) -> "223.70 MB"

global CutBlanks (string input) -> string

Remove blanks at begin and end of input string.

Parameters:
input string to be stripped
Return value:
stripped string
Example:
  CutBlanks("  any  input     ") -> "any  input"

global CutZeros (string input) -> string

Remove any leading zeros that make tointeger inadvertently assume an octal number (e.g. "09" -> "9", "0001" -> "1", but "0" -> "0")

Parameters:
input number that might contain leadig zero
Return value:
that has leading zeros removed

global Pad (string text, integer length) -> string

Add spaces after the text to make it long enough. If the text is longer than requested, no changes are made.

Parameters:
text text to be padded
length requested length
Return value:
padded text

global PadZeros (string text, integer length) -> string

Add zeros before the text to make it long enough. If the text is longer than requested, no changes are made.

Parameters:
text text to be padded
length requested length
Return value:
padded text

global ParseOptions (string options, map parameters) -> list<string>

Parse string of values - split string to values, quoting and backslash sequences are supported

Parameters:
options Input string
parameters Parmeter used at parsing - map with keys: "separator": - value separator (default: " \t"), "unique": - result will not contain any duplicates, first occurance of the string is stored into output (default: false), "interpret_backslash": - convert backslash sequence into one character (e.g. "\\n" => "\n") (default: true) "remove_whitespace": - remove white spaces around values (default: true),
Return value:
List of strings

global CutRegexMatch (string input, string regex, boolean glob) -> string

Remove first or every match of given regular expression from a string (e.g. CutRegexMatch( "abcdef12ef34gh000", "[0-9]+", true ) -> "abcdefefgh", CutRegexMatch( "abcdef12ef34gh000", "[0-9]+", false ) -> "abcdefef34gh000")

Parameters:
input string that might occur regex
regex regular expression to search for, must not contain brackets
glob flag if only first or every occuring match should be removed
Return value:
that has matches removed

YaST2 Developers Documentation