Il programma prende in input un file di testo, e produce un file di output contenente il testo del file di input, incolonnato come una pagina di giornale, secondo le misure definite dall'utente.
Ad esempio, è possibile impaginare il testo contenuto in sample_inputs/example_in.txt, come riportato in expected_outputs/example_out.txt, ovvero:
Come si può perfettamente specificati
vedere incolonnato e dall'utente:
all'interno di giustificato infatti per
questo esempio, secondo i produrre questo
il testo viene parametri output è stato
%%%
scelto di caratteri per l'altra
utilizzare 3 riga di all'interno di
colonne per colonna, e 5 una pagina.
pagina, 5 righe caratteri tra
per colonna, 15 una colonna e Si noti inoltre
%%%
come il UTF-8, e originale,
programma è in mantiene la inserendo tra
grado di separazione in questi una riga
gestire paragrafi del vuota di
caratteri testo separazione. 😃
Si noti che nell'esempio qui riportato alcune delle colonne potrebbero sembrare non allineate, poiché alcuni browser usano le "ligatures" per renderizzare il testo, ed alcuni gruppi di caratteri vengono uniti in uno solo, ad esempio f e i in fi; per visualizzare il testo incolonnato correttamente, è necessario disporre di un visualizzatore di testo monospace, che non usi le ligatures.
Per compilare il programma, dopo aver scaricato la repository con
git clone https://github.com/ph04/newspaperè sufficiente eseguire il comando
makeDi seguito è riportato il comando che è stato eseguito per compilare la demo mostrata precedentemente:
newspaper --par sample_inputs/example_in.txt output.txt 3 5 15 5eseguendo questo comando, il testo impaginato verrà inserito in un file chiamato output.txt.
Il programma può essere eseguito con un solo processo (comportamento di default), oppure attraverso la versione multi-processo, attivando la flag --par (o -p).
Per maggiori informazioni, consultare il comando
newspaper --helpPer eseguire i test, usare il seguente comando:
sh run_tests.shLa versione mono-processo del programma effettua la lettura dei caratteri, dal file di input, in "chunk" (ovvero, una riga di una colonna di una pagina); contemporaneamente, viene costruita una struttura dati per mantenere le informazioni delle pagine che vengono costruite, per poterle stampare correttamente sul file di output successivamente.
La struttura che viene utilizzata (anche all'interno della versione multi-processo) è la seguente:
+-----PAGINA--------------------------------------------------+
| +---LINEA-------------------------------------------------+ |
| | +-CHUNK--+ +--------+ +--------+ | |
| | | | --> | | --> | | --> ... | |
| | +--------+ +--------+ +--------+ | |
| +---------------------------------------------------------+ |
| | |
| v |
| +---------------------------------------------------------+ |
| | +--------+ +--------+ +--------+ | |
| | | | --> | | --> | | --> ... | |
| | +--------+ +--------+ +--------+ | |
| +---------------------------------------------------------+ |
| | |
| v |
| +---------------------------------------------------------+ |
| | +--------+ +--------+ +--------+ | |
| | | | --> | | --> | | --> ... | |
| | +--------+ +--------+ +--------+ | |
| +---------------------------------------------------------+ |
| | |
| v |
| ... |
+-------------------------------------------------------------+
|
v
...
La versione multi-processo è gestita spawnando 3 processi, il primo responsabile della lettura del file di input, il secondo responsabile della creazione della struttura dati, ed il terzo responsabile della stampa sul file di output. Il processo che spawna tali sottoprocessi è invece responsabile di gestire gli errori che i suoi processi figli potrebbero restituire, andando a terminare quelli ancora in esecuzione.