home *** CD-ROM | disk | FTP | other *** search
/ No Fragments Archive 4: The Falcon Archive / nf_archive_four_v1.0.iso / ARCHIVE / WORK / TOOLS / DSPDIT08.ZIP / DSPDIT.TXT < prev   
Text File  |  1995-12-26  |  17KB  |  512 lines
  1.  
  2.  
  3.               Watch your daughters, SCYNACORE prod. is back!
  4.  
  5.  
  6.                                  DSPdit
  7.  
  8.                         -THE devkit for the DSP-
  9.  
  10.  
  11.  
  12. # This software may not be sold or published on CDs, via PDL etc without 
  13. # written permission of the authors. QDSP-ASM is (c) by Gilles Audoly and 
  14. # DSPdit is (c) by Andreas John, Achim Settelmeier.
  15. # The authors must not be made responsible for anything!
  16. #
  17. # Read the manual carefully and don't misunderstand the jokes, ok?! ;-)
  18.  
  19.  
  20. ***** ß-Release *****
  21.  
  22.  
  23. => DSPdit is a fast DSP devkit for your ATARI Falcon030, consisting of an 
  24. => assembler and an editor. 
  25.  
  26.  
  27. ------------------------------------------------------------------------------
  28. Content:
  29.  
  30. 1.      General informations
  31.  1.1    Files needed
  32.  
  33.  
  34. 2.      Getting started
  35.  
  36.  
  37. 3.      The editor
  38.  3.1    Cursor movement
  39.  3.2    Special functions
  40.   3.2.1 PART
  41.   3.2.2 (Un-)Splitline
  42.   3.2.3 (Un-)rem line
  43.  3.3    Mouse
  44.  
  45.  
  46. 4.      The menu
  47.  4.1    About DSPdit
  48.  4.2    File
  49.  4.3    Assembler
  50.  4.4    Editor
  51.  4.5    Search
  52.  4.6    Block
  53.  4.7    Options
  54.  
  55. 5.     Various
  56.  5.1    Addresses
  57.  5.2    Thanks
  58. ------------------------------------------------------------------------------
  59.  
  60.  
  61. 1. General information
  62. ======================
  63.  
  64. This comfortable DSPd(evk)it/DSP(e)dit was written because we had none ;-)
  65. It  looks  very   much  like  TurboAss  because  TAss is our beloved Assembler
  66. (believe it or not, DSPdit is completely written with TurboAss).
  67. DSPdit  consists  of  two  parts, an assembler (coded by Gilles Audoly) and an
  68. editor  (done by TSCC).  As QDSP-ASM is originally done to process ASCII-Files
  69. (like  Motorola's assembler), it can be used for ASCII-Files as well but then,
  70. you don't have all those nice features of this devkit.
  71.  
  72.  
  73. DSPdit is PD. This means, that it is allowed to copy and spread the program as 
  74. long as you copy all the files listed in 1.1 (but of course it is allowed to
  75. copy QDSP-ASM separatly, read the DSP_ASM.DOC for more info)! 
  76. The files may not be altered!
  77.  
  78. We don't expect large donations for our work but at least you should say thanks, 
  79. if you like DSPdit :-)
  80.  
  81.  
  82.  
  83. 1.1 Files needed
  84. ================
  85.  
  86.     DSPDIT.PRG - the program (commandline accepted)
  87.     DSPDIT.TXT - this text
  88.     DSPDIT.SET - the settings (not really required; see 4.7 Options)
  89.  
  90.   QDSP_ASM.TTP - the assembler (can be used without DSPdit)
  91.    DSP_ASM.DOC - the manual for QDSP-ASM
  92.  
  93.  
  94.  
  95.  
  96. 2. Getting started
  97. ==================
  98.  
  99. To  install DSPdit, format your harddisk and copy DSPdit to the AUTO-folder of
  100. your  boot  partition so that is available everytime you boot up. Then install
  101. MutliTos  and  thousands of accessories to slow down your Falcon 'cause DSPdit
  102. is too fast for you ;-)
  103.  
  104.  
  105. Ok, now for the serious part:
  106.  
  107. Just  copy  the  whole  folder  to  any path on your harddisk you want and run
  108. DSPDIT.PRG.   You'll   get   a message saying, that no settings are available,
  109. meaning, the DSPDIT.SET-file is missing and and default settings will be used.
  110.  
  111. First,     you   should   locate   all  the applications you need. Use 'LOCATE
  112. APPLICATIONS' in the Options-menu to do so. Here, you select the path and name
  113. of  QDSP-ASM,  which  may be located in another folder as well as your beloved
  114. debugger and up to 4 'external' applications (you don't really need to use all
  115. four entries, ok?).
  116.  
  117. Now,  you  can  set  up  the  editor  if you want. Try 'Settings' (^S) in menu
  118. Options and see chapter 4.7 Options for further informations.
  119.  
  120. Don't forget to save your settings using 'Save Settings' in menu Options!
  121.  
  122.  
  123.  
  124.  
  125. 3. The editor
  126. =============
  127.  
  128. The  editor  was  especally  desinged to allow fast and comfortable editing of
  129. DSP-Sources. It features syntaxcheck (ok, still a bit buggy but it gets better
  130. ;-)), autoformat (meaning evertime, your HD is full, it is wiped out ;-)   Ha!
  131. Just   kidding,   it's   only   the  autoformatting  of  the  lines  entered),
  132. keyboardmacros (to allow fast linedelete everytime you hit return ;-)), direct
  133. support of the great QDSP-ASM and easy call of external programs.
  134.  
  135. Of  course,  such  simple functions like cursormovement and tabulator jump are
  136. included, too (for the guys, who need that).
  137.  
  138.  
  139.  
  140. 3.1 Cursor movement
  141. ===================
  142.  
  143. To control this little  box that inverts letters (some call it cursor) use the
  144. four  arrowkeys.  For special moves try control to jump wordwise left/right or
  145. pagewise  up/down  and  use  shift to jump to the begining/end of a line or to
  146. scroll  the  source and let the cursor stand, where it is. For finishing moves
  147. use  ClrHome  to  access the top line on the current page or Shift ClrHome for 
  148. the  top  line  of  the  source. Hitting ClrHome twice will jump to the bottom 
  149. line.  Tab  will  jump  to  the  next  and Shift-Tab will jump to the previous 
  150. tabulator.
  151.  
  152. Of  course,  there're  lotsa  hidden  special moves as well but as no mag will
  153. publish  them  in  the near future (they're too complex to find out), here's a
  154. list (a=alternate, s=shift, ^=control):
  155.  
  156.  
  157.          ^DEL - delete line
  158.        ^U - undelte line (same as undo but can be used several times)
  159.    (^) Insert - insert line
  160.        Return - delete source
  161.            ^Z - jump to last edited line
  162.            aZ - jump to line or label
  163.          Undo - Guess it! (Yes! It's harddisk quickformatting ;-))
  164.            ^L - search
  165.            aL - continue search
  166.        ^(1-9) - set bookmark 1-9
  167.        a(1-9) - jump to bookmark 1-9
  168.          HELP - fold part/macro (see 3.2 Special functions)
  169.         ^HELP - fold all following parts/macros (see 3.2 Special functions)
  170.       sRETURN - split line (see 3.2 Special functions)
  171.    sBACKSPACE - unsplit line (see 3.2 Special functions)
  172.       ^RETURN - rem line (see 3.2 ...)
  173.      s^RETURN - unrem line (yeah, I think, ya know where to find that)
  174.           ESC - call menu
  175.        ^W - changes valuebase or jumps to the label (see also 3.3 Mouse)
  176.        
  177.  
  178. 3.2 Special functions
  179. =====================
  180.  
  181.  3.2.1 PART
  182.  ----------
  183.  To  provide a better readability of the sources, it can be devided into parts
  184.  indicated  by  PART  and ENDPART. If you're inside a part and press HELP, the
  185.  part  is  folded  to one single line. To reopen it, press HELP once again.  A
  186.  closed part is indicated by >PART. You may even enter a string behind PART to
  187.  remember, what's inside it! Yeah, that's comfortable!
  188.  Press  ^HELP to open all FOLLOWING parts. Of course, you may also fold macros
  189.  indicated by MACRO and ENDM.
  190.  
  191.  
  192.  3.2.2 (un-)split line
  193.  ---------------------
  194.  From  your  texteditor  you  know,  that  (s)RETURN  cuts  the  line  at  the
  195.  cursorposition  and  moves  the  rest into the next line. So far so good. but
  196.  does  cutting  move X0,A into pieces like mov ~ e X0,A make sense to you???
  197.  Well,  not  all  guys know it doesn't and that's why DSPdit only splits where
  198.  it's  possible!  You  may  split  the  line  between label and instruction or
  199.  between instruction and remark. To confuse you even more, we also allowed you
  200.  to  split  the  line  between parallelmoves! DSPdit then automatically adds a
  201.  move  to  the  next  line  where the former parallelmove stands! Of course we
  202.  included  the  other  way round, too. This means, you can make a parallelmove
  203.  out of a normal move (of course only, if it's allowed).
  204.  
  205.  
  206.  3.2.3 (un-)rem line
  207.  -------------------
  208.  By  pressing  ^RETURN, the current line can be quickly deactivated (a ;> will
  209.  be  added  to  the  beginning  of  the  line).  s^RETURN  removes  those  two
  210.  characters.
  211.  
  212.  
  213.  
  214. 3.3 Mouse
  215. =========
  216.  
  217. The mouse (or trackball) is usually used to control the good old mousecursor.
  218. But  how  can this help me developping a source, you ask? Well, a single click
  219. with  the  left  button  will  set  the  normal  cursor to this position. This
  220. provides  extremly  fast access for all three-hand-humanoids (two hands on the
  221. keyboard  and  one  hand on the mouse). A doubleclick on a Symbol will jump to
  222. the  line  in  which  this  symbol is defined. A doublclick on Label opens the
  223. search  box,  so by hitting return, you can search for the lines in which this
  224. label  is  used.  A  doubleclick on a Number will change it from Hex to Bin to
  225. Deci to Hex etc...   This function is also accessable via keyboard. Just press 
  226. ^W.
  227.  
  228. You  can  mark a block using the mouse by holding the button for a longer time 
  229. and move up'n'down.
  230.  
  231. For those of you, who think, GEM is great, we also included a nice menu, which
  232. can be accessed using the mouse (of course it's no GEM, because, WE don't like
  233. GEM).
  234.  
  235.  
  236. 4. Menu
  237. =======
  238.  
  239. The menu can be used by two methods: You can select a drop down menu using the
  240. mouse  and  then  click on the submenu. Or you may press ESC and scroll though
  241. the  menu  with  the  cursorkeys  or  numbers.  This  allows  you  to  have  a
  242. keyboardmacro that selects a menu that can't be reached with shortcuts.
  243.  
  244.  
  245. 4.1    About DSPdit
  246. ===================
  247.  
  248. Click  and  see  (much  better  than  plug'n play on PC ;-) - besides that: It
  249. really is the truth ;-)))
  250.  
  251.  
  252. 4.2 File
  253. ========
  254.  
  255. Just those standard save/load-functions...
  256. But to explain some in more detail:
  257.  
  258.  4.2.1 Save ASCII
  259.  ----------------
  260.  Saves the source just like it is shown on the screen (except, that all closed
  261.  PARTs are saved open.
  262.  If  a block is marked you are asked if you want to save just the block or the
  263.  whole source.
  264.  
  265.  4.2.2 Save ASM
  266.  --------------
  267.  Saves  the  source as ASCII-Text with all PARTs/ENDPARTs mutated to comments,
  268.  so  that  you  can use any assembler (e.g. the one from Motorola) to assemble
  269.  your (with DSPdit edited) sources...
  270.  
  271.  
  272.  
  273. 4.3 Assembler
  274. =============
  275.  
  276.  4.3.1 Assemble
  277.  --------------
  278.  Look  4.3.2  (silly, but it's a 'forward' declaration ;-)). This one does the
  279.  same, but without dialog.
  280.  
  281.  4.3.2 Assemble...
  282.  -----------------
  283.  The  output-filename  can  be  chosen  (with  paths  and  anything  that  the
  284.  MS-DOS-Filesystem  features,  which is not much). This name is saved with the
  285.  source, so don't think, you will always get 'NONAME.P56'.
  286.  You  can  also  decide,  if   you   want to select an output-file anytime you
  287.  assemble  your  source  or just use the fixed one (in our mind better than to
  288.  have an 'OUTPUT'-pseudoop).
  289.  And  you can suppress the wait-for-a-key-when-assembling-is-finished-function
  290.  if  you  want.  This  can be done because DSPdit automatically takes over all
  291.  errors from QDSP-ASM so there's no real need to see all the messages.
  292.  
  293.  And then it is possible to change the assemble-modes:
  294.         Outputfile is a P56-file,
  295.                       a LOD-file or,
  296.                       a LOD-file with a yell for the debugger afterwards
  297.                                  (only, if no syntax errors are left over!)
  298.  
  299.  Not to forget that it is possible to choose cancel.
  300.  
  301.  
  302.  
  303.  
  304. 4.4 Editor
  305. ==========
  306.  
  307.  4.4.1 Calculator
  308.  ----------------
  309.  Just to look like TAss ;-))
  310.  No,  it really calcs formulas! But no symbols allowed to calc with (in a deep
  311.  mood of being bored this will maybe change but it's hard to do).
  312.  Please remember that this calculator can not calc fractionals.
  313.  
  314.  
  315.  
  316. 4.5 Search
  317. ==========
  318.  The standard search/replace-functions (and even more ;-))
  319.  
  320.  
  321.  4.5.1 Replace
  322.  -------------
  323.  Ok,  you  surely  know, how replacling works, so we won't bore you with that.
  324.  But  this  replacefunction  can  do more than just replace explicit words! To
  325.  completely  confuse you, we included not one of those simple allquantors, no!
  326.  We have multiquantors, yeah!
  327.  
  328.  Ok, what the fuck is a multiquantor?
  329.  You  can  define  which letters can be used instead of the multiquantor. This
  330.  allows  you  to  replace  only what you really want to replace. Let's have an
  331.  example: Multiquantors are k and d, the string to search for is mo*e.
  332.  This will replace mode or smoke but not move!
  333.  
  334.  If  you  select exclude multiquantor, all letters except the ones you entered
  335.  will be used instead of the multiquantor.
  336.  
  337.  The multiquantor has no effect on the replacestring.
  338.  
  339.  
  340.  4.5.2 Jump to line
  341.  ------------------
  342.  Set  cursor  to  the line you entered, or jumps to the label you want to jump
  343.  to. Just that easy.
  344.  
  345.  
  346.  4.5.3 Next error
  347.  ----------------
  348.  Moves  cursor  to  the line with the next error.  The warnig is cleared after
  349.  the line is changed.
  350.  
  351.  
  352.  4.5.4 Underline errors
  353.  ----------------------
  354.  This flag forces DSPdit to underline the lines with errors in them. 
  355.  Errors are updated everytime you assemble the source.
  356.   
  357.  
  358. 4.6 Block
  359. =========
  360.  
  361. I  think,  this  doesn't  need  any  explainations, except perhaps, that  this
  362. blockfunctions  don't  work like cut'n insert via clipboard but always copy or
  363. move  the  currently  marked block (to be honest: I hate clipboards, you never
  364. know, what will be inserted).
  365.  
  366.  
  367.  
  368. 4.7 Options
  369. ===========
  370.  
  371.  4.7.1 Source Settings
  372.  ---------------------
  373.  
  374.  Click  on  Act.src  will  choose the actual source to be automatically loaded
  375.  after  entering DSPdit. Of course, this can be turned off (guess which button
  376.  to use ;-)).
  377.  There's  also  a  button  to allow saving the source packed (with a damn fast
  378.  lzwpack-routine  supplied by G. Audoly :-)). It should be on as packing takes
  379.  no time but safes some discspace.
  380.  
  381.  We  also  included  the possibility to save your source automatically after a 
  382.  while. It may be saved under the current source's name (Act.Src) or under the
  383.  name  of  a temporary file (SaveSrc). The temporary file can be choosen using 
  384.  Sel. This setting also affects minimum RAM mode savings.
  385.  
  386.  
  387.  The  changed settings  may be saved under  the actual  settingsname using the 
  388.  Save Set button.
  389.  
  390.  
  391.  4.7.2 Settings
  392.  --------------
  393.  
  394.  In this very big box you can choose your preferred settings. Some words about
  395.  them:
  396.  Show HEX: all hexvalues can be cut, expanded or cut bytewise.
  397.  Capitalizing  is  provide,  too, in order to increase the readability of your
  398.  source.
  399.  You  may  even choose if an immediate value or adress should be short or long
  400.  as default.
  401.  The  settings  will  be  saved  together  with  the source AND with the other
  402.  settings.  This  means,  you're  using  the default settings until you load a
  403.  source. Then you use the source' settings. Clever, ne?
  404.  
  405.  
  406.  4.7.3 Screen Save
  407.  -----------------
  408.  
  409.  Hmm, nothing special about this, I think...
  410.  
  411.  
  412.  4.7.4 Tabulators
  413.  ----------------
  414.  
  415.  No need to explain, or is it to simple for your brain?
  416.  
  417.  
  418.  4.7.5 Locate Applications
  419.  -------------------------
  420.  
  421.  This nice function helps you to recover all your lost applications ;-)
  422.  Naa,  it  just  provides  to  enter  path  and  name of your beloved programs
  423.  (including  QDSP-ASM),  which  can  be  called  by  a  single  click on start
  424.  application.  You  don't need to enter all for programs but at least QDSP-ASM
  425.  and a debugger (eg the one by Brainstorm) should be entered.
  426.  
  427.  
  428.  4.7.6 Memory
  429.  ------------
  430.  
  431.  You  may enter the maximum amount of free memory which may be used by DSPdit.
  432.  
  433.  
  434.  
  435.  
  436.  4.7.7 Minimum RAM Mode
  437.  ----------------------
  438.  
  439.  This  mode  forces  DSPdit  to  save the actual source, deallocate the memory
  440.  before calling an external program. Afterwards, the memory is allocated again
  441.  and the source loaded. This allows you to use nearly the full memory for your
  442.  external  application. The source may be saved under the actual source's name 
  443.  or under the name of a temporary file. See 4.7.1 Source settings for more. 
  444.  
  445.  
  446.  
  447.  4.7.8 Load/Save Settings
  448.  ------------------------
  449.  
  450.  After  you've  changed  your settings and located all applications you should
  451.  save them. Here's a list of what will be saved:
  452.  
  453.    -autoload file
  454.    -applications' names
  455.    -applications' command line
  456.    -tabulators
  457.    -autoloadflag
  458.    -packflag
  459.    -screensaver time
  460.    -autosave time and flags
  461.    -some other settings
  462.  
  463.  This will be saved together with the source:
  464.    -cursorposition
  465.    -time and date of last change
  466.    -time and date of creation
  467.    -block start and end
  468.    -insertmode
  469.    -bookmarks
  470.    -output filename
  471.    -assemblemode
  472.    -show hex setting
  473.    -capitalizing settings
  474.  
  475.  
  476.  
  477. 5. Various
  478. ==========
  479.  
  480.  5.1 Addresses
  481.  -------------
  482.  
  483.  For bugreports, suggestions, updates etc write to:
  484.   
  485.   Settelmeier Achim (SCY)         or      John Andreas (Dynacore)
  486.   Ruelzheimer Str. 39                     Schulzestraße 36
  487.   76756 Bellheim                          76771 Hoerdt
  488.   GERMANY                                 GERMANY    
  489.   Email: achim_settelmeier@ka2.maus.de    andreas_john@ka.maus.de
  490.     (due to the limits of the Mausnet no mails >16kBytes!!!)
  491.   
  492. Do NOT FORGET to include a DISK for an update as well as a STAMP and an 
  493. envelope for a quick reply. 
  494.   
  495.  
  496. Remember that PD-Soft just lives from feedback! WRITE US!!!
  497.  
  498.  
  499.  5.2 Thanks
  500.  ----------
  501.  
  502. We just want to say thanks to CRAC for fixing bugs and including many features.
  503. Thanks also go to Rebelsoft (Hi Björn&Michael!) for massiv betatesing and long 
  504. bugreports :-)
  505.  
  506.  
  507.  
  508.  
  509. ok, this should do.
  510.  
  511. bye
  512.  Andreas (Dynacore) and Achim (SCY)