chiark - git - mdw - jog/blob - 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 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: aunum.h,v $
  32  * Revision 1.1  2002/02/02 19:16:28  mdw
  33  * New audio subsystem.
  34  *
  35  */
  36
  37 #ifndef AU_NUM_H
  38 #define AU_NUM_H
  39
  40 #ifdef __cplusplus
  41   extern "C" {
  42 #endif
  43
  44 /*----- Functions provided ------------------------------------------------*/
  45
  46 /* --- @aunum@ --- *
  47  *
  48  * Arguments:   @const char *p@ = pointer to number's textual representation
  49  *
  50  * Returns:     ---
  51  *
  52  * Use:         Reads the given number aloud.
  53  */
  54
  55 extern void aunum(const char */*p*/);
  56
  57 /* --- @aunum_ulong@ --- *
  58  *
  59  * Arguments:   @unsigned long n@ = number to be read
  60  *
  61  * Returns:     ---
  62  *
  63  * Use:         Reads a number expressed as an @unsigned long@.
  64  */
  65
  66 extern void aunum_ulong(unsigned long /*n*/);
  67
  68 /*----- That's all, folks -------------------------------------------------*/
  69
  70 #ifdef __cplusplus
  71   }
  72 #endif
  73
  74 #endif