0. Mask

Mask is a central class responsible for formatting the input, producing the output, and extracting the valuable characters.

class Mask {
    struct Result {
        let formattedText: CaretString
        let extractedValue: String
        let affinity: Int
        let complete: Bool
    }

    init(format: String, customNotations: [Notation] = []) throws

    class func getOrCreate(withFormat format: String, customNotations: [Notation] = []) throws -> Mask

    class func isValid(format: String, customNotations: [Notation] = []) -> Bool

    func apply(toText text: CaretString, autocomplete: Bool = false) -> Result

    var placeholder:           String
    var acceptableTextLength:  Int
    var totalTextLength:       Int
    var acceptableValueLength: Int
    var totalValueLength:      Int
}

Initialisation

Mask object is a state machine with its own internal graph of states to move through. The graph is compiled from the format during the initialisation. If the format is invalid, compiler throws an exception.

init(format: String, customNotations: [Notation] = []) throws

— the only constructor passes the list of custom notations and the format to the internal compiler.

class func getOrCreate(withFormat format: String, customNotations: [Notation] = []) throws -> Mask

— in order to avoid graph re-compilation overhead each time you make a Mask object, use the getOrCreate() class method — it has its own cache from where previously created Mask objects with similar graphs are fetched instead of being created.

class func isValid(format: String, customNotations: [Notation] = []) -> Bool

— is a convenience method to check whether or not this particular format will cause a compilation exception given the list of custom notations.

Applying the format

func apply(toText text: CaretString, autocomplete: Bool = false) -> Result

— you may use this method as a «headless» approach to format some text somewhere in your application's code without involving a UIView.

CaretString is a structure representing a string and a caret (cursor) position inside of it.

struct CaretString {
    let string:        String
    let caretPosition: String.Index
}

Adding and removing characters leads to the cursor movements. For instance, if the input string contains unwanted symbols, they are removed, and the cursor moves left:

Mask:    [000]

Input:   1a2
           ^
Output:  12
          ^

The resulting cursor position along with the output (formatted text), value completeness and calculated affinity are returned as a Mask.Result object:

struct Result {
    let formattedText:  CaretString
    let extractedValue: String
    let affinity:       Int
    let complete:       Bool
}

affinity is an integer value representing the similarity between the input and the mask pattern. This value is necessary to determine the most suitable mask.

complete flag shows if the extracted value contains all the mandatory characters.

Properties and metrics

Each mask has its metrics.

• acceptableTextLength is the minimum length the output has to be in order to be acceptable (complete == true);
• totalTextLength is the maximum output length, with all optional characters included;
• acceptableValueLength is the minimum acceptable extracted value length;
• totalValueLength is the maximum extracted value length.

placeholder produces a simple placeholder text that can serve as a text field hint (including optional symbols; a for arbitrary letters, 0 for arbitrary digits, - for arbitrary alphanumerics):

([009])[Aa] ~> (000)aa