CharacterMap class

A CharacterMap class object contains a mapping of characters to characters. Each character in an In string (the “input table”) is associated with, or mapped to, an individual character from an Out string (the “output table”). The output table may be supplemented with instances of a pad character to ensure a one-to-one mapping with the input table characters.

The methods in this class are listed in Category:CharacterMap methods.

CharacterMap includes a constructor, copy methods, and an update method for modifying the map. Most of these methods are shown in the following example, which features the intrinsic String Translate function. In the example, a new CharacterMap is the argument for the Translate method; then that map is copied and modified, and the modified map is used in a second Translate call:

    begin
    %map is object characterMap
    %map2 is object characterMap
    %ls is longstring
 
    %map = New(in='x-', out='!c')
    %ls = 'xu--exx'
    printtext {~} = '{%ls:translate(%map)}'
 
    %map2 = %map:Copy
    %map2:Update(in='x',out='s')
    printtext {~} = '{%ls:translate(%map2)}'
 
    end

The result is:

    %ls:translate(%map) = '!ucce!!'
    %ls:translate(%map2) = 'success'

The methods in the class are described in the subsections that follow. For information about the conventions followed in the method descriptions, see Notation conventions for methods.

This class is new as of version 7.3 of the Sirius Mods.