wpm.h

 1/*
 2 * Copyright 2020 Richard Sutherland (rich@brickbots.com)
 3 *
 4 * This program is free software: you can redistribute it and/or modify
 5 * it under the terms of the GNU General Public License as published by
 6 * the Free Software Foundation, either version 2 of the License, or
 7 * (at your option) any later version.
 8 *
 9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 */
17
18#pragma once
19
20#include <stdbool.h>
21#include <stdint.h>
22
23#ifndef WPM_ESTIMATED_WORD_SIZE
24#    define WPM_ESTIMATED_WORD_SIZE 5
25#endif
26#ifndef WPM_SAMPLE_SECONDS
27#    define WPM_SAMPLE_SECONDS 5
28#endif
29#ifndef WPM_SAMPLE_PERIODS
30#    define WPM_SAMPLE_PERIODS 25
31#endif
32
33bool wpm_keycode(uint16_t keycode);
34bool wpm_keycode_kb(uint16_t keycode);
35bool wpm_keycode_user(uint16_t keycode);
36
37#ifdef WPM_ALLOW_COUNT_REGRESSION
38uint8_t wpm_regress_count(uint16_t keycode);
39#endif
40
41void    set_current_wpm(uint8_t);
42uint8_t get_current_wpm(void);
43void    update_wpm(uint16_t);
44
45void decay_wpm(void);