complete_sequence

 complete_sequence(%args) -> array

Complete string from a sequence of choices.

Sometime you want to complete a string where its parts (sequence items) are formed from various pieces. For example, suppose your program "delete-user-data" accepts an argument that is in the form of:

 USERNAME
 UID "(" "current" ")"
 UID "(" "historical" ")"
 
 "EVERYONE"

Supposed existing users include "budi", "ujang", and "wati" with UID 101, 102, 103.

This can be written as:

 [
     {
         alternative => [
             [qw/budi ujang wati/],
             {sequence => [
                 [qw/101 102 103/],
                 ["(current)", "(historical)"],
             ]},
             "EVERYONE",
         ],
     }
 ]

When word is empty (''), the offered completion is:

 budi
 ujang
 wati
 
 101
 102
 103
 
 EVERYONE

When word is 101, the offered completion is:

 101
 101(current)
 101(historical)

When word is "101(h", the offered completion is:

 101(historical)

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

•

sequence* => array

A sequence structure is an array of items. An item can be:

 {sequence => [ ... ]}   # put items in here

 {alternative => [ ... ]}    # put items in here

•

word* => str (default: "")

Word to complete.

Return value: (array)

COMPLETE_SEQUENCE_TRACE