home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / dev / asm / fd2asminc / fd2asminc.doc < prev    next >
Encoding:
Text File  |  1993-09-02  |  6.3 KB  |  114 lines
  1.  
  2.    ›42m    ##     #   ###    ###                ###             ›0m
  3.    ›42m   #       #  #   #  #   #                #              ›0m
  4.    ›42m #####  ####      #  #   #  ###  ### ##   #  ####   ###  ›0m (version 1.0b)
  5.    ›42m   #   #   #   ###   ##### #     #  #  #  #  #   # #   # ›0m
  6.    ›42m   #   #   #  #      #   #  ###  #  #  #  #  #   # #     ›0m
  7.    ›42m   #   #   #  #      #   #     # #  #  #  #  #   # #   # ›0m
  8.    ›42m   #    ####  #####  #   # ####  #  #  # ### #   #  ###  ›0m
  9.  
  10. ›1mfdAsmInc›0m, a ›1mTropicDesign›0m product,  is used to convert .fd-files into assembler-
  11. includefiles; you need OS2.0!
  12.  
  13. ›42m-- Table of contents ----------------------------------------------------- 1 --›0m
  14.  
  15. Chapter 1....................Table of contents
  16.         2....................Copyright
  17.         3....................About the program
  18.         4....................Technical stuff
  19.         5....................Concluding words
  20.  
  21. ›42m-- Copyright ------------------------------------------------------------- 2 --›0m
  22.  
  23. This Freeware-program  and the sourcecode  are copyrighted  by the author Hanns
  24. Holger Rutz (that's me...),  this conditions have  to be followed to distribute
  25. it:
  26. - the copying-fee may not be higher than $3 (inclusive disk, exclusive postage
  27.   +packing).
  28. - the following files have to be kept together in one directory:
  29.     ›3m fd2AsmInc              ›0m(the executable)
  30.     ›3m fd2AsmInc.doc          ›0m(the English doc-file)
  31.   or›3m fd2AsmInc.dok          ›0m(the German doc-file)
  32.     ›3m fd2AsmInc.asm          ›0m(the assembler-source)
  33.   These files must be remain unmodified;  of course,  the filenotes,  the dates
  34.   and the protect-bits may be changed. What about copying the icons, too?
  35. ›4mOnly the user himself is responsible›0m for any damage  caused by one of the files
  36. listed above  (of course,  I'd like to see bugreports,  improvement-suggestions
  37. etc.!). The sourcecode is only for private use!
  38.  
  39. ›42m-- About the program ----------------------------------------------------- 3 --›0m
  40.  
  41. I had the idea of  this program when  I decrunched the OS2.0 assembler-includes
  42. - because there are  no includefiles for  the libraries since includeversion 36
  43. any longer. The _LVO-definitions are in the fucking link-libraries now. Because
  44. on the one hand I was unable to link these libraries with my object-code (BLink
  45. always gurued) and on  the other hand  I had no desire  to start a linker every
  46. time I assembled something (I'm using AsmOne), I created the assembler-includes
  47. from the .fd-files.  Afterwards I wrote this program,  so you don't have  to do
  48. this hard work  yourself.  It translates any .fd-files  into assembler-includes
  49. (using the standard _LVO-definitions). This is the usage:
  50. ›3m
  51. fd2AsmInc <from> [<to>] [comments] [spaces] [tabs <1-65535>] [dec] [hex]
  52.  
  53. <from>      ›0mName of the .fd-file (may contain wildcards);›3m
  54. <to>        ›0mName of the includefile to be created or the target directory;›3m
  55. <comments>  ›0mif you set  this switch,  all comments  found in the  .fd-file will
  56.             also appear in the include-file.›3m
  57. spaces      ›0mspaces are used to format the include-file.›3m
  58. tab <size>  ›0msame as›3m spaces›0m, only that tabulators of the size›3m <size> ›0mare used;›3m
  59. dec         ›0mthe function-offsets appear as decimal numbers;›3m
  60. hex         ›0mthe offsets appear as hexadecimal numbers;
  61.  
  62. If you don't  specify  a Targetname/-path,  the includefile  will be created in
  63. your current directory.
  64. If you neither select ›3m spaces ›0mnor›3m tabs ›0m (this is default),  the equals sign and
  65. the offset will be directly put next to each functionname  (no space).  If both
  66. switches are set,  the program prefers tabulators and a space is set after each
  67. equals sign. When formatting the file, ›1mfd2AsmInc›0m calculates the position of the
  68. equals sign in a manner  that they all appear  in the same column  and there is
  69. the smallest possible  space between  the longest functionname  and the  equals
  70. sign.
  71. While the program works,  the filenames are listet in two columns:  on the left
  72. there are the names of the .fd-files - on the right there are the includefiles.
  73. Two dots after a filename mean  that this file is currently worked with.  If an
  74. error accurs,  its description is printed next to the filename  (if there is an
  75. syntax error in  the .fd-file  the number of  the errorline is also displayed).
  76. The includefile is tried to be deleted, if it was already opened, and a message
  77. is printed (in case of success). If the parameter›3m from ›0mcontained wildcards, the
  78. program asks, if you want to continue with the converting process.  By the way,
  79. you can stop the program by pressing CTRL+C.
  80.  
  81. ›42m-- Technical stuff ------------------------------------------------------- 4 --›0m
  82.  
  83. Here's some background information for the guys who want to know everything:
  84. - ›1mfd2AsmInc›0m is programmed reentrant and PC-relative (with AsmOne v1.02);
  85. - the length of a functionname (incl.›3m _LVO›0m) may not be greater that›3m $ffff›0m;
  86. -›3m ##private, ##public, ##base ›0mand other›3m ##xxx ›0mare ignored;
  87. -›3m ##bias ›0mand›3m ##end ›0mare recognized, if they contain upper-case letters;
  88. - the program refuses to work properly on A600 machines :-)
  89. -›3m RETURN_FAIL ›0mis returned in case of an error,›3m RETURN_WARN ›0min case of›3m ***break›0m;
  90. - the program contains a versionstring;
  91. - the hexadecimal offsets appear in lower-case in the include-file;
  92. - ›1mTropicDesign›0m are Hanns Holger Rutz and Marco Brinkmann;
  93. - the continue-request checks, if you enter 'y' or 'Y';
  94. - tabulators are recognized (like spaces);
  95. - if the .fd-file contains no›3m ##bias›0m, an offset of›3m NULL ›0mis used;
  96. - .fd-files that don't contain an›3m ##end ›0mdon't cause an error;
  97. - if›3m from ›0mcontains wildcards and›3m to ›0mdoesn't exist, (as opposed to c:copy) no
  98.   target-directory is created;
  99. - you can suck the rest out of the sourcecode;
  100.  
  101. ›42m-- Concluding words ------------------------------------------------------ 5 --›0m
  102.  
  103. Well, that's it.  I don't know any features for the future - ok,  you could in-
  104. clude an›3m ALL›0m-Option  and a›3m FROM/M ›0m and create a target directory,  if›3m from ›0mcon-
  105. tains wildcards, but I think noone needs this (and I'm too lazy to include this
  106. in my sourcecode).  If you  have  bugreports,  improvement-suggestions  or what
  107. ever, write to:
  108.  
  109. ›1mTropicDesign›0m
  110. c/o Hanns Holger Rutz
  111. Auf dem Godenstedter Berg 17
  112. 27404 Zeven
  113. Germany
  114.