home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #31 / NN_1992_31.iso / spool / comp / lang / forth / 3714 < prev    next >
Encoding:
Text File  |  1992-12-31  |  11.9 KB  |  297 lines
  1. Newsgroups: comp.lang.forth
  2. Path: sparky!uunet!gatech!emory!sol.ctr.columbia.edu!venezia!penev
  3. From: penev@venezia (Penio Penev)
  4. Subject: Re: Documenting
  5. References: <C03sAB.MoB@starnine.com>
  6. Sender: nobody@ctr.columbia.edu
  7. Organization: Rockefeller University
  8. Date: Thu, 31 Dec 1992 11:23:48 GMT
  9. X-Newsreader: TIN [version 1.1 PL6]
  10. Message-ID: <1992Dec31.112348.12448@sol.ctr.columbia.edu>
  11. Reply-To: penev@venezia.rockefeller.edu
  12. X-Posted-From: venezia.rockefeller.edu
  13. NNTP-Posting-Host: sol.ctr.columbia.edu
  14. Lines: 281
  15.  
  16. Mike Haas (mikeh@starnine.com) wrote:
  17. : In article <4195.UUL1.3#5129@willett.pgh.pa.us> ForthNet@willett.pgh.pa.us (ForthNet articles from GEnie) writes:
  18. : >Category 3,  Topic 3
  19. : >Message 8         Mon Dec 28, 1992
  20. : >ELLIOTT.C                    at 12:26 EST
  21. : > 
  22. : > ----via CRS Premium Bulletin Board -
  23. : >  USR Dual Standard 16.8K  (416) 629-7000
  24. : >
  25. : > Date: 12-19-92 (13:38)
  26. : >   To: ALL
  27. : > From: MARK VANDITTA
  28. : > Subj: FORTH CODING STYLE
  29. : >
  30. : > Is it my imagination, or do most Forth programmers lack formal
  31. : > instruction in structured coding?  I have found that most Forth
  32. : > programmers write code that is even more unlegible than that of C
  33. : > programmers raised on DEC Writers.  Why do Forth programmers
  34. : > insist on packing so many words on a single line at the sacrifice
  35. : > of clarity?
  36. : 
  37. : > Here's an example from
  38. : > Frank Sargent's Pygmy:
  39. : >
  40. : > CODE 0branch HERE T0BR !
  41. : >  AX LODS, DI BX CMP, 0=, IF, AX SI MOV, THEN, BX POP,
  42. : >  NXT,   END-CODE
  43. : >
  44. : > Now I really like what Frank has done with Pygmy, but his coding
  45. : > style leaves a lot to be desired.  I had to reformat his code to
  46. : > be able to follow its structure.
  47. : >
  48. : > CODE 0branch
  49. : >     HERE T0BR !
  50. : >     AX LODS,
  51. : >     DI BX CMP,
  52. : >     0=, IF,
  53. : >         AX SI MOV,
  54. : >     THEN,
  55. : >     BX POP,
  56. : >     NXT,
  57. : > END-CODE
  58. : >
  59. : > Granted, I used 10 lines instead of 3, but it is now clear to me
  60.  
  61. The same could de _indented_ this way:
  62.  
  63. CODE 0branch    HERE T0BR !
  64.     AX LODS,   DI BX CMP,   0=, IF,  AX SI MOV,  THEN, 
  65.     BX POP,   NXT,   END-CODE
  66.  
  67. There is really no need to have the commas  after the ASSEMBLER words
  68. and NXT can be a macro, which does the END-CODE. With the definitions
  69.  
  70. BX CONSTANT TS ( Or TOS if You prefer it) 
  71. SI CONSTANT R
  72.  
  73. in the beginning, the word may look like 
  74.  
  75. CODE 0branch    HERE T0BR !   LODS   
  76.     DI TS CMP   0= IF  AX R MOV  THEN 
  77.     TS POP   NEXT
  78.  
  79. And still be on three lines. Of course I would write this as 
  80.  
  81. CODE 0branch    HERE T0BR !   LODS   DI TS CMP
  82.     0= IF  AX R MOV  THEN   TS POP   NEXT
  83.  
  84.  
  85. Conside the following code:
  86.  
  87.  1 : RP+   4 R R addi ;
  88.  2 : RP-   -4 R R addi ;
  89. ..
  90.  9 : SP+  4 S S addi ;     
  91. 10 : SP-  -4 S S addi ;
  92.  
  93.  0  ( Structures)                                      PSP 11/12/92
  94.  1 : ?CELL ( n - n ?)  0 ;
  95.  2 : ?RANGE ( n - n)   ?CELL ABORT" Out of range" ;
  96.  3 : OFFS ( s d)  OVER - ?RANGE  2/ 2/  SWAP 2- TW! ;
  97.  4 
  98.  5 : begin   HERE  -CODE ;
  99.  6 : if  ( n - a)  INST!  W, 0 W,  begin ;
  100.  7 : then ( a)  begin OFFS ;
  101.  8 : else   0 Z# if nop  SWAP then  -4 GAP ;
  102.  9 : until ( a)  if  SWAP OFFS ;
  103. 10 
  104. 11 : Drop1  S ) 1 lw  SP+ ;
  105. 12 : Drop1+   S ) 1 lw  SP++ ;
  106. 13 : 0check ( - a)  Drop1  TS Z# if  1 TS mov  -CODE ;
  107. 14 
  108. 15  
  109.  
  110.  0 \   Compiler directives                             PSP 11/12/92
  111.  1 : BEGIN ( - a)   begin ;   TARGET
  112.  2 : UNTIL ( a)  0check  SWAP OFFS ;   TARGET
  113.  3 : AGAIN ( a)  j nop ;  TARGET
  114.  4 : THEN ( a)  then ;  TARGET
  115.  5 : IF ( - a)  0check ;   TARGET
  116.  6 : WHILE ( a - a a)   [COMPILE] IF  SWAP ;   TARGET
  117.  7 : REPEAT ( a a)   [COMPILE] AGAIN  [COMPILE] THEN ;   TARGET
  118.  8 : ELSE ( a - a)  else nop ;   TARGET
  119.  9 
  120. 10 : FOR ( - a)  TS TR mov  RP-  Drop  TR dec
  121. 11     begin  4 R TR sw ; TARGET
  122. 12 : NEXT ( a)  nop TR Z= until  TR dec  RPOP ;  TARGET
  123. 13 : IFOR ( - a a)  TS T1 mov  0check  -1 T1 TR addi  RP-
  124. 14     begin  4 R TR sw ;  TARGET
  125. 15 : NEXTHEN ( a a)  [COMPILE] NEXT  [COMPILE] THEN ; TARGET 
  126.  
  127. This is code for R3000, which has branch delay slots, load delay slots
  128. and three register instructions. INST! and -CODE are for the optimiser.
  129.  
  130. Do You need vertical format?    No
  131. Do You need indentation?    No
  132. Do You need three lines?    Extremely unlikely
  133. Do You need two lines?        Rarely
  134. Do You need shadows?        Only here and there
  135.  
  136. : 
  137. : This is a side-effect of those ever-so-limiting 64 x 16 damn SCREENS!
  138. : 
  139. : In normal file-based environments (which all other languages are
  140. : standardized on), you don't have to worry about packing as much
  141. : into that tiny space as possible.
  142.  
  143. You don't have to wory about about packing as much info in the screen
  144. either. One screen can hold 5 to 12 words (subroutines). This is
  145. enormous amount of info. The equivalent amount in C is more, that You
  146. can fit even on today workstations' 17" screens. Consider the overhead
  147. in C:
  148.  
  149. procname(args) {
  150.     variables declaration;
  151.     body
  152. }  
  153. empty line
  154.  
  155. You have four lines per entry, which cary basically no information.
  156.  
  157. : 
  158. : In otherwords, with SCREENS, there is no way to create pretty,
  159. : indented, clear code.  You either have to spread it over
  160.  
  161. Look at _any_ 10 screens of FORTH, Inc.'s code and You can find 9 to
  162. be pretty, clear, UNindented code. 
  163.  
  164. : several screens (requiring constant flipping in an editor), or
  165. : pack the hell out of each line (to get it all visible in one place).
  166. .. or factor the words better.
  167.  
  168. : 
  169. : SCREENS only display 16 lines at a time.  More dark ages stuff which
  170. : continues to cripple Forth's image.
  171. : 
  172. : Personally, I'll probably never work with SCREENS again, as I don't
  173. : anticipate any more SBC projects.  That's fine with me, as Forth
  174.  
  175. I have worked on i486/MSDOS and R3000/UNIX and find it much more
  176. convinient to work with screens.
  177.  
  178. : really does interface well with modern OS's (even some that aren't
  179. : so modern), and I'm spoiled by working with standard text files
  180. : for about 7 years now.  I can't imagine ever preferring SCREENS...
  181.  
  182. There are things, that files are very unsuitable for. consider a
  183. sextet index of a Monte Carlo Simulation Program:
  184.  
  185.  
  186.        420 \ Polymers - Main                                   PSP 22/11/92
  187.        421 \   Polymers - local                                PSP  3/06/92
  188.        422 \   Polymers - contd.                               PSP 30/05/92
  189.        423 \ Energy discretization                             PSP  2/11/92
  190.        424 \ Parameters of the polymer simulation              PSP 28/05/92
  191.        425 \ Initial values of the parameters                  PSP  2/06/92
  192.        426 \ Interaction - structures                          PSP  9/05/92
  193.        427 \   Horizontal interaction                          PSP 28/05/92
  194.        428 \   Vertical interaction                            PSP 28/05/92
  195.        429 \   Location interactions                           PSP 15/04/92
  196.        430 \   2D-Array calcualtions                           PSP 21/05/92
  197.        431 \ T-dependent energies for the run                  PSP 29/05/92
  198.        432 \ Polymer latice                                    PSP 17/04/92
  199.        433 \   Neibours with cyclic boundary conditions        PSP 27/04/92
  200.        434 \ Calculate energy index                            PSP 29/05/92
  201.        435 \ Update sites                                      PSP 29/05/92
  202.        436 \ Dynamics                                          PSP  5/06/92
  203.        437 
  204.        438 \ Tabulate all energy differences                   PSP 29/05/92
  205.        439 \   Access energies and probabilities               PSP 29/05/92
  206.        440 \   Build energy and probability                    PSP 29/05/92
  207.        441 \   Horizontal connectivity                         PSP 26/04/92
  208.        442 \   Vertical connectivity                           PSP 26/04/92
  209.        443 \ 
  210.        444 \ Cluster statistics - structures                   PSP 27/04/92
  211.        445 \   Walk clusters                                   PSP 27/04/92
  212.        446 \   Collect cluster lengths                         PSP 22/05/92
  213.        447 \   Write cluster statistics to disk                PSP 22/05/92
  214.        448 \ Concentration of monomers                         PSP 25/04/92
  215.        449 
  216.        450 \ Stat variables                                    PSP 21/05/92
  217.        451 \   Definition of stat variables                    PSP 21/05/92
  218.        452 \   Statistics                                      PSP 21/05/92
  219.        453 \   Compute thermo-dynamic properties from stat     PSP 20/05/92
  220.        454 
  221.        455 
  222.        456 \ Swapper                                           PSP 17/05/92
  223.        457 \ Swapping interface                                PSP 17/05/92
  224.        458 \ Change Lattice side and reboot                    PSP 14/05/92
  225.        459 \ 96-bit data                                       PSP 22/05/92
  226.        460 \ Statistical words                                 PSP 30/05/92
  227.        461 \   Statistical words                               PSP 31/05/92
  228.        462 \ Data base management                              PSP 20/05/92
  229.        463 \ Additional operators                              PSP 21/05/92
  230.        464 \ Invalid fields                                    PSP 24/05/92
  231.        465 \ File of samples                                   PSP 21/05/92
  232.        466 \ Thermodynamic quantilies                          PSP  3/11/92
  233.        467 \ File of lengths                                   PSP 22/05/92
  234.        468 \ File Density of states                            PSP  8/11/92
  235.        469 \ Produce SAMPLES from TDQ                          PSP 20/05/92
  236.        470 \ Convert SAMPLES Old > New                         PSP  3/06/92
  237.        471 \ Locate L in the file                              PSP 21/05/92
  238.        472 \ Produce Thermo Dynamic quantities from samples    PSP 24/05/92
  239.        473 \ Avaraged statistics                               PSP  6/06/92
  240.        474 \ Cumulant computation from samples                 PSP  6/06/92
  241.        475 
  242.        476 
  243.        477 HEX \ Optimizing                                    PSP 23/04/92
  244.        478 \ Internal registers                                PSP  5/05/92
  245.        479 
  246.  
  247. Try to have this with files. And talk about documentation afterwards.
  248.  
  249. : and I don't care how cool a Forth SCREEN editor you have... there are
  250. : much better ones for text files.
  251. : 
  252.  
  253. This is not quite true. I've tried almost all of the editors on the PC
  254. (pe2, e3, kedit, edit, professional editor (IBM), WINWORD) and emacs on UNIX.
  255. None is better for editing programs that the screen editor I use. The
  256. reason is very simple. Even though the good editors have their
  257. languages, not is a flexible as FORTH is. They are pretty narrow too.
  258. On the contary one has the entire source of his editor in FORTH and
  259. implements whatever functions he considers usefull. And one ends up
  260. with a highly tuned to himself editor. 
  261.  
  262.  
  263. : I hope I never again have to wind my way trough something like...
  264. : 
  265. : 5 LOAD 8 LOAD 23 LOAD 100 110 THRU 56 LOAD 13 LOAD etc. etc. etc
  266. : 
  267.  
  268. You can write extremely cryptic code in FORTH, as well as in almost
  269. any languge. An usual load screen, though looks like:
  270.  
  271.  0 ( Electives)   DECIMAL
  272.  1 : <CREATE>   >IN 2@   SWAP 1024 * + ,  (CREATE) ;
  273.  2    ' <CREATE> 'CREATE !     4 CONSTANT B/H  ( 0 if no  LOCATE)
  274.  3 ( Aids) 12 LOAD  13 LOAD  14 LOAD 11 HELPS  10 LOAD  23 LOAD
  275.  4 ( Disk retries   33 LOAD     6 LOAD)  2 LOAD
  276.  5 ( 32-bit)  15 18 THRU   ( 21 23 THRU)  ( char)  19 LOAD
  277.  6 ( L.C. Editor) 20 LOAD  ( UNIX Date & Time) 34 35 THRU
  278.  7 ( Calendar)  31 LOAD   TODAY @ .DATE  ( Loops)  4 5 THRU
  279.  8 ( Time)  32 LOAD   .(  Time )  @TIME .TIME
  280.  9 : SYSTEM   11 DATED  ."  Time "  @TIME .TIME ;
  281. 10 : ONDISK   7 OFFSET @ -  HELPS ;     7 LOAD
  282. 11 ( Tasks)  24 25 THRU   \ Printer)  28 LOAD  ( Runner)  29 LOAD
  283. 12 ( Screen editor)  1 LOAD \TERM    222 LOAD
  284. 13 : HELP   SYSTEM ;    GILD
  285. 14 ( Terminal: ANSI)     ' ?CREATE 'CREATE !
  286. 15 \S   polyFORTH II Level 4      31 Jan 1992 
  287.  
  288.  
  289. FORTH is a extremely democratic language. You can write _whatever_ You
  290. want (and be responsible for this afterwards). I won't argue, that
  291. screens is better or worse than files for everybody. I'll argue, that
  292. it's beter for me.  And this is the beauty of FORTH - You can express
  293. Your abstractions in code. FORTH is neither high level, nor low level.
  294. It is of one particular level - _Your_ level.
  295.  
  296. -- Penio.
  297.