Archive-Date: Tue, 02 Aug 1994 06:17:52 CDT Sender: owner-litprog@SHSU.edu From: marcus@x4u2.desy.de (Marcus Speh) Subject: Literate Programming on the World Wide Web [Revised 1 July 1994] Date: 02 Aug 1994 09:58:05 GMT Message-ID: Reply-To: LitProg@SHSU.edu, marcus@x4u.desy.de To: LitProg@SHSU.EDU Archive-name: www/resources/literate-programming Last-modified: 1 July 1994 Posting-Frequency: monthly ----------------------------------------------------------------------------- * Literate Programming on the World Wide Web ----------------------------------------------------------------------------- FYI, there is a wealth of information on Literate Programming, the art of structured programming and documentation [like WEB-like systems with (La)TeX formatting] available on the World Wide Web [WWW], a distributed HyperText system, a network of documents connected by links which can be activated electronically. Examples for LitProg environments are WEB for Pascal (DEK), CWEB for C/C++ (Levy/Knuth), FWEB for C/C++/Fortran/ratfor/TeX (Krommes), various language independent tools...and many more. ----------------------------------------------------------------------------- * How to get to the Web ----------------------------------------------------------------------------- If you have a WWW browser up and running, try going to http://info.desy.de/general/users.html and look for "Literate Programming" in the panel which appears. The precise URL is http://info.desy.de/user/projects/LitProg.html If you have no clue what WWW is, you can go over the Internet with telnet info.cern.ch which brings you to the WWW Home Page at CERN. You are now using the simple line mode browser. To move around the Web, enter the numbers given after an item. To go to the Literate Programming documents, enter go http://info.desy.de/user/projects/LitProg.html This is what you should see now: ----------------------------------------------------------------------------- * What you will see here ----------------------------------------------------------------------------- Getting Start(l)ed[2] A first look into Literate Programming with WEB Virtual Course[3] Planned GNA[4] Internet course on Literate Programming Editing[5] GNU Emacs mode for WEB programming Tools[6] Common, freely available Literate Programming environments Examples[7] Literate Programming archives and selected examples Discussion[8] Discussion on LitProg takes place on a mailing list and a newsgroup Program Library[9] George D. Greenwade's Literate Programming Library at Niord.shsu.edu. Experimental service: Archive Search[10] FAQs[11] Lists of Frequently Asked Questions: General and FWEB Further Reading Nelson Beebe's Literate Programming bibliography at ftp.math.utah.edu in directory /pub/tex/bib[12](files litprog.*) HyperLitProg[13] Literate Programming using HyperText[14] Techniques OO-LitProg[15] Opinions and examples on Object-Oriented[16] Literate Programming [[Now you can continue climbing down the documentation tree by entering numbers 1-16 and follow your own interests]] ----------------------------------------------------------------------------- * More on Browsing the Web ----------------------------------------------------------------------------- A very nice way of "browsing" through WWW uses X-based tools like "tkWWW" or "NCSA Mosaic". For the latter, binaries for many platforms (ready for use) and sources are available via anonymous FTP from ftp.ncsa.uiuc.edu in directory Web/Mosaic-binaries. For vt100 terminals there is a much-used browser called "Lynx" which can be obtained by FTP from ftp2.cc.ukans.edu in the pub/lynx directory. Emacs users will like the "W3" browser, FTP to cs.indiana.edu:/pub/elisp/w3. There is a FTP repository for browser software at info.cern.ch (including a hypertext browser/editor for NeXTStep 3.0 and tkWWW). If you cannot go through TELNET, you can still retrieve WWW documents by e-mail: send Email to test-list@info.cern.ch with one or more lines of the form send [http-address] e.g. send http://info.desy.de/user/projects/LitProg.html at the bottom of the page you'll find all links of that document listed. Your mail system must have a mail gateway to internet mail. ----------------------------------------------------------------------------- * Contact for Further Information ----------------------------------------------------------------------------- Please feel free to contact me for questions, suggestions and further contributions, or just to tell me whether you found this information useful in any way. For questions related to WWW, consult the WWW-FAQ: available via anonymous FTP from rtfm.mit.edu in directory pub/usenet/news.answers/www/faq, or on WWW at URL http://siva.cshl.org/~boutell/www_faq.html Enjoy! Marcus Speh for GNA. ***************************************************************************** Copyright 1993-94 Globewide Network Academy, Inc. Distributed under the terms of the GNU Public License. Permission is granted to copy this document for free distribution so long as it remains intact and unmodified. See more on WWW at http://uu-gna.mit.edu:8001/uu-gna/index.html or get the GNA FAQ via anonymous FTP to rtfm.mit.edu as file pub/usenet/news.answers/globewide-network-academy-faq ------------------------------------------------------------------------- END -- ----------------------------------------------------------------------- Marcus Speh, DESY Theory Group, Notkestr. 85, D-22603 Hamburg, Germany Phone: +49-40 8998 3753, Fax: +49-40 8998 2777, Private: +49-40 4203206 Email: WWW: http://info.desy.de/www/marcus.html ================================================================================ Archive-Date: Tue, 02 Aug 1994 11:26:42 CDT Sender: owner-litprog@SHSU.edu From: ara@zurich.ai.mit.edu (Allan Adler) Reply-To: LitProg@SHSU.edu, ara@ZURICH.AI.MIT.EDU Subject: Re: FWEB problems Date: 2 Aug 94 11:35:39 Message-ID: To: LitProg@SHSU.EDU In article ara@zurich.ai.mit.edu (Allan Adler) writes: I placed two files in altdorf.ai.mit.edu:archive/adler/FISCHER for anonymous ftp. The files are named fischer.f and fischer.web. I would appreciate it if someone would look at the original fortran file fischer.f and the web I'm trying to write for it and tell me what I am doing wrong. The trouble all started when web began complaining about line numbers. I didn't put the line numbers in: they were in the code when I got it. Some people reported to me that the file fischer.f was the wrong one, being not the original fortran but the one generated automatically by ftangle. I have now replaced it by the original fortran file. Please try again. Allan Adler ara@altdorf.ai.mit.edu ================================================================================ Archive-Date: Tue, 02 Aug 1994 13:41:24 CDT Sender: owner-litprog@SHSU.edu From: theedge@rbg.informatik.th-darmstadt.de (Felix Gartner) Reply-To: LitProg@SHSU.edu, theedge@RBG.INFORMATIK.TH-DARMSTADT.DE Subject: A parsing bug in CWEAVE?! Date: 2 Aug 1994 18:08:56 GMT Message-ID: <31m23o$crq@rs18.hrz.th-darmstadt.de> To: LitProg@SHSU.EDU I've come across a situation where the CWEAVE parser doesn't seem to do the job correctly: ---------example follows: ---------------------------------------- @ Try this: @c #define string char* /* why doesn't this work? */ ----------end example---------------------------------------------- Has anybody else discovered this and is there are solution to the problem? Anyway TeX takes care of the problem but it's not nice that CWEAVE can't handle this on its own. Felix ================================================================================ Archive-Date: Wed, 03 Aug 1994 08:07:23 CDT Sender: owner-litprog@SHSU.edu From: nsysu11@cc (Werner Lemberg) Reply-To: LitProg@SHSU.edu, nsysu11@CC Subject: Re: A parsing bug in CWEAVE?! Message-ID: <1994Aug3.044709.21121@news.nsysu.edu.tw> Date: Wed, 3 Aug 1994 04:47:09 GMT To: LitProg@SHSU.EDU Felix Gartner (theedge@rbg.informatik.th-darmstadt.de) wrote: : I've come across a situation where the CWEAVE parser doesn't seem to : do the job correctly: : ---------example follows: ---------------------------------------- : @ Try this: : @c : #define string char* /* why doesn't this work? */ : ----------end example---------------------------------------------- : Has anybody else discovered this and is there are solution to the : problem? The original CWEAVE don't handle #define statements properly. Try my patched CWEAVE in the c2cweb.zip bundle (at all CTAN hosts). Werner ================================================================================ Archive-Date: Wed, 03 Aug 1994 08:10:30 CDT Sender: owner-litprog@SHSU.edu Date: Wed, 3 Aug 94 13:11:38 +0200 From: kaufmann@analog.shraero.co.at (Roland Kaufmann SCHRACK AEROSPACE) Reply-To: LitProg@SHSU.edu, kaufmann@ANALOG.SHRAERO.CO.AT Message-ID: <9408031111.AA25697@analog.co.at.> To: LitProg@SHSU.edu Subject: Re: A parsing bug in CWEAVE?! Felix (theedge@rbg.informatik.th-darmstadt.de) found the parsing bug when cweaving @ Try this: @c #define string char* /* why doesn't this work? */ With CWEAVE 2.1 (yes, I know it's old ;-), the following workaround solves the problem: @ Try this: @d string @[char*@] /* It's ugly, but it works. */ but the more natural (? to a C programmer) variant @ Try this: @c #define string @[char*@] /* This is going to disappear from the listing! */ is even worse than the original: the entire code is lost from the listing (i.e. TeX file), although it is tangled fine. Has anyone tried a more recent version of CWEAVE? Roland Kaufmann kaufmann@shraero.co.at P.S. Is there a friendly soul out there to tell me the CTAN site closest to Vienna, Austria? ================================================================================ Archive-Date: Wed, 03 Aug 1994 08:17:29 CDT Sender: owner-litprog@SHSU.edu From: sboyle@shiloh.mentorg.com (Sean Boyle) Reply-To: LitProg@SHSU.edu, sboyle@SHILOH.MENTORG.COM Subject: ProTex example? Date: 2 Aug 94 12:30:05 Message-ID: To: LitProg@SHSU.EDU Does anyone use ProTex? I tried to convert a nuweb document to ProTex using what I could figure out from the examples (actually incomplete exercises from the book I believe) and got it to work until it hit a perl format. Specifically, I made a declaration \AlProTex{pl,<<<>>>,list,title} and when it got to a format with @>>> in it, the whole thing barfed. I tried changing the call (not understanding the format) to \AlProTex{pl,!>,list,title} figuring that it was looking for three character sequences to open and close a macro definition. This also barfed. If I had a clue as to what the various parameters meant... *sigh* I do have the book on order, but it shall probably be a couple of weeks in arriving. -- +------------------------+------------------------------+ | sean_boyle@mentorg.com | Mentor Graphics Corporation | | uunet!mntgfx!sboyle | 8005 S.W. Boeckman Road | | | Wilsonville, OR 97070-7777 | | "Intrinsically lazy, therefore creative" | +------------------------+------------------------------+ ================================================================================ Archive-Date: Wed, 03 Aug 1994 11:46:43 CDT Sender: owner-litprog@SHSU.edu Date: Wed, 3 Aug 94 12:47:26 EDT From: Lee Wittenberg Reply-To: LitProg@SHSU.edu, leew@PILOT.NJIN.NET To: LitProg@shsu.edu, theedge@rbg.informatik.th-darmstadt.de Subject: Re: A parsing bug in CWEAVE?! Message-ID: Felix Gartner writes: > I've come across a situation where the CWEAVE parser doesn't seem to > do the job correctly: > > ---------example follows: ---------------------------------------- > > @ Try this: > > @c > #define string char* /* why doesn't this work? */ > > ----------end example---------------------------------------------- > > Has anybody else discovered this and is there are solution to the > problem? Werner Lemberg and Roland Kaufmann have proposed solutions, but might I suggest a different tack? Try @c typedef char *string; #defines used in this situation can cause strange (and hard to find) problems. An added advantage is that CWEB will now recognize string as a type name, and typeset it like `int'. -- Lee ------------------------------------------------------------------------ Lee Wittenberg | Computer Science Department | It's much more difficult to live Kean College of New Jersey | decently than to die decently. Union, NJ 07083 | USA | | -- Erich Kuby leew@pilot.njin.net | "The Sitzkrieg of Private Stefan" (1962) ------------------------------------------------------------------------ ================================================================================ Archive-Date: Wed, 03 Aug 1994 15:17:47 CDT Sender: owner-litprog@SHSU.edu From: trashy@icicle.winternet.com (Barry Schwartz) Reply-To: LitProg@SHSU.edu, trashy@ICICLE.WINTERNET.COM Subject: Re: A parsing bug in CWEAVE?! Date: 3 Aug 1994 19:20:52 GMT Message-ID: <31oqmk$42g@blackice.winternet.com> To: LitProg@SHSU.EDU In article <31m23o$crq@rs18.hrz.th-darmstadt.de> theedge@rbg.informatik.th-darmstadt.de (Felix Gartner) writes: ]I've come across a situation where the CWEAVE parser doesn't seem to ]do the job correctly: ] ]---------example follows: ---------------------------------------- ] ]@ Try this: ] ]@c ]#define string char* /* why doesn't this work? */ ] ]----------end example---------------------------------------------- You don't say what the problem is. The real solution is to use a typedef rather than a macro. If you can't use a typedef, then you are probably doing something you shouldn't be doing. But if you just want to know how to get the correct formatting, try adding @f string int before the @c. -- Barry Schwartz at MedGraphics trashy@winternet.com ================================================================================ Archive-Date: Wed, 03 Aug 1994 15:18:16 CDT Sender: owner-litprog@SHSU.edu From: trashy@icicle.winternet.com (Barry Schwartz) Reply-To: LitProg@SHSU.edu, trashy@ICICLE.WINTERNET.COM Subject: REQUEST: experiences with eplain and cwebmac Date: 3 Aug 1994 19:25:38 GMT Message-ID: <31oqvi$42q@blackice.winternet.com> To: LitProg@SHSU.EDU I have started playing with using the eplain format along with cweave and the cwebmac macros. I am using a dumped eplain format, so that I can easily load the eplain macros before cwebmac is loaded. Has anybody discovered any conflicts between eplain and cwebmac, and could you please post any to this newsgroup? Also, if someone is pretty sure there are no conflicts, that would be useful information. -- Barry Schwartz at MedGraphics trashy@winternet.com ================================================================================ Archive-Date: Wed, 03 Aug 1994 16:16:36 CDT Sender: owner-litprog@SHSU.edu From: timcheng@aol.com (TimCheng) Reply-To: LitProg@SHSU.edu, timcheng@AOL.COM Subject: CASE tool for Reverse Engineering C programs written for DOS Date: 3 Aug 1994 16:56:13 -0400 Message-ID: <31p09d$ff5@search01.news.aol.com> To: LitProg@SHSU.EDU Hi! The company I work for is considering resurrecting a two year-old DOS/ C project and "make it work" again. That project took four software engineers three years to reach 80% completion. And only one of those four is still with the company. I was tasked to look into CASE tools (on DOS/Windows/OS2) which could provide some reverse engineering capability. We want to look at what was done years ago and re-evaluate the effort involved in this software archeology. Basically, C----->[Black Case BOX]--->{Data Flow Diagrams, Calling Trees, Dependency Trees, Metrics, etc.} So ... does anyone out there know of any? Even if the tool exists on some Unix machine ... we can deal with that. THANK! tim ================================================================================ Archive-Date: Thu, 04 Aug 1994 13:24:00 CDT Sender: owner-litprog@SHSU.edu From: maavl@cwi.nl (Marc van Leeuwen) Reply-To: LitProg@SHSU.edu, maavl@CWI.NL Subject: Re: A parsing bug in CWEAVE?! Message-ID: Date: Thu, 4 Aug 1994 13:53:05 GMT To: LitProg@SHSU.EDU In article <31m23o$crq@rs18.hrz.th-darmstadt.de>, Felix Gartner writes: |> I've come across a situation where the CWEAVE parser doesn't seem to |> do the job correctly: |> ---------example follows: ---------------------------------------- |> @ Try this: |> @c |> #define string char* /* why doesn't this work? */ |> ----------end example---------------------------------------------- The syntax used by (Levy/Knuth) CWEB is so complicated that I would be very surprised if it worked at all reliably (i.e., leading to proper formatting) in strange situations. However, in this particular case it produces code that makes TeX choke, which should of course not happen. Schematically the problematic output looks like $ ... math stuff ... { ... $ \C{ comment } $ ... } ... $ The $'s were put around the comment since it should be processed in text mode, but the extra braces around it cause TeX to protest about this way of temporarily getting out of math mode. The extra braces are caused by rule 34, which attemts to put braces around a `*' to prevent it from becoming a binary opertor. However rule 0 has already stuck the comment onto the `*', so the braces go around it as well. One cannot change the definition of \C using \hbox so that it will survive in math mode, since comments must be allowed to break across lines. So I would say that rule 34 (in combination with the general rule 0) is fundamentally flawed, as are other rules that stick in braces. Here is another problematic case (by rule 18) @c * p = * /* why would one want to put a comment here? */ q; By the way, if your example had been with `@d' instead of `#define', it would even fail without the trailing comment, since there is insert-like stuff after a `@d' definition. |> Has anybody else discovered this and is there are solution to the |> problem? I'd say the only way is to avoid using braces that are not immediately matched (without intervening scraps) in the RHS of rules altogether. I have done this in my version of CWEB that is available from the LPA. Marc van Leeuwen CWI Amsterdam ================================================================================ Archive-Date: Fri, 05 Aug 1994 17:57:28 CDT Sender: owner-litprog@SHSU.edu From: bart@cs.tamu.edu (Bart Childs) Reply-To: LitProg@SHSU.edu, bart@CS.TAMU.EDU Subject: Re: FWEB p Debugging WEBs is not that painful Debugging WEBs is not that painful Date: 5 Aug 1994 20:18:20 GMT Message-ID: <31u6qd$dc5@news.tamu.edu> To: LitProg@SHSU.EDU Allan Adler posted a message about debugging an FWEB he was creating from an existing Fortran program. The frustrations he had that caused the posting are similar to those many of us have when we do something that is a little out of the ordinary of our normal mode of operation. I thought I would post this note of how I debugged his problem. I don't think the process is in the FAQ and thought it might help others. Allan posted a second message before I read the first so it might help to know that when I saw it, he had stored both the WEB and the original Fortran. The steps I took were: 1) I ftp's the files fischer.web and fischer.F (I named it with the uppercase extension because my ftangle would create fischer.f. 2) I ftangle'd fischer.web and produced fischer.f. I did some comparisons of the files fischer.f and fischer.F in a split window in emacs to assure myself that they were somewhat equivalent. 3) I compiled fischer.f on the RS6000 I use and got the messages like his post implied. (Incidentally, I only looked deep enough to make sure of the first message because the others I figured would be similar.) That message was like: "fischer.f", line 247.1: 1516-034 (E) Statement label is previously defined in this scope. Label is ignored. and the offending line of code and some of them around it are: *line 49 "fischer.web" C* :1 * C* 22: * *line 221 "fischer.web" C* 23: * *line 226 "fischer.web" 13 PRINT=.FALSE. !!!!!!!!!!!This is the one.!!!!!!!!!!!!!! SCFTOL=1.D-8 NSCF=12 IC=2+(NWF+1-IB)/4 TRACE=.FALSE. C* 24: * *line 240 "fischer.web" IF(IB.LE.NWF)THEN WRITE(0,'(/A)')' Default values for remaining parameters? (Y/N/H) &' READ(5,'(A)')ANS C* 25: * *line 253 "fischer.web" 4) Strings like `PRINT=.FALSE.' may not be so uncommon, but the line before shows `*line 226 ' and I quickly determined that line was in fischer.f twice. Then looking at the INDEX of section names, we see that the code in section 23 (Notice the `C* 23: *' comment above) was ``inserted'' into sections 1 and 22. Hints for that are in the 2nd and 3rd lines of the code excerpt copied. I also can see this information when using web-mode under emacs and issuing the `view-sections' command. It shows the list of numbers of sections that define code for these pseudo-code names and then where they are used. On unix systems, the following lines of commands (which could easily be a script) can be quite handy. I show them as applied to Allan's file: lanczos ~/fweb> grep -e'@>$' fischer.web | sort > fischer.scn.all lanczos ~/fweb> grep -e'@>$' fischer.web | sort -u > fischer.scn.uniq lanczos ~/fweb> diff fischer.scn.all fischer.scn.uniq And the diff step gave this output which is really what is needed. 31d30 < @ 72d70 < @ 83d80 < @
121d117 < @ Thus, Allan had four places where code was copied to two places. The third of these three repeats gives the first compiler error message. I frequently have repeated use of code in Fortran and C. In Fortran, I may have a main and several subprograms that have identical inclusion of COMMONs and similar needs for inclusion in C. A couple of years ago I taught a special topics course on literate programming. After a quick introduction, I gave an assignment of coding the wc.w (unix' word count) from scratch (and luckily none of the students knew where to find it). One student's version worked in spite of some fairly serious errors. (This was done using FWEB) and here is part of the INDEX.tex file that was generated. \Windexspace \:\\{buf\_ebnd}, \[12]. \:\\{buf\_end}, 13, 16. \:\\{buf\_size}, 12, 16. \:\\{buff\_size}, 12. \:\\{buffer}, \[12], 13, 16. \:\\{BUFSIZ}, 12. \:\\{bur\_end}, 16. Due to his errors on the keyboard, he had 3 spellings of buf_end and two of buf_size. Sure, he had some compiler warnings ..., but it worked! Incidentally, I was checking his index to see how many extra entries he had put there (the answer was none). The message is: a quick review of the index of variables (hopefully extra entries too) and index of section names show a lot about your code. Reviewing the latter (or the file fischer.scn.all above) and considering if the names are really appropriate can really help make codes `literate.' I hope this is helpful. Bart Childs ================================================================================ Archive-Date: Sat, 06 Aug 1994 06:08:18 CDT Sender: owner-litprog@SHSU.edu From: marcus@x4u2.desy.de (Marcus Speh) Reply-To: LitProg@SHSU.edu, marcus@X4U2.DESY.DE Subject: DEK Interview now on WWW Date: 06 Aug 1994 10:52:22 GMT Message-ID: To: LitProg@SHSU.EDU In the LitProg Virtual Library on the World-Wide Web at http://info.desy.de/user/projects/LitProg.html I have linked to an interview with DEK on CWEB and other stuff, conducted by Comp.Literacy Bookshops (with permission). Reach it from the "Getting Start(l)ed" page at http://info.desy.de/user/projects/LitProg/Start.html Enjoy, ms -- ----------------------------------------------------------------------- Marcus Speh, DESY Group -R-, Notkestr. 85, D-22603 Hamburg, Germany FRG Phone: +49-40 8998 3753, Fax: +49-40 8998 2777, Private: +49-40 4203206 Email: speh@desy.de, World-Wide Web http://info.desy.de/www/marcus.html ================================================================================ Archive-Date: Mon, 08 Aug 1994 23:23:37 CDT Sender: owner-litprog@SHSU.edu From: j_mcarthur@BIX.com (Jeffrey McArthur) Reply-To: LitProg@SHSU.edu, j_mcarthur@BIX.COM Subject: Literate Programming and Quick and dirty programs Date: Mon, 08 Aug 1994 23:33:56 Message-ID: <326vv1$3v6@news.delphi.com> To: LitProg@SHSU.EDU I just had an interresting experience. I have been working 12-16 hour days, 7 days a week for the last month. Two days ago I realized I needed a utility. It had to process several files and create a new file as input for another application. I was really under pressure. The program was not trivial, but it was also not a major undertaking. The problem I had was two fold. First I needed it as soon as possible. Every hour it took to write was another hour at work and less time to finish before the stuff shipped. I started work on Saturday at 8:30 AM. I had to have the program finished, and the rest of the project complete by 9:00 PM on Sunday so it could be picked up by a courier to be taken to the client. (The utility would not be shipped to the client, it would just be used to create the output.) Time was very tight. But there was also the problem that the logic required was a little convoluted. The final problem was I knew that this utility would be used many, many times in the future. So I threw convensional wisdom to the winds and decided to do it right the first time and write the utility using Literate Programming. This would mean I would write meaningful comments and documentation into a program written in very little time. To my suprise, it took no extra time. There was a lot less debugging than I expected. The code did not run the first time, but the it only took a tiny amount of debugging to get it to work. I admit that some of the documentation is rough. I need to make sure it typesets properly and run it through a spelling checker. But it proved to me that it takes no extra time to use Literate Programming. ---- Jeffrey M\kern-.05em\raise.5ex\hbox{\b c}\kern-.05emArthur a.k.a. Jeffrey McArthur email: j_mcarthur@bix.com phone: (301) 210-6655 fax: (301) 210-4999 home: (410) 290-6935 The opinions express are mine. They do not reflect the opinions of my employer. My access to the Internet is not paid for by my employer. ================================================================================ Archive-Date: Tue, 09 Aug 1994 08:04:20 CDT Sender: owner-litprog@SHSU.edu From: ohl@crunch.ikp.physik.th-darmstadt.de (Thorsten Ohl) Reply-To: LitProg@SHSU.edu, ohl@CRUNCH.IKP.PHYSIK.TH-DARMSTADT.DE Subject: Hyper DVI Date: 09 Aug 1994 11:37:28 GMT Message-ID: To: LitProg@SHSU.EDU Most of you will have seen Paul Ginsparg's announcement of xhdvi (in case you missed it, the URL is http://xxx.lanl.gov/hypertex/). xhdvi is a modified xdvi and interprets HTML tags which are inserted as \special{}s. That is, you can follow hypertext links with your mouse in a suitably instrumented dvi file. The relevant news for this newsgroup is that ftp://nqcd.lanl.gov/people/tanmoy/hypertex/hyperncwebmac.tex [*] is a modified cwebmac.tex which automagically instruments your woven CWEBs. For the _first_ time, I enjoy reading on screen more than reading a hardcopy! See for yourself. Cheers, -Thorsten [*] hypercwebmac.tex (w/o `n') is a CWEB 2.1 version. -- /// Thorsten Ohl, TH Darmstadt, Schlossgartenstr. 9, D-64289 Darmstadt, Germany //////////////// net: ohl@crunch.ikp.physik.th-darmstadt.de, ohl@gnu.ai.mit.edu /// voice: +49-6151-16-3116, secretary: +49-6151-16-2072, fax: +49-6151-16-2421 ================================================================================ Archive-Date: Wed, 10 Aug 1994 08:55:01 CDT Sender: owner-litprog@SHSU.edu Date: Wed, 10 Aug 1994 15:57:12 +0200 From: Thomas.Herter@mch.sni.de Reply-To: LitProg@SHSU.edu, Thomas.Herter@MCH.SNI.DE Message-ID: <199408101357.AA15996@pgtd0143.mch.sni.de> To: LitProg@SHSU.edu, ohl@CRUNCH.IKP.PHYSIK.TH-DARMSTADT.DE Subject: Re: Hyper DVI Content-Type: text Hallo Thorsten, thank you for the interesting pointer to the hyphertext DVI- and WEB-Tools. But please explain the details of your message: a) What is URL? b) What does it mean nnn://dir.dir.dir/dir ? Is the first part the ftp-address and the last part die directory at the ftp site? c) What is http in http://xxx.lang ...(etc)? Excuse me, but for some reason I am not familiar with the notation from your mail message. Thannnx in advance for the support, Thomas. ------------------------------------ Thomas Herter, SNI Muenchen (thomas.herter@mch.sni.de) tel +89 636 49973 ================================================================================ Archive-Date: Wed, 10 Aug 1994 12:01:19 CDT Sender: owner-litprog@SHSU.edu From: mxm1003@s24.msi.umn.edu (Ram V. Mohan) Reply-To: LitProg@SHSU.edu, mxm1003@S24.MSI.UMN.EDU Subject: help ! how to do dynamic memory allocation in fortran Message-ID: Keywords: help - dynamic memory allocation using fortran Date: Wed, 10 Aug 1994 16:40:33 GMT To: LitProg@SHSU.EDU I am trying to find out how to do dynamic memory allocations while using fortran. Right now, my array dimensions are becoming larger and i get either warnings regarding "not enough memory" or segmentation faults in my code for larger problems. Any suggestions to improve these situations are welcome. suggestions regarding how to effectively optimize fortran codes which involve large dimensions so that they can be effectively run on most machines are appreciated. Thanks and appreciate your help. ================================================================================ Archive-Date: Fri, 12 Aug 1994 10:07:22 CDT Sender: owner-litprog@SHSU.edu From: ara@zurich.ai.mit.edu (Allan Adler) Reply-To: LitProg@SHSU.edu, ara@ZURICH.AI.MIT.EDU Subject: more FWEB questions Date: 12 Aug 94 09:47:11 Message-ID: To: LitProg@SHSU.EDU I find that FWEB eliminates spaces in certain pieces of FORTRAN code when I print out the TeX file. For example, something like CALL ROUTINE becomes CALLROUTINE The same thing happens for declarations. I find that spaces are scrupulously preserved in WRITE statements, however. How do I get fweave to respect the spaces? A similar problem has to do with code that defines one piece of code as being a bunch of other pieces of code, each being a named module. I would expect to see each of the named modules on a separate line, but for some reason fweave runs them together without line breaks. You can see this in the first few sections of the file fischer.web which is still available at altdorf.ai.mit.edu in archive/adler/FISCHER. I haven't changed the file since I haven't yet figured out which of the duplicated pieces of code I ought to eliminate. Meanwhile, it still serves to exhibit these other problems. Allan Adler ara@altdorf.ai.mit.edu ================================================================================ Archive-Date: Fri, 12 Aug 1994 19:01:33 CDT Sender: owner-litprog@SHSU.edu From: ai729@FreeNet.Carleton.CA (Stephane Rainville) Reply-To: LitProg@SHSU.edu, ai729@FREENET.CARLETON.CA Subject: DLLs, C++, and Visual Basic Message-ID: Date: Fri, 12 Aug 1994 23:38:47 GMT To: LitProg@SHSU.EDU Hi, We want to write a DLL file in C++ to and call one of its subroutines in a Visual Basic programm. So far, we figure we've written a DLL in C++ that works (although we're not sure). Calling it from Visual Basic has proven more difficult. Basically (forgive the pun), we declare the DLL in the general procedure, as well as the sub we want. However, when we call the subroutine, Visual Basic doesn't seem to think it's defined. If someone out there could instruct as to what we should do to: 1- write up a DLL in Boreland C++ 2- call it up from Visual Basic please do so. Steph and Chuck ================================================================================ Archive-Date: Fri, 12 Aug 1994 23:14:16 CDT Sender: owner-litprog@SHSU.edu From: thompson@sun1.coe.ttu.edu Subject: comp.programming.literate FAQ Date: 13 Aug 1994 03:50:58 GMT Message-ID: Reply-To: LitProg@SHSU.edu, thompson@sun1.coe.ttu.edu To: LitProg@SHSU.EDU Archive-name: literate-programming-faq Last-modified: 1994/06/16 Version: 1.1.9 Welcome to the Literate Programming Frequently Asked Questions List ------------------------------------------------------------------- This version was created Thursday - June 16, 1994, and should considered stale after 90 days. Information contained in this document is the best available at preparation. The original file was dated October 15, 1993 (just for historical purposes). Disclaimer: "This FAQ is presented with no warranties or guarantees of ANY KIND including correctness or fitness for any particular purpose. The author of this document has attempted to verify correctness of the data contained herein; however, slip-ups can and do happen. If you use this data, you do so at your own risk." Copyright 1993, 1994 David B. Thompson. All rights reserved worldwide. Permission is granted to copy this document for free distribution so long as it remains intact and unmodified. For other arrangements, contact the author/maintainer via email: thompson@sun1.coe.ttu.edu. What's New? ----------- + Update to ProTeX entry. + Update FAQ availability. + Update noweb entry. = ====================================================================== * Introduction or "What's this all about?" ------------------------------------------ This document is for new and experienced users of literate programming tools. The purpose is to explain the concept of literate programming and to provide a resource for locating files of interest to literate programmers and those interested in literate programming. The Literate Programming (LitProg) Frequently Asked Questions (FAQ) list is maintained by Dave Thompson, who can be reached at: thompson@sun1.coe.ttu.edu * Preferred mailing address for FAQ related comments/questions. wqdbt@ttacs1.ttu.edu * Forwarded to my pc. Comment and constructive criticism is welcome. Direct flames to /dev/null (or > nul if you're a msdos user! ;-) If you find an error, please report it. I'm particularly interested in establishing the locations of generally available literate programming tools. If you are the author of such a tool and wish to have it included in this list, please send email. Please note this is a work-in-progress. It is *not* complete, and probably will not be complete for some months. Nevertheless, the information contained herein may be useful to some. Use it as it is intended. - ---------------------------------------------------------------------- - Typography ------------ Major sections of the FAQ are divided by double lines (====). Minor sections and other divisions are separated by single lines (----). Major topics use a "* " as a leader. Minor topics use a "- " as a leader. This should simplify searching for topics. = ====================================================================== Table of Contents: ------------------ * Introduction, or "What's this all about?" - Typography * How do I get the FAQ? - Literate Programming FAQ - FWEB FAQ * Is there a newsgroup? (The comp.programming.literate newsgroup) * What internet nodes are of interest to literate programmers? * What is literate programming? * How do I begin literate programming? * What literate programming tools are available and where are they? - APLWEB - AWEB - CLiP - CWEB - FunnelWeb - FWEB - IMPACT - lit2x - Literate Programmer's Workshop (LPW) - MapleWEB - MWEB (Schrod/Detig) - MWEB (Sewell) - noweb - nuweb - ProTeX - RWEB - SchemeWEB - Spidery WEB - WEB - WinWordWEB * Are there other tools I should know about? - C2LaTeX - c2cweb - c2man - cnoweb - FunnelWeb mode - noweb.el - nuweb.el - TIE - Web mode * What other resources are available? - World Wide Web - TeX Resources - Virtual Coursework * Are there any code examples? - Examples included with developer's tools - Cameron Smith's KR-CWEB - Stanford GraphBase * Bibliographies. * How to anonymously ftp. * Acknowledgements. * End notes. = ====================================================================== * How do I get the FAQ? ----------------------- - Literate Programming FAQ -------------------------- You have many ways to get a current copy of this FAQ. One is to use anonymous ftp (if you don't know how, see a later section in this FAQ) to connect to one of the Comprehensive TeX Arvchive Network (CTAN) sites or the Literate Programming Archive and retrieve a copy of the file. Open an ftp connection to one of the CTAN sites and retrieve the file: help/LitProg-FAQ (For more information on CTAN and the literate programming archive, see the section below entitled "Internet Nodes of Interest to Literate Programmers.") An alternative is to use the fileserver at Sam Houston State University (SHSU). Send a message to FILESERV@SHSU.EDU and include in your message: SENDME LITPROG.FAQ The file server will forward a copy of the file to you via email. - ---------------------------------------------------------------------- - FWEB FAQ ---------- Marcus Speh maintains the FWEB FAQ. The current version number is 1.29. It can be retrieved in the same way as this FAQ; either by anonymous ftp or through the SHSU file server. On the SHSU server, the file name is FAQ.FWEB. Invoke your ftp software, open a connection to NIORD.SHSU.EDU [192.92.115.8], attach to the directory FAQ, and transfer the file FAQ.FWEB. Alternatively, send a message to the file server, FILESERV@SHSU.EDU, and include the following text in a one line message: SENDME FAQ.FWEB The file server will send the current version of the file via email. The FWEB FAQ exists in various formats, including HyperText (see other resources below). In Europe, the complete distribution can also be obtained from ftp.desy.de [131.169.10.115] in directory /pub/faq/web/fweb/. It is also available from the literate programming archive (LPA) in the directory LPA/Documentation/faq/fweb (see the references to LPA below for more information). Also, Marcus Speh is looking for someone willing to take over the FWEB FAQ. The text of his email message follows... "Please add to the FWEB FAQ the note that I am looking for someone to take the maintenance of the FAQ over - I am ready to assist in any way whatsoever, including tons of mail, notes for v1.29->v1.30, Texinfo sources, a WWW server and Hypertextification etc." If you're interested, send mail to marcus@x4u2.desy.de and express your willingness to serve. = ====================================================================== * Is there a newsgroup? ----------------------- One of the most important resources is the literate programming newsgroup, comp.programming.literate. You can read this newsgroup using your standard reader. Altenatively, the newsgroup is gated to a mailing list hosted by George Greenwade and Sam Houston State University. You can subscribe by sending mail to the list-server, LISTSERV@SHSU.EDU, and include in the message one line of text: SUBSCRIBE LITPROG "your name in quotes" The list is unmoderated; messages sent to litprog@shsu.edu are automatically distributed to all subscribers and cross-posted to comp.programming.literate. Archives of the mailing list and newsgroup are maintained on niord.shsu.edu [192.92.115.8] in the directory litprog. = ====================================================================== * What internet nodes are of interest to literate programmers? -------------------------------------------------------------- The principal nodes of interest to literate programmers are the Literate Programming Archive (LPA hereafter) and the CTAN (Comprehensive TeX Archive Network). The Literate Programming Archive (LPA) is: Node: ftp.th-darmstadt.de [130.83.55.75] Directory: programming/literate-programming Notes: Fastest response during off-U.S. [yep] business hours. The CTAN sites are: ftp host IP CTAN root Institution and Sponsor ------------------------------------------------------------------------- ftp.tex.ac.uk 134.151.79.32 pub/archive Aston Univ./UK TeX U.G. ftp.dante.de 129.206.100.192 soft/tex DANTE e.V. ftp.shsu.edu 192.92.115.10 tex-archive Sam Houston State Univ. Other nodes and directories of interest include: Node: niord.shsu.edu [192.92.115.8] Directory: various (do some snooping!) Notes: Has a gopher server. Node: ftp.desy.de [131.169.10.115] Directory: pub/web. Various documents, samples, and the FWEB FAQ. Notes: Has a www server, http://info.desy.de:80/ = ====================================================================== * What is Literate Programming? ------------------------------- Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings. In fact, literate programs should be enjoyable reading, even inviting! (Sorry Bob, I couldn't resist!) In general, literate programs combine source and documentation in a single file. Literate programming tools then parse the file to produce either readable documentation or compilable source. The WEB style of literate programming was created by D.E. Knuth during the development of his TeX typsetting software. All the original work revolves around a particular literate programming tool called WEB. Knuth says: The philosophy behind WEB is that an experienced system programmer, who wants to provide the best possible documentation of his or her software products, needs two things simultaneously: a language like TeX for formatting, and a language like C for programming. Neither type of language can provide the best documentation by itself; but when both are appropriately combined, we obtain a system that is much more useful than either language separately. The structure of a software program may be thought of as a web that is made up of many interconnected pieces. To document such a program we want to explain each individual part of the web and how it relates to its neighbours. The typographic tools provided by TeX give us an opportunity to explain the local structure of each part by making that structure visible, and the programming tools provided by languages such as C or Fortran make it possible for us to specify the algorithms formally and unambigously. By combining the two, we can develop a style of programming that maximizes our ability to perceive the structure of a complex piece of software, and at the same time the documented programs can be mechanically translated into a working software system that matches the documentation. Another author (Eric W. van Ammers) wrote me a short article treating his opinions on literate programming. The text follows: First observation on LP About 90% of the disussion on this list is about problems with applying some WEB-family member to a particular programming language or a special documentation situation. This is ridiculous, I think. Let me explain shortly why... Lemma 1: I have proposed for many years that programming has nothing to do with programming langauges, i.e. a good programmer makes good programs in any language (given some time to learn the syntax) and a bad programmer will never make a good program, no matter the language he uses (today many people share this view, fortunately). Lemma 2: Literate Programming has (in a certain way not yet completely understood) to do with essential aspects of programming. Conclusion 1: A LP-tool should be independent of programming language. Lemma 3: It seems likely that the so called BOOK FORMAT PARADIGM [ref. 1] plays an important role in making literate programs work. Lemma 4: There are very many documentation systems currently being used to produce documents in the BOOK FORMAT. Conclusion 2: A LP-tool should be independent of the documentation system that the program author whishes to use. My remark some time ago that we should discuss the generic properties of an LP-tool was based on the above observation. References: [1] Paul W. Oman and Curtus Cook. Typographical style is more than cosmetic. CACM 33, 5, 506-520 (May 1990) Second observation on LP The idea of a literate program as a text book should be extendend even further. I would like to see a literate program as an (in)formal argument of the correctness of the program. Thus a literate program should be like a textbook on mathematicics. A mathematical textbook explains a theory in terms of lemma and theorems. But the proofs are never formal in the sense that they are obtaind by symbol manipulation of a proof checker. Rather the proofs are by so called "informal rigour", i.e. by very precise and unambiguous sentences in a natural language. Eric W. van Ammers Department of Computer Science Wageningen Agricultural University Dreijenplein 2 E-mail: ammers@rcl.wau.nl 6703 HB Wageningen voice: +31 (0)8370 83356/84154 The Netherlands fax: +31 (0)8370 84731 = ====================================================================== * How do I begin literate programming? -------------------------------------- A recommended book is D.E. Knuth's collection of articles (1992) "Literate Programming," Center for the Study of Language and Information, Stanford University, ISBN 0-937073-80-6 (pbk). This book gives insight into Knuth's thoughts as he developed the web system of literate programming (and TeX for typesetting). It does not document methods for literate programming. A recommended book is Wayne Sewell's (1989) "Weaving a Program: Literate Programming in WEB," Van Nostrand Reinhold, ISBN 0-442-31946-0 (pbk). This book focuses on using Knuth's web system. Some talk exists in the newsgroup/mailing list for a Usenet University course in literate programming. I'm sure discussion of this topic will be welcomed. If you are interested, please participate. = ====================================================================== * What literate programming tools are available and where are they? ------------------------------------------------------------------- A significant number of tools for literate programming are available. Most have been ported from their original systems, so support multiple computer platforms. If you are the developer of such a tool, and would like to make the software freely available, please send me email and I'll reply with a form (like those below) for you to fill in. (Or short-circuit the process and kludge a form from below. :-) - ---------------------------------------------------------------------- - APLWEB -------- Developer: Christoph von Basum Version: Unknown Hardware: MSDOS Languages: IBM APL2 and STSC APL Formatter: Plain TeX Availability: Anonymous ftp from: LPA:/apl watserv1.uwaterloo.ca:/languages/apl/aplweb Readme: Unknown Description: None available. Support: Unknown Note: The status of this particular package is unknown. - ---------------------------------------------------------------------- - AWEB ------ Developer: Unknown Version: Unknown Hardware: Unknown Languages: Ada Formatter: Unknown Availability: Anonymous ftp from: LPA:/ada/web Readme: Unknown Description: None available Support: Not supported. - ---------------------------------------------------------------------- - CLiP ------ Developer: E.W. van Ammers and M.R. Kramer Version: Unknown Hardware: Vax/VMS, Unix, and MS-DOS Languages: Any programming language. Formatter: Any formatter (TeX, LaTeX, Troff, Runoff, etc) or any wordprocessor including WYSIWYG systems (Word Perfect, Win Word, Ami Pro, Word, etc.) Availability: Anonymous ftp from: sun01.info.wau.nl:/CLIP/ms_dos MS-DOS version sun01.info.wau.nl:/CLIP/vax_vms VAX/VMS version CTAN:/web/clip LPA:/machines/ms-dos LPA:/machines/vax Readme: With bundle above Description: CLiP does not use explicite commands to perform the extraction process. Rather it recognizes pseudostatemens written as comments in the programming language in question. CLiP distinguishes pseudostatments from ordinary comments because the former comply with a a particular style. This style can be adjusted to suit virtually any programming language. The CLiP approach to LP makes the system extremely versatile. It is independent of programming language and text processing environment. We designed CLiP to be compatible with hypertext systems as well but we have not yet experimented with this form of documentation. Features: + CLiP imposes virtually no limitations on the text-processing system used to produce the documentation. If the text-processor supports these items you can + structure the documentation according to your own taste. + include drawings, pictures, tables etc. + disclose your documentatio my means of X-ref tables, Indexes, Table of contents, Table of tables, Table of figures, etc. + typeset the documented code. + Extracts any number of modules from a maximum of 64 source files. + No pretty-printing. Code from the source files is copied "as is" to the module. + Appearance of code segments in the documentation matches those of the modules to ease the identification of code segements. + Supports partially specified data types. + Comprehensive user manual (preliminary version) and technical description. - No automatic generation of a X-ref table for program identifiers. Support: Bugs, problems and assistance by e-mail: ammers@rcl.wau.nl - ---------------------------------------------------------------------- - CWEB ------ Developer: Silvio Levy and D.E. Knuth Version: 3.0 Hardware: Unix systems (dos and amiga ports available) Languages: C and C++ Formatter: Plain TeX and LaTeX. Availability: Anonymous ftp from: labrea.stanford.edu:/pub/cweb LPA:/c.c++ CTAN:/web/c_cpp/cweb DOS version in CTAN:/web/c_cpp/cwb30p8c DOS version in LPA:/machines/ms-dos Amiga version CTAN:/web/c_cpp/AmigaCWEB Mac port of CTANGLE in LPA:/machines/mac LaTeX support in LPA:/c.c++ Readme: Bundled with above Description: No description provided. Support: Bugs to levy@math.berkeley.edu Note: A fork of CWEB 3.x was developed by Marc van Leeuwen which implements several changes to CWEB. It is available for anonymous ftp from ftp.cwi.nl:pub/cweb. The principle changes are: - Scans include files for typedef definitions - Grammar and formatting rules are well separated, allowing for run-time selection of a rule set (via command line option) - New manual. - ---------------------------------------------------------------------- - FunnelWeb ----------- Developer: Ross N. Williams: ross@guest.adelaide.edu.au Version: Unknown Hardware: MSDOS, Mac, VMS, Sun. Other ports reported. Languages: No restrictions. Formatter: Plain TeX for printing. Otherwise, no restrictions. Availability: Anonymous ftp from: CTAN:/web/funnelweb LPA:/independent ftp.adelaide.edu.au:/pub/funnelweb Readme: With bundle above. Description: FunnelWeb is a production-quality literate-programming tool that emphasises simplicity and reliability. Everything about FunnelWeb, from the simplicity of its language to the comprehensive tutorial in the user's manual, has been designed to make this as simple, as practical, and as usable a tool as possible. Features: + Provides a simple macro preprocessor facility. + Can produce typeset documentation. + Runs on Sun, VMS VAX, Macintosh, PC, and others. + Portable C source code distributed under GNU licence. + Comprehensive user's manual including tutorial. + Programming-language independent. + Can generate multiple output files. + Allows complete control over the output text. + Regression test suite with over 200 tests. + Fully worked example (in /pub/funnelweb/examples). - Requires TeX to produce typeset documentation. - Typesets program code using TT font only. Support: No formal support available. Mailing list maintained with about 50 subscribers. Informal assistance available from mailing list. - ---------------------------------------------------------------------- - FWEB ------ Developer: John A. Krommes Version: 1.30a (1.40 for the experienced, patient, and brave) Hardware: Unix, VMS, and DOS platforms (anything with ANSI C) Languages: C, C++, Fortran-77, Fortran-90, Ratfor, TeX; also, a language-independent mode. Formatter: Plain TeX and LaTeX. Availability: Anonymous ftp from: ftp.pppl.gov:/pub/fweb CTAN:/web/fweb LPA:/fweb DOS version in LPA:/machines/ms-dos Readme: In bundle with above. Description: It also has a well-developed user's manual and its own FAQ (see above). Beginning with 1.40, documentation is maintained in gnu texinfo format. It runs on most platforms: VMS, PC, UNIX, and pretty much anything that the GNU C compiler (GCC) is supported for. Features: + Processes multiple languages during a single run (so one can mix C and Fortran, for example). + Language-independent mode (v1.40). + Ability to turn off pretty-printing (v1.40). + Built-in Ratfor translator. + Built-in macro preprocessor (closely follows ANSI C, with extensions). + A style file that allows the user to adjust many parameters and behavior patterns of FWEB. + Various operator-overloading features that provide additional pretty-printing capabilities to languages such as C++ and Fortran-90. + Numerous miscellaneous features and command-line options. Support: Bug reports and suggestions to krommes@princeton.edu - ---------------------------------------------------------------------- - IMPACT -------- Developer: Timothy Larkin, from Levy/Knuth CWEB 3.1 Version: 1.0 Hardware: Macintosh; requires AppleEvents. Languages: C, C++ Formatter: TeX Availability: CTAN archives Readme: A short readme file is included in the SEA archive. Description: IMPACT implements CTangle from the Levy/Knuth CWEB 3.1. It operates as a foreground program, tangling files selected from the Mac File Picker. Or it can operate in the background, tangling files in response to odoc events sent by other applications, such as editors. Support: I welcome any reports of bugs. The product will be updated as new versions of the CWEB appear. Other features may be added as users suggest them. - ---------------------------------------------------------------------- - lit2x ------- Developer: Unknown Version: Unknown Hardware: Unknown Languages: Unknown Formatter: Unknown Availability: Anonymous ftp from: LPA:/independent Readme: Unknown Description: None available Support: Unknown - ---------------------------------------------------------------------- - Literate Programmer's Workshop (LPW) -------------------------------------- Developer: Norbert Lindenberg Version: 1.1 Hardware: Apple Macintosh Languages: C++, Object Pascal & others Formatter: self-contained WYSIWYG system Availability: Anonymous ftp from: LPA:/machines/mac CTAN:/web/lpw ftp.apple.com:/pub/literate.prog Readme: With bundle above. Also comes with 38-page manual. Description: The Literate Programming Workshop is an environment for the integrated development of program source text and documentation in combined documents. It consists of a WYSIWYG word processor based on a style sheet approach, a mechanism to extract parts of the text in a document, and a project management system that handles multi-document projects. The system is designed to be used in conjunction with the Macintosh Programmer's Workshop: it prepares raw source text for the MPW compilers, accepts MPW error messages, and shows them in the context of the original documents. Automatic indexing and hypertext features allow for easy access to both source text and documentation. LPW is shareware. Support: Bugs, problems, and questions to lpw@aol.com. - ---------------------------------------------------------------------- - MapleWEB ---------- Developer: Unknown Version: Unknown Hardware: Unknown Languages: Maple Formatter: Unknown Availability: Anonymous ftp from: LPA:/maple Readme: Unknown Description: None Support: Unknown - ---------------------------------------------------------------------- - MWEB (Schrod/Detig) --------------------- Developer: Joachim Schrod Version: Unknown Hardware: Unknown Languages: Modula-2 Formatter: Unknown Availability: Anonymous ftp from: LPA:/modula-2 Readme: Unknown Description: None Support: Not supported. - ---------------------------------------------------------------------- - MWEB (Sewell) --------------- Developer: Sewell Version: Unknown Hardware: Unknown Languages: Modula-2 Formatter: Unknown Availability: Anonymous ftp from: LPA:/modula-2 Readme: Unknown Description: None Support: Not supported. - ---------------------------------------------------------------------- - noweb ------- Developer: Norman Ramsey Version: 2.6 Hardware: Unix and DOS platforms. Languages: All programming languages. Formatter: Plain TeX, LaTeX, and HTML (Mosaic) formatters. Availability: Anonymous ftp from: CTAN:/web/noweb LPA:/independent DOS version also in LPA:/machines/ms-dos also bart.kean.edu:/pub/leew Last recourse, use bellcore.com:/pub/norman Readme: With bundle above. Description: noweb is designed to meet the needs of literate programmers while remaining as simple as possible. Its primary advantages are simplicity, extensibility, and language-independence. noweb uses 5 control sequences to WEB's 27. noweb now supports indexing and identifier cross-reference, including hypertext ``hot links'' courtesy of Mosaic. The simple noweb manual is only 2 pages; documenting the full power of noweave and notangle requires another 3 pages. noweb works ``out of the box'' with any programming language, and its formatter-dependent part is a 60-line nawk program. The primary sacrifice relative to WEB is the loss of prettyprinting. Support: email to the author - ---------------------------------------------------------------------- - nuweb ------- Developer: Preston Briggs: preston@cs.rice.edu Version: 0.87 Hardware: Unix systems: Sparcs, RS/6000s, HPs; (!) MSDOS and Amiga. Languages: Any programming language or combination of programming languages. Formatter: Latex Availability: Anonymous ftp from: Unix: CTAN:/web/nuweb DOS: CTAN:/web/nuweb-pc LPA:/independent Amiga: CTAN:/web/nuweb/nuweb_ami Amiga: wuarchive.wustl.edu/pub/aminet Readme: Send mail to preston@cs.rice.edu Description: A single program that takes a web file written in a combination of latex and any programming language(s) and produces a latex file that can be pretty printed and a set of files containing code for compilation/interpretation by the appropriate language processors. Strengths include speed, simplicity, multiple languages, nice indices and cross-references, latex. Doesn't require any special macros or macro files. Drawbacks: latex-dependent, no code pretty printing, harder to make indices than cweb. More good stuff: nice support for make, doesn't reformat source files, so they're easy to debug. Lots of control without too much effort. That is, it doesn't do too much! Future directions... Very little change planned, except perhaps refinements in the indexing software. Support: Hack it yourself or send e-mail to preston@cs.rice.edu - ---------------------------------------------------------------------- - ProTeX -------- Developer: Eitan Gurari Version: 1.1 (AlProTeX 1.2) Hardware: Any platform with TeX (ProTeX is written in TeX) Languages: Any language Formatter: TeX and LaTeX Availability: Anonymous ftp from: ftp.cis.ohio-state.edu : pub/tex/osu/gurari/ LPA:/independent Readme: Unknown Description: There is a book published on using ProTeX, @Book{Gurari:TLD94, author = "Eitan M. Gurari", title = "{\TeX} and {\LaTeX}: Drawing and Literate Programming", publisher = pub-MH, year = "1994", address = pub-MH:adr, bibdate = "Wed Sep 29 17:55:14 1993", acknowledgement = ack-nhfb, } Support: gurari@cis.ohio-state.edu - ---------------------------------------------------------------------- - RWEB ------ Developer: Unknown Version: Unknown Hardware: Unknown Languages: Unknown Formatter: Unknown Availability: Anonymous ftp from: LPA:/reduce Readme: Unknown Description: Web generator in AWK. Support: Unknown - ---------------------------------------------------------------------- - SchemeWEB ----------- Developer: John D. Ramsdell Version: 2.0 Hardware: Unix and DOS platforms Languages: Any dialect of Lisp. Formatter: LaTeX. Availability: The Unix version is in the Scheme Repository and it is available via anonymous ftp from: cs.indiana.edu:pub/scheme-repository/new/schemeweb.sh LPA:/lisp CTAN:web/schemeweb The DOS version is part of the PCS/Geneva Scheme system which is available via anonymous ftp from: cui.unige.ch:/pub/pcs LPA:/machines/ms-dos Readme: In bundle with above. Description: SchemeWEB is a Unix filter that allows you to generate both Lisp and LaTeX code from one source file. The generated LaTeX code formats Lisp programs in typewriter font obeying the spacing in the source file. Comments can include arbitrary LaTeX commands. SchemeWEB was originally developed for the Scheme dialect of Lisp, but it can easily be used with most other dialects. Support: Bug reports to ramsdell@triad.mitre.org. - ---------------------------------------------------------------------- - SpideryWEB ------------ Developer: Norman Ramsey Version: Unknown Hardware: Unix and DOS platforms Languages: Most Algol-like languages, including C, Ada, Pascal, Awk, and many others. Formatter: Plain TeX and latex for text formatters. Availability: Anonymous ftp from: CTAN LPA:/spiderweb Readme: In distribution. Description: A system for building language-dependent WEBs. Spider is frozen; no further development is planned. Support: Bug reports to spider-bugs@oracorp.com. - ---------------------------------------------------------------------- - WEB ----- Developer: Donald Knuth Version: Unknown Hardware: Unknown Languages: Pascal Formatter: TeX (of course! ;-) Availability: Anonymous ftp from: LPA:/pascal Readme: Unknown Description: This is the original software that started it all. The original TeX processor was written in WEB. Support: None known. - ---------------------------------------------------------------------- - WinWordWEB ------------ Developer: Lee Wittenberg Version: Unknown Hardware: Needs Microsoft Word for Windows, v.2.x, and, of course, MS-Windows 3.x. Languages: Any programming language. Formatter: Word for Windows 2.x for text formatting and file maintenance. Availability: Anonymous ftp from: bart.kean.edu:pub/leew LPA:/machines/ms-dos World-Wide Web (WWW) Readme: WORDWEB.DOC in the downloadable package describes the system. Description: WinWordWEB is a set of a Word for Windows macros (plus a paragraph style) that provide a crude literate programming environment. The ``look and feel'' of the system is based on Norman Ramsey's noweb, but can easily be modified to suit individual tastes. Support: None. WinWordWEB was written as a prototype to see if a WYSIWYG literate programming system was possible. It is intended as a jumping off point for future work by others. However, the system is surprisingly usable as it stands, and the author is interested in hearing from users (satisfied and dissatisfied). Anyone interested in actively supporting (and improving) the product should contact the author via email. = ====================================================================== * Are there other tools I should know about? -------------------------------------------- First of all, I'll list some not-quite-literate-programming tools. Some may consider these to be pretty-printers. Others may call them literate programming tools. In any event, they don't seem to be quite in the same category as the tools listed above, so I'll include them here. - C2LaTeX --------- Developer: John D. Ramsdell Version: Unknown Hardware: Unix Languages: C Formatter: LaTeX but it's easy to change the formatter. Availability: Anonymous ftp from omnigate.clarkson.edu:/pub/tex/tex-programs/c2latex. Readme: Absent. Documentation is in the C source for c2latex. Description: C2latex provides simple support for literate programming in C. Given a C source file in which the comments have been written in LaTeX, c2latex converts the C source file into a LaTeX source file. It can be used to produce typeset listings of C programs and/or documentation associated with the program. C2latex produces LaTeX source by implementing a small number of rules. A C comment that starts at the beginning of a line is copied unmodified into the LaTeX source file. Otherwise, non-blank lines are surrounded by a pair of formatting commands (\begin{flushleft} and \end{flushleft}), and the lines are separated by \\*. Each non-blank line is formatted using LaTeX's \verb command, except comments within the line are formatted in an \mbox. Support: Send bug reports to ramsdell@mitre.org. - ---------------------------------------------------------------------- - c2cweb -------- Developer: Werner Lemberg Version: 1.1 Hardware: DOS, OS/2, Unix (presumed) -- source included Languages: C, C++ Formatter: TeX Availability: Anonymous ftp from CTAN:/web/c_cpp Readme: In distribution. Description: c2cweb will transform plain C or C++ code into a CWEB file to get a pretty formatted output. A modified CWEAVE (which transforms the CWEB file into a TeX file, see below) is included also. Support: Werner Lemberg - ---------------------------------------------------------------------- - c2man ------- Developer: Graham Stoney Version: 2.0 patchlevel 26 Hardware: Unix, MSDOS, OS/2. Languages: C Formatter: nroff -man, texinfo (requires yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX). Availability: Anonymous ftp from ftp.wustl.edu: /usenet/comp.sources.reviewed/volume03/c2man* ftp.informatik.uni-stuttgart.de: /pub/archive/comp.sources/reviewed/c2man* Readme: See distribution. Description: The primary philosophy here is to use the programming language as far as possible to express the programmer's intentions, and to use comments only when the programming language is not sufficiently expressive. A comment can then become part of the language grammar which is recognised by a "documentation compiler". This tool parses a superset of the programming language and can automatically generate documentation in human-readable form by associating the programmer's comments with the objects in the code by their context. Support: Actively supported; mailing list available: send "subscribe c2man " (in the message body) to listserv@research.canon.oz.au. - ---------------------------------------------------------------------- - cnoweb -------- Developer: Jim Fox Version: 1.4 (January 4, 1991) Hardware: Anything with C and TeX. Languages: C Formatter: Plain TeX. Availability: Anonymous ftp from: CTAN LPA:/c.c++ Readme: Unknown, cnoweb.tex contains documentation. Description: cnoweb is as it's name describes: write C, not web. No tangling or weaving is implemented. Documentation (between standard /* */ delimiteres) is written in TeX. cnoweb provides typesetting of documentation, an table of contents of routines, and pretty-printing of C source. Support: None known. - ---------------------------------------------------------------------- - Funnelweb Mode ---------------- Developer: Daniel Simmons Version: Unknown Availability: Litprog archives (was in email) Anonymous ftp from: ftp.imada.ou.dk Description: The other day I did a quick hack to nuweb.el as included with the nuweb distribution so as to make a funnelweb-mode.el. I've only used it briefly, and I'm sure that it can be improved quite a bit. I've been thinking about adding support for folding on sections, a pull-down menu to select macro definitions (like the recent functions posted to gnu.emacs.sources for a C function definition pull-down menu) and some kind of tags support for funnelweb. Support: Unknown - ---------------------------------------------------------------------- - noweb.el ---------- Developer: Bruce Stephens Version: Unknown. Availability: LitProg archives (in an email message). Description: This is a very simple mode I just hacked up. There's a lot wrong with it, but I thought others may be interested, even as it stands. It *requires* text properties, and assumes those used in GNU Emacs 19.22; it'll quite likely work with Lucid Emacs, but I haven't tried it. I use it with auctex8.1 and cc-mode 3.229, both of which are loaded separately (I think my emacs is dumped with them, in fact). The idea is to have one mode (which calls itself c-mode, but actually has LaTeX-mode keybindings) generally (this means that the code is hilighted nicely), and have the code chunks use a different keymap. Support: Email to ddw@sunbim.be - ---------------------------------------------------------------------- - nuweb.el ---------- Developer: Dominique de Waleffe Version: 1.15 (2.0 RSN) Availability: Anonymous ftp from: LPA CTAN Description: Provides a major mode extending Auctex for editing nuweb files. Main features (in 2.0): - Edit scrap bodies in a separate buffer in a different mode (selected using emacs defaults for files, specific indication -*-mode-*-, or a buffer-local variable) - Extends Auctex commands so that nuweb is called before LaTeX, - Easy navigation on scrap definition and use points. Support: Email to ddw@sunbim.be - ---------------------------------------------------------------------- - TIE ----- Developer: Unknown Version: Unknown Hardware: Unknown Availability: Anonymous ftp from: LPA:/Tools Readme: Unknown Description: This software merges change files. Support: Unknown - ---------------------------------------------------------------------- - Web mode ---------- Developer: Bart Childs Version: Unknown Tools supported: web, fweb, cweb, funnelweb Availability: Anonymous ftp from ftp.cs.tamu.edu:pub/tex-web/web/EMACS.web-mode thrain.anu.edu.au:pub/web/EMACS.web-mode Description: This version works with versions 18 and 19 of Emacs to be best of my knowledge. I have cleaned up a number of documentation items ... In the same directory is wm_refcard.tex which is an edited version of the famous one to include some web-mode commands. The files limbo* are related to its use and notice that half them have an uppercase L in them for LaTeX. The setup is based upon the fact that we (I am not alone here) primarily use FWEB for C and Fortran programming. We are using version 1.40 of FWEB although John Krommes warns that it is not mature and the manual is not yet updated. The info files are! We are using LaTeX almost exclusively. That will likely change and we will revert to version 1.30 if the final form of 1.40 cannot return to the simple section numbers and avoid the HORRIBLE LATEX 0.1.7.2.4.6 type section numbers. Support: Unknown = ====================================================================== * What other resources are available? ------------------------------------- - World Wide Web ---------------- An untapped resource (by me anyway ;-) is the World Wide Web. Marcus Speh has expended considerable effort in this regard. If you're connected to WWW, then access: http://info.desy.de/user/projects/LitProg.html If you aren't connected to WWW, telnet to info.cern.ch and explore. You can reach Marcus' literate programming pages by typing: go http://info.desy.de/user/projects/LitProg.html Help for people who have only Email and neither WWW nor telnet, can be obtained by Email from TEST-LIST@INFO.CERN.CH by sending a message, SEND , for example, SEND http://info.desy.de/user/projects/LitProg.html to retrieve the LitProg library page. A help file can be retrieved by sending a message to the list server above with the text HELP in the body of the message. Instructions will be returned by email. For literate programming documents, you can try anonymous ftp to ftp.desy.de [131.169.10.115] and get the file: /pub/userWWW/projects/Announce/LitProg.txt - ---------------------------------------------------------------------- - TeX Resources --------------- Another resource of interest to literate programmers is the info-tex mailing list. If you're using (La)TeX as your typsetting system and have access to internet, then you should investigate this mailing list. Mail list service is available through the SHSU list-server. To subscribe, send a message to LISTSERV@SHSU.EDU, and include in the message one line of text: SUBSCRIBE INFO-TEX "your name in quotes" The list is unmoderated; messages sent to info-tex@shsu.edu are automatically distributed to all subscribers and cross-posted to comp.text.tex. Archives of the mailing list and newsgroup are maintained on niord.shsu.edu [192.92.115.8] in the directory info-tex. Another reason the TeX resources should be important is that so many of the literate programming tools rely on either plain TeX or LaTeX as their text formatter. (La)TeX software systems exist for most computing platforms. These systems can be found on CTAN and other major archive sites. Use archie to find them or simply ftp to one of the CTAN sites and browse. - ---------------------------------------------------------------------- - Virtual Coursework -------------------- Marcus Speh plans an introductory course on Literate Programming on the Internet, part of the first semester of "Global Network Academy" [GNA], a non-profit corporation incorporated in the state of Texas, affilated with the Usenet University project. The texts/sample programs for this class will be made available via the World-Wide Web. A special room on GNA Virtual Campus will be staffed by a consultant in one to two hour shifts. Students with questions can telnet to the virtual campus and ask questions of the staff there. If you are interested in registering for the course either as a student or as a consultant, please contact marcus@x4u.desy.de. You will receive a standard reply message; no further action will be taken until June 94. Interested parties can check teh hypertext notes for the ongoing C++ Course done in a similar fashion, at URL http://info.desy.de/pub/uu-gna/html/cc/index.html [Editor's note: Because of workload, Marcus requests that email inquiries be limited to a statement of interest for either a student or consultant position until June 1994.] = ====================================================================== * Are there any code examples? ------------------------------ Examples of web programs are included with the FWEB, CWEB, and noweb distributions. nuweb is written in itself. Cameron Smith converted the K&R calculator program into a literate program. It can be retrieved by anonymous ftp from: niord.shsu.edu [192.92.115.8] directory kr-cweb-sample as krcwsamp.zip or from LPA/Documentation Ross Williams has released a funnelweb example. You can retrieve this file from node ftp.adelaide.edu.au [129.127.40.3] as /pub/funnelweb/examples/except.* This file should be on CTAN as well. Lee Wittenberg has posted a few litprog examples. They are available via anonymous ftp from: bart.kean.edu:/pub/leew/samples.LP The Stanford GraphBase is a large collection of programs by Don Knuth for doing all kinds of computations and games with graphs; it is written in (Levy/Knuth) CWEB. More details in the distribution. It is available via anonymous ftp from: labrea.stanford.edu:/pub/sgb = ====================================================================== * Bibliographies ---------------- Nelson Beebe has collected an extensive bibliography treating literate programming. His work is available for anonymous ftp from ftp.math.utah.edu [128.110.198.2] in directory /pub/tex/bib as files: litprog.bib litprog.ltx litprog.twx. Although I have not verified this, LPA is an alternate source for these files. Note that they are updated frequently (Nelson says several times each week), so be sure to get a fresh copy before extensive use. Joachim Schrod indicates that these files may be updated daily and can be retrieved via anonymous ftp at LPA/documentation. = ====================================================================== * How to anonymously ftp ------------------------ Pretty much everything mentioned here is available by anonymous FTP. FAQ lists cross-posted to news.answers and rec.answers can be gotten from rtfm.mit.edu [18.181.0.24], under /pub/usenet/news.answers or under /pub/usenet/more.specific.group.name "anonymous FTP" is just a way for files to be stored where anyone can retrieve them over the Net. For example, to retrieve the latest version of the literate programming FAQ, do the following: > ftp rtfm.mit.edu /* connect to the site; message follows */ > anonymous /* type this when it asks for your name */ > /* type your address as the password */ > cd /pub/usenet /* go to the directory you want to be */ > cd comp.programming.literate /* one level down (no slash). */ > dir /* look at what's there */ > get literate-progamming-faq /* get the file; case-sensitive */ > quit /* stop this mysterious thing */ If your FTP program complains that it doesn't know where the site you want to use is, type the numerical address instead of the sitename: > ftp 18.181.0.24 /* connect with numerical address */ If you don't have ftp access, send e-mail to mail-server@rtfm.mit.edu with the single word "help" in the body of the message. Getting binary files (executables, or any compressed files) is only slightly more difficult. You need to set binary mode inside FTP before you transfer the file. > binary /* set binary transfer mode */ > ascii /* set back to text transfer mode */ FAQs and spoiler lists are generally ascii files; everything else is generally binary files. Some common extensions on binary files in archive sites are: .Z Compressed; extract with uncompress .tar.Z Compressed 'tape archive'; uncompress then untar or tar -xvf .gz or .z Gnu gzip; use gunzip (available from prep.gnu.ai.mit.edu) .sit (Mac) StufIt archive .zip Extract with Zip or Unzip .zoo Yet another archive/compress program .lhe (Amiga) ? .lzh Lha archive program. .arj (PC) Arj archive program. .exe (PC) Sometimes self-extracting archives-just execute them. .uue or .UUE Transfer as text file; use uudecode to convert to binary .hqx (Mac) BinHex format; transfer in text mode Generic help can be found in the FAQs of comp.binaries. for how to transfer, extract, and virus-check binary files. (At rtfm.mit.edu) If you can't FTP from your site, use one of the following ftp-by-mail servers: ftpmail@decwrl.dec.com ftpmail@src.doc.ic.ac.uk ftpmail@cs.uow.edu.au ftpmail@grasp.insa-lyon.fr For complete instructions, send a message reading "help" to the server. If you don't know exactly what you're looking for, or exactly where it is, there are programs and servers that can help you. For more info, send e-mail to mail-server@rtfm.mit.with with the body of the message reading send usenet/news.answers/finding-sources Thanks to Aliza R. Panitz (the "buglady") for this text. I copied it verbatim from her post on faq-maintainers with only minor modifications. = ====================================================================== * Acknowledgements ------------------ This document would not have happened without the help of many people. Among them are Marcus Speh, George Greenwade, Rob Beezer, Joachim Schrod, Piet van Oostrum, and Ross N. Williams. A special thanks to Aliza R. Panitz for the text describing how to execute an anonymous ftp for files of interest. Any omissions from these acknowledgements should be considered an act of stupidity on my part. Of course, the authors of literate programming tools mentioned above all play a vital role in the vitality of literate programming. Furthermore, participants in the comp.programming.literate newsgroup (and associated mailing list) all contributed in various fashions. Thank all of you. = ====================================================================== * End notes ----------- This document will continue to evolve. I'm planning on adding entries for additional literate programming tools and will expand the sections on examples as more examples become available. Tools I will include are WEB (the original pascal version) for starters. Others will be added as I find and document them. Omission of a particular tool should not be considered a snub in any sense--simply an error or oversight on my part. = End of File ========================================================== ================================================================================ Archive-Date: Sat, 13 Aug 1994 02:56:10 CDT Sender: owner-litprog@SHSU.edu From: mpg59@aol.com (MPG59) Reply-To: LitProg@SHSU.edu, mpg59@AOL.COM Subject: Dissassembler Date: 13 Aug 1994 03:39:01 -0400 Message-ID: <32htal$gbq@search01.news.aol.com> To: LitProg@SHSU.EDU I am looking for information on a program that would allow me to disassemble an executeable back into code. I am just learning Visual Basic, and this would greatly increase my knowledge on how things work. I've heard of a program called Slueth 2.0, does anybody know about this? Thanks in advance MPG59@aol.com ================================================================================ Archive-Date: Sat, 13 Aug 1994 11:25:54 CDT Sender: owner-litprog@SHSU.edu From: ara@zurich.ai.mit.edu (Allan Adler) Reply-To: LitProg@SHSU.edu, ara@ZURICH.AI.MIT.EDU Subject: Re: more FWEB questions Date: 13 Aug 94 11:55:23 Message-ID: To: LitProg@SHSU.EDU In article ara@zurich.ai.mit.edu (Allan Adler) writes: A similar problem has to do with code that defines one piece of code as being a bunch of other pieces of code, each being a named module. I would expect to see each of the named modules on a separate line, but for some reason fweave runs them together without line breaks. This is easily solved by skipping a line between each named module. The other questions are still open. Allan Adler ara@altdorf.ai.mit.edu ================================================================================ Archive-Date: Sat, 13 Aug 1994 19:30:02 CDT Sender: owner-litprog@SHSU.edu Date: Sat, 13 Aug 94 20:27:09 -0400 From: gtk@walsh.med.harvard.edu (Gregory Tucker-Kellogg) Reply-To: LitProg@SHSU.edu, gtk@WALSH.MED.HARVARD.EDU Message-ID: <9408140027.AA10627@walsh.med.harvard.edu> To: LitProg@SHSU.edu, ara@ZURICH.AI.MIT.EDU Subject: Re: more FWEB questions References: >>>>> "Allan" == Allan Adler writes: > In article > ara@zurich.ai.mit.edu (Allan Adler) writes: A similar problem has > to do with code that defines one piece of code as being a bunch of > other pieces of code, each being a named module. I would expect to > see each of the named modules on a separate line, but for some > reason fweave runs them together without line breaks. > This is easily solved by skipping a line between each named module. > The other questions are still open. > Allan Adler ara@altdorf.ai.mit.edu It may be a system-dependent problem. I had the same problem under 1.30 until I made the appropriate "bootstrap" changes. For 1.40, I had no such problem. (SGI IRIS running IRIX 4.0.5c). -- Gregory W. Tucker-Kellogg Department of Biological Chemistry and Molecular Pharmacology Harvard Medical School, Boston MA 02115 (617) 432-0930 or (617) 432-3212 ================================================================================ Archive-Date: Sat, 13 Aug 1994 22:49:56 CDT Sender: owner-litprog@SHSU.edu Date: Sat, 13 Aug 1994 20:50:54 -0700 (MST) From: bauer@spock.AME.Arizona.EDU (Holger Bauer 8/93) Reply-To: LitProg@SHSU.edu, bauer@SPOCK.AME.ARIZONA.EDU Subject: Re: more FWEB questions To: LitProg@SHSU.edu, ara@ZURICH.AI.MIT.EDU CC: LitProg@SHSU.EDU Message-ID: <9408140350.AA21905@AME.Arizona.edu> MIME-Version: 1.0 Content-Type: TEXT/PLAIN; CHARSET=US-ASCII Content-Transfer-Encoding: 7BIT >>>>> "Allan" == Allan Adler writes: Allan> In article Allan> ara@zurich.ai.mit.edu (Allan Adler) writes: A similar Allan> problem has to do with code that defines one piece of code Allan> as being a bunch of other pieces of code, each being a Allan> named module. I would expect to see each of the named Allan> modules on a separate line, but for some reason fweave runs Allan> them together without line breaks. Allan> This is easily solved by skipping a line between each named Allan> module. The other questions are still open. Allan> Allan Adler ara@altdorf.ai.mit.edu What about putting a ';' (semicolon) after the module names? This works for me perfectly! Holger |==========================================================================| | _ _ _ | | Holger Bauer ... __o ( ) ( ) (_ ) _ | | 1426 E. 8th St. .. _`\<,_ | |_| | _ | | __ (_) | | Tucson, AZ 85719 ...(*)/ (*). | _ | /'_`\ | | /'_ `\ | | | | (602) 623-9003 | | | | ( (_) ) | | ( (_) | | | | | (_) (_) `\___/ (___)`\__ | (_) | |============================= bauer@spock.ame.arizona.edu === ( )_) | ====| "Experience comes from bad judgment" Mark Twain \___/' ================================================================================ Archive-Date: Sun, 14 Aug 1994 15:56:23 CDT Sender: owner-litprog@SHSU.edu From: Thorbjoern Ravn Andersen Reply-To: LitProg@SHSU.edu, ravn@IMADA.OU.DK Message-ID: <199408142057.AA23595@imada.ou.dk> Subject: Re: Dissassembler To: LitProg@SHSU.edu, mpg59@aol.com Date: Sun, 14 Aug 1994 22:57:13 +0200 (MET DST) MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 8bit MPG59 | | I am looking for information on a program that would allow me to | disassemble | an executeable back into code. I am just learning Visual Basic, and this | would | greatly increase my knowledge on how things work. I've heard of a program | | called Slueth 2.0, does anybody know about this? Thanks in advance | MPG59@aol.com I don't know what this is doing in my mailbox but I am perfectly willing to answer. 1) An executable is generally pure machine code either written (originally) in assembler or a high-level language. 2) There are several programs available for turning machinecode into equivalent assembler -- uncommented. Generally a human reader needs long time and thought to turn it into *understandable* source. 3) There is no way for a machine to convert machinelanguage back into a high-level language, and even if it could it would have to guess all variable names etc. My advice to you as a newcomer to programming would be finding a good introductory book to programming and a good text for algorithmics. The first to teach you the language, and the second the things you can do with a computer. Regards, -- Thorbjo/rn Ravn Andersen ravn@imada.ou.dk P.S. If you need elaboration on any of the above, please write me back. ================================================================================ Archive-Date: Mon, 15 Aug 1994 10:50:59 CDT Sender: owner-litprog@SHSU.edu Date: Mon, 15 Aug 94 11:51:56 EDT From: Lee Wittenberg Reply-To: LitProg@SHSU.edu, leew@PILOT.NJIN.NET To: LitProg@shsu.edu Subject: Literate Programming in the Sixties (sic) Message-ID: Documentation of Programs" in the second volume of the proceedings of the 1965 IFIP Congress, I came across the following: [G.E. Felton] described a working system in which most of the documentation is kept with the source language program on magnetic tape, is skipped during assembly or compilation, and is easily updated together with the program by an editing program. A particular advantage of this arrangement is found when many copies of a program have to be prepared and issued; each copy of the program is automatically accompanied by the documentation. Anyone out there ever heard of this system (or G.E. Felton)? It may have been developed for the Orion computer (which I have also never heard of) -- Felton mentions the Orion in some of his other remarks. -- Lee P.S. If anyone wants a more complete citation of the quote, let me know; I'll be glad to suppy it. ------------------------------------------------------------------------ Lee Wittenberg | The world is my idea; as such I present it Computer Science Department | to you. I have my own set of weights and Kean College of New Jersey | measures and my own table for computing Union, NJ 07083 | values. You are privileged to have yours. USA | | -- Charles G. Finney leew@pilot.njin.net | "The Circus of Doctor Lao" (1948) ------------------------------------------------------------------------ ================================================================================ Archive-Date: Tue, 16 Aug 1994 15:34:35 CDT Sender: owner-litprog@SHSU.edu Date: Tue, 16 Aug 1994 08:46:59 CDT From: "Ronald D. Parker" Reply-To: LitProg@SHSU.edu, rdp@BUTLER.CPS.COM Message-ID: <2e50c354.butler@butler.cps.com> To: LitProg@SHSU.edu Subject: Re: DLLs, C++, and Visual Basic On Fri, 12 Aug 1994 23:38:47 GMT, "Stephane Rainville" wrote: > > Hi, > We want to write a DLL file in C++ to and call one of its subroutines > in a Visual Basic programm. So far, we figure we've written a DLL in C++ > that works (although we're not sure). Calling it from Visual Basic has > proven more difficult. Basically (forgive the pun), we declare the DLL > in the general procedure, as well as the sub we want. However, when we > call the subroutine, Visual Basic doesn't seem to think it's defined. > If someone out there could instruct as to what we should do to: > 1- write up a DLL in Boreland C++ > 2- call it up from Visual Basic > > please do so. > > Steph and Chuck Pardon my replying to the list, but I'm temporarily strapped with a mailer that accepts no alternate reply address. One possible problem is that you need to declare your exported C++ function as ``extern "C"'' so that VB can see its name in an unmangled form. Also be warned that if you are using Borland C++ Version 4.0 to write a DLL for use by an application that is not written in Borland 4.0, you WILL have problems. There is a feature, read as BUG, in the Borland compiler that causes the DLL to corrupt the executable. This may result in a crash. Hope this might be some help. -- Ron Parker Butler Manufacturing Company BMA Tower -- 4th Floor rdp@butler.cps.com Post Office Box 419917 Phone: (816) 968-3537 Kansas City, Missouri 64141-0917 ================================================================================ Archive-Date: Wed, 17 Aug 1994 00:52:59 CDT Sender: owner-litprog@SHSU.edu From: chris@kd3bj.uucp (C. T. Nadovich) Reply-To: LitProg@SHSU.edu, chris@KD3BJ.UUCP Subject: Re: help ! how to do dynamic memory allocation in fortran Message-ID: Keywords: help - dynamic memory allocation using fortran Date: Wed, 17 Aug 1994 02:50:10 GMT To: LitProg@SHSU.EDU mxm1003@s24.msi.umn.edu (Ram V. Mohan) writes: >I am trying to find out how to do dynamic memory allocations while >using fortran. Use f2c to convert to c, then use malloc. (Sorry, I couldn't resist.) But seriously, if you are doing math, consider using the public domain version of Matlab (the source for that is in FORTRAN). Either code your problem in Matlab directly or use the source for matlab as a model for a FORTRAN dynamic memory manager. Or write a simple lisp or forth in FORTRAN and code in that. (Whoops! Did it again.) -- 73 de KD3BJ (Chris Nadovich, chris@kd3bj.ampr.org) ================================================================================ Archive-Date: Wed, 17 Aug 1994 19:28:02 CDT Sender: owner-litprog@SHSU.edu From: kencham@ulysses.cs.umn.edu (deepak r. kenchammana-hosekote) Reply-To: LitProg@SHSU.edu, kencham@ULYSSES.CS.UMN.EDU Subject: A couple of questions on using FWEB Message-ID: Keywords: FWEB Date: Wed, 17 Aug 1994 23:38:54 GMT To: LitProg@SHSU.EDU Hi, Having just discovered the wonderful world of literate programming this novice has run into a problem in writing his latest code in FWEB. Your responses to it would be most useful. Working with multiple files: Typically code is written in multiple source files for various reasons. How does one inform ftangle to resolve references to named modules across different files. For example, foo.web and goo.web be two FWEB files. [foo.web]: some_routine () { .... @; } [goo.web]: @= another_routine() { .... } I get a multiple definition error on compiling the ftangle-d code if I do a "@i goo.web" in foo.web. Any clues as the best way to get around the problem without preventing fweave from doing its job? Please feel free to email your response. Much thanks in advance. \deepak \PS If you have a comprehensive makefile for handling web files for a large project and are willing to share it I'd sure appreciate it. -- And then the alien anthropologists admitted they were still perplexed, But on eliminating every other reason for our sad demise, They logged the explanation left, this species has amused itself to death, No tears to cry no feelings left, this species has amused itself to death. ================================================================================ Archive-Date: Sat, 20 Aug 1994 12:28:31 CDT Sender: owner-litprog@SHSU.edu From: ihh1000@hermes.cam.ac.uk (Ian Holmes) Reply-To: LitProg@SHSU.edu, ihh1000@HERMES.CAM.AC.UK Subject: Re: DLLs, C++, and Visual Basic Date: Sat, 20 Aug 1994 18:26:32 +0000 Message-ID: To: LitProg@SHSU.EDU In article , ai729@FreeNet.Carleton.CA (Stephane Rainville) wrote: > Hi, > We want to write a DLL file in C++ to and call one of its subroutines > in a Visual Basic programm. So far, we figure we've written a DLL in C++ > that works (although we're not sure). Calling it from Visual Basic has > proven more difficult. Basically (forgive the pun), we declare the DLL > in the general procedure, as well as the sub we want. However, when we > call the subroutine, Visual Basic doesn't seem to think it's defined. > If someone out there could instruct as to what we should do to: > 1- write up a DLL in Boreland C++ > 2- call it up from Visual Basic > > please do so. > > Steph and Chuck Usually if VB says that a DLL function isn't defined, it's because: (i) the DLL is not in the app's Path; (ii) an older version of the DLL is already loaded, in which case you can use the WPS utility to free it. -- Ian Holmes Undergraduate Dept.Physics,Univ.Cambridge UK ================================================================================ Archive-Date: Sat, 20 Aug 1994 18:02:19 CDT Sender: owner-litprog@SHSU.edu From: norman@flaubert.bellcore.com (Norman Ramsey) Reply-To: LitProg@SHSU.edu, norman@FLAUBERT.BELLCORE.COM Subject: Version 2.6b of noweb, supports C auto-indexing Message-ID: Date: Thu, 18 Aug 1994 22:23:03 GMT To: LitProg@SHSU.EDU Version 2.6b of noweb is now available from the CTAN sites in directory web/noweb. This version is primarily a bug-fix version, but it does include a rudimentary recognizer for definitions in C programs, so noweb can now provide reasonable automatic cross-reference for C. (Note that this feature, as with the other auto-recognizers, is available only in the Icon version.) I append the list of changes---if you don't care about any of these bugs, you needn't get the new version. Norman Ramsey CHANGES FOR VERSION 2.6b Added -autodefs c Changed installation procedure so that source is no longer distributed with contributed software --- you now must install noweb, then build contributed software. Bug fixes: - Makefile didn't create .../man/man1 - noweave botched -x option, emitted index info anyway - markup complained, incorrectly, about [[<<]] in documentation. - noidx died if it tripped over an identifier used only in quoted code - tohtml wasn't inserting doc anchor into above_defns, so some xrefs that should have read `above' were coming out `below' - when one identifier was a prefix of another, as in Class and Class::member, finduses duplicated the prefix. -- Norman Ramsey norman@bellcore.com ================================================================================ Archive-Date: Sun, 21 Aug 1994 22:25:32 CDT Sender: owner-litprog@SHSU.edu From: richard@cs.anu.edu.au (Richard Walker) Reply-To: LitProg@SHSU.edu, richard@CS.ANU.EDU.AU Subject: Vertical bars in CWEB Date: 22 Aug 1994 13:13:21 +1000 Message-ID: <33954iINN4kj@barnard.anu.edu.au> To: LitProg@SHSU.EDU I have searched the CWEB manual, but I can't find the answers to these questions. Can you help? 1. How do I insert a literal vertical bar (|) in the documentation part? Do I have to use \char"7c ? If so, what do I do if I am using a verbatim environment? 2. How do I insert a vertical bar in the middle of C code surrounded by | ... | ? Richard. -- Richard Walker richard@cs.anu.edu.au Department of Computer Science Aust: (06) 249 5689 The Australian National University Intl: +61 6 249 5689 Canberra, ACT 0200, Australia Fax: +61 6 249 0010 ================================================================================ Archive-Date: Mon, 22 Aug 1994 04:27:59 CDT Sender: owner-litprog@SHSU.edu From: maavl@cwi.nl (Marc van Leeuwen) Reply-To: LitProg@SHSU.edu, maavl@CWI.NL Subject: Re: Vertical bars in CWEB Message-ID: Date: Mon, 22 Aug 1994 09:06:11 GMT To: LitProg@SHSU.EDU In article <33954iINN4kj@barnard.anu.edu.au>, richard@cs.anu.edu.au (Richard Walker) writes: |> I have searched the CWEB manual, but I can't find the answers to |> these questions. Can you help? |> |> 1. How do I insert a literal vertical bar (|) in the documentation |> part? Do I have to use \char"7c ? If so, what do I do if |> I am using a verbatim environment? You can say \chardef\v=`| in the limbo part so that you can write `\v' instead of `\char"7c'. Note however that the ordinary text fonts don't have a vertical bar (you would get `---' instead), so it would only work with fonts like \tt (and in math mode). You shouldn't be using a verbatim environment though, since, as with any system using a preprocessor (in this case CWEAVE), it is impossible to create a true verbatim environment after the preprocessing, for the simple reason that original text simply isn't there any more. This is assuming the preprocessor, like CWEAVE, does not itself have a verbatim mode; even if it would, managing the various verbatim modes simultaneously would be quite tedious. |> 2. How do I insert a vertical bar in the middle of C code surrounded |> by | ... | ? There is no easy way to mention the bitwise-OR operator `|' within `|...|' in CWEB. You can write `@t$|$@>' within `|...|' to obtain the desired symbol, but it would not be parsed as an operator by CWEAVE, so the output might still look wrong. If your expression is not too complicated, you could use `$...$' instead of `|...|', and then use either the plain TeX symbol `\vert', or `\v' as defined above. Marc van Leeuwen CWI, Amsterdam ================================================================================ Archive-Date: Tue, 23 Aug 1994 02:14:50 CDT Sender: owner-litprog@SHSU.edu From: A7621GAC@AWIUNI11.EDVZ.UniVie.AC.AT Reply-To: LitProg@SHSU.edu, A7621GAC@AWIUNI11.EDVZ.UNIVIE.AC.AT Subject: Re: Vertical bars in CWEB Date: Tue, 23 Aug 94 08:44:21 MEZ Message-ID: <1701B7AEF.A7621GAC@AWIUNI11.EDVZ.UniVie.AC.AT> To: LitProg@SHSU.EDU In article maavl@cwi.nl (Marc van Leeuwen) writes: >In article <33954iINN4kj@barnard.anu.edu.au>, richard@cs.anu.edu.au (Richard >Walker) writes: > >|> I have searched the CWEB manual, but I can't find the answers to >|> these questions. Can you help? >|> >|> 1. How do I insert a literal vertical bar (|) in the documentation >|> part? Do I have to use \char"7c ? If so, what do I do if >|> I am using a verbatim environment? > >You can say \chardef\v=`| in the limbo part so that you can write `\v' >instead of `\char"7c'. Note however that the ordinary text fonts don't have >a vertical bar (you would get `---' instead), so it would only work with >fonts like \tt (and in math mode). You shouldn't be using a verbatim >environment though, since, as with any system using a preprocessor (in this >case CWEAVE), it is impossible to create a true verbatim environment after >the preprocessing, for the simple reason that original text simply isn't >there any more. This is assuming the preprocessor, like CWEAVE, does not >itself have a verbatim mode; even if it would, managing the various verbatim >modes simultaneously would be quite tedious. > >|> 2. How do I insert a vertical bar in the middle of C code surrounded >|> by | ... | ? > >There is no easy way to mention the bitwise-OR operator `|' within `|...|' >in CWEB. You can write `@t$|$@>' within `|...|' to obtain the desired >symbol, but it would not be parsed as an operator by CWEAVE, so the output >might still look wrong. If your expression is not too complicated, you could >use `$...$' instead of `|...|', and then use either the plain TeX symbol >`\vert', or `\v' as defined above. > You should have added that your version of CWEB (I think you should change the name to CWEBX or something else -- what do you think about uploading to CTAN?) can handle this situation properly :-) Werner P.S.: The same bug that caused upgrade from CWEB 3.1 to 3.2 occurs in your CWEB version too... ================================================================================ Archive-Date: Tue, 23 Aug 1994 14:02:26 CDT Sender: owner-litprog@SHSU.edu From: futuretracs@delphi.com (Future Tracs) Reply-To: LitProg@SHSU.edu, futuretracs@DELPHI.COM Subject: AD-Do you have 5 or more people 2 train? Date: 23 Aug 1994 18:31:12 GMT Message-ID: <94082314275911.DLITE.futuretracs@delphi.com> To: LitProg@SHSU.EDU ================================================================================ Archive-Date: Tue, 23 Aug 1994 15:07:26 CDT Sender: owner-litprog@SHSU.edu From: greyham@research.canon.oz.au (Graham Stoney) Reply-To: LitProg@SHSU.edu, greyham@RESEARCH.CANON.OZ.AU Subject: An Automatic C++ documentation compilation project. Message-ID: Keywords: c2man, C, C++, Literate Programming, Documentation Date: Mon, 22 Aug 1994 09:34:39 GMT To: LitProg@SHSU.EDU [ This is an updated version of an article last posted late 1993. ] Copyright 1993, 1994 by Graham Stoney. This may be freely redistributed or quoted, so long as it's attributed to me. Writing and maintaining documentation has often been a thorn in the side of the Software Engineer and Programmer. After spending a great deal of time and effort writing documentation about a program or software system, the code invariably changes, quickly rendering the documentation out of date. The documentation becomes misleading, gets neglected, and quickly becomes useless. "Literate Programming" is one approach to solving this problem. It effectively introduces a whole new (typesetting) language, requires a quite radical shift on the part of the "non-literate" programmer and still requires a good deal of effort on the part of the programmer[1]. I'd like to suggest a different approach which lies considerably closer to more traditional programming practices, and can offer quite immediate benefits when functional interface documentation is the main documentation required. The primary philosophy here is to use the programming language as far as possible to express the programmer's intentions, and to use comments only when the programming language is not sufficiently expressive. A comment can then become part of the language grammar which is recognised by a "documentation compiler". This tool parses a superset of the programming language and can automatically generate documentation in human-readable form by associating the programmer's comments with the objects in the code by their context. Whilst the idea of extracting documentation from comments in source code is by no means new, the difference here is that the comments actually form part of the grammar of the language recognised by the documentation compiler[2]. Comments should not repeat information that is already represented in the program code; for instance, a comment describing a function argument should not repeat the name and type of that argument (since that information has already been included, for the compiler), but should appear near the argument. For example, in C, the programmer should write this: /* include an example in the article */ enum Result example(int page /* page it appears on */); Rather than this: /* include an example in the article * * PARAMETERS: * int page page it appears on * * RETURNS: * RESULT_YES The readers agreed * RESULT_NO The readers disagreed * RESULT_YOURE_JOKING The readers disagreed strongly * RESULT_BLANK_LOOKS The readers didn't understand */ enum Result example(int page); Also in this example, the documentation compiler knows the possible enumerated values that the function can return (as does the "real" compiler), so it is unnecessary for the programmer to restate them. The comments need simply be included in the definition for "enum Result" for the "RETURNS" information to be generated automatically: enum Result { RESULT_YES, /* The readers agreed */ RESULT_NO, /* The readers disagreed */ RESULT_YOURE_JOKING, /* The readers disagreed strongly */ RESULT_BLANK_LOOKS /* The readers didn't understand */ }; Critics have suggested that the latter style in the example is easier to read for someone wishing to call the function in question. Of course, this is a style question which depends on each person's tastes; but the criticism is tied to the notion that the source code needs to look "beautiful" because it is the primary reference for someone wishing to use that function. This becomes much less significant once documentation is available which is known to _always_ be up to date. Of course, the latter style takes longer to write and maintain, and can become out of date should the name or type of the parameter be changed, yet the comment get neglected. I have implemented one such documentation compiler for the C language called "c2man", which is freely available[3]. The response from users has been extremely encouraging; I suspect this is partly because of the wide variety of styles of comment placement that are recognised: it often correctly recognises comments that weren't written with c2man in mind at all. While it's use is focused solely on functional interface documentation and it doesn't have anywhere near the power of a full Literate Programming system, the focus is on reducing the effort required by the programmer to the absolute minimum, and seeing how much documentation we can get essentially "for free". Many people have requested C++ support be added to c2man, and I suspect that this philosophy would be even more suitable and powerful for documenting interfaces to C++ classes automatically. Here is an example of how I envisage this philosophy would work when applied to C++. It's interesting to note that this code was written a couple of years ago exactly as you see it here, without the idea of generating documentation from it in mind at all: // generic Timer class class Timer { private: static int numactive; // number of constructed timers. static Timer *first; // first one in list. Timer *next; // next one in linked list. Time ticksdiff; // ticks we take to expire once at front. enum { INACTIVE, // timer is not in chain. STARTED, // one-shot RUNNING // continuous. } state; // original interrupt vector value. static void interrupt (far *old_vector)(...); void (*timeout_function)(int); // function called when we time out int timeout_parameter; // gets passed to timeout_function Time duration; // timer length (ticks) static void interrupt far tick(...); // clock tick routine. void insert(); // add into active chain. void remove(); // remove from active chain. void set(Time milliseconds); // set duration from ms. public: // constructor Timer(Time time=0, // milliseconds void (*function)(int)=0, // called at timeout int param=-1); // param for function // destructor ~Timer(); // start (or restart) a timer running. void Start(); void Start(Time duration); // how long to run for // start a timer running continuous. void Run(); // stop a timer. void Stop(); // is a timer active? boolean Active() const { return state != INACTIVE; }; }; Processing this class declaration could generate the following automatically: NAME Timer - generic timer class SYNOPSIS class Timer { public: Timer(Time time=0, void (*function)(int)=0, int param=-1); ~Timer(); void Start(); void Start(Time duration); void Run(); void Stop(); boolean Active() const; }; PARAMETERS Time time Milliseconds void (*function)(int) called at timeout. int param Param for function. Time duration How long to run for. DESCRIPTION Timer Constructor ~Timer Destructor Start Start (or restart) a timer running. Run Start a timer running continuous. Stop Stop a timer. Active Is a timer active?. It should also be possible to extract this information from the implementation of the class (rather than the declaration), if that's where the user prefers to put the comments describing each member function and their parameters. The ideal tool should: 1. Avoid imposing a style on the programmer. 2. Work out section names (NAME, SYNOPSIS etc) without the programmer having to specify them explicitly. 3. Handle C++ and C style code equally well. 4. Not require the programmer to restate information which is already expressed in the syntax of the programming language. 5. Work reasonably well with existing code. 6. Flatten the class hierarchy so that the documentation for each class includes virtually everything the user needs to know about it. A number of tools already exist which attempt to tackle this problem, such as class2man, genman, classdoc and docclass. They vary in sophistication, utility, and the demands they place on the programmer; however, none as yet meet all the criteria set out above, and no one tool will suit the tastes of all programmers. Pouring lots of effort into a really ``smart'' documentation generator makes sense because once it's done, you get a payback for every document you generate. Every little feature added to the documentation generator to make things easier for the programmer pays off multiple times, and minimising the effort required by the programmer is the key. The logical starting point would be to graft Jim Roskind's C++ grammar[4] into c2man, modifying it to recognise comments in the relevant places, and adding all the necessary structures to hold the information from the parser that will get included in the output. Very little functional change should be needed in the lexer, which already recognises C++ comments. Unfortunately, at present I do not have sufficient spare time to make the additions to c2man required to support C++. It would be a great contribution to the C++ community, not to mention the documentation time saved by themselves, for someone involved in C++ work to add this support and release the result[5]. If you work with a team developing C++ code, please consider having one of your developers on a ``Usenet Sabbatical'' to extend this philosophy to C++, and start reaping the benefits in documentation time savings. It could also make an ideal Computer Science student compiler project. Please contact me via E-mail if you are interested in undertaking such a project. Graham Stoney greyham@research.canon.oz.au Footnotes: 1. Advocates of Literate Programming would argue that Literate Programming is much more than snazzy documents and that it encourages this extra effort to focus early on in the design of the software, which pays off later. 2. To get a better idea, see the file grammar.y in the c2man distribution. 3. c2man has been posted to comp.sources.misc. It should be available from: location: ftp from any comp.sources.misc archive, in volume42 (the version in the comp.sources.reviewed archive is obsolete) ftp /pub/Unix/Util/c2man-2.0.*.tar.gz from dnpap.et.tudelft.nl Australia: ftp /usenet/comp.sources.misc/volume42/c2man-2.0/* from archie.au N.America: ftp /usenet/comp.sources.misc/volume42/c2man-2.0/* from ftp.wustl.edu Europe: ftp /News/comp.sources.misc/volume42/c2man-2.0/* from ftp.irisa.fr Japan: ftp /pub/NetNews/comp.sources.misc/volume42/c2man-2.0/* from ftp.iij.ad.jp Patches: ftp pub/netnews/sources.bugs/volume93/sep/c2man* from lth.se 4. Jim Roskind's yaccable C++ grammar is available via ftp from ics.uci.edu in the ftp/pub directory as: c++grammar2.0.tar.Z byacc1.8.tar.Z 5. c2man's copyright requires that all derivative works remain freely available. ================================================================================ Archive-Date: Tue, 23 Aug 1994 15:37:45 CDT Sender: owner-litprog@SHSU.edu From: hnguyen1@csupomona.edu (WHAT'S MY NAME) Reply-To: LitProg@SHSU.edu, hnguyen1@CSUPOMONA.EDU Subject: FOXPRO 2.6 FOR DOS Date: 23 Aug 94 13:33:15 PST Message-ID: <1994Aug23.133315.1@clstac> To: LitProg@SHSU.EDU -- Help Help Help! I need some good reference book on programming in FOXPRO. and/or need an address where I can download some related sample on FOXPRO. Please send an email to this address with the suggestion. Thank you very much. --- Email: hnguyen1@csupomona.edu ================================================================================ Archive-Date: Wed, 24 Aug 1994 00:07:20 CDT Sender: owner-litprog@SHSU.edu From: mueller@biologie.uni-oldenburg.de (Arne Mueller) Reply-To: LitProg@SHSU.edu, mueller@BIOLOGIE.UNI-OLDENBURG.DE Subject: Need faq about standard-algorithms Date: Tue, 23 Aug 1994 13:00:09 GMT Message-ID: To: LitProg@SHSU.EDU Hi there, I search some faqs about standard-algorithms and programming in Pascal( graphics, statistics,...) , if you know a site where to get infos about Pascal, please mail me (mueller@biologie.uni-oldenburg.de) Thanks Arne ;) ================================================================================ Archive-Date: Wed, 24 Aug 1994 22:05:30 CDT Sender: owner-litprog@SHSU.edu From: cybersf@netcom.com (Scott Fraley) Reply-To: LitProg@SHSU.edu, cybersf@NETCOM.COM Subject: Re: DLLs, C++, and Visual Basic Message-ID: Date: Thu, 25 Aug 1994 02:34:32 GMT To: LitProg@SHSU.EDU In article , Stephane Rainville wrote: : We want to write a DLL file in C++ to and call one of its subroutines : in a Visual Basic programm. : in the general procedure, as well as the sub we want. However, when we : call the subroutine, Visual Basic doesn't seem to think it's defined. First, let me say that I have never even played with VB before, but I have done C++ and read stuff. The problem could be that VB can't call a C++ function because of the "name mangling" the C++ compiler does. You will probably have better luck if you write a 'plain C' front end (calling function) which could then call the C++ function for you and be called from VB. This way, your function(s) could be called from C++ apps (via the C++ interface) and VB through the plain C interface. -- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ /-- | | | --- /-- /-- |-- @netcom.com ``Party On Dudes" | \/ |--\ --- | \-\ |- @aol.com Bill & Ted. \-- | |--/ --- | --/ | ( Scott Fraley ) ================================================================================ Archive-Date: Thu, 25 Aug 1994 14:44:39 CDT Sender: owner-litprog@SHSU.edu From: rohan@nmrc.ucc.ie (Michael Rohan) Reply-To: LitProg@SHSU.edu, rohan@NMRC.UCC.IE Subject: Defining X Application Resources with FWEB Date: 25 Aug 1994 19:16:30 GMT Message-ID: <33iqme$o8t@durban.nmrc.ucc.ie> To: LitProg@SHSU.EDU Hello, I am writing an X (Motif) application using FWEB and I would like to find out other people handle X resource files. Currently I define an output file for the resources and then define the resources as they arise. For example, the following is the overall definition of the resource file: @*1 Resources. The X resources used by the help system are written to the file ``Help.ad': @a @o Help.ad @ With resources being gathered by the ``Resources for the help system'' module: @ For the File pulldown menu, the following are reasonable resources: @= @=*HelpShell*File.labelString: File@>@; @=*HelpShell*Save.labelString: Save ...@>@; @=*HelpShell*Close.labelString: Close@>@; I am using verbatim text for the resources and the output file needs some post-processing (removal of FWEB info). Is this the best way of doing something like this? Or, has someone a better solution? Thanks in advance, Michael. -- Michael Rohan, rohan@nmrc.ucc.ie NMRC, Cork, Ireland. +353-21-276871 x 4792 ================================================================================ Archive-Date: Sat, 27 Aug 1994 05:17:04 CDT Sender: owner-litprog@SHSU.edu From: luke@svpal.org (Luther Welsh Jr) Reply-To: LitProg@SHSU.edu, luke@SVPAL.ORG Subject: Preparing for takeoff Date: 27 Aug 1994 02:27:21 -0700 Message-ID: <33n0tp$oc7@svpal.svpal.org> To: LitProg@SHSU.EDU I'm an experienced C programmer simultaneously migrating to C++ and DOS/Windows from VAX/VMS. I figured that I might as well do it right, so I've decided to learn LP, too. I'm all ready to go, FAQ in hand: MS C/C++ 7.0 Software Developement Kit 3.1 MS Word 6.0 (MS Office 4.2) CLiP v??, from ftp.shsu.edu Any final words of advice/encouragement/warning before I take the plunge? In particular, are the any CLiP Word C/C++ examples out there other than what I might find via the FAQ? Best regards, Luke "I don't even know MS Word" Welsh +--------------------+ .-. .- -.. .. --- .- -.-. - .. ...- .. - -.-- + | Luke Welsh | "Ich bin Ihr Diener und Ihr Herr zugleich" | | luke@svpal.org | <"I am both your servant and your master"> | | Mersenne@aol.com | Kraftwerk, The Voice Of Energy | +--------------------+... --- ... ... --- ... ... --- ... ... --- ...+ -- ================================================================================ Archive-Date: Sun, 28 Aug 1994 08:47:16 CDT Sender: owner-litprog@SHSU.edu From: thompson@sun1.coe.ttu.edu Subject: comp.programming.literate FAQ Date: 28 Aug 1994 13:40:17 GMT Message-ID: Reply-To: LitProg@SHSU.edu, thompson@sun1.coe.ttu.edu To: LitProg@SHSU.EDU Archive-name: literate-programming-faq Last-modified: 1994/08/23 Version: 1.1.10 Welcome to the Literate Programming Frequently Asked Questions List ------------------------------------------------------------------- This version was created Tuesday, August 23, 1994, and should considered stale after 90 days. Information contained in this document is the best available at preparation. The original file was dated October 15, 1993 (just for historical purposes). Disclaimer: "This FAQ is presented with no warranties or guarantees of ANY KIND including correctness or fitness for any particular purpose. The author of this document has attempted to verify correctness of the data contained herein; however, slip-ups can and do happen. If you use this data, you do so at your own risk." Copyright 1993, 1994 David B. Thompson. All rights reserved worldwide. Permission is granted to copy this document for free distribution so long as it remains intact and unmodified. For other arrangements, contact the author/maintainer via email: thompson@sun1.coe.ttu.edu. What's New? ----------- + Add Fold2Web entry. + Correct noweb.el entry. (Thanks Dominique!) + Update nuweb.el entry. + Update SchemeWEB entry. + Update WWW and literate programming entry. + Update c2cweb entry. = ====================================================================== * Introduction or "What's this all about?" ------------------------------------------ This document is for new and experienced users of literate programming tools. The purpose is to explain the concept of literate programming and to provide a resource for locating files of interest to literate programmers and those interested in literate programming. The Literate Programming (LitProg) Frequently Asked Questions (FAQ) list is maintained by Dave Thompson, who can be reached at: thompson@sun1.coe.ttu.edu * Preferred mailing address for FAQ related comments/questions. wqdbt@ttacs1.ttu.edu * Forwarded to my pc. Comment and constructive criticism is welcome. Direct flames to /dev/null (or > nul if you're a msdos user! ;-) If you find an error, please report it. I'm particularly interested in establishing the locations of generally available literate programming tools. If you are the author of such a tool and wish to have it included in this list, please send email. Please note this is a work-in-progress. It is *not* complete, and probably will not be complete for some months. Nevertheless, the information contained herein may be useful to some. Use it as it is intended. - ---------------------------------------------------------------------- - Typography ------------ Major sections of the FAQ are divided by double lines (====). Minor sections and other divisions are separated by single lines (----). Major topics use a "* " as a leader. Minor topics use a "- " as a leader. This should simplify searching for topics. = ====================================================================== Table of Contents: ------------------ * Introduction, or "What's this all about?" - Typography * How do I get the FAQ? - Literate Programming FAQ - FWEB FAQ * Is there a newsgroup? (The comp.programming.literate newsgroup) * What internet nodes are of interest to literate programmers? * What is literate programming? * How do I begin literate programming? * What literate programming tools are available and where are they? - APLWEB - AWEB - CLiP - CWEB - FunnelWeb - FWEB - IMPACT - lit2x - Literate Programmer's Workshop (LPW) - MapleWEB - MWEB (Schrod/Detig) - MWEB (Sewell) - noweb - nuweb - ProTeX - RWEB - SchemeWEB - Spidery WEB - WEB - WinWordWEB * Are there other tools I should know about? - C2LaTeX - c2cweb - c2man - cnoweb - Fold2web - FunnelWeb mode - noweb.el - nuweb.el - TIE - Web mode * What other resources are available? - World Wide Web - TeX Resources - Virtual Coursework * Are there any code examples? - Examples included with developer's tools - Cameron Smith's KR-CWEB - Stanford GraphBase * Bibliographies. * How to anonymously ftp. * Acknowledgements. * End notes. = ====================================================================== * How do I get the FAQ? ----------------------- - Literate Programming FAQ -------------------------- You have many ways to get a current copy of this FAQ. One is to use anonymous ftp (if you don't know how, see a later section in this FAQ) to connect to one of the Comprehensive TeX Arvchive Network (CTAN) sites or the Literate Programming Archive and retrieve a copy of the file. Open an ftp connection to one of the CTAN sites and retrieve the file: help/LitProg-FAQ (For more information on CTAN and the literate programming archive, see the section below entitled "Internet Nodes of Interest to Literate Programmers.") An alternative is to use the fileserver at Sam Houston State University (SHSU). Send a message to FILESERV@SHSU.EDU and include in your message: SENDME LITPROG.FAQ The file server will forward a copy of the file to you via email. - ---------------------------------------------------------------------- - FWEB FAQ ---------- Marcus Speh maintains the FWEB FAQ. The current version number is 1.29. It can be retrieved in the same way as this FAQ; either by anonymous ftp or through the SHSU file server. On the SHSU server, the file name is FAQ.FWEB. Invoke your ftp software, open a connection to NIORD.SHSU.EDU [192.92.115.8], attach to the directory FAQ, and transfer the file FAQ.FWEB. Alternatively, send a message to the file server, FILESERV@SHSU.EDU, and include the following text in a one line message: SENDME FAQ.FWEB The file server will send the current version of the file via email. The FWEB FAQ exists in various formats, including HyperText (see other resources below). In Europe, the complete distribution can also be obtained from ftp.desy.de [131.169.10.115] in directory /pub/faq/web/fweb/. It is also available from the literate programming archive (LPA) in the directory LPA/Documentation/faq/fweb (see the references to LPA below for more information). Also, Marcus Speh is looking for someone willing to take over the FWEB FAQ. The text of his email message follows... "Please add to the FWEB FAQ the note that I am looking for someone to take the maintenance of the FAQ over - I am ready to assist in any way whatsoever, including tons of mail, notes for v1.29->v1.30, Texinfo sources, a WWW server and Hypertextification etc." If you're interested, send mail to marcus@x4u2.desy.de and express your willingness to serve. = ====================================================================== * Is there a newsgroup? ----------------------- One of the most important resources is the literate programming newsgroup, comp.programming.literate. You can read this newsgroup using your standard reader. Altenatively, the newsgroup is gated to a mailing list hosted by George Greenwade and Sam Houston State University. You can subscribe by sending mail to the list-server, LISTSERV@SHSU.EDU, and include in the message one line of text: SUBSCRIBE LITPROG "your name in quotes" The list is unmoderated; messages sent to litprog@shsu.edu are automatically distributed to all subscribers and cross-posted to comp.programming.literate. Archives of the mailing list and newsgroup are maintained on niord.shsu.edu [192.92.115.8] in the directory litprog. = ====================================================================== * What internet nodes are of interest to literate programmers? -------------------------------------------------------------- The principal nodes of interest to literate programmers are the Literate Programming Archive (LPA hereafter) and the CTAN (Comprehensive TeX Archive Network). The Literate Programming Archive (LPA) is: Node: ftp.th-darmstadt.de [130.83.55.75] Directory: programming/literate-programming Notes: Fastest response during off-U.S. [yep] business hours. The CTAN sites are: ftp host IP CTAN root Institution and Sponsor ------------------------------------------------------------------------- ftp.tex.ac.uk 134.151.79.32 pub/archive Aston Univ./UK TeX U.G. ftp.dante.de 129.206.100.192 soft/tex DANTE e.V. ftp.shsu.edu 192.92.115.10 tex-archive Sam Houston State Univ. Other nodes and directories of interest include: Node: niord.shsu.edu [192.92.115.8] Directory: various (do some snooping!) Notes: Has a gopher server. Node: ftp.desy.de [131.169.10.115] Directory: pub/web. Various documents, samples, and the FWEB FAQ. Notes: Has a www server, http://info.desy.de:80/ = ====================================================================== * What is Literate Programming? ------------------------------- Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings. In fact, literate programs should be enjoyable reading, even inviting! (Sorry Bob, I couldn't resist!) In general, literate programs combine source and documentation in a single file. Literate programming tools then parse the file to produce either readable documentation or compilable source. The WEB style of literate programming was created by D.E. Knuth during the development of his TeX typsetting software. All the original work revolves around a particular literate programming tool called WEB. Knuth says: The philosophy behind WEB is that an experienced system programmer, who wants to provide the best possible documentation of his or her software products, needs two things simultaneously: a language like TeX for formatting, and a language like C for programming. Neither type of language can provide the best documentation by itself; but when both are appropriately combined, we obtain a system that is much more useful than either language separately. The structure of a software program may be thought of as a web that is made up of many interconnected pieces. To document such a program we want to explain each individual part of the web and how it relates to its neighbours. The typographic tools provided by TeX give us an opportunity to explain the local structure of each part by making that structure visible, and the programming tools provided by languages such as C or Fortran make it possible for us to specify the algorithms formally and unambigously. By combining the two, we can develop a style of programming that maximizes our ability to perceive the structure of a complex piece of software, and at the same time the documented programs can be mechanically translated into a working software system that matches the documentation. Another author (Eric W. van Ammers) wrote me a short article treating his opinions on literate programming. The text follows: First observation on LP About 90% of the disussion on this list is about problems with applying some WEB-family member to a particular programming language or a special documentation situation. This is ridiculous, I think. Let me explain shortly why... Lemma 1: I have proposed for many years that programming has nothing to do with programming langauges, i.e. a good programmer makes good programs in any language (given some time to learn the syntax) and a bad programmer will never make a good program, no matter the language he uses (today many people share this view, fortunately). Lemma 2: Literate Programming has (in a certain way not yet completely understood) to do with essential aspects of programming. Conclusion 1: A LP-tool should be independent of programming language. Lemma 3: It seems likely that the so called BOOK FORMAT PARADIGM [ref. 1] plays an important role in making literate programs work. Lemma 4: There are very many documentation systems currently being used to produce documents in the BOOK FORMAT. Conclusion 2: A LP-tool should be independent of the documentation system that the program author whishes to use. My remark some time ago that we should discuss the generic properties of an LP-tool was based on the above observation. References: [1] Paul W. Oman and Curtus Cook. Typographical style is more than cosmetic. CACM 33, 5, 506-520 (May 1990) Second observation on LP The idea of a literate program as a text book should be extendend even further. I would like to see a literate program as an (in)formal argument of the correctness of the program. Thus a literate program should be like a textbook on mathematicics. A mathematical textbook explains a theory in terms of lemma and theorems. But the proofs are never formal in the sense that they are obtaind by symbol manipulation of a proof checker. Rather the proofs are by so called "informal rigour", i.e. by very precise and unambiguous sentences in a natural language. Eric W. van Ammers Department of Computer Science Wageningen Agricultural University Dreijenplein 2 E-mail: ammers@rcl.wau.nl 6703 HB Wageningen voice: +31 (0)8370 83356/84154 The Netherlands fax: +31 (0)8370 84731 = ====================================================================== * How do I begin literate programming? -------------------------------------- A recommended book is D.E. Knuth's collection of articles (1992) "Literate Programming," Center for the Study of Language and Information, Stanford University, ISBN 0-937073-80-6 (pbk). This book gives insight into Knuth's thoughts as he developed the web system of literate programming (and TeX for typesetting). It does not document methods for literate programming. A recommended book is Wayne Sewell's (1989) "Weaving a Program: Literate Programming in WEB," Van Nostrand Reinhold, ISBN 0-442-31946-0 (pbk). This book focuses on using Knuth's web system. Some talk exists in the newsgroup/mailing list for a Usenet University course in literate programming. I'm sure discussion of this topic will be welcomed. If you are interested, please participate. = ====================================================================== * What literate programming tools are available and where are they? ------------------------------------------------------------------- A significant number of tools for literate programming are available. Most have been ported from their original systems, so support multiple computer platforms. If you are the developer of such a tool, and would like to make the software freely available, please send me email and I'll reply with a form (like those below) for you to fill in. (Or short-circuit the process and kludge a form from below. :-) - ---------------------------------------------------------------------- - APLWEB -------- Developer: Christoph von Basum Version: Unknown Hardware: MSDOS Languages: IBM APL2 and STSC APL Formatter: Plain TeX Availability: Anonymous ftp from: LPA:/apl watserv1.uwaterloo.ca:/languages/apl/aplweb Readme: Unknown Description: None available. Support: Unknown Note: The status of this particular package is unknown. - ---------------------------------------------------------------------- - AWEB ------ Developer: Unknown Version: Unknown Hardware: Unknown Languages: Ada Formatter: Unknown Availability: Anonymous ftp from: LPA:/ada/web Readme: Unknown Description: None available Support: Not supported. - ---------------------------------------------------------------------- - CLiP ------ Developer: E.W. van Ammers and M.R. Kramer Version: Unknown Hardware: Vax/VMS, Unix, and MS-DOS Languages: Any programming language. Formatter: Any formatter (TeX, LaTeX, Troff, Runoff, etc) or any wordprocessor including WYSIWYG systems (Word Perfect, Win Word, Ami Pro, Word, etc.) Availability: Anonymous ftp from: sun01.info.wau.nl:/CLIP/ms_dos MS-DOS version sun01.info.wau.nl:/CLIP/vax_vms VAX/VMS version CTAN:/web/clip LPA:/machines/ms-dos LPA:/machines/vax Readme: With bundle above Description: CLiP does not use explicite commands to perform the extraction process. Rather it recognizes pseudostatemens written as comments in the programming language in question. CLiP distinguishes pseudostatments from ordinary comments because the former comply with a a particular style. This style can be adjusted to suit virtually any programming language. The CLiP approach to LP makes the system extremely versatile. It is independent of programming language and text processing environment. We designed CLiP to be compatible with hypertext systems as well but we have not yet experimented with this form of documentation. Features: + CLiP imposes virtually no limitations on the text-processing system used to produce the documentation. If the text-processor supports these items you can + structure the documentation according to your own taste. + include drawings, pictures, tables etc. + disclose your documentatio my means of X-ref tables, Indexes, Table of contents, Table of tables, Table of figures, etc. + typeset the documented code. + Extracts any number of modules from a maximum of 64 source files. + No pretty-printing. Code from the source files is copied "as is" to the module. + Appearance of code segments in the documentation matches those of the modules to ease the identification of code segements. + Supports partially specified data types. + Comprehensive user manual (preliminary version) and technical description. - No automatic generation of a X-ref table for program identifiers. Support: Bugs, problems and assistance by e-mail: ammers@rcl.wau.nl - ---------------------------------------------------------------------- - CWEB ------ Developer: Silvio Levy and D.E. Knuth Version: 3.0 Hardware: Unix systems (dos and amiga ports available) Languages: C and C++ Formatter: Plain TeX and LaTeX. Availability: Anonymous ftp from: labrea.stanford.edu:/pub/cweb LPA:/c.c++ CTAN:/web/c_cpp/cweb DOS version in CTAN:/web/c_cpp/cwb30p8c DOS version in LPA:/machines/ms-dos Amiga version CTAN:/web/c_cpp/AmigaCWEB Mac port of CTANGLE in LPA:/machines/mac LaTeX support in LPA:/c.c++ Readme: Bundled with above Description: No description provided. Support: Bugs to levy@math.berkeley.edu Note: A fork of CWEB 3.x was developed by Marc van Leeuwen which implements several changes to CWEB. It is available for anonymous ftp from ftp.cwi.nl:pub/cweb. The principle changes are: - Scans include files for typedef definitions - Grammar and formatting rules are well separated, allowing for run-time selection of a rule set (via command line option) - New manual. - ---------------------------------------------------------------------- - FunnelWeb ----------- Developer: Ross N. Williams: ross@guest.adelaide.edu.au Version: Unknown Hardware: MSDOS, Mac, VMS, Sun. Other ports reported. Languages: No restrictions. Formatter: Plain TeX for printing. Otherwise, no restrictions. Availability: Anonymous ftp from: CTAN:/web/funnelweb LPA:/independent ftp.adelaide.edu.au:/pub/funnelweb Readme: With bundle above. Description: FunnelWeb is a production-quality literate-programming tool that emphasises simplicity and reliability. Everything about FunnelWeb, from the simplicity of its language to the comprehensive tutorial in the user's manual, has been designed to make this as simple, as practical, and as usable a tool as possible. Features: + Provides a simple macro preprocessor facility. + Can produce typeset documentation. + Runs on Sun, VMS VAX, Macintosh, PC, and others. + Portable C source code distributed under GNU licence. + Comprehensive user's manual including tutorial. + Programming-language independent. + Can generate multiple output files. + Allows complete control over the output text. + Regression test suite with over 200 tests. + Fully worked example (in /pub/funnelweb/examples). - Requires TeX to produce typeset documentation. - Typesets program code using TT font only. Support: No formal support available. Mailing list maintained with about 50 subscribers. Informal assistance available from mailing list. - ---------------------------------------------------------------------- - FWEB ------ Developer: John A. Krommes Version: 1.30a (1.40 for the experienced, patient, and brave) Hardware: Unix, VMS, and DOS platforms (anything with ANSI C) Languages: C, C++, Fortran-77, Fortran-90, Ratfor, TeX; also, a language-independent mode. Formatter: Plain TeX and LaTeX. Availability: Anonymous ftp from: ftp.pppl.gov:/pub/fweb CTAN:/web/fweb LPA:/fweb DOS version in LPA:/machines/ms-dos Readme: In bundle with above. Description: It also has a well-developed user's manual and its own FAQ (see above). Beginning with 1.40, documentation is maintained in gnu texinfo format. It runs on most platforms: VMS, PC, UNIX, and pretty much anything that the GNU C compiler (GCC) is supported for. Features: + Processes multiple languages during a single run (so one can mix C and Fortran, for example). + Language-independent mode (v1.40). + Ability to turn off pretty-printing (v1.40). + Built-in Ratfor translator. + Built-in macro preprocessor (closely follows ANSI C, with extensions). + A style file that allows the user to adjust many parameters and behavior patterns of FWEB. + Various operator-overloading features that provide additional pretty-printing capabilities to languages such as C++ and Fortran-90. + Numerous miscellaneous features and command-line options. Support: Bug reports and suggestions to krommes@princeton.edu - ---------------------------------------------------------------------- - IMPACT -------- Developer: Timothy Larkin, from Levy/Knuth CWEB 3.1 Version: 1.0 Hardware: Macintosh; requires AppleEvents. Languages: C, C++ Formatter: TeX Availability: CTAN archives Readme: A short readme file is included in the SEA archive. Description: IMPACT implements CTangle from the Levy/Knuth CWEB 3.1. It operates as a foreground program, tangling files selected from the Mac File Picker. Or it can operate in the background, tangling files in response to odoc events sent by other applications, such as editors. Support: I welcome any reports of bugs. The product will be updated as new versions of the CWEB appear. Other features may be added as users suggest them. - ---------------------------------------------------------------------- - lit2x ------- Developer: Unknown Version: Unknown Hardware: Unknown Languages: Unknown Formatter: Unknown Availability: Anonymous ftp from: LPA:/independent Readme: Unknown Description: None available Support: Unknown - ---------------------------------------------------------------------- - Literate Programmer's Workshop (LPW) -------------------------------------- Developer: Norbert Lindenberg Version: 1.1 Hardware: Apple Macintosh Languages: C++, Object Pascal & others Formatter: self-contained WYSIWYG system Availability: Anonymous ftp from: LPA:/machines/mac CTAN:/web/lpw ftp.apple.com:/pub/literate.prog Readme: With bundle above. Also comes with 38-page manual. Description: The Literate Programming Workshop is an environment for the integrated development of program source text and documentation in combined documents. It consists of a WYSIWYG word processor based on a style sheet approach, a mechanism to extract parts of the text in a document, and a project management system that handles multi-document projects. The system is designed to be used in conjunction with the Macintosh Programmer's Workshop: it prepares raw source text for the MPW compilers, accepts MPW error messages, and shows them in the context of the original documents. Automatic indexing and hypertext features allow for easy access to both source text and documentation. LPW is shareware. Support: Bugs, problems, and questions to lpw@aol.com. - ---------------------------------------------------------------------- - MapleWEB ---------- Developer: Unknown Version: Unknown Hardware: Unknown Languages: Maple Formatter: Unknown Availability: Anonymous ftp from: LPA:/maple Readme: Unknown Description: None Support: Unknown - ---------------------------------------------------------------------- - MWEB (Schrod/Detig) --------------------- Developer: Joachim Schrod Version: Unknown Hardware: Unknown Languages: Modula-2 Formatter: Unknown Availability: Anonymous ftp from: LPA:/modula-2 Readme: Unknown Description: None Support: Not supported. - ---------------------------------------------------------------------- - MWEB (Sewell) --------------- Developer: Sewell Version: Unknown Hardware: Unknown Languages: Modula-2 Formatter: Unknown Availability: Anonymous ftp from: LPA:/modula-2 Readme: Unknown Description: None Support: Not supported. - ---------------------------------------------------------------------- - noweb ------- Developer: Norman Ramsey Version: 2.6 Hardware: Unix and DOS platforms. Languages: All programming languages. Formatter: Plain TeX, LaTeX, and HTML (Mosaic) formatters. Availability: Anonymous ftp from: CTAN:/web/noweb LPA:/independent DOS version also in LPA:/machines/ms-dos also bart.kean.edu:/pub/leew Last recourse, use bellcore.com:/pub/norman Readme: With bundle above. Description: noweb is designed to meet the needs of literate programmers while remaining as simple as possible. Its primary advantages are simplicity, extensibility, and language-independence. noweb uses 5 control sequences to WEB's 27. noweb now supports indexing and identifier cross-reference, including hypertext ``hot links'' courtesy of Mosaic. The simple noweb manual is only 2 pages; documenting the full power of noweave and notangle requires another 3 pages. noweb works ``out of the box'' with any programming language, and its formatter-dependent part is a 60-line nawk program. The primary sacrifice relative to WEB is the loss of prettyprinting. Support: email to the author - ---------------------------------------------------------------------- - nuweb ------- Developer: Preston Briggs: preston@cs.rice.edu Version: 0.87 Hardware: Unix systems: Sparcs, RS/6000s, HPs; (!) MSDOS and Amiga. Languages: Any programming language or combination of programming languages. Formatter: Latex Availability: Anonymous ftp from: Unix: CTAN:/web/nuweb DOS: CTAN:/web/nuweb-pc LPA:/independent Amiga: CTAN:/web/nuweb/nuweb_ami Amiga: wuarchive.wustl.edu/pub/aminet Readme: Send mail to preston@cs.rice.edu Description: A single program that takes a web file written in a combination of latex and any programming language(s) and produces a latex file that can be pretty printed and a set of files containing code for compilation/interpretation by the appropriate language processors. Strengths include speed, simplicity, multiple languages, nice indices and cross-references, latex. Doesn't require any special macros or macro files. Drawbacks: latex-dependent, no code pretty printing, harder to make indices than cweb. More good stuff: nice support for make, doesn't reformat source files, so they're easy to debug. Lots of control without too much effort. That is, it doesn't do too much! Future directions... Very little change planned, except perhaps refinements in the indexing software. Support: Hack it yourself or send e-mail to preston@cs.rice.edu - ---------------------------------------------------------------------- - ProTeX -------- Developer: Eitan Gurari Version: 1.1 (AlProTeX 1.2) Hardware: Any platform with TeX (ProTeX is written in TeX) Languages: Any language Formatter: TeX and LaTeX Availability: Anonymous ftp from: ftp.cis.ohio-state.edu : pub/tex/osu/gurari/ LPA:/independent Readme: Unknown Description: There is a book published on using ProTeX, @Book{Gurari:TLD94, author = "Eitan M. Gurari", title = "{\TeX} and {\LaTeX}: Drawing and Literate Programming", publisher = pub-MH, year = "1994", address = pub-MH:adr, bibdate = "Wed Sep 29 17:55:14 1993", acknowledgement = ack-nhfb, } Support: gurari@cis.ohio-state.edu - ---------------------------------------------------------------------- - RWEB ------ Developer: Unknown Version: Unknown Hardware: Unknown Languages: Unknown Formatter: Unknown Availability: Anonymous ftp from: LPA:/reduce Readme: Unknown Description: Web generator in AWK. Support: Unknown - ---------------------------------------------------------------------- - SchemeWEB ----------- Developer: John D. Ramsdell Version: 2.1 Hardware: Unix and DOS platforms Languages: Any dialect of Lisp. Formatter: LaTeX. Availability: The Unix version is in the Scheme Repository and it is available via anonymous ftp from: cs.indiana.edu:/pub/scheme-repository/utl/schemeweb.sh LPA:/lisp CTAN:/tex-archive/web/schemeweb The DOS version is part of the PCS/Geneva Scheme system which is available via anonymous ftp from: cui.unige.ch:/pub/pcs LPA:/machines/ms-dos Readme: In bundle with above. Description: SchemeWEB is a Unix filter that allows you to generate both Lisp and LaTeX code from one source file. The generated LaTeX code formats Lisp programs in typewriter font obeying the spacing in the source file. Comments can include arbitrary LaTeX commands. SchemeWEB was originally developed for the Scheme dialect of Lisp, but it can easily be used with most other dialects. Support: Bug reports to ramsdell@mitre.org. - ---------------------------------------------------------------------- - SpideryWEB ------------ Developer: Norman Ramsey Version: Unknown Hardware: Unix and DOS platforms Languages: Most Algol-like languages, including C, Ada, Pascal, Awk, and many others. Formatter: Plain TeX and latex for text formatters. Availability: Anonymous ftp from: CTAN LPA:/spiderweb Readme: In distribution. Description: A system for building language-dependent WEBs. Spider is frozen; no further development is planned. Support: Bug reports to spider-bugs@oracorp.com. - ---------------------------------------------------------------------- - WEB ----- Developer: Donald Knuth Version: Unknown Hardware: Unknown Languages: Pascal Formatter: TeX (of course! ;-) Availability: Anonymous ftp from: LPA:/pascal Readme: Unknown Description: This is the original software that started it all. The original TeX processor was written in WEB. Support: None known. - ---------------------------------------------------------------------- - WinWordWEB ------------ Developer: Lee Wittenberg Version: Unknown Hardware: Needs Microsoft Word for Windows, v.2.x, and, of course, MS-Windows 3.x. Languages: Any programming language. Formatter: Word for Windows 2.x for text formatting and file maintenance. Availability: Anonymous ftp from: bart.kean.edu:pub/leew LPA:/machines/ms-dos World-Wide Web (WWW) Readme: WORDWEB.DOC in the downloadable package describes the system. Description: WinWordWEB is a set of a Word for Windows macros (plus a paragraph style) that provide a crude literate programming environment. The ``look and feel'' of the system is based on Norman Ramsey's noweb, but can easily be modified to suit individual tastes. Support: None. WinWordWEB was written as a prototype to see if a WYSIWYG literate programming system was possible. It is intended as a jumping off point for future work by others. However, the system is surprisingly usable as it stands, and the author is interested in hearing from users (satisfied and dissatisfied). Anyone interested in actively supporting (and improving) the product should contact the author via email. = ====================================================================== * Are there other tools I should know about? -------------------------------------------- First of all, I'll list some not-quite-literate-programming tools. Some may consider these to be pretty-printers. Others may call them literate programming tools. In any event, they don't seem to be quite in the same category as the tools listed above, so I'll include them here. - C2LaTeX --------- Developer: John D. Ramsdell Version: Unknown Hardware: Unix Languages: C Formatter: LaTeX but it's easy to change the formatter. Availability: Anonymous ftp from omnigate.clarkson.edu:/pub/tex/tex-programs/c2latex. Readme: Absent. Documentation is in the C source for c2latex. Description: C2latex provides simple support for literate programming in C. Given a C source file in which the comments have been written in LaTeX, c2latex converts the C source file into a LaTeX source file. It can be used to produce typeset listings of C programs and/or documentation associated with the program. C2latex produces LaTeX source by implementing a small number of rules. A C comment that starts at the beginning of a line is copied unmodified into the LaTeX source file. Otherwise, non-blank lines are surrounded by a pair of formatting commands (\begin{flushleft} and \end{flushleft}), and the lines are separated by \\*. Each non-blank line is formatted using LaTeX's \verb command, except comments within the line are formatted in an \mbox. Support: Send bug reports to ramsdell@mitre.org. - ---------------------------------------------------------------------- - c2cweb -------- Developer: Werner Lemberg Version: 1.4 Hardware: DOS, OS/2, Unix (gcc) - CWEB source included Languages: C, C++ Formatter: TeX Availability: Anonymous ftp from CTAN:/web/c_cpp/c2cweb Readme: In distribution. Description: c2cweb will transform plain C or C++ code into a CWEB file to get a pretty formatted output. A modified CWEAVE (which transforms the CWEB file into a TeX file, see below) is included also. Support: Werner Lemberg - ---------------------------------------------------------------------- - c2man ------- Developer: Graham Stoney Version: 2.0 patchlevel 26 Hardware: Unix, MSDOS, OS/2. Languages: C Formatter: nroff -man, texinfo (requires yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX). Availability: Anonymous ftp from ftp.wustl.edu: /usenet/comp.sources.reviewed/volume03/c2man* ftp.informatik.uni-stuttgart.de: /pub/archive/comp.sources/reviewed/c2man* Readme: See distribution. Description: The primary philosophy here is to use the programming language as far as possible to express the programmer's intentions, and to use comments only when the programming language is not sufficiently expressive. A comment can then become part of the language grammar which is recognised by a "documentation compiler". This tool parses a superset of the programming language and can automatically generate documentation in human-readable form by associating the programmer's comments with the objects in the code by their context. Support: Actively supported; mailing list available: send "subscribe c2man " (in the message body) to listserv@research.canon.oz.au. - ---------------------------------------------------------------------- - cnoweb -------- Developer: Jim Fox Version: 1.4 (January 4, 1991) Hardware: Anything with C and TeX. Languages: C Formatter: Plain TeX. Availability: Anonymous ftp from: CTAN LPA:/c.c++ Readme: Unknown, cnoweb.tex contains documentation. Description: cnoweb is as it's name describes: write C, not web. No tangling or weaving is implemented. Documentation (between standard /* */ delimiteres) is written in TeX. cnoweb provides typesetting of documentation, an table of contents of routines, and pretty-printing of C source. Support: None known. - ---------------------------------------------------------------------- - Fold2Web ---------- Developer: Bernhard Lang Version: V0.8 Hardware: MSDOS Languages: All (must allow comment lines) Formatter: LaTeX Availability: Anonymous ftp from: kirk.ti1.tu-harburg.de (134.28.41.50) /pub/fold2web/readme /pub/fold2web/fold2web.zip Readme: In distribution Description: The idea behind the Fold2Web tool is the following: A programmer can write his program source with a folding editor and later map the folded source files automatically to WEB-files. The generated WEB-files can then be modified by inserting required documentations. The advantage by starting program developement with original sources is to get short design cycles during the compile/debug steps. By using a folding editor the global structuring information can be already captured in folds during this developement phase. Fold information is typically stored in comment lines and thus will not affect the efficiency of the compile/debug design cycle. Some folding editors and a folding mode for the emacs are available (e.g. see our FUE folding editor for MSDOS machines which is a modified micro emacs. Pick it at kirk in directory /pub/fold2web). After reaching a stable version of a program source its time to convert the source file to a WEB-file and do the program documentation. Fold2Web is written to convert folded source text of any programming language to nuweb files. The folded structure is kept by mapping folds to scraps. Fold markers which differ between languages due to different ways of specifying comments can be configured for each language. Good results can also achived when given but poor documented program sources have to be modified. Such sources can be folded using a folding editor to extract the global structures. This offers a global view to the program structures and help to understand its functionality. Furthermore the program code is not affected, only comment lines are inserted. Once folded the program source can be automatically translated to a WEB document using the above tool. Support: email to lang@tu-harburg.d400.de - ---------------------------------------------------------------------- - Funnelweb Mode ---------------- Developer: Daniel Simmons Version: Unknown Availability: Litprog archives (was in email) Anonymous ftp from: ftp.imada.ou.dk Description: The other day I did a quick hack to nuweb.el as included with the nuweb distribution so as to make a funnelweb-mode.el. I've only used it briefly, and I'm sure that it can be improved quite a bit. I've been thinking about adding support for folding on sections, a pull-down menu to select macro definitions (like the recent functions posted to gnu.emacs.sources for a C function definition pull-down menu) and some kind of tags support for funnelweb. Support: Unknown - ---------------------------------------------------------------------- - noweb.el ---------- Developer: Bruce Stephens Version: Unknown. Availability: LitProg archives (in an email message). Description: This is a very simple mode I just hacked up. There's a lot wrong with it, but I thought others may be interested, even as it stands. It *requires* text properties, and assumes those used in GNU Emacs 19.22; it'll quite likely work with Lucid Emacs, but I haven't tried it. I use it with auctex8.1 and cc-mode 3.229, both of which are loaded separately (I think my emacs is dumped with them, in fact). The idea is to have one mode (which calls itself c-mode, but actually has LaTeX-mode keybindings) generally (this means that the code is hilighted nicely), and have the code chunks use a different keymap. Support: Email to bruce@liverpool.ac.uk - ---------------------------------------------------------------------- - nuweb.el ---------- Developer: Dominique de Waleffe Version: 1.99 Availability: Anonymous ftp from: LPA CTAN Description: Provides a major mode extending Auctex for editing nuweb files. Main features (in 2.0): - Edit scrap bodies in a separate buffer in a different mode (selected using emacs defaults for files, specific indication -*-mode-*-, or a buffer-local variable) - Extends Auctex commands so that nuweb is called before LaTeX, - Easy navigation on scrap definition and use points. - Now creates an imenu (C-M-mouse1) with user index entries, macro definition positions and file definition positions. Support: Email to ddw@sunbim.be - ---------------------------------------------------------------------- - TIE ----- Developer: Unknown Version: Unknown Hardware: Unknown Availability: Anonymous ftp from: LPA:/Tools Readme: Unknown Description: This software merges change files. Support: Unknown - ---------------------------------------------------------------------- - Web mode ---------- Developer: Bart Childs Version: Unknown Tools supported: web, fweb, cweb, funnelweb Availability: Anonymous ftp from ftp.cs.tamu.edu:pub/tex-web/web/EMACS.web-mode thrain.anu.edu.au:pub/web/EMACS.web-mode Description: This version works with versions 18 and 19 of Emacs to be best of my knowledge. I have cleaned up a number of documentation items ... In the same directory is wm_refcard.tex which is an edited version of the famous one to include some web-mode commands. The files limbo* are related to its use and notice that half them have an uppercase L in them for LaTeX. The setup is based upon the fact that we (I am not alone here) primarily use FWEB for C and Fortran programming. We are using version 1.40 of FWEB although John Krommes warns that it is not mature and the manual is not yet updated. The info files are! We are using LaTeX almost exclusively. That will likely change and we will revert to version 1.30 if the final form of 1.40 cannot return to the simple section numbers and avoid the HORRIBLE LATEX 0.1.7.2.4.6 type section numbers. Support: Unknown = ====================================================================== * What other resources are available? ------------------------------------- - World Wide Web ---------------- An untapped resource (by me anyway ;-) is the World Wide Web. Marcus Speh has expended considerable effort in this regard. If you're connected to WWW, then access: http://info.desy.de:80/user/projects/LitProg.html If you aren't connected to WWW, telnet to info.cern.ch and explore. You can reach Marcus' literate programming pages by typing: go http://info.desy.de:80/user/projects/LitProg.html Help for people who have only Email and neither WWW nor telnet, can be obtained by Email from TEST-LIST@INFO.CERN.CH by sending a message, SEND , for example, SEND http://info.desy.de:80/user/projects/LitProg.html to retrieve the LitProg library page. A help file can be retrieved by sending a message to the list server above with the text HELP in the body of the message. Instructions will be returned by email. For literate programming documents, you can try anonymous ftp to ftp.desy.de [131.169.10.115] and get the file: /pub/userWWW/projects/Announce/LitProg.txt - ---------------------------------------------------------------------- - TeX Resources --------------- Another resource of interest to literate programmers is the info-tex mailing list. If you're using (La)TeX as your typsetting system and have access to internet, then you should investigate this mailing list. Mail list service is available through the SHSU list-server. To subscribe, send a message to LISTSERV@SHSU.EDU, and include in the message one line of text: SUBSCRIBE INFO-TEX "your name in quotes" The list is unmoderated; messages sent to info-tex@shsu.edu are automatically distributed to all subscribers and cross-posted to comp.text.tex. Archives of the mailing list and newsgroup are maintained on niord.shsu.edu [192.92.115.8] in the directory info-tex. Another reason the TeX resources should be important is that so many of the literate programming tools rely on either plain TeX or LaTeX as their text formatter. (La)TeX software systems exist for most computing platforms. These systems can be found on CTAN and other major archive sites. Use archie to find them or simply ftp to one of the CTAN sites and browse. - ---------------------------------------------------------------------- - Virtual Coursework -------------------- Marcus Speh plans an introductory course on Literate Programming on the Internet, part of the first semester of "Global Network Academy" [GNA], a non-profit corporation incorporated in the state of Texas, affilated with the Usenet University project. The texts/sample programs for this class will be made available via the World-Wide Web. A special room on GNA Virtual Campus will be staffed by a consultant in one to two hour shifts. Students with questions can telnet to the virtual campus and ask questions of the staff there. If you are interested in registering for the course either as a student or as a consultant, please contact marcus@x4u.desy.de. You will receive a standard reply message; no further action will be taken until June 94. Interested parties can check the hypertext notes for the completed C++ Course done in a similar fashion, at URL http://info.desy.de:80/pub/uu-gna/html/cc/index.html [Editor's note: Because of workload, Marcus requests that email inquiries be limited to a statement of interest for either a student or consultant position until June 1994.] = ====================================================================== * Are there any code examples? ------------------------------ Examples of web programs are included with the FWEB, CWEB, and noweb distributions. nuweb is written in itself. Cameron Smith converted the K&R calculator program into a literate program. It can be retrieved by anonymous ftp from: niord.shsu.edu [192.92.115.8] directory kr-cweb-sample as krcwsamp.zip or from LPA/Documentation Ross Williams has released a funnelweb example. You can retrieve this file from node ftp.adelaide.edu.au [129.127.40.3] as /pub/funnelweb/examples/except.* This file should be on CTAN as well. Lee Wittenberg has posted a few litprog examples. They are available via anonymous ftp from: bart.kean.edu:/pub/leew/samples.LP The Stanford GraphBase is a large collection of programs by Don Knuth for doing all kinds of computations and games with graphs; it is written in (Levy/Knuth) CWEB. More details in the distribution. It is available via anonymous ftp from: labrea.stanford.edu:/pub/sgb = ====================================================================== * Bibliographies ---------------- Nelson Beebe has collected an extensive bibliography treating literate programming. His work is available for anonymous ftp from ftp.math.utah.edu [128.110.198.2] in directory /pub/tex/bib as files: litprog.bib litprog.ltx litprog.twx. Although I have not verified this, LPA is an alternate source for these files. Note that they are updated frequently (Nelson says several times each week), so be sure to get a fresh copy before extensive use. Joachim Schrod indicates that these files may be updated daily and can be retrieved via anonymous ftp at LPA/documentation. = ====================================================================== * How to anonymously ftp ------------------------ Pretty much everything mentioned here is available by anonymous FTP. FAQ lists cross-posted to news.answers and rec.answers can be gotten from rtfm.mit.edu [18.181.0.24], under /pub/usenet/news.answers or under /pub/usenet/more.specific.group.name "anonymous FTP" is just a way for files to be stored where anyone can retrieve them over the Net. For example, to retrieve the latest version of the literate programming FAQ, do the following: > ftp rtfm.mit.edu /* connect to the site; message follows */ > anonymous /* type this when it asks for your name */ > /* type your address as the password */ > cd /pub/usenet /* go to the directory you want to be */ > cd comp.programming.literate /* one level down (no slash). */ > dir /* look at what's there */ > get literate-progamming-faq /* get the file; case-sensitive */ > quit /* stop this mysterious thing */ If your FTP program complains that it doesn't know where the site you want to use is, type the numerical address instead of the sitename: > ftp 18.181.0.24 /* connect with numerical address */ If you don't have ftp access, send e-mail to mail-server@rtfm.mit.edu with the single word "help" in the body of the message. Getting binary files (executables, or any compressed files) is only slightly more difficult. You need to set binary mode inside FTP before you transfer the file. > binary /* set binary transfer mode */ > ascii /* set back to text transfer mode */ FAQs and spoiler lists are generally ascii files; everything else is generally binary files. Some common extensions on binary files in archive sites are: .Z Compressed; extract with uncompress .tar.Z Compressed 'tape archive'; uncompress then untar or tar -xvf .gz or .z Gnu gzip; use gunzip (available from prep.gnu.ai.mit.edu) .sit (Mac) StufIt archive .zip Extract with Zip or Unzip .zoo Yet another archive/compress program .lhe (Amiga) ? .lzh Lha archive program. .arj (PC) Arj archive program. .exe (PC) Sometimes self-extracting archives-just execute them. .uue or .UUE Transfer as text file; use uudecode to convert to binary .hqx (Mac) BinHex format; transfer in text mode Generic help can be found in the FAQs of comp.binaries. for how to transfer, extract, and virus-check binary files. (At rtfm.mit.edu) If you can't FTP from your site, use one of the following ftp-by-mail servers: ftpmail@decwrl.dec.com ftpmail@src.doc.ic.ac.uk ftpmail@cs.uow.edu.au ftpmail@grasp.insa-lyon.fr For complete instructions, send a message reading "help" to the server. If you don't know exactly what you're looking for, or exactly where it is, there are programs and servers that can help you. For more info, send e-mail to mail-server@rtfm.mit.with with the body of the message reading send usenet/news.answers/finding-sources Thanks to Aliza R. Panitz (the "buglady") for this text. I copied it verbatim from her post on faq-maintainers with only minor modifications. = ====================================================================== * Acknowledgements ------------------ This document would not have happened without the help of many people. Among them are Marcus Speh, George Greenwade, Rob Beezer, Joachim Schrod, Piet van Oostrum, and Ross N. Williams. A special thanks to Aliza R. Panitz for the text describing how to execute an anonymous ftp for files of interest. Any omissions from these acknowledgements should be considered an act of stupidity on my part. Of course, the authors of literate programming tools mentioned above all play a vital role in the vitality of literate programming. Furthermore, participants in the comp.programming.literate newsgroup (and associated mailing list) all contributed in various fashions. Thank all of you. = ====================================================================== * End notes ----------- This document will continue to evolve. I'm planning on adding entries for additional literate programming tools and will expand the sections on examples as more examples become available. Tools I will include are WEB (the original pascal version) for starters. Others will be added as I find and document them. Omission of a particular tool should not be considered a snub in any sense--simply an error or oversight on my part. = End of File ========================================================== ================================================================================ Archive-Date: Wed, 31 Aug 1994 07:44:42 CDT Sender: owner-litprog@SHSU.edu From: "Denis B. Roegel" Reply-To: LitProg@SHSU.edu, Denis.Roegel@LORIA.FR Date: Wed, 31 Aug 1994 14:45:37 +0200 Message-ID: <199408311245.OAA11118@pandore.loria.fr> To: litprog@shsu.edu Subject: give me arguments! CC: roegel@lorraine.loria.fr Hello, I was trying to convince somebody to use CWEB for his C programming. As usual, people are skeptical. I explained him the idea of chunks that would be called in other chunks. I explained him that this is just kind of macro expansion, not a function call. So, he answers: this is something that can be done with the preprocessor. I don't have arguments against this claim. What should I say ? Thanks, Denis. ================================================================================ Archive-Date: Wed, 31 Aug 1994 09:56:00 CDT Sender: owner-litprog@SHSU.edu Date: Wed, 31 Aug 94 10:56:57 EDT From: Lee Wittenberg Reply-To: LitProg@SHSU.edu, leew@PILOT.NJIN.NET To: LitProg@shsu.edu, Denis.Roegel@loria.fr Subject: Re: give me arguments! Message-ID: Denis Roegel writes: > I was trying to convince somebody to use CWEB for his C programming. > As usual, people are skeptical. I explained him the idea of chunks that > would be called in other chunks. I explained him that this is just > kind of macro expansion, not a function call. So, he answers: this is > something that can be done with the preprocessor. I don't have arguments > against this claim. What should I say ? Unfortunately, you're fighting a losing battle. As a programmer who scoffed at LP until I had occasion to try it (is there anything worse than a converted sinner?), I know that human beings tend to be quite satisfied with the status quo, thank you, and resist learning new techniques as much as possible. Although we've all been fed a load of psychological pap that says learning is fun an challenges are exciting, human beings are inherently conservative. Change means stress. Change makes us uncomfortable and fearful. (Michael Crichton, "Electronic Life", 1983) As a CS teacher and LP proselytizer, I've found that a major problem is in perceptions. Most students ignore what I say about top-down design and stepwise refinement, because it seems as if the right way to do things takes too much time. No matter what I tell them (and they discover for themselves) about the time wasted debugging a poorly thought out program, they refuse to take the extra time up front. LP has the same perception problem. Programmers look at the extra time necessary up front and don't see the (tremendous!) savings in debugging time. [sidebar: I recently hacked together a program to put Pascal type declarations in proper order. It was a fairly complex program, involving binary search trees, topological sorting, and the furshlugginer mess of lexical analysis in Pascal (even with the use of a non-standard string type). I finished the web in a week of afternoons, and was able to debug it in less than 2 hours, finding a total of 6 errors. If I had not been using LP techniques, it's arguable whether I could have completed the program in the same time, but I certainly couldn't have debugged it in as short a time. In addition, I'm fairly confident of the program's correctness as it stands, something that never happened before with a hacked-up tool before.] However, if you wish to persist in your efforts to bring a new LP'er into the fold, these are the advantages I believe that chunk names have over plain ol' macro definitions: -- Typesetting of chunk names makes them easier to spot than macros, and encourages the use of descriptive phrases, which are understandable immediately, rather than short function-name-like abbreviations, which require at least one level of interpretation. -- The descriptive nature of chunk names makes it easier to spot errors in the corresponding code. I once had a chunk name that (correctly) read @. The definition began with the typographical error ``if (x < 0)''. I hate to admit how long I stared at the (non-working) code without seeing the obvious. I only discovered it by reading through the web, making sure that each definition agreed with its description. -- Chunk names are cross-referenced by section number. Take a look at the code for CWEB. It's much easier to to follow the trail from a chunk name use to its definition, than for a macro (or function) call. -- If you already have an algorithm, you can translate it into chunks in a single step (with a corresponding increase in confidence that the code will be correct). I contend that the following would be much messier using macro/function notation than chunks: Algorithm (from Bentley's "Programming Pearls", p. 36) initialize range to 1..N loop if range is empty, return that T is nowhere in the array compute M, the middle of the range use M as a probe to shrink the range if T is found during the shrinking process return its position CWEB Translation @d loop while(1) @f loop else @c @; loop { if (@) { @; } @; @; } Of course, Bentley translates the algorithm into more code-like form, but we can follow the same steps, with the added advantage that we don't have to replace the English placeholders with code ourselves -- CTANGLE does it for us. (Completing the translation is left as an exercise for the reader :-). -- Lee P.S. My debugging time for the Pascal program described above was actually less than one hour, but I didn't think anyone would believe that (and I'm still not sure I believe it). ------------------------------------------------------------------------ Lee Wittenberg | Thinking's a dizzy business, a matter of Computer Science Department | catching as many of those foggy glimpses Kean College of New Jersey | as you can and fitting them together the Union, NJ 07083 | best you can. USA | | -- Dashiell Hammett leew@pilot.njin.net | "The Dain Curse" (1929) ------------------------------------------------------------------------ ================================================================================ Archive-Date: Wed, 31 Aug 1994 12:24:16 CDT Sender: owner-litprog@SHSU.edu From: georg@doey.nero.uni-bonn.de (Georg Bisseling (++49-228-550-349)) Reply-To: LitProg@SHSU.edu, georg@DOEY.NERO.UNI-BONN.DE Subject: Re^2: DLLs, C++, and Visual Basic Date: 31 Aug 94 18:46:45 Message-ID: To: LitProg@SHSU.EDU In article cybersf@netcom.com (Scott Fraley) writes: Newsgroups: comp.programming.literate Path: olymp.informatik.uni-bonn.de!news.rhrz.uni-bonn.de!urmel.informatik.rwth-aachen.de!nntp.gmd.de!newsserver.jvnc.net!darwin.sura.net!howland.reston.ans.net!usc!nic-nac.CSU.net!charnel.ecst.csuchico.edu!csusac!csus.edu!netcom.com!cybersf From: cybersf@netcom.com (Scott Fraley) Organization: NETCOM On-line Communication Services (408 261-4700 guest) X-Newsreader: TIN [version 1.2 PL1] References: Date: Thu, 25 Aug 1994 02:34:32 GMT Lines: 21 In article , Stephane Rainville wrote: : We want to write a DLL file in C++ to and call one of its subroutines : in a Visual Basic programm. : in the general procedure, as well as the sub we want. However, when we : call the subroutine, Visual Basic doesn't seem to think it's defined. First, let me say that I have never even played with VB before, but I have done C++ and read stuff. The problem could be that VB can't call a C++ function because of the "name mangling" the C++ compiler does. You will probably have better luck if you write a 'plain C' front end (calling function) which could then call the C++ function for you and be called from VB. This way, your function(s) could be called from C++ apps (via the C++ interface) and VB through the plain C interface. If name mangling is the problem then write your function into a *.c file that is compiled as plain C and try this in your header: extern "C" double foo(int a); ================================================================================ Archive-Date: Wed, 31 Aug 1994 15:27:02 CDT Sender: owner-litprog@SHSU.edu From: norman@flaubert.bellcore.com (Norman Ramsey) Reply-To: LitProg@SHSU.edu, norman@FLAUBERT.BELLCORE.COM Subject: Noweb 2.6c now available, with better documentation Message-ID: Date: Wed, 31 Aug 1994 19:11:57 GMT To: LitProg@SHSU.EDU Noweb version 2.6c is now available from bellcore.com and should soon propagate to the CTAN sites. The purpose of this release is to make good on my promise to write the ``Noweb Hacker's Guide.'' The earlier technical report ``Literate-Programming Tools can be Simple and Extensible'' is now officially obsolete. The best source for an overview of noweb is now: ``Literate Programming Simplified,'' IEEE Software, September 1994, pp97-105. The proper place for technical details is in the manual pages and in the Noweb Hacker's guide, both of which are distributed with noweb. Send questions, comments, and errata to norman@bellcore.com -- Norman Ramsey norman@bellcore.com ================================================================================ Archive-Date: Wed, 31 Aug 1994 18:10:48 CDT Sender: owner-litprog@SHSU.edu From: schrod@iti.informatik.th-darmstadt.de (Joachim Schrod) Reply-To: LitProg@SHSU.edu, schrod@ITI.INFORMATIK.TH-DARMSTADT.DE Subject: Diff to Contents of the LitProg Archive (monthly posting) Date: 1 Sep 1994 00:20:07 +0200 Message-ID: <342vmnINNdk5@spice.iti.informatik.th-darmstadt.de> To: LitProg@SHSU.EDU There were no changes in the last month. -- The Literate Programming Archive, or LitProg Archive for short, resides at ftp.th-darmstadt.de [130.83.55.75], directory pub/programming/literate-programming/. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= Joachim Schrod Email: schrod@iti.informatik.th-darmstadt.de Literate Programming Archive, maintainer Technical University of Darmstadt, Germany ================================================================================ Archive-Date: Wed, 31 Aug 1994 18:10:52 CDT Sender: owner-litprog@SHSU.edu From: schrod@iti.informatik.th-darmstadt.de (Joachim Schrod) Reply-To: LitProg@SHSU.edu, schrod@ITI.INFORMATIK.TH-DARMSTADT.DE Subject: Contents of the LitProg Archive (monthly posting) Date: 1 Sep 1994 00:20:03 +0200 Message-ID: <342vmjINNdk3@spice.iti.informatik.th-darmstadt.de> To: LitProg@SHSU.EDU # literate-programming/Contents 04 May 94 -*- Indented-Text -*- #------------------------------------------------------------ The material available from the Literate Programming Archive is categorized, each category is put in a directory tree. While this structure (which is described in the README files) supports browsing, the need for quick access to a specific Literate Programming tool remains. This file shall assist you in this need. It presents the *WEB systems and tools available, in an alphabetic order, and names the directory where you can find it. In addition to the systems mentioned below, the LitProg Archive features texts in the directory Documentation: FAQs, papers, and an extensive bibliography in BibTeX format. Since this file is updated manually, I cannot guarantee that it's up to date. Send reports about inconsistencies of description and reality to Joachim Schrod . SYSTEM DIRECTORY REMARK ------ --------- ------ APLWEB apl w/o source, but under the GPL! [this was an error by the author] AWEB ada/aweb not supported any more cfa Tools Change File Analyzer CLiP any language, any formatter, any -- source independent wordprocessor. Hypertext -- for DOS machines/ms-dos integration possible -- for VMS machines/vms CWEB (Levy/Knuth) C++, ANSI C, K&R C -- source c.c++ -- Amiga port machines/amiga -- Atari TOS port machines/atari-tos an old version [2.4 p5b] -- DOS port machines/ms-dos -- Mac port machines/mac -- Mac CTANGLE machines/mac Impact: CTANGLE & Apple-Events cweb style c.c++ CWEB programs as LaTeX documents CWEB (van Leeuwen) c.c++ CWEB for ANSI C, in ANSI C CWEB (Schrod) not supported any more send me mail if you have historic interests :-) Funnelweb independent FWEB multi-lingual WEB -- source fweb -- DOS port machines/ms-dos -- MS-Windows port machines/ms-windows Impact machines/mac CTANGLE & Apple-Events Knit pascal not supported any more lit2x independent [????] from Glasgow LPW machines/mac Literate Programming Workshop CAVEAT: Shareware! MapleWEB spiderweb MWEB (Schrod/Detig) modula-2 not supported any more MWEB (Sewell) modula-2 not supported any more noweb uses the UNIX toolbox paradigm -- source independent -- DOS port machines/ms-dos nuweb lean system, written in C -- source independent -- Amiga port machines/amiga -- DOS port machines/ms-dos ProTex independent WEB system based on TeX RWEB spiderweb for Reduce smlweb spiderweb for Standard ML SpiderWEB WEB generator, in awk -- source spiderweb -- DOS port machines/ms-dos -- OS/2 port machines/os2 -- Mac port machines/mac TIE Tools Change File Merger WEB The basis, it started with it... -- source pascal -- DOS port machines/ms-dos WEB mode Tools for GNU Emacs WinWordWEB machines/ms-dos WEB with Word for Windows Literate Documentation Systems ------------------------------ (or LitDoc systems for short): Tools that do not support refinements but enable the use of usual document preparation systems (e.g., LaTeX) in program comments. cnoweb c.c++ doc package /pub/tex/latex CAVEAT: No LitProg A directory! oriented towards TeX code; part of the LaTeX2e distrib. MAKEPROG independent is here for my own convenience :-) SchemeWEB lisp wbuild /pub/X11/other/fwf CAVEAT: No LitProg A directory! creating new X widget classes -- The Literate Programming Archive, or LitProg Archive for short, resides at ftp.th-darmstadt.de [130.83.55.75], directory pub/programming/literate-programming/. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= Joachim Schrod Email: schrod@iti.informatik.th-darmstadt.de Literate Programming Archive, maintainer Technical University of Darmstadt, Germany