home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 1 / FishNMoreVol1.bin / more / programming / arpprog / newdocs / newpro.arc / EscapeString < prev    next >
Text File  |  1988-02-22  |  2KB  |  133 lines
  1.  
  2.  
  3.  
  4.      EscapeString(33.4)      ARP Programmers Manual    EscapeString(33.4)
  5.  
  6.  
  7.  
  8.      NAME
  9.       EscapeString -- convert escape characters in string.
  10.  
  11.      SYNOPSIS
  12.       NewLength = EscapeString( "String" )
  13.           D0               A0
  14.  
  15.      FUNCTION
  16.       This function    scans the string, replacing all    escaped
  17.       characters with the correct byte value.  This    function uses
  18.       the byte stored in ArpBase.ESCChar to    detect the escape
  19.       values. This defaults    to the undocumented BCPL '*'
  20.       character, but the Set program provides users    with a method
  21.       for changing this default.
  22.  
  23.       This function    currently recognizes the following special
  24.       characters:
  25.           N   -    newline
  26.           T   -    horizontal tab
  27.           V   -    vertical tab
  28.           B   -    backspace
  29.           R   -    return
  30.           F   -    formfeed
  31.           E   -    escape (ascii 27 decimal)
  32.           Xnn -    character representd by    hex value nn.
  33.  
  34.       The above may    be either upper    or lower case.    If this
  35.       function finds an escaped character which is not one of the
  36.       above, it will return    the character value (i.e. '\A' will be
  37.       replaced by the single character 'A'.    The sequence '\\' is
  38.       replaced by the single character '\',    and so on.)
  39.  
  40.       For sending hexcodes,    the \x argument    may be followed    by
  41.       either one or    two hex    digits,    in either upper    or lower case.
  42.  
  43.      INPUTS
  44.       string -- pointer to a null terminated ASCII string.
  45.  
  46.      RESULT
  47.       NewCount -- The new length of    the string.
  48.  
  49.      ADDITIONAL    NOTES
  50.       For easy use in assembly language parsers, this function
  51.       will return with the A0 register unchanged.
  52.  
  53.      BUGS
  54.       This function    overwrites the original    string with the    new
  55.       string so if you wish    to retain a pristine copy of the
  56.       string, copy it first.
  57.  
  58.      SEE ALSO
  59.       GADS()
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 2/22/88)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      EscapeString(33.4)      ARP Programmers Manual    EscapeString(33.4)
  71.  
  72.  
  73.  
  74.      AUTHOR
  75.       SDB
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 2/22/88)
  130.  
  131.  
  132.  
  133.