time.c File Reference

#include <assert.h>
#include <limits.h>
#include <uv.h>
#include "nvim/event/loop.h"
#include "nvim/main.h"
#include "nvim/os/input.h"
#include "nvim/os/os.h"
#include "nvim/os/time.h"

Functions
void	time_init (void)
	Initializes the time module. More...
uint64_t	os_hrtime (void)
uint64_t	os_now (void)
void	os_delay (uint64_t ms, bool ignoreinput)
void	os_microdelay (uint64_t us, bool ignoreinput)
struct tm *	os_localtime_r (const time_t *restrict clock, struct tm *restrict result) FUNC_ATTR_NONNULL_ALL
struct tm *	os_localtime (struct tm *result) FUNC_ATTR_NONNULL_ALL
char *	os_ctime_r (const time_t *restrict clock, char *restrict result, size_t result_len) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_NONNULL_RET
char *	os_ctime (char *result, size_t result_len) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_NONNULL_RET
char *	os_strptime (const char *str, const char *format, struct tm *tm) FUNC_ATTR_NONNULL_ALL
Timestamp	os_time (void)

Function Documentation

os_ctime()

char* os_ctime	(	char *	result,
		size_t	result_len
	)

Gets the current Unix timestamp and adjusts it to local time.

Parameters

result[out]	Pointer to a 'char' where the result should be placed
result_len	length of result buffer

Returns

human-readable string of current local time

os_ctime_r()

char* os_ctime_r	(	const time_t *restrict	clock,
		char *restrict	result,
		size_t	result_len
	)

Portable version of POSIX ctime_r()

Parameters

clock[in]
result[out]	Pointer to a 'char' where the result should be placed
result_len	length of result buffer

Returns

human-readable string of current local time

os_delay()

void os_delay	(	uint64_t	ms,
		bool	ignoreinput
	)

Sleeps for ms milliseconds.

See also

uv_sleep() (libuv v1.34.0)

Parameters

ms	Number of milliseconds to sleep
ignoreinput	If true, only SIGINT (CTRL-C) can interrupt.

os_hrtime()

uint64_t os_hrtime

(

void

)

Gets a high-resolution (nanosecond), monotonically-increasing time relative to an arbitrary time in the past.

Not related to the time of day and therefore not subject to clock drift.

Returns

Relative time value with nanosecond precision.

os_localtime()

struct tm* os_localtime

(

struct tm *

result

)

Gets the current Unix timestamp and adjusts it to local time.

Parameters

result

Pointer to a 'struct tm' where the result should be placed

Returns

A pointer to a 'struct tm' in the current time zone (the 'result' argument) or NULL in case of error

os_localtime_r()

struct tm* os_localtime_r	(	const time_t *restrict	clock,
		struct tm *restrict	result
	)

Portable version of POSIX localtime_r()

Returns

NULL in case of error

os_microdelay()

void os_microdelay	(	uint64_t	us,
		bool	ignoreinput
	)

Sleeps for us microseconds.

See also

uv_sleep() (libuv v1.34.0)

Parameters

us	Number of microseconds to sleep.
ignoreinput	If true, ignore all input (including SIGINT/CTRL-C). If false, waiting is aborted on any input.

os_now()

uint64_t os_now

(

void

)

Gets a millisecond-resolution, monotonically-increasing time relative to an arbitrary time in the past.

Not related to the time of day and therefore not subject to clock drift. The value is cached by the loop, it will not change until the next loop-tick (unless uv_update_time is called).

Returns

Relative time value with millisecond precision.

os_strptime()

char* os_strptime	(	const char *	str,
		const char *	format,
		struct tm *	tm
	)

Portable version of POSIX strptime()

Parameters

str[in]	string to convert
format[in]	format to parse "str"
tm[out]	time representation of "str"

Returns

Pointer to first unprocessed character or NULL

os_time()

Timestamp os_time

(

void

)

Obtains the current Unix timestamp.

Returns

Seconds since epoch.

time_init()

void time_init

(

void

)

Initializes the time module.