home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / asm / getlvo105.lha / GetLVO.doc next >
Encoding:
Text File  |  1991-10-26  |  3.8 KB  |  120 lines
  1. /****** GetLVO.doc **********************************************************
  2. *
  3. *   NAME   
  4. *    GetLVO -- Obtain legible LVOs or *.i's from *_lib.fd files. (V1.05)
  5. *
  6. *   TEMPLATE
  7. *    LIB/A,PAT/A
  8. *
  9. *   SYNOPSIS
  10. *    GetLVO <libName> <funcName>
  11. *
  12. *   FUNCTION
  13. *    GetLVO first of all attempts to get a path to the *_lib.fd files
  14. *    contained in the environment variable 'GETLVO'. If this fails, it
  15. *       uses its default setting: 'FD:'.
  16. *    Next it scans the libName_lib.fd file and any matches to 'funcName'
  17. *    is sent to stdout in this format:
  18. *
  19. *            _LVOfuncName EQU -$XXXX ; (parms,...)(regs,...)
  20. *
  21. *    GetLVO might be useful as a quick reference to functions that you
  22. *    only vaguely remember or for creating *.i files ready to use with
  23. *    your assembler (use <GetLVO libName *> for a total list of funct-
  24. *    ions). 
  25. *
  26. *   INPUTS
  27. *    libName  - Name of library without the '.library' extension.
  28. *    funcName - Function or pattern to search for in libName_lib.fd.
  29. *
  30. *   RESULT
  31. *    If all goes well a list of matching functions is sent to stdout
  32. *    and the returncode is set to 0.
  33. *
  34. *    If execution is halted while reading or writing GetLVO returns 1.
  35. *
  36. *    If no matches are found the program returns 5.
  37. *
  38. *    If something else goes wrong, like "Couldn't open file" or "Not
  39. *    enough memory" GetLVO exits with returncode 10 and additional
  40. *    information may be obtained by using the Why command.
  41. *
  42. *   EXAMPLE
  43. *    1> GetLVO exec FreeMem
  44. *    _LVOFreeMem EQU -$00D2 ; (memoryBlock,byteSize)(a1,d0)
  45. *
  46. *    1> GetLVO intuition FakeFunc
  47. *    - No matches found -
  48. *
  49. *    1> GetLVO dos Write*
  50. *    _LVOWrite      EQU -$0030 ; (file,buffer,length)(d1/d2/d3)
  51. *    _LVOWriteChars EQU -$03AE ; (buf,buflen)(d1/d2)
  52. *
  53. *   NOTES
  54. *    Requires dos.library V37+.
  55. *
  56. *    No wildcard matching for the 'libName' entry [yet]. If you want
  57. *    to create *.i files for all of your *_lib.fd's, I suggest that
  58. *    you get hold of my 'Expand' program, which allows wildcards with
  59. *    any program that is run from shell.
  60. *
  61. *       GetLVO is fully re-entrant (PURE) and can be made resident under
  62. *       e.g. WShell or by using the AmigaDOS 2.0 Resident command.
  63. *
  64. *    GetLVO is copyright (C) 1991 SmallCode SoftWare (KAS), but is free-
  65. *    ly redistributable if the following conditions are met:
  66. *
  67. *        o  GetLVO is 'PostCardWare' - i.e., if you like this program
  68. *           and use it regularly, you are OBLIGED to send me a post-
  69. *           card. You'll find my address below.
  70. *
  71. *        o  This archive should ALWAYS be redistributed in its entire-
  72. *           ty and original format, holding the following files:
  73. *
  74. *                   GetLVO        - The executable itself 
  75. *                   GetLVO.doc    - What you are now reading
  76. *                   Env/GETLVO    - Sample ENV:GETLVO file
  77. *                   ZZEndPad.FOO  - Someone's still using XModem...
  78. *
  79. *        o  It should NEVER be included in ANY commercial packages
  80. *           without PRIOR written consent from the author.
  81. *
  82. *        o  No monetary gains may be made from the distibution of this
  83. *           archive.
  84. *
  85. *   BUGS
  86. *    Due to the action of dos.library's ReadArgs(), GetLVO fails in
  87. *    wildcard searching for single-char LVOs (e.g.: GetLVO asl ?) -
  88. *    however, this should be of no inconvenience in 'real life'.
  89. *
  90. *   SEE ALSO
  91. *
  92. *****************************************************************************
  93. *
  94. *   HISTORY
  95. *    V1.00 - Prototype.
  96. *    V1.01 - Skipped main() - now using _main() instead.
  97. *    V1.02 - Most routines now uses __regargs
  98. *    V1.03 - Now looks for path to *_lib.fd files in $GETLVO.
  99. *    V1.04 - Minor bugs fixed.
  100. *    V1.05 - First public release.
  101. *
  102. *   GREETINGS
  103. *    Sincere thanks go to:
  104. *
  105. *        Carolyn Scheppner (CATS), whose "LVO" inspired me to write
  106. *        this program.
  107. *
  108. *        Adam Sjoegren (FastJack), FidoNet @2:230/149, for รก-testing.
  109. *
  110. *   AUTHOR'S ADDRESS
  111. *    SmallCode SoftWare (KAS)
  112. *    Klaus Alexander Seistrup
  113. *    Islevdalvej 162/14
  114. *    DK-2610 Roedovre
  115. *    D E N M A R K
  116. *
  117. *    FidoNet @2:230/119.5
  118. *
  119. */
  120.