summaryrefslogtreecommitdiff
path: root/typing-break/drw-timer.h
blob: a9ab2ea76d9206d3de36a0fba8b00202e35c663a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2009 Nathaniel Smith <njs@pobox.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __DRW_TIMER_H__
#define __DRW_TIMER_H__

/*
 * This file defines a timer interface similar to GTimer, but defined in real
 * wall-clock time. A GTimer may stop counting while the computer is suspended
 * or the process is stopped:
 *   https://bugzilla.gnome.org/show_bug.cgi?id=552994
 * but a DrwTimer keeps counting regardless.
 *
 * Currently this only provides second resolution as compared to GTimer's
 * microsecond resolution, but a typing break program doesn't really need
 * microsecond resolution anyway.
 */

typedef struct _DrwTimer DrwTimer;
DrwTimer * drw_timer_new (void);
void drw_timer_start (DrwTimer *timer);
gint drw_timer_elapsed (DrwTimer *timer);
void drw_timer_destroy (DrwTimer *timer);

#endif /* __DRW_TIMER_H__ */