Come documentare una specifica del formato file [chiuso]

Per un progetto, devo lavorare con vari tipi di file da alcuni vecchi giochi e software correlati: file di configurazione, salvataggi, archivi di risorse e così via. La maggior parte di questi non è ancora documentata, né esistono strumenti per lavorare con loro, quindi devo decodificare i formati e costruire le mie librerie per gestirli.

Anche se non credo che ci sia una grande richiesta per gran parte, intendo pubblicare i risultati dei miei sforzi. Esistono standard accettati per la documentazione dei formati di file? Guardandosi intorno, ci sono diversi stili in uso: alcuni, come la specifica del formato di file .ZIP , sono molto prolissi; altri, come quelli su XentaxWiki, sono molto più concisi: trovo alcuni di essi difficili da leggere; quella che mi piace di più personalmente è questa descrizione del file system della scheda di memoria di PlayStation 2 , che include sia un testo descrittivo dettagliato che diverse "mappe di memoria" con offset e simili - inoltre si adatta molto al mio caso d'uso. Varia un po 'per i diversi formati, ma sembra che ci dovrebbero essere alcuni principi generali che dovrei provare a seguire.

Modifica: mi sembra di non aver spiegato molto bene cosa voglio fare. Lasciami costruire un esempio.

Potrei avere un vecchio software che memorizza la sua configurazione in un file 'binario' - una serie di bitfield, numeri interi, stringhe e quant'altro incollato insieme e compreso dal programma, ma non leggibile dall'uomo. Decifro questo. Vorrei documentare esattamente qual è il formato di questo file, in modo leggibile dall'uomo, come specifica per l'implementazione di una libreria per analizzare e modificare questo file. Inoltre, vorrei che questo fosse facilmente comprensibile da altre persone.

Esistono diversi modi per scrivere un documento del genere. L'esempio di PKZIP sopra è molto prolisso e descrive principalmente il formato del file in testo libero. L'esempio PS2 fornisce tabelle di tipi di valore, offset e dimensioni, con ampi commenti su cosa significano tutti. Molti altri, come quelli su XentaxWiki, elencano solo i tipi e le dimensioni delle variabili, con commenti piccoli o nulli.

Chiedo se esiste uno standard, simile a una guida di stile di codifica, che fornisce una guida su come scrivere questo tipo di documentazione. In caso contrario, c'è qualche esempio eccellente ben noto che dovrei emulare? In caso contrario, qualcuno può almeno riassumere qualche consiglio utile?

Un file binario è solo una sequenza di bit disposti in unità logiche secondo determinate regole . Queste regole sono generalmente chiamate grammatica . La grammatica può essere classificata in quattro tipi (la gerarchia di Chomsky ), e per le grammatiche libere dal contesto dovresti usare Extended Backus-Naur Form, come sottolineato da Matt Fenwick nel suo commento. L'interpretazione (o semantica) della sequenza memorizzata nel file può essere descritta verbalmente o con programmi di esempio ben annotati che serializzano e deserializzano le informazioni.

Per saperne di più sulla documentazione dei formati di file binari, suggerisci di leggere ad esempio lo standard ASN.1 .

È strano perché una rapida ricerca di formati di file ha fatto apparire un articolo di Wikipedia (Elenco dei formati di file) . Include anche diversi formati di dati di videogiochi .

Elenco di formati di file comuni di dati per videogiochi su sistemi che supportano filesystem, più comunemente giochi per PC.

Include anche un'ampia selezione di formati di supporti per l'archiviazione di videogiochi .

Elenco delle estensioni di file più comuni utilizzate quando l'immagine della ROM o il supporto di archiviazione di un gioco viene copiato da un dispositivo ROM originale su una memoria esterna come disco rigido a scopo di backup o per rendere il gioco giocabile con un emulatore. Nel caso di software basato su cartucce, se l'estensione specifica della piattaforma non viene utilizzata, le estensioni di file ".rom" o ".bin" vengono generalmente utilizzate per chiarire che il file contiene una copia di un contenuto di una ROM. Le immagini ROM, disco o nastro di solito non sono costituite da un singolo file o ROM, piuttosto da un intero file o struttura ROM contenuta in un singolo file sul supporto di backup.

Esistono standard accettati per la documentazione dei formati di file?

Non esiste uno standard "ufficiale" da nessuna parte. Poiché i formati di file sono creati da un'azienda, l'azienda decide in merito al formato per la documentazione.