LIBRARY

The roken library (libroken, -lroken)

SYNOPSIS

Fd #include <parse_time.h> Ft int Fn parse_time const char *timespec const char *def_unit Ft void Fn print_time_table FILE *f Ft size_t Fn unparse_time int seconds char *buf size_t len Ft size_t Fn unparse_time_approx int seconds char *buf size_t len

DESCRIPTION

The Fn parse_time function converts the period of time specified into a number of seconds. The Fa timespec can be any number of Aq number unit pairs separated by comma and whitespace. The number can be negative. Numbers without explicit units are taken as being Fa def_unit .

The Fn unparse_time and Fn unparse_time_approx do the opposite of Fn parse_time , that is they take a number of seconds and express that as human readable strings. Fa unparse_time produces an exact time, while Fa unparse_time_approx restricts the result to include only one unit.

Fn print_time_table prints a descriptive list of available units on the passed file descriptor.

The possible units include:

second , s

minute , m

hour , h

day

week

seven days

month

30 days

year

365 days

Units names can be arbitrarily abbreviated (as long as they are unique).

RETURN VALUES

Fn parse_time returns the number of seconds that represents the expression in Fa timespec or -1 on error. Fn unparse_time and Fn unparse_time_approx return the number of characters written to Fa buf . if the return value is greater than or equal to the Fa len argument, the string was too short and some of the printed characters were discarded.

EXAMPLES

#include <stdio.h>
#include <parse_time.h>
int
main(int argc, char **argv)
{
    int i;
    int result;
    char buf[128];
    print_time_table(stdout);
    for (i = 1; i < argc; i++) {
        result = parse_time(argv[i], "second");
        if(result == -1) {
            fprintf(stderr, "%s: parse error\n", argv[i]);
            continue;
        }
        printf("--\n");
        printf("parse_time = %d\n", result);
        unparse_time(result, buf, sizeof(buf));
        printf("unparse_time = %s\n", buf);
        unparse_time_approx(result, buf, sizeof(buf));
        printf("unparse_time_approx = %s\n", buf);
    }
    return 0;
}

$ ./a.out "1 minute 30 seconds" "90 s" "1 y -1 s"
1   year = 365 days
1  month = 30 days
1   week = 7 days
1    day = 24 hours
1   hour = 60 minutes
1 minute = 60 seconds
1 second
--
parse_time = 90
unparse_time = 1 minute 30 seconds
unparse_time_approx = 1 minute
--
parse_time = 90
unparse_time = 1 minute 30 seconds
unparse_time_approx = 1 minute
--
parse_time = 31535999
unparse_time = 12 months 4 days 23 hours 59 minutes 59 seconds
unparse_time_approx = 12 months