#!/usr/bin/env bash
# -*- coding: utf-8 -*-
# region header
# Copyright Torben Sickert (info["~at~"]torben.website) 16.12.2012

# License
# -------

# This library written by Torben Sickert stands under a creative commons naming
# 3.0 unported license. See https://creativecommons.org/licenses/by/3.0/deed.de
# endregion
# shellcheck disable=SC2016,SC2034,SC2155
# region variables
declare -gr BL_TIME__DOCUMENTATION__='
    The time module implements utility functions concerning time measurments.
'
declare -gi BL_TIME_START=0
# endregion
# region functions
alias bl.time.get_elapsed=bl_time_get_elapsed
bl_time_get_elapsed() {
    local -r __documentation__='
        Prints elapsed time in milliseconds since last `bl.time.start` call.

        >>> local time=$(bl.time.get_elapsed)
        >>> (( time > 0 )); echo $?
        0

        >>> bl.time.start
        >>> local time=$(bl.time.get_elapsed)
        >>> (( time > 0 )); echo $?
        0
    '
    local -ir end_time="$(date +%s%N)"
    local -ir elapsed_time_in_nano_seconds=$(( end_time - BL_TIME_START ))
    echo $(( elapsed_time_in_nano_seconds / 1000000 ))
}
alias bl.time.start=bl_time_start
bl_time_start() {
    local -r __documentation__='
        Prints elapsed time in milliseconds since last `bl.time.start` call.

        >>> bl.time.start
        >>> bl.time.start
        >>> local time=$(bl.time.get_elapsed)
        >>> (( time > 0 )); echo $?
        0
    '
    BL_TIME_START=$(date +%s%N)
}
# endregion
# region vim modline
# vim: set tabstop=4 shiftwidth=4 expandtab:
# vim: foldmethod=marker foldmarker=region,endregion:
# endregion