Skip to content

Character Functions

⬅ Parent

Usage

isCharacterClass className [ character ... ] [ --help ]

Poor-man's bash character class matching Returns true if all characters are of className className can be one of: alnum alpha ascii blank cntrl digit graph lower print punct space upper word xdigit

Arguments

  • className - String. Required. Class to check.
  • character ... - String. Optional. Characters to test.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

characterClassReport [ --class ] [ --char ] [ --help ]

Write a report of the character classes

Arguments

  • --class - Flag. Optional. Show class and then characters in that class.
  • --char - Flag. Optional. Show characters and then class for that character.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

characterClasses [ --help ] [ character ... ]

List the classes allowed in isCharacterClass

Arguments

  • --help - Flag. Optional. Display this help.
  • character ... - String. Optional. Output the character classes associated with this character. Uses the first character only. Multiple parameters are output without a delimiter.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

characterFromInteger [ --help ]

Given a list of integers, output the character codes associated with them (e.g. chr in other languages)

Arguments

  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

characterToInteger [ character ] [ --help ]

Convert one or more characters from their ascii representation to an integer value. Requires a single character to be passed

Arguments

  • character - String. Optional. One or more characters to convert to their ASCII equivalent.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

isCharacterClasses character [ class ... ] [ --help ]

Does this character match one or more character classes?

Arguments

  • character - Required. Single character to test.
  • class ... - String. Optional. A class name or a character to match. If more than is supplied, a single value must match to succeed (any).
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

stringValidate [ text ] [ class0 ... ] [ --help ]

Ensure that every character in a text string passes all character class tests

Arguments

  • text - Text to validate
  • class0 ... - One or more character classes that the characters in string should match
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error