Format strings¶

The first parameter to new() is the format string which contains the following special characters:

characters '%d'

a revolving dash, format '/-\|'

characters '%t'

time elapsed, format 'hh:mm:ss'

characters '%b'

progress bar, format '#####_____'

characters '%p'

Progress in percentage, format '999%'

characters '%c'

Actual counter value (commified by '_'), format '99_999_999'

characters '%m'

Target maximum value (commified by '_'), format '99_999_999'

characters '%k'

Token which updates its value before being displayed. An example use of this would be a loop wherein every step of the loop could be identified by a particular string. For example:

    my $ctr = Term::Sk->new('Processing %k counter %c',
      {base => 0, token => 'Albania'});
    foreach my $country (@list_of_european_nations) {
      $ctr->token($country);
      for (1..500) {
          $ctr->up;
          ## do something...
      }
    };
    $ctr->close;
    

You can also have more than one token on a single line. Here is an example:

    my $ctr = Term::Sk->new('Processing %k Region %k counter %c',
      {base => 0, token => ['Albania', 'South']});
    foreach my $country (@list_of_european_nations) {
      $ctr->token([$country, 'North']);
      for (1..500) {
          $ctr->up;
          ## do something...
      }
    };
    $ctr->close;
    

The "token" method is used to update the token value immediately on the screen.

The "tok_maybe" method is used to set the token value, but the screen is not refreshed immediately.

If '%k' is used, then the counter must be instantiated with an initial value for the token.

characters '%P'

The '%' character itself

Options¶

The second parameter are the following options:

option {freq => 999}

This option sets the refresh-frequency on STDOUT to every 999 up() or down() calls. If {freq => 999} is not specified at all, then the refresh-frequency is set by default to every up() or down() call.

option {freq => 's'}

This is a special case whereby the refresh-frequency on STDOUT is set to every second.

option {freq => 'd'}

This is a special case whereby the refresh-frequency on STDOUT is set to every 1/10th of a second.

option {base => 0}

This specifies the base value from which to count. The default is 0

option {target => 10_000}

This specifies the maximum value to which to count. The default is 10_000.

option {pdisp => '!'}

This option (with the exclamation mark) is obsolete and has no effect whatsoever. The progressbar will always be displayed using the hash-symbol "#".

option {quiet => 1}

This option disables most printing to STDOUT, but the content of the would be printed line is still available using the method get_line(). The whisper-method, however, still shows its output.

The default is in fact {quiet => !-t STDOUT}

option {num => '9_999'}

This option configures the output number format for the counters.

option {commify => sub{...}}

This option allows one to register a subroutine that formats the counters.

option {test => 1}

This option is used for testing purposes only, it disables all printing to STDOUT, even the whisper shows no output. But again, the content of the would be printed line is still available using the method get_line().

Processing¶

The new() method immediately displays the initial values on screen. From now on, nothing must be printed to STDOUT and/or STDERR. However, you can write to STDOUT during the operation using the method whisper().

We can either count upwards, $ctr->up, or downwards, $ctr->down. Everytime we do so, the value is either incremented or decremented and the new value is replaced on STDOUT. We should do so regularly during the process. Both methods, $ctr->up(99) and $ctr->down(99) can take an optional argument, in which case the value is incremented/decremented by the specified amount.

When our process has finished, we must close the counter ($ctr->close). By doing so, the last displayed value is removed from STDOUT, as if nothing had happened. Now we are allowed to print again to STDOUT and/or STDERR.

Post hoc transformation¶

In some cases it makes sense to redirected STDOUT to a flat file. In this case, the backspace characters remain in the flat file.

There is a function "rem_backspace()" that removes the backspaces (including the characters that they are supposed to remove) from a redirected file.

Here is a simplified example:

  use Term::Sk qw(rem_backspace);
  my $flatfile = "Test hijabc\010\010\010xyzklmttt\010\010yzz";
  printf "before (len=%3d): '%s'\n", length($flatfile), $flatfile;
  rem_backspace(\$flatfile);
  printf "after  (len=%3d): '%s'\n", length($flatfile), $flatfile;