chiark / gitweb /
c7712393b5d038ebf5fe23f7d9bca30cdf23972c
[jog] / aunum.h
1 /* -*-c-*-
2  *
3  * $Id: aunum.h,v 1.1 2002/02/02 19:16:28 mdw Exp $
4  *
5  * Reading numbers to audio output
6  *
7  * (c) 2002 Mark Wooding
8  */
9
10 /*----- Licensing notice --------------------------------------------------* 
11  *
12  * This file is part of Jog: Programming for a jogging machine.
13  *
14  * Jog is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  * 
19  * Jog is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  * 
24  * You should have received a copy of the GNU General Public License
25  * along with Jog; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27  */
28
29 #ifndef AU_NUM_H
30 #define AU_NUM_H
31
32 #ifdef __cplusplus
33   extern "C" {
34 #endif
35
36 /*----- Functions provided ------------------------------------------------*/
37
38 /* --- @aunum@ --- *
39  *
40  * Arguments:   @const char *p@ = pointer to number's textual representation
41  *
42  * Returns:     ---
43  *
44  * Use:         Reads the given number aloud.
45  */
46
47 extern void aunum(const char */*p*/);
48
49 /* --- @aunum_ulong@ --- *
50  *
51  * Arguments:   @unsigned long n@ = number to be read
52  *
53  * Returns:     ---
54  *
55  * Use:         Reads a number expressed as an @unsigned long@.
56  */
57
58 extern void aunum_ulong(unsigned long /*n*/);
59
60 /*----- That's all, folks -------------------------------------------------*/
61
62 #ifdef __cplusplus
63   }
64 #endif
65
66 #endif