Mercurial > molko

annotate libcore/core/clock.h @ 121:789b23e01f52

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: reorganize hierarchy, closes #2490
author David Demelier <markand@malikania.fr>
date Mon, 05 Oct 2020 13:25:06 +0200
parents src/core/clock.h@6203e1ac9b18
children b386d25832c8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * clock.h -- track elapsed time
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_CLOCK_H
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_CLOCK_H
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file clock.h
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Track elapsed time.
72
6203e1ac9b18 doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents: 59
diff changeset
25 * \ingroup basics
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 */
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 /**
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 * \brief Clock structure.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 */
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 struct clock {
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
32 unsigned int ticks; /*!< time point on initialization */
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 };
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 /**
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * Start the clock and track elapsed time.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 * \pre clock != NULL
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 * \param clock the clock
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 */
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 void
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 clock_start(struct clock *clock);
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 /**
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 * Tell the measured time.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * \pre clock != NULL
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * \param clock the clock
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 * \return the elapsed time in milliseconds
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 */
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
51 unsigned int
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 clock_elapsed(const struct clock *clock);
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 #endif /* !MOLKO_CLOCK_H */