home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / CPROG / ASMEDIT.ZIP / ASMED1.DOC next >
Text File  |  1989-04-24  |  8KB  |  169 lines

  1. ASMED (C) 1989 - The Integrated Assembly Language Editor
  2.  
  3.  
  4.  
  5. Thank you for trying ASMED. First, let me tell you what it does:
  6.  
  7. ASMED is a Programmer's Editor that is especially suited to Assembly
  8. Language. If you're using MASM or TASM or a similar assembler, you can
  9. edit your programs and assemble them right from the Editor. If errors
  10. are found during assembly, ASMED will flag them and the cursor will be
  11. positioned on the line(s) with the error(s). You can then use function
  12. keys to jump to the next/previous errors. This operates much like Turbo
  13. C for those of you who have used the integrated environment. The Editor
  14. itself operates exactly like the Borland Editors, all the same editing
  15. commands are supported (TPascal, TC, Prolog, ETC.)
  16.  
  17. BACKGROUND: The whole idea behind ASMED is to give you the same
  18. effectiveness the integrated compiler/editors give you. It is much
  19. easier and faster to write code and debug when the editor catches your
  20. errors and highlights them than to have to keep loading and unloading
  21. editors and assemblers. I wrote ASMED because I'm used to using the
  22. great Borland products with integrated environments, and when TASM came
  23. out, there was no editor to accompany it. Well, this and the fact that
  24. I couldn't afford a commercial editor that does the same thing. ASMED
  25. is especially useful to people learning to program in assembly (who
  26. isn't, right?) because you can view your error messages on-screen while
  27. editing. ASMED is a simple program by nature, it is not fancy, and there
  28. is not alot of error checking performed. It does work nicely though.
  29. You might say it's in a beta test state right now...........I wanted
  30. to make it as small as possible to free up memory when assembling. It
  31. uses only about 45k so you should be able to assemble very large
  32. programs. Also included is an ASCII and Key Scan Code chart for
  33. reference. You should find ASMED useful until Borland comes out with a
  34. full-blown integrated environment for their assembler products. If not,
  35. I'll keep updating ASMED.
  36.  
  37.  
  38. USER POLICY: Basically, there is no user policy, if you find ASMED
  39. useful, use it! You do not have to send in any money (but if you want
  40. to, go ahead.) I would ask that you send me your comments though. If
  41. there's any sort of response I will implement the changes you desire.
  42.  
  43.  
  44. OPERATING INSTRUCTIONS: Since most people with access to this file
  45. already know how the Borland Turbo xxxxx editors work, I won't bother
  46. to explain the editing commands, they're all there though. In addition
  47. to the edit commands, there are 8 functions (F1-F8) that can be used.
  48. These are reflected in the top and bottom status lines of the editor
  49. window. 
  50.  
  51. F1 - HELP (N/A AT THIS TIME, SORRY)
  52. F2 - SAVE CURRENT FILE
  53. F3 - LOAD A NEW FILE
  54. F4 - DOS SHELL (TO LINK, RUN ???)
  55. F5 - NEXT ERROR - JUMP TO NEXT ERROR AND HIGHLIGHT WITH MESSAGE
  56. F6 - PREVIOUS ERROR - SAME AS ABOVE WITH PREVIOUS ERRORS
  57. F7 - CHARTS - VIEW ASCII CODES AND KEY SCAN VALUES IN WINDOW
  58. F8 - ASSEMBLE - THIS WILL CALL YOUR ASSEMBLER AND ASSEMBLE YOUR CODE
  59.  
  60. Take note that you must have an assembler to assemble programs! This is
  61. not a language but a connection to an assembler product. 
  62.  
  63. INSTALLING ASMED: You should take a couple of steps to ensure that
  64. ASMED can find your assembler and linker. No, there isn't an
  65. extravagant install program, just a simple config file that contains
  66. the path names where your assembler files reside, and an error flag
  67. character used to catch errors. Explanation is this: ASMED reads the
  68. config file (if it exists) and uses the paths to run the assembler, if
  69. you have your "PATH= " set, or use any memres path programs, you won't
  70. even need to bother with this. The config file is as follows:
  71.  
  72. A plain ascii file, 5 lines long in this format - 
  73.  
  74. line 1 - assembler name (TASM, MASM, etc.)
  75. line 2 - linker name (LINK, TLINK, etc.)
  76. line 3 - error flag. This is the character(s) that the assembler
  77. produces when it finds an error. For TASM, it is the * character, for
  78. MASM, it is the ( character. You get this information by looking at the
  79. output the assembler produces when it finds an error. As an example,
  80. consider this TASM example session assembling the file "test.asm":
  81. ----------------------------------------------------------------------
  82. C:TASM>TASM TEST.ASM
  83.  
  84. Turbo Assembler  Version 1.0   (c) 1988 Borland International
  85.  
  86. Assembling file: \TASM\TEST.ASM
  87.  
  88. **Error** (31) open procedure xxxx
  89.  
  90. Error messages: 1
  91. Warning messages: None
  92. Remaining Memory: 475k
  93. -----------------------------------------------------------------------
  94. See the * characters surrounding the "Error" message? That is all ASMED
  95. needs to find the error messages and line numbers. Although the *'s
  96. occur in multiples of two, only one is needed by ASMED to distinguish
  97. an error. In MASM, the errors look more like: ERROR: (31) 127:xxxxx
  98. And the "(" character is enough. At any rate, you have up to 3
  99. characters you can use for this depending on your particular assembler.
  100. But make sure this character ONLY appears on lines with errors. If
  101. you're using TASM, just use the *.
  102.  
  103. line 4 - assembler path (\tasm, etc.)
  104. line 5 - linker path (\tasm\link, etc.)
  105. line 6 - ASMED path (\Editor, etc.)
  106.  
  107. When you put it all together, a config file might look like this:
  108.  
  109. \TASM
  110. \TASM
  111. *
  112. \ASSEMBLY
  113. \LINK
  114. \EDITOR
  115.  
  116. If you want to use the current directory, just use a blank line. This
  117. is probably a bit confusing, the sole purpose of the config file is to
  118. let ASMED know where to find your assembler files. If you have pathing
  119. setup (ie:PATH=C:\TASM;C:\EDITOR...), you don't have to worry about
  120. this. The config file must be named "ASMED.CNF" and can reside in any
  121. directory. You can use any ascii editor to change the file, even ASMED.
  122. Remember, if you botch up this file, ASMED won't be able to find the
  123. right files needed to work properly, but will still be a good editor.
  124. If you need help, leave me a message on CIS (72207, 247.)
  125.  
  126. Next, there are up to two (2) command line parameters you can send
  127. while starting ASMED. 1) filename, 2) subdir that the ASMED.CNF file is
  128. in. The reasoning behind this is simple, so you can run ASMED from
  129. anywhere on your hard drive and still load the config file, even if
  130. it's in yet another subdir. Say you have pathing set up so you can run
  131. ASMED from anywhere, well, the config file might not be in the
  132. directory you type "ASMED" from so you can specify a path. Example:
  133.  
  134. ASMED test /\bin
  135.  
  136. This will run ASMED, load the file TEST.ASM, and look for the config
  137. file in the \bin directory. The config parameter must start with a
  138. slash (/) and include the full pathname. You know you're doing it right
  139. when you get the little tree symbol (/\) The parameters can be in any
  140. order (filename path or path filename.) If you omit a filename, you
  141. will be prompted to enter a file to edit. If you omit the config path,
  142. ASMED will look in the default directory. If no config file exists,
  143. defaults for TASM go into effect.
  144.  
  145. Once you load the editor, everything is pretty cut-and-dried. Look at
  146. the top and bottom lines for function key instructions, everything else
  147. is just like the turbo editors, using the ctrl key command sequences
  148. (ie:ctrl-k-p to print a block.) <ESC> will exit the program.
  149.  
  150. NOTE: After you assemble, if there were errors, they will be
  151. highlighted along with the assembler error message, displayed on line
  152. two, and the cursor will be on the actual line of your code where the
  153. error took place. ALL messages are displayed on line 2 or line 24. If
  154. you can't figure out what's going on, check these lines! Also, if there
  155. is a problem when you try and assemble, look at line 24, if it says 
  156. "bad command or filename" then chances are your assembler was not
  157. found. 
  158.  
  159. I thinks that's it. If there's anyone out there that wants to learn
  160. assembly, there's no excuses not to now right?  
  161.  
  162. GOOD LUCK, JOE
  163.  
  164.  
  165.  
  166.                           CHICAGO SOFTWARE
  167.                           1805 BRUNETTI WAY
  168.                           SPARKS, NV 89431
  169.                           CIS 72207, 247