Literate programming

Il Literate programming è un paradigma di programmazione introdotto da Donald Knuth in cui un programma per computer viene fornito come una spiegazione della sua logica in un linguaggio naturale, come l'inglese, intervallata da frammenti di macro e codice sorgente tradizionale, da cui può essere generato codice sorgente compilabile.

Il paradigma del literate programming, come concepito da Knuth, rappresenta un allontanamento dalla scrittura di programmi per computer nel modo e nell'ordine imposti dal computer, e consente invece ai programmatori di sviluppare programmi nell'ordine richiesto dalla logica e dal flusso dei loro pensieri. I literate programs sono scritti come un'esposizione ininterrotta della logica in un linguaggio umano ordinario, proprio come il testo di un saggio, in cui sono incluse le macro per nascondere le astrazioni e il codice sorgente tradizionale.

Gli strumenti per il literate programming (LP) vengono utilizzati per ottenere due rappresentazioni da un file sorgente literate: uno adatto per ulteriori compilazioni o esecuzioni da un computer, il codice "aggrovigliato" o "tangled" e un altro per la visualizzazione come documentazione formattata, che si dice sia "intessuta" o "woven". Mentre la prima generazione di strumenti di literate programming era specifica per un certo linguaggio di programmazione, i successivi sono indipendenti ed esistono al di sopra di questi.

Storia e filosofia

Il literate programming fu introdotto per la prima volta da Knuth nel 1984. L'intenzione principale dietro questo approccio era di trattare un programma come letteratura comprensibile agli esseri umani. Questo approccio è stato implementato presso l'Università di Stanford come parte della ricerca sugli algoritmi e sulla tipografia digitale. Questa implementazione fu chiamata " WEB " da Knuth poiché credeva che fosse una delle poche parole inglesi di tre lettere che non erano già state applicate al computer. Tuttavia, ricorda effettivamente la natura complicata del software delicatamente assemblato da materiali semplici.

Concetto

Il literate programming consiste nello scrivere la logica del programma in un linguaggio umano con frammenti di codice e macro inclusi (separati da un markup primitivo). Le macro in un file sorgente literate sono semplicemente frasi simili a titoli o esplicative in un linguaggio umano, che descrivono le astrazioni umane create risolvendo il problema di programmazione, e nascondendo blocchi di codice o macro di livello inferiore. Queste macro sono simili agli algoritmi in pseudocodice tipicamente utilizzati nell'insegnamento dell'informatica. Queste frasi esplicative arbitrarie diventano precisi nuovi operatori, creati al volo dal programmatore, formando un metalinguaggio in cima al linguaggio di programmazione sottostante.

Un preprocessore viene utilizzato per sostituire gerarchie arbitrarie, o piuttosto "reti" di macro "interconnesse, per produrre il codice sorgente compilabile con un comando ("tangle" o "groviglio") e la documentazione con un altro ("weave" o "trama"). Il preprocessore offre anche la possibilità di generare il contenuto delle macro e di aggiungere le macro già create in qualsiasi posizione nel testo del file sorgente del programma, eliminando così la necessità di tenere presente le restrizioni imposte dai linguaggi di programmazione tradizionali o di interrompere il flusso del pensiero.

Vantaggi

Secondo Knuth, il literate programming fornisce programmi di qualità superiore, poiché obbliga i programmatori a dichiarare esplicitamente i pensieri alla base del programma, rendendo più ovvie le decisioni di progettazione scarsamente ponderate. Knuth afferma anche che il literate programming fornisce un sistema di documentazione di prim'ordine, che non è un componente aggiuntivo, ma è "cresciuto" naturalmente nel processo di esposizione dei propri pensieri durante la creazione di un programma. La documentazione risultante consente all'autore di riavviare i propri processi di pensiero in qualsiasi momento successivo, e consente ad altri programmatori di comprendere più facilmente la costruzione del programma. Ciò differisce dalla documentazione tradizionale, in cui a un programmatore viene presentato un codice sorgente che segue un ordine imposto dal compilatore e da cui deve decifrare il processo di pensiero dietro il programma dal codice e dai commenti associati. Le capacità metalinguistiche del literate programming si sostiene anche che facilitino il ragionamento, offrendo una "visione a volo d'uccello" del codice e aumentando il numero di concetti che la mente può conservare ed elaborare con successo. L'applicabilità del concetto alla programmazione su larga scala, quella dei programmi di livello commerciale, è dimostrata da una edizione del codice TeX come literate program.

Knuth afferma inoltre che il Literate Programming può portare ad un facile porting di un dato software su più ambienti, e cita persino l'implementazione di TeX come esempio.

Contrasto con il classico processo di generazione della documentazione

Molto spesso si chiama erroneamente literate programming il processo di estrazione della documentazione formattata prodotta da un file comune con codice sorgente e commenti - che è propriamente chiamata generazione di documentazione - o ai commenti copiosamente inclusi nel codice. Questo è il contrario del literate programming: il codice ben documentato o la documentazione estratta dal codice segue la struttura del codice, con la documentazione incorporata nel codice; mentre nel literate programming, il codice è incorporato nella documentazione, con il codice che segue la struttura della documentazione.

Questo malinteso ha portato alcuni a sostenere che gli strumenti di estrazione dei commenti, che i sistemi Perl Plain Old Documentation o Java Javadoc, siano "strumenti per il literate programming". Tuttavia, poiché questi strumenti non implementano la "rete di concetti astratti" che si nasconde dietro il sistema di macro in linguaggio naturale, o forniscono la capacità di cambiare l'ordine del codice sorgente da una sequenza imposta dalla macchina in una comoda per la mente umana, non possono essere correttamente chiamati strumenti di literate programming nel senso inteso da Knuth.

Critica

Nel 1986, Jon Bentley chiese a Knuth di dimostrare il concetto di literate programming scrivendo un programma in WEB. Knuth produsse un lungo listato monolitico di 8 pagine che fu pubblicato insieme a una critica di Douglas McIlroy di Bell Labs. McIlroy ha elogiato la complessità della soluzione Knuth, e la sua scelta di una struttura di dati (hash trie di Frank M. Liang), ma ha notato che una più pratica, molto più veloce da implementare, debuggare e modificare soluzione del problema richiedeva solo sei righe di script shell riutilizzando utilities Unix standard. McIlroy ha concluso dicendo:

«Knuth ci ha mostrato come programmare intellegibilmente, ma non saggiamente. Apprezzo la disciplina. Non apprezzo il risultato. Ha creato una sorta di intricato uovo Faberge di qualità industriale, magnificamente lavorato, rifinito oltre ogni ordinario desiderio, un autentico pezzo da museo.»

McIlroy ha successivamente ammesso che la sua critica era ingiusta, dal momento che ha criticato il programma di Knuth su basi ingegneristiche, mentre lo scopo di Knuth era solo quello di dimostrare la tecnica del literate programming. Nel 1987, Communications of the ACM ha pubblicato un articolo di follow-up che illustrava il literate programming con un programma C che combinava l'approccio artistico di Knuth con l'approccio ingegneristico di McIlroy, con una critica di John Gilbert.

Flusso di lavoro

L'implementazione del literate programming prevede due passaggi:

  1. Tessitura o Weaving: Generazione di un documento completo a proposito del programma e sulla sua manutenzione.
  2. Aggrovigliamento o Tangling: Generazione del codice macchina eseguibile

La tessitura e l'aggrovigliamento vengono eseguiti sulla stessa fonte in modo che siano coerenti tra loro.

Esempio

Un classico esempio di literate programming è l'implementazione literate del programma standard di conteggio parole wc Unix. Knuth ha presentato una versione CWEB di questo esempio nel capitolo 12 del suo libro Literate Programming. Lo stesso esempio è stato successivamente riscritto per lo strumento di programmazione letterato noweb. Questo esempio fornisce una buona illustrazione degli elementi di base del literate programming.

Creazione di macro

Il frammento seguente del literate program wc mostra come frasi descrittive arbitrarie in un linguaggio naturale vengono utilizzate per creare macro, che fungono da nuovi "operatori" nel linguaggio di programmazione literate e nascondono blocchi di codice o altre macro. La notazione di markup è composta da parentesi quadre (" <<...>> ") che indicano le macro, il simbolo " @ " che indica la fine della sezione di codice in un file noweb. Il simbolo " <<*>> " sta per "radice", nodo più in alto dal quale lo strumento di programmazione alfabetico inizierà a espandere la rete di macro. In realtà, scrivere il codice sorgente espanso può essere fatto da qualsiasi sezione o sottosezione (cioè un pezzo di codice designato come " <<name of the chunk>>= ", con il segno uguale), quindi un file di un literate program può contenere diversi file con codice sorgente.

The purpose of wc is to count lines, words, and/or characters in a list of files. The
number of lines in a file is ......../more explanations/

Here, then, is an overview of the file wc.c that is defined by the noweb program wc.nw:
  <<*>>=
  <<Header files to include>>
  <<Definitions>>
  <<Global variables>>
  <<Functions>>
  <<The main program>>
  @

We must include the standard I/O definitions, since we want to send formatted output
to stdout and stderr.
  <<Header files to include>>=
  #include <stdio.h>
  @

Il dipanarsi dei blocchi può essere eseguito in qualsiasi posizione nel file di testo del programma letterato, non necessariamente nell'ordine in cui sono sequenziati nel blocco racchiudente, ma come richiesto dalla logica riflessa nel testo esplicativo che avvolge l'intero programma.

Programma come Web: le macro non sono solo nomi di sezioni

Le macro non corrispondono ai "nomi di sezione" nella documentazione standard. Le macro nel literate programming possono nascondere dietro di sé qualsiasi blocco di codice ed essere utilizzate all'interno di qualsiasi operatore di linguaggio macchina di basso livello, spesso all'interno di operatori logici come " if ", " while " o " case ". Ciò è illustrato dal seguente frammento del literate program wc.

The present chunk, which does the counting, was actually one of
the simplest to write. We look at each character and change state if it begins or ends
a word.

  <<Scan file>>=
  while (1) {
   <<Fill buffer if it is empty; break at end of file>>
   c = *ptr++;
   if (c > ' ' && c < 0177) {
    /* visible ASCII codes */
    if (!in_word) {
     word_count++;
     in_word = 1;
    }
    continue;
   }
   if (c == '\n') line_count++;
   else if (c != ' ' && c != '\t') continue;
   in_word = 0;
    /* c is newline, space, or tab */
  }
  @

In effetti, le macro possono rappresentare qualsiasi frammento arbitrario di codice o altre macro e sono quindi più generali di una frammentazione top-down o bottom-up o di una sorta di sottosezionamento. Knuth dice che quando ha realizzato questo, ha iniziato a pensare a un programma come a una rete di varie parti.

Ordine della logica umana, non quello del compilatore

In un literate program noweb oltre all'ordine libero della loro esposizione, i blocchi dietro le macro, una volta introdotti con " <<...>>= ", possono essere sviluppati successivamente in qualsiasi posto nel file semplicemente scrivendo " <<name of the chunk>>= "e aggiungendo più contenuto ad esso, come illustra il seguente frammento (" più" viene aggiunto dal formatter del documento per la leggibilità e non è nel codice).

 The grand totals must be initialized to zero at the beginning of the program.
If we made these variables local to main, we would have to do this initialization
explicitly; however, C globals are automatically zeroed. (Or rather,``statically
zeroed.'' (Get it?)

  <<Global variables>>+=
  long tot_word_count, tot_line_count,
     tot_char_count;
   /* total number of words, lines, chars */
  @

Registrazione del processo di ragionamento

La documentazione per un literate program viene prodotta come parte della stesura del programma. Invece dei commenti forniti come note a margine del codice sorgente, un literate program contiene la spiegazione dei concetti su ciascun livello, con concetti di livello inferiore rinviati al loro posto appropriato, cosa che consente una migliore comunicazione del pensiero. I frammenti di wc sopra mostrano come si intrecciano la spiegazione del programma e del suo codice sorgente. Tale esposizione di idee crea un flusso del pensiero, come un'opera letteraria. Knuth ha scritto un "romanzo" che spiega il codice del gioco di narrativa interattiva Colossal Cave Adventure.

Strumenti

Il primo ambiente di literate programming pubblicato fu WEB, introdotto da Knuth nel 1981 per il suo sistema di composizione tipografica TeX; utilizza Pascal come linguaggio di programmazione sottostante e TeX per la composizione della documentazione. Il codice sorgente TeX commentato completo è stato pubblicato in TeX: The Program di Knuth, volume B dell'opera in 5 volumi Computers and Typesetting. Knuth aveva usato privatamente un sistema di literate programming chiamato DOC già dal 1979. Si ispirava alle idee di Pierre-Arnoul de Marneffe. Il CWEB gratuito, scritto da Knuth e Silvio Levy, è WEB adattato per C e C++, funziona sulla maggior parte dei sistemi operativi e può produrre documentazione TeX e PDF.

Esistono varie altre implementazioni del concetto di programmazione letterata (alcune non hanno macro e quindi violano il principio dell'ordine della logica umana come punto prioritario):

I literate script possono essere testo sorgente LaTeX completo, e allo stesso tempo possono essere compilati, senza modifiche, perché l'interprete compila il testo solo in un ambiente di codice, ad esempio
% here text describing the function:
\begin{code}
fact 0 = 1
fact (n+1) = (n+1) * fact n
\end{code}
here more text
Il codice può anche essere marcato nello stile Richard Bird, iniziando ogni riga con un simbolo maggiore di e uno spazio, precedendo e terminando il pezzo di codice con linee vuote.
\newenvironment{code}{\lstlistings[language=Haskell]}{\endlstlistings}

\begin{code}
comp :: (beta -> gamma) -> (alpha -> beta) -> (alpha -> gamma)
(g `comp` f) x = g(f x)
\end{code}
può essere configurato per ottenere qualcosa simile a questo:
Sebbene il pacchetto non fornisca i mezzi per organizzare blocchi di codice, è possibile dividere il codice sorgente LaTeX in diversi file. Vedere il manuale di listings per una panoramica.

Note

  1. 1 2 3 Knuth.
  2. ↑ Knuth
    «I had the feeling that top-down and bottom-up were opposing methodologies: one more suitable for program exposition and the other more suitable for program creation. But after gaining experience with WEB, I have come to realize that there is no need to choose once and for all between top-down and bottom-up, because a program is best thought of as a web instead of a tree. A hierarchical structure is present, but the most important thing about a program is its structural relationships. A complex piece of software consists of simple parts and simple relations between those parts; the programmer's task is to state those parts and those relationships, in whatever order is best for human comprehension not in some rigidly determined order like top-down or bottom-up»
  3. ↑ Se si ricorda ch la prima versione dello strumento era chiamata WEB, l'interessante riferimento letterario nascosto da Knuth in questi nomi diventa ovvio:
    «Oh, what a tangled web we weave when first we practise to deceive»
    La citazione reale apparve come un'epigrafe all'interno di un articolo pubblicato nel maggio del 1986 da Jon Bentley e Donald Knuth in una colonna di Programming Pearls, presente in Communications of the ACM, vol. 29, n. 5, p.365.
  4. ↑ (EN) Literate Programming (PDF), su archive.computerhistory.org. URL consultato il 3 giugno 2019.
  5. ↑ Knuth
    «WEB's macros are allowed to have at most one parameter. Again, I did this in the interests of simplicity, because I noticed that most applications of multiple parameters could in fact be reduced to the one-parameter case. For example, suppose that you want to define something like... In other words, the name of one macro can usefully be a parameter to another macro. This particular trick makes it possible to...»
  6. 1 2 Interview with Donald Knuth, su informit.com, 25 aprile 2008. URL consultato il 4 gennaio 2009.
    «Yet to me, literate programming is certainly the most important thing that came out of the TeX project. Not only has it enabled me to write and maintain programs faster and more reliably than ever before, and been one of my greatest sources of joy since the 1980s-it has actually been indispensable at times. Some of my major programs, such as the MMIX meta-simulator, could not have been written with any other methodology that I've ever heard of. The complexity was simply too daunting for my limited brain to handle; without literate programming, the whole enterprise would have flopped miserably.... Literate programming is what you need to rise above the ordinary level of achievement.»
  7. ↑ Knuth.
    «Another surprising thing that I learned while using WEB was that traditional programming languages had been causing me to write inferior programs, although I hadn't realized what I was doing. My original idea was that WEB would be merely a tool for documentation, but I actually found that my WEB programs were better than the programs I had been writing in other languages.»
  8. ↑ Knuth.
    «Thus the WEB language allows a person to express programs in a "stream of consciousness" order. TANGLE is able to scramble everything up into the arrangement that a PASCAL compiler demands. This feature of WEB is perhaps its greatest asset; it makes a WEB-written program much more readable than the same program written purely in PASCAL, even if the latter program is well commented. And the fact that there's no need to be hung up on the question of top-down versus bottom-up, since a programmer can now view a large program as a web, to be explored in a psychologically correct order is perhaps the greatest lesson I have learned from my recent experiences.»
  9. ↑ (EN) "Oral History of Donald Knuth"- an Interview with Ed Feigenbaum (PDF), su archive.computerhistory.org. URL consultato il 7 dicembre 2018.
  10. 1 2 Mark Jason Dominus, POD is not Literate Programming, su Perl.com, 20 marzo 2000 (archiviato il 2 gennaio 2009).
  11. ↑ Knuth.
    «I chose the name WEB partly because it was one of the few three-letter words of English that hadn't already been applied to computers. But as time went on, I've become extremely pleased with the name, because I think that a complex piece of software is, indeed, best regarded as a web that has been delicately pieced together from simple materials. We understand a complicated system by understanding its simple parts, and by understanding the simple relations between those parts and their immediate neighbors. If we express a program as a web of ideas, we can emphasize its structural properties in a natural and satisfying way.»
  12. ↑ (EN) Jon Bentley, D. E. Knuth e M. D. McIlroy, Programming pearls (PDF), vol. 29, 1986, pp. 471-483.
  13. ↑ (EN) Michael Sean Mahoney, Interview with M. D. McIlroy, su princeton.edu, 18 agosto 1989.
  14. ↑ (EN) Christopher J. Van Wyk, David R. Hanson e John Gilbert, Literate programming (PDF), vol. 30, n. 7, luglio 1987, pp. 593-599. URL consultato il 30 luglio 2019 (archiviato dall'url originale il 16 luglio 2023).
  15. 1 2 3 4 (EN) Norman Ramsey, An Example of noweb, su cs.tufts.edu, 13 maggio 2008. URL consultato il 4 gennaio 2009.
  16. ↑ Il gioco, noto anche come ADVENT, era stato inizialmente scritto da Crowther in circa 700 linee di codice FORTRANcode; Knuth lo rimaneeggiò nel linguaggio WEB. È disponibile su literateprogramming.com o sul sito di Knuth (Archiviato il 20 agosto 2008 in Internet Archive.).
  17. ↑ Pierre-Arnoul de Marneffe, Holon Programming – Report PMAR 73-23, Université de Liège - Service d'Informatique, dicembre 1973.
  18. ↑ (EN) Zachary Yedidia, A literate programming tool for any language, su GitHub, 24 luglio 2019. URL consultato il 30 luglio 2019.
  19. ↑ (EN) The FunnelWeb Literate Programming Tool, su FunnelWeb (archiviato dall'url originale il 4 giugno 2019).
  20. ↑ (EN) The nuweb system for Literate Programming, su nuweb.sourceforge.net. URL consultato il 30 luglio 2019.
  21. ↑ (EN) A literate programming "weaver" which can run as CGI to produce folding HTML-formatted documentation and runs with "noweb" tools of Norman Ramsey: unixtechie/Literate-Molly, su GitHub, 13 febbraio 2019. URL consultato il 30 luglio 2019.
  22. ↑ (EN) Oren Ben-Kiki, Code Narrator: an inverse literate programming tool. - orenbenkiki/codnar, su GitHub, 21 giugno 2019. URL consultato il 30 luglio 2019.
  23. ↑ (EN) Edward K. Ream, Leo's Home Page, su leoeditor.com, 2 settembre 2008. URL consultato il 3 aprile 2015 (archiviato dall'url originale il 16 luglio 2023).
  24. ↑ (EN) Sian Mountbatten, Web 68: Literate programming with Algol 68, su poenikatu.co.uk. URL consultato il 1º gennaio 2013 (archiviato dall'url originale il 20 gennaio 2013).
  25. ↑ (EN) Babel: Introduction, su orgmode.org. URL consultato il 30 luglio 2019.
  26. ↑ (EN) Babel Languages, su orgmode.org. URL consultato il 30 luglio 2019.
  27. ↑ (EN) Babel: Introduction - Literate Programming, su orgmode.org. URL consultato il 30 luglio 2019.
  28. ↑ (EN) Jeremy Ashkenas, Literate CoffeeScript, su coffeescript.org. URL consultato il 13 novembre 2014.
  29. ↑ Edwin D. Reilly, Milestones in Computer Science and Information Technology, p. 157.
  30. ↑ (EN) Wolfram Notebooks, su wolfram.com. URL consultato il 28 novembre 2018.
  31. ↑ (EN) Markup Formatting Reference: Markup Overview, su developer.apple.com. URL consultato il 15 novembre 2015.
  32. ↑ (EN) Literate Agda, su Agda Wiki. URL consultato il 26 marzo 2017.
  33. ↑ (EN) Eve and Literate Programming, su Eve Handbook. URL consultato il 25 maggio 2017 (archiviato dall'url originale il 24 maggio 2017).
  34. ↑ (EN) TEI Guidelines, su TEI Consortium. URL consultato il 23 agosto 2018 (archiviato dall'url originale il 22 agosto 2018).

Bibliografia

  Portale Informatica: accedi alle voci di Wikipedia che trattano di informatica