ArDoc • DSG

Analisi

REQ cat • nome

Disegno Logico
DSG cat • nome
MAN cat • nome

Disegno Tecnico
DST cat • nome
SYS cat • nome

DAF nome
DAT nome
KON nome

CLA nome
FUN nome

SRC cat • nome

Disegno Utente
DSU cat • nome

JOB nome
UUI nome
RPT nome

Varie
AMM cat • nome
QCL cat • nome
RIS cat • nome

e-mail

Parametri di scansione

La scansione dei sorgenti � controllata dal file daf.ScanSource.ini. Questo file contiene i parametri della scansione. I parametri ricadono in tre gruppi:

Il primo gruppo, sezione SrcCatMethod, controlla come vengono categorizzati i sorgenti.
Il secondo gruppo, sezione Keys, decodifica le keys utilizzate nei sorgenti.
Il terzo gruppo, sezione Scan ripetuta quanto serve, definisce i sorgenti da scandire.

I sorgenti sono categorizzati separatamente dagli altri elementi tecnici. Il motivo per questa scelta � duplice:

Se si fosse stabilito che l'owner di un sorgente � un sistema, avremmo avuto tutti i sorgenti insieme suddivisi per sistema, mischiando sorgenti di tipo diverso. Per altro un sorgente � un contenitore di funzionalit�, e solo nel caso di mainline batch pu� essere considerata una funzionalit� a s� stante. Mischiare sorgenti con classi, funzioni, costanti significava mischiare funzionalit� con contenitori.
E' utile categorizzare i sorgenti per sistema, ma � anche utile categorizzarli per linguaggio, e forse anche in base ad un criterio stabilito dall'utente. Si � dunque deciso di categorizzare i sorgenti nel modo che il documentatore ritiene pi� opportuno, mischiando liberamente tre elementi:

Il sistema default a cui appartiene il sorgente.
Il gruppo, che � basato sull'estensione, o tipo di sorgente.
Una o pi� chiavi messe nella testata dei sorgenti. Il contenuto e il numero di chiavi � libero. Abbiamo per� previsto delle chiavi standard che possono essere compilate in automatico.

Sezione SrcCatMethod
Variabile	Significato
First	Indica come formare la prima parte della categoria. Il valore va scelto tra uno dei seguenti: System, si usa il sistema indicato sul sorgente. Se non � usato per formare la categoria dei sorgenti viene comunque usato come default di eventuali documenti generati scandendo il sorgente. Keys, si usano le chiavi indicate nel sorgente. Spesso questo argomento viene usato congiuntamente con il parametro DefaultKey. Group, si usa il gruppo di appartenenza del sorgente. Il gruppo � determinato dal suffisso (v. Tipi di files sorgente). E' possibile indicare fino a tre chiavi. Se non si indica nulla il sistema assume la sequenza: System, Keys, Group.
Second	La seconda chiave della categoria. I medesimi valori visti per la chiave First. Ovviamente si sceglie un valore diverso.
Third	La terza chiave della categoria. I medesimi valori visti per la chiave First. Ovviamente si sceglie un valore diverso da quello indicato in First e Second.
Omit	Possono essere indicate una o pi� stringhe tramite una regular expression Perl. Le chiavi che hanno un match con queste stringhe vengono omesse. E' necessario porre attenzione che almeno una chiave sopravviva a questo filtro.

In questa sezione vengono fornite le decodifiche delle chiavi non standard utilizzate nella categorizzazione dei sorgenti.

Sezione Keys
Variabile	Significato
...nome...	Il nome della variabile � uno dei codici chiave utilizzati. Il valore � la sua decodifica. Vengono usati nel creare automaticamente le categorie del sorgente. Le chiavi che seguono sono le chiavi standard predefinite.
std	Applicazione standard (c puro).
base	Applicazione AR usando le componenti base.
cui	Applicazione AR che usa l'interfaccia cui.
gui	Applicazione AR che usa l'interfaccia gui.
batch	Applicazione AR che usa l'interfaccia batch.
mainline	Il programma contiene la mainline.
modulo	Il programma � un modulo linkato insieme ad altri per creare l'eseguibile.
libreria	Il programma � un modulo di libreria.

Gruppo Scan
Variabile	Significato
Il gruppo riporta tutte le specifiche relative alla scansione di un insieme di sorgenti.
Dir	La directory da esaminare.
Base	Le specifiche dei file da esaminare. Possono essere inserite pi� specifiche separate da white-space.
Ext	Il suffisso dei file da esaminare.
NamePrefix	Un prefisso che viene aggiunto al nome del file. Evita conflitti di nomi se la scansione viene fatta da pi� directory. Ovviamente non � ammesso il separatore '\' n� il separatore '/'. Usate invece come separatore '.'.
ListFile	Il nome di un file dove il sistema scrive la testata di tutti i files esaminati. Questo file pu� essere utilizzato per aggiornare la testata dei files medesimi, in stile batch editor.
ListOkFiles	Vengono elencati i files che non presentano errori.
ListBadFiles	Vengono elencati i files che hanno presentato un errore.
UseKeys	Si vogliono usare le chavi presenti nel sorgente. Se il valore � No significa che le chiavi presenti nel sorgente vengono ignorate. Possono per� essere posizionate automaticamente o sulla base della chiave default.
AutoKey	Si vuole che il sistema deduca le chiavi esaminando il sorgente. Pu� essere fatto solo per i programmi C. Vengono in questo modo gestite le chiavi standard. Queste chiavi si aggiungono a quelle presenti sul sorgente e ad una eventuale chiave default.
DefaultKey	Una chiave che viene aggiunta automaticamente ai sorgenti se non sono presenti chiavi. Associato al parametro "UseKeys=No" comporta una forzatura ignorando le chiavi presenti nel sorgente.
SrcDocument	Viene generato il documento di tipo src.
SrcDocumentOldStyle	Viene generato il documento di tipo src anche se lheader � "old style".

Links verso

Files
: ScanSource.ini • Ini Scansione Sorgenti
Disegno Logico
: src.groups • Tipi di files sorgente

Links da

Disegno Logico
: src • Scansione dei sorgenti
Disegno Utente
: pm.3XK3TGW • Setup dello Scan dei Sorgenti