home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.2 / amidev_cd_12.iso / inc&ad2.0 / text_autodocs / debug_lib.doc < prev    next >
Text File  |  1992-09-01  |  4KB  |  127 lines
  1. TABLE OF CONTENTS
  2.  
  3. debug.lib/KCmpStr
  4. debug.lib/KGetChar
  5. debug.lib/KGetNum
  6. debug.lib/KMayGetChar
  7. debug.lib/KPrintF
  8. debug.lib/KPutChar
  9. debug.lib/KPutStr
  10. debug.lib/KCmpStr                                           debug.lib/KCmpStr
  11.  
  12.    NAME
  13.     KCmpStr - compare two null terminated strings
  14.  
  15.    SYNOPSIS
  16.     mismatch = KCmpStr(string1, string2)
  17.     D0         A0        A1
  18.  
  19.    FUNCTION
  20.     string1 is compared to string2 using the ASCII coalating
  21.     sequence.  0 indicates the strings are identical.
  22. debug.lib/KGetChar                                         debug.lib/KGetChar
  23.  
  24.    NAME
  25.     KGetChar - get a character from the console
  26.            (defaults to the serial port at 9600 baud)
  27.  
  28.    SYNOPSIS
  29.     char = KGetChar()
  30.     D0
  31.  
  32.    FUNCTION
  33.     busy wait until a character arrives from the console.
  34.     KGetChar is the assembly interface, _KGetChar and _kgetc
  35.     are the C interfaces.
  36. debug.lib/KGetNum                                           debug.lib/KGetNum
  37.  
  38.    NAME
  39.     KGetNum - get a number from the console
  40.  
  41.    SYNOPSIS
  42.     number = KGetNum()
  43.     D0
  44.  
  45.    FUNCTION
  46.     get a signed decimal integer from the console.  This will busy
  47.     wait until the number arrives.
  48.  
  49. debug.lib/KMayGetChar                                   debug.lib/KMayGetChar
  50.  
  51.    NAME
  52.     KMayGetChar - return a character if present, but don't wait
  53.               (defaults to the serial port at 9600 baud)
  54.  
  55.    SYNOPSIS
  56.     flagChar = KMayGetChar()
  57.     D0
  58.  
  59.    FUNCTION
  60.     return either a -1, saying that there is no character present, or
  61.     whatever character was waiting.  KMayGetChar is the assembly
  62.     interface,  _KMayGetChar is the C interface.
  63. debug.lib/KPrintF                                           debug.lib/KPrintF
  64.  
  65.    NAME
  66.     KPrintF - print formatted data to the console
  67.               (defaults to the serial port at 9600 baud)
  68.  
  69.    SYNOPSIS
  70.     KPrintF("format string",values)
  71.              A0             A1
  72.  
  73.    FUNCTION
  74.     print a formatted C-type string to the console.  See the
  75.     exec RawDoFmt() call for the supported % formatting commands.
  76.  
  77.    INPUTS
  78.     "format string" - A C style string with % commands to indicate
  79.                       where paramters are to be inserted.
  80.     values - A pointer to an array of paramters, to be inserted into
  81.              specified places in the string.
  82.  
  83.     KPutFmt and KPrintF are identical assembly interfaces that want the
  84.     two pointers in registers.  _KPrintF and _kprintf are C interfaces
  85.     that expect the format string pointer on the stack, and the
  86.     paramters on the stack above that.
  87.  
  88.    SEE ALSO
  89.     exec.library/RawDoFmt, any C compiler's "printf" call.
  90. debug.lib/KPutChar                                         debug.lib/KPutChar
  91.  
  92.    NAME
  93.     KPutChar - put a character to the console
  94.            (defaults to the serial port at 9600 baud)
  95.  
  96.    SYNOPSIS
  97.     char = KPutChar(char)
  98.     D0            D0
  99.  
  100.    FUNCTION
  101.     Put a character to the console.  This function will not return
  102.     until the character has been completely transmitted.
  103.  
  104.    INPUTS
  105.     KPutChar is the assembly interface, the character must be in D0.
  106.     _KPutChar and _kputc are the C interfaces, the character must be
  107.     a longword on the stack.
  108.  
  109. debug.lib/KPutStr                                           debug.lib/KPutStr
  110.  
  111.    NAME
  112.     KPutStr - put a string to the console
  113.            (defaults to the serial port at 9600 baud)
  114.  
  115.    SYNOPSIS
  116.     KPutStr(string)
  117.             A0
  118.  
  119.    FUNCTION
  120.     put a null terminated string to the console.  This function will
  121.     not return until the string has been completely transmitted.
  122.  
  123.    INPUTS
  124.     KPutStr is the assembly interface, a string pointer must be in A0.
  125.     _KPutStr and _kputs are the C interfaces, the string pointer must
  126.     be on the stack.
  127.