home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1997 #3 / amigamamagazinepolishissue03-1 / polski_aminet / michal_letowski / debuglib / autodocs / debug_lib.doc
Text File  |  1996-05-11  |  7KB  |  219 lines
  1. TABLE OF CONTENTS
  2.  
  3. debug.lib/KCmpStr
  4. debug.lib/KDoFmt
  5. debug.lib/KGetChar
  6. debug.lib/KMayGetChar
  7. debug.lib/KPutChar
  8. debug.lib/KPutStr
  9. debug.lib/VKPrintf
  10. debug.lib/KCmpStr                                           debug.lib/KCmpStr
  11.  
  12.    NAME
  13.         KCmpStr -- compare two NULL-terminated strings. (V37)
  14.  
  15.    SYNOPSIS
  16.         mismatch = KCmpStr(string1, string2)
  17.         D0                 A0       A1
  18.  
  19.         LONG KCmpStr(STRPTR, STRPTR);
  20.  
  21.    FUNCTION
  22.         string1 is compared to string2 using the ASCII collating sequence.
  23.         If the strirngs have different lengths, the shorter is treated as if
  24.         it were extended with zeros.
  25.  
  26.    INPUTS
  27.         string1, string2 - strings to be compared.
  28.  
  29.    RESULT
  30.         result - value representing relationship between string1 and string2:
  31.                      <0 means string1 < string2
  32.                      =0 means string1 = string2
  33.                      >0 means string1 > string2
  34.  
  35.    NOTES
  36.         @KCmpStr, @KStrCmp, @kstrcmp, KStrCmp are identical assembly
  37.         interfaces that want two pointers in registers. _KCmpStr, _KStrCmp,
  38.         _kstrcmp are C interfaces that expect the parameters on the stack.
  39.  
  40.    SEE ALSO
  41.         locale.library/StrnCmp(),
  42.         utility.library/Stricmp(), utility.library/Strnicmp().
  43.  
  44. debug.lib/KDoFmt                                             debug.lib/KDoFmt
  45.  
  46.    NAME
  47.         KDoFmt -- format data into a character stream. (V37)
  48.  
  49.    SYNOPSIS
  50.         nextData = KDoFmt(formatString, dataStream, putChProc, putChData)
  51.         D0                A0            A1          A2         A3
  52.  
  53.         APTR KDoFmt(STRPTR, STRPTR, void (*)(), APTR);
  54.  
  55.    FUNCTION
  56.         Interface to ROM RawDoFmt() function.
  57.  
  58.    INPUTS
  59.         formatString - "C"-language-like NULL terminated format string.
  60.         dataStream   - stream of data to be interpreted.
  61.         putChProc    - the procedure to call with each character to be
  62.                        output.
  63.         putChData    - the value that is passed through to the putChProc
  64.                        procedure.
  65.  
  66.    RESULT
  67.         nextData - pointer to end of the data stream (the next argument that
  68.                    would have been processed).
  69.  
  70.    NOTES
  71.         @KDoFmt, KDoFmt are identical assembly interfaces that want pointers
  72.         in registers. _KDoFmt is a C interface that expects the parameters
  73.         on the stack.
  74.  
  75.    SEE ALSO
  76.         exec.library/RawDoFmt().
  77.  
  78. debug.lib/KGetChar                                         debug.lib/KGetChar
  79.  
  80.    NAME
  81.         KGetChar -- get a character from the debugging console. (V37)
  82.  
  83.    SYNOPSIS
  84.         char = KGetChar()
  85.         D0
  86.  
  87.         LONG KGetChar(VOID);
  88.  
  89.    FUNCTION
  90.         Busy waits until a character arrives from the debugging console
  91.         (defaults to the serial port at 9600 baud).
  92.  
  93.    RESULT
  94.         char - a character that arrived from console.
  95.  
  96.    NOTES
  97.         @KGetChar, @kgetc and KGetChar are identical assembly interfaces.
  98.         _KGetChar, _kgetc are the C interfaces.
  99.  
  100. debug.lib/KMayGetChar                                   debug.lib/KMayGetChar
  101.  
  102.    NAME
  103.         KMayGetChar -- get a character from debugging console if present,
  104.                        but don't wait. (V37)
  105.  
  106.    SYNOPSIS
  107.         flagchar = KMayGetChar()
  108.         D0
  109.  
  110.         LONG KMayGetChar(VOID);
  111.  
  112.    FUNCTION
  113.         Checks the status of the debugging console (defaults to the serial
  114.         port at 9600 baud). Returns either -1, saying that there is no
  115.         character present, or whatever character was waiting.
  116.  
  117.    RESULT
  118.         char - a character that arrived from console, or -1 if there was
  119.                no char waiting.
  120.  
  121.    NOTES
  122.         @KMayGetChar and KMayGetChar are identical assembly interfaces.
  123.         _KGetChar is the C interface.
  124.  
  125. debug.lib/KPutChar                                         debug.lib/KPutChar
  126.  
  127.    NAME
  128.         KPutChar -- put a character to the debugging console. (V37)
  129.  
  130.    SYNOPSIS
  131.         char = KPutChar(char)
  132.         D0              D0
  133.  
  134.         LONG KPutChar(LONG);
  135.  
  136.    FUNCTION
  137.         Puts a character to the debugging console (defaults to the serial
  138.         port at 9600 baud). This function will not return until the
  139.         character has been completely transmitted.
  140.  
  141.    INPUTS
  142.         char - a char to be outputted.
  143.  
  144.    RESULT
  145.         char - a character that was outputted.
  146.  
  147.    NOTES
  148.         @KPutChar, @kputc and KPutChar are identical assembly interfaces that
  149.         expect character in D0 register. _KPutChar, _kputc are the C
  150.         interfaces that expect a character to be a longword on stack.
  151.  
  152. debug.lib/KPutStr                                           debug.lib/KPutStr
  153.  
  154.    NAME
  155.         KPutStr -- put a string to the debugging console. (V37)
  156.  
  157.    SYNOPSIS
  158.         KPutStr(string)
  159.                 A0
  160.  
  161.         VOID KPutStr(STRPTR);
  162.  
  163.    FUNCTION
  164.         Puts a NULL-terminated string to debugging console (defaults to the
  165.         serial port at 9600 baud). This function will not return until the
  166.         string has been completely transmitted.
  167.  
  168.    INPUTS
  169.         string - a string to be outputted.
  170.  
  171.    NOTES
  172.         @KPutStr, @kputs and KPutStr are identical assembly interfaces that
  173.         expect a string pointer to be in A0 register. _KPutStr, _kputs are the
  174.         C interfaces that expect a string pointer to be a longword on stack.
  175.  
  176.    SEE ALSO
  177.         KPutChar(), KPrintf().
  178.  
  179. debug.lib/VKPrintf                                         debug.lib/VKPrintf
  180.  
  181.    NAME
  182.         VKPrintf -- print formatted data to the debugging console. (V37)
  183.  
  184.    SYNOPSIS
  185.         nextData = VKPrintf(format, data)
  186.         D0                  A0      A1
  187.  
  188.         APTR VKPrintf(STRPTR, APTR);
  189.  
  190.         nextData = KPrintf(buffer, format, ...)
  191.  
  192.         APTR KPrintf(STRPTR, STRPTR, ...);
  193.  
  194.    FUNCTION
  195.         Prints data formatted with C-like string to the debugging console
  196.         (defaults to the serial port at 9600 baud). The data is formatted
  197.         using ROM RawDoFmt() function.
  198.  
  199.    INPUTS
  200.         format - "C"-language-like NULL terminated format string.
  201.         data   - stream of data to be interpreted.
  202.  
  203.    RESULT
  204.         nextData - pointer to end of the data stream (the next argument that
  205.                    would have been processed).
  206.  
  207.    NOTES
  208.         @VKPrintf, @VKPrintF, KPutFmt, KPrintF are identical assembly
  209.         interfaces that want the two pointers in registers.
  210.         _VKPrintf, _VKPrintF, _vkprintf, _KPutFmt are C interfaces that want
  211.         the two string pointers on stack.
  212.         _KPrintf, _KPrintF, _kprintf are C interfaces that expect the format
  213.         string pointer on the stack, and the parameters on the stack above
  214.         that.
  215.  
  216.    SEE ALSO
  217.         KDoFmt(), exec.library/RawDoFmt().
  218.  
  219.