strings.subr revision 263980
1238438Sdteskeif [ ! "$_STRINGS_SUBR" ]; then _STRINGS_SUBR=1 2238438Sdteske# 3247280Sdteske# Copyright (c) 2006-2013 Devin Teske 4252980Sdteske# All rights reserved. 5238438Sdteske# 6238438Sdteske# Redistribution and use in source and binary forms, with or without 7238438Sdteske# modification, are permitted provided that the following conditions 8238438Sdteske# are met: 9238438Sdteske# 1. Redistributions of source code must retain the above copyright 10238438Sdteske# notice, this list of conditions and the following disclaimer. 11238438Sdteske# 2. Redistributions in binary form must reproduce the above copyright 12238438Sdteske# notice, this list of conditions and the following disclaimer in the 13238438Sdteske# documentation and/or other materials provided with the distribution. 14238438Sdteske# 15238438Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16252987Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17238438Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18238438Sdteske# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19238438Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20252987Sdteske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21238438Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22238438Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23238438Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24238438Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25238438Sdteske# SUCH DAMAGE. 26238438Sdteske# 27238438Sdteske# $FreeBSD: stable/10/usr.sbin/bsdconfig/share/strings.subr 263980 2014-04-01 00:19:13Z dteske $ 28249751Sdteske# 29256361Sdteske############################################################ INCLUDES 30256361Sdteske 31256361SdteskeBSDCFG_SHARE="/usr/share/bsdconfig" 32256361Sdteske. $BSDCFG_SHARE/common.subr || exit 1 33256361Sdteske 34249751Sdteske############################################################ GLOBALS 35238438Sdteske 36249751Sdteske# 37263980Sdteske# A Literal newline (for use with f_replace_all(), or IFS, or whatever) 38263980Sdteske# 39263980SdteskeNL=" 40263980Sdteske" # END-QUOTE 41263980Sdteske 42263980Sdteske# 43249751Sdteske# Valid characters that can appear in an sh(1) variable name 44249751Sdteske# 45249751Sdteske# Please note that the character ranges A-Z and a-z should be avoided because 46249751Sdteske# these can include accent characters (which are not valid in a variable name). 47249751Sdteske# For example, A-Z matches any character that sorts after A but before Z, 48249751Sdteske# including A and Z. Although ASCII order would make more sense, that is not 49249751Sdteske# how it works. 50249751Sdteske# 51249751SdteskeVALID_VARNAME_CHARS="0-9ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_" 52249751Sdteske 53249751Sdteske############################################################ FUNCTIONS 54249751Sdteske 55258420Sdteske# f_substr "$string" $start [$length] 56238438Sdteske# 57238438Sdteske# Simple wrapper to awk(1)'s `substr' function. 58238438Sdteske# 59238438Sdteskef_substr() 60238438Sdteske{ 61238438Sdteske local string="$1" start="${2:-0}" len="${3:-0}" 62238438Sdteske echo "$string" | awk "{ print substr(\$0, $start, $len) }" 63238438Sdteske} 64238438Sdteske 65258420Sdteske# f_snprintf $var_to_set $size $format [$arguments ...] 66250701Sdteske# 67250701Sdteske# Similar to snprintf(3), write at most $size number of bytes into $var_to_set 68258420Sdteske# using printf(1) syntax (`$format [$arguments ...]'). The value of $var_to_set 69258420Sdteske# is NULL unless at-least one byte is stored from the output. 70250701Sdteske# 71250701Sdteskef_snprintf() 72250701Sdteske{ 73250701Sdteske local __var_to_set="$1" __size="$2" 74258420Sdteske shift 2 # var_to_set size 75258420Sdteske eval "$__var_to_set"=\$\( printf -- \"\$@\" \| \ 76258420Sdteske awk -v max=\"\$__size\" \'' 77250701Sdteske { 78250701Sdteske len = length($0) 79250701Sdteske max -= len 80250701Sdteske print substr($0,0,(max > 0 ? len : max + len)) 81250701Sdteske if ( max < 0 ) exit 82250701Sdteske max-- 83250701Sdteske }'\' \) 84250701Sdteske} 85250701Sdteske 86258420Sdteske# f_sprintf $var_to_set $format [$arguments ...] 87258420Sdteske# 88258420Sdteske# Similar to sprintf(3), write a string into $var_to_set using printf(1) syntax 89258420Sdteske# (`$format [$arguments ...]'). 90258420Sdteske# 91258420Sdteskef_sprintf() 92258420Sdteske{ 93258420Sdteske local __var_to_set="$1" 94258420Sdteske shift 1 # var_to_set 95258420Sdteske eval "$__var_to_set"=\$\( printf -- \"\$@\" \) 96258420Sdteske} 97258420Sdteske 98251278Sdteske# f_vsnprintf $var_to_set $size $format $format_args 99251278Sdteske# 100251278Sdteske# Similar to vsnprintf(3), write at most $size number of bytes into $var_to_set 101251278Sdteske# using printf(1) syntax (`$format $format_args'). The value of $var_to_set is 102251278Sdteske# NULL unless at-least one byte is stored from the output. 103251278Sdteske# 104251278Sdteske# Example 1: 105251278Sdteske# 106251278Sdteske# limit=7 format="%s" 107251278Sdteske# format_args="'abc 123'" # 3-spaces between abc and 123 108251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[abc 1] 109251278Sdteske# 110251278Sdteske# Example 2: 111251278Sdteske# 112251278Sdteske# limit=12 format="%s %s" 113251278Sdteske# format_args=" 'doghouse' 'foxhound' " 114251278Sdteske# # even more spaces added to illustrate escape-method 115251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[doghouse fox] 116251278Sdteske# 117251278Sdteske# Example 3: 118251278Sdteske# 119251278Sdteske# limit=13 format="%s %s" 120251278Sdteske# f_shell_escape arg1 'aaa"aaa' # arg1=[aaa"aaa] (no change) 121251278Sdteske# f_shell_escape arg2 "aaa'aaa" # arg2=[aaa'\''aaa] (escaped s-quote) 122251278Sdteske# format_args="'$arg1' '$arg2'" # use single-quotes to surround args 123251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[aaa"aaa aaa'a] 124251278Sdteske# 125251278Sdteske# In all of the above examples, the call to f_vsnprintf() does not change. Only 126251278Sdteske# the contents of $limit, $format, and $format_args changes in each example. 127251278Sdteske# 128251278Sdteskef_vsnprintf() 129251278Sdteske{ 130251278Sdteske eval f_snprintf \"\$1\" \"\$2\" \"\$3\" $4 131251278Sdteske} 132251278Sdteske 133258420Sdteske# f_vsprintf $var_to_set $format $format_args 134258420Sdteske# 135258420Sdteske# Similar to vsprintf(3), write a string into $var_to_set using printf(1) 136258420Sdteske# syntax (`$format $format_args'). 137258420Sdteske# 138258420Sdteskef_vsprintf() 139258420Sdteske{ 140258420Sdteske eval f_sprintf \"\$1\" \"\$2\" $3 141258420Sdteske} 142258420Sdteske 143238438Sdteske# f_longest_line_length 144238438Sdteske# 145238438Sdteske# Simple wrapper to an awk(1) script to print the length of the longest line of 146238438Sdteske# input (read from stdin). Supports the newline escape-sequence `\n' for 147238438Sdteske# splitting a single line into multiple lines. 148238438Sdteske# 149238438Sdteskef_longest_line_length_awk=' 150238438SdteskeBEGIN { longest = 0 } 151238438Sdteske{ 152238438Sdteske if (split($0, lines, /\\n/) > 1) 153238438Sdteske { 154238438Sdteske for (n in lines) 155238438Sdteske { 156238438Sdteske len = length(lines[n]) 157238438Sdteske longest = ( len > longest ? len : longest ) 158238438Sdteske } 159238438Sdteske } 160238438Sdteske else 161238438Sdteske { 162238438Sdteske len = length($0) 163238438Sdteske longest = ( len > longest ? len : longest ) 164238438Sdteske } 165238438Sdteske} 166238438SdteskeEND { print longest } 167238438Sdteske' 168238438Sdteskef_longest_line_length() 169238438Sdteske{ 170238438Sdteske awk "$f_longest_line_length_awk" 171238438Sdteske} 172238438Sdteske 173238438Sdteske# f_number_of_lines 174238438Sdteske# 175238438Sdteske# Simple wrapper to an awk(1) script to print the number of lines read from 176238438Sdteske# stdin. Supports newline escape-sequence `\n' for splitting a single line into 177238438Sdteske# multiple lines. 178238438Sdteske# 179238438Sdteskef_number_of_lines_awk=' 180238438SdteskeBEGIN { num_lines = 0 } 181238438Sdteske{ 182241700Sdteske num_lines += split(" "$0, unused, /\\n/) 183238438Sdteske} 184238438SdteskeEND { print num_lines } 185238438Sdteske' 186238438Sdteskef_number_of_lines() 187238438Sdteske{ 188238438Sdteske awk "$f_number_of_lines_awk" 189238438Sdteske} 190238438Sdteske 191238438Sdteske# f_isinteger $arg 192238438Sdteske# 193238438Sdteske# Returns true if argument is a positive/negative whole integer. 194238438Sdteske# 195238438Sdteskef_isinteger() 196238438Sdteske{ 197260678Sdteske local arg="${1#-}" 198263980Sdteske [ "${arg:-x}" = "${arg%[!0-9]*}" ] 199238438Sdteske} 200238438Sdteske 201247280Sdteske# f_uriencode [$text] 202247280Sdteske# 203247280Sdteske# Encode $text for the purpose of embedding safely into a URL. Non-alphanumeric 204247280Sdteske# characters are converted to `%XX' sequence where XX represents the hexa- 205247280Sdteske# decimal ordinal of the non-alphanumeric character. If $text is missing, data 206247280Sdteske# is instead read from standard input. 207247280Sdteske# 208247280Sdteskef_uriencode_awk=' 209247280SdteskeBEGIN { 210247280Sdteske output = "" 211247280Sdteske for (n = 0; n < 256; n++) pack[sprintf("%c", n)] = sprintf("%%%02x", n) 212247280Sdteske} 213247280Sdteske{ 214247280Sdteske sline = "" 215247280Sdteske slen = length($0) 216247280Sdteske for (n = 1; n <= slen; n++) { 217247280Sdteske char = substr($0, n, 1) 218247280Sdteske if ( char !~ /^[[:alnum:]_]$/ ) char = pack[char] 219247280Sdteske sline = sline char 220247280Sdteske } 221247280Sdteske output = output ( output ? "%0a" : "" ) sline 222247280Sdteske} 223247280SdteskeEND { print output } 224247280Sdteske' 225247280Sdteskef_uriencode() 226247280Sdteske{ 227247280Sdteske if [ $# -gt 0 ]; then 228247280Sdteske echo "$1" | awk "$f_uriencode_awk" 229247280Sdteske else 230247280Sdteske awk "$f_uriencode_awk" 231247280Sdteske fi 232247280Sdteske} 233247280Sdteske 234247280Sdteske# f_uridecode [$text] 235247280Sdteske# 236247280Sdteske# Decode $text from a URI. Encoded characters are converted from their `%XX' 237247280Sdteske# sequence into original unencoded ASCII sequences. If $text is missing, data 238247280Sdteske# is instead read from standard input. 239247280Sdteske# 240247280Sdteskef_uridecode_awk=' 241247280SdteskeBEGIN { for (n = 0; n < 256; n++) chr[n] = sprintf("%c", n) } 242247280Sdteske{ 243247280Sdteske sline = "" 244247280Sdteske slen = length($0) 245247280Sdteske for (n = 1; n <= slen; n++) 246247280Sdteske { 247247280Sdteske seq = substr($0, n, 3) 248247280Sdteske if ( seq ~ /^%[[:xdigit:]][[:xdigit:]]$/ ) { 249247280Sdteske hex = substr(seq, 2, 2) 250247280Sdteske sline = sline chr[sprintf("%u", "0x"hex)] 251247280Sdteske n += 2 252247280Sdteske } else 253247280Sdteske sline = sline substr(seq, 1, 1) 254247280Sdteske } 255247280Sdteske print sline 256247280Sdteske} 257247280Sdteske' 258247280Sdteskef_uridecode() 259247280Sdteske{ 260247280Sdteske if [ $# -gt 0 ]; then 261247280Sdteske echo "$1" | awk "$f_uridecode_awk" 262247280Sdteske else 263247280Sdteske awk "$f_uridecode_awk" 264247280Sdteske fi 265247280Sdteske} 266247280Sdteske 267249751Sdteske# f_replaceall $string $find $replace [$var_to_set] 268249751Sdteske# 269250702Sdteske# Replace all occurrences of $find in $string with $replace. If $var_to_set is 270249751Sdteske# either missing or NULL, the variable name is produced on standard out for 271249751Sdteske# capturing in a sub-shell (which is less recommended due to performance 272249751Sdteske# degradation). 273249751Sdteske# 274263980Sdteske# To replace newlines or a sequence containing the newline character, use $NL 275263980Sdteske# as `\n' is not supported. 276263980Sdteske# 277249751Sdteskef_replaceall() 278249751Sdteske{ 279249751Sdteske local __left="" __right="$1" 280249751Sdteske local __find="$2" __replace="$3" __var_to_set="$4" 281249751Sdteske while :; do 282249751Sdteske case "$__right" in *$__find*) 283249751Sdteske __left="$__left${__right%%$__find*}$__replace" 284249751Sdteske __right="${__right#*$__find}" 285249751Sdteske continue 286249751Sdteske esac 287249751Sdteske break 288249751Sdteske done 289249751Sdteske __left="$__left${__right#*$__find}" 290249751Sdteske if [ "$__var_to_set" ]; then 291249751Sdteske setvar "$__var_to_set" "$__left" 292249751Sdteske else 293249751Sdteske echo "$__left" 294249751Sdteske fi 295249751Sdteske} 296249751Sdteske 297249751Sdteske# f_str2varname $string [$var_to_set] 298249751Sdteske# 299249751Sdteske# Convert a string into a suitable value to be used as a variable name 300249751Sdteske# by converting unsuitable characters into the underscrore [_]. If $var_to_set 301249751Sdteske# is either missing or NULL, the variable name is produced on standard out for 302249751Sdteske# capturing in a sub-shell (which is less recommended due to performance 303249751Sdteske# degradation). 304249751Sdteske# 305249751Sdteskef_str2varname() 306249751Sdteske{ 307249751Sdteske local __string="$1" __var_to_set="$2" 308249751Sdteske f_replaceall "$__string" "[!$VALID_VARNAME_CHARS]" "_" "$__var_to_set" 309249751Sdteske} 310249751Sdteske 311249751Sdteske# f_shell_escape $string [$var_to_set] 312249751Sdteske# 313249751Sdteske# Escape $string for shell eval statement(s) by replacing all single-quotes 314249751Sdteske# with a special sequence that creates a compound string when interpolated 315249751Sdteske# by eval with surrounding single-quotes. 316249751Sdteske# 317249751Sdteske# For example: 318249751Sdteske# 319249751Sdteske# foo="abc'123" 320249751Sdteske# f_shell_escape "$foo" bar # bar=[abc'\''123] 321251272Sdteske# eval echo \'$bar\' # produces abc'123 322249751Sdteske# 323249751Sdteske# This is helpful when processing an argument list that has to retain its 324249751Sdteske# escaped structure for later evaluations. 325249751Sdteske# 326249751Sdteske# WARNING: Surrounding single-quotes are not added; this is the responsibility 327249751Sdteske# of the code passing the escaped values to eval (which also aids readability). 328249751Sdteske# 329249751Sdteskef_shell_escape() 330249751Sdteske{ 331249751Sdteske local __string="$1" __var_to_set="$2" 332249751Sdteske f_replaceall "$__string" "'" "'\\''" "$__var_to_set" 333249751Sdteske} 334249751Sdteske 335249751Sdteske# f_shell_unescape $string [$var_to_set] 336249751Sdteske# 337249751Sdteske# The antithesis of f_shell_escape(), this function takes an escaped $string 338249751Sdteske# and expands it. 339249751Sdteske# 340249751Sdteske# For example: 341249751Sdteske# 342249751Sdteske# foo="abc'123" 343249751Sdteske# f_shell_escape "$foo" bar # bar=[abc'\''123] 344249751Sdteske# f_shell_unescape "$bar" # produces abc'123 345249751Sdteske# 346249751Sdteskef_shell_unescape() 347249751Sdteske{ 348249751Sdteske local __string="$1" __var_to_set="$2" 349249751Sdteske f_replaceall "$__string" "'\\''" "'" "$__var_to_set" 350249751Sdteske} 351249751Sdteske 352256361Sdteske# f_expand_number $string [$var_to_set] 353256361Sdteske# 354256361Sdteske# Unformat $string into a number, optionally to be stored in $var_to_set. This 355256361Sdteske# function follows the SI power of two convention. 356256361Sdteske# 357256361Sdteske# The prefixes are: 358256361Sdteske# 359256361Sdteske# Prefix Description Multiplier 360256361Sdteske# k kilo 1024 361256361Sdteske# M mega 1048576 362256361Sdteske# G giga 1073741824 363256361Sdteske# T tera 1099511627776 364256361Sdteske# P peta 1125899906842624 365256361Sdteske# E exa 1152921504606846976 366256361Sdteske# 367256361Sdteske# NOTE: Prefixes are case-insensitive. 368256361Sdteske# 369256392Sdteske# Upon successful completion, success status is returned; otherwise the number 370256392Sdteske# -1 is produced ($var_to_set set to -1 or if $var_to_set is NULL or missing) 371256392Sdteske# on standard output. In the case of failure, the error status will be one of: 372256361Sdteske# 373256392Sdteske# Status Reason 374256392Sdteske# 1 Given $string contains no digits 375256392Sdteske# 2 An unrecognized prefix was given 376256392Sdteske# 3 Result too large to calculate 377256361Sdteske# 378256361Sdteskef_expand_number() 379256361Sdteske{ 380256361Sdteske local __string="$1" __var_to_set="$2" 381256392Sdteske local __cp __num __bshift __maxinput 382256361Sdteske 383256361Sdteske # Remove any leading non-digits 384263980Sdteske __string="${__string#${__string%%[0-9]*}}" 385256361Sdteske 386263980Sdteske # Store the numbers (no trailing suffix) 387263980Sdteske __num="${__string%%[!0-9]*}" 388263980Sdteske 389256392Sdteske # Produce `-1' if string didn't contain any digits 390263980Sdteske if [ ! "$__num" ]; then 391256361Sdteske if [ "$__var_to_set" ]; then 392256361Sdteske setvar "$__var_to_set" -1 393256361Sdteske else 394256361Sdteske echo -1 395256361Sdteske fi 396256392Sdteske return 1 # 1 = "Given $string contains no digits" 397256361Sdteske fi 398256361Sdteske 399256361Sdteske # Remove all the leading numbers from the string to get at the prefix 400263980Sdteske __string="${__string#"$__num"}" 401256361Sdteske 402256392Sdteske # 403256392Sdteske # Test for invalid prefix (and determine bitshift length) 404256392Sdteske # 405256361Sdteske case "$__string" in 406256392Sdteske ""|[[:space:]]*) # Shortcut 407256392Sdteske if [ "$__var_to_set" ]; then 408256392Sdteske setvar "$__var_to_set" $__num 409256392Sdteske else 410256392Sdteske echo $__num 411256392Sdteske fi 412256392Sdteske return $SUCCESS ;; 413256392Sdteske [Kk]*) __bshift=10 ;; 414256392Sdteske [Mm]*) __bshift=20 ;; 415256392Sdteske [Gg]*) __bshift=30 ;; 416256392Sdteske [Tt]*) __bshift=40 ;; 417256392Sdteske [Pp]*) __bshift=50 ;; 418256392Sdteske [Ee]*) __bshift=60 ;; 419256361Sdteske *) 420256361Sdteske # Unknown prefix 421256361Sdteske if [ "$__var_to_set" ]; then 422256361Sdteske setvar "$__var_to_set" -1 423256361Sdteske else 424256361Sdteske echo -1 425256361Sdteske fi 426256392Sdteske return 2 # 2 = "An unrecognized prefix was given" 427256361Sdteske esac 428256361Sdteske 429256392Sdteske # Determine if the wheels fall off 430256392Sdteske __maxinput=$(( 0x7fffffffffffffff >> $__bshift )) 431256392Sdteske if [ $__num -gt $__maxinput ]; then 432256392Sdteske # Input (before expanding) would exceed 64-bit signed int 433256361Sdteske if [ "$__var_to_set" ]; then 434256361Sdteske setvar "$__var_to_set" -1 435256361Sdteske else 436256361Sdteske echo -1 437256361Sdteske fi 438256392Sdteske return 3 # 3 = "Result too large to calculate" 439256361Sdteske fi 440256361Sdteske 441256392Sdteske # Shift the number out and produce it 442256392Sdteske __num=$(( $__num << $__bshift )) 443256361Sdteske if [ "$__var_to_set" ]; then 444256361Sdteske setvar "$__var_to_set" $__num 445256361Sdteske else 446256361Sdteske echo $__num 447256361Sdteske fi 448256361Sdteske} 449256361Sdteske 450249751Sdteske############################################################ MAIN 451249751Sdteske 452244675Sdteskef_dprintf "%s: Successfully loaded." strings.subr 453244675Sdteske 454238438Sdteskefi # ! $_STRINGS_SUBR 455