NOTE DI RILASCIO

Premessa

L'idea alla base di questo progetto, è nata visionando il progetto di un collega:
Fabio D'agostino, DataPath Simulator.
Utilizzando quest'ultimo progetto, ho elaborato idee per migliorarne il funzionamento, rendendone più semplice la visualizzazione. Nasce quindi così CPU Datapath.
Il progetto è interamente sviuppato in HTML, JavaScript e CSS.
L'unica libreria esterna utilizzata è: MATERIALIZE, un framework basato su Material Design, composto da fogli di stile CSS e script JavaScript, che facilitano la realizzazione di un'interfaccia semplice ed elegante.

Architettura software

Nota: Si descrive qui un breve schema sull'esecuzione del programma, per maggiori dettagli sul funzionamento di ogni metodo si riporta il collegamento alla documentazione del codice

• INSERIMENTO
  Si inizia con l'inserimento di istruzioni e variabili, reso possibile dai vari bottoni sull'interfaccia, che permettono l'inserimento, o in generale la modifica del numero di istruzioni e di variabili.
  • L'inserimento (sia di nuove operazioni, che di nuove variabili) viene gestito allo stesso modo:
    Si crea un clone da un elemento base privo di informazioni, per poi modificarne classi di stile e attributi, rendendolo modificabile all'utente. (metodi di riferimento AddInstruction(), AddMemVar())
    
  • La rimozione, anch'essa simile tra variabili e operazioni, viene gestita dando possibilità all'utente di rimuovere dal basso, premendo i bottoni "-" posti accanto alle sezioni, o rimuovendo i singoli elementi, semplicemente muovendo il cursore del mouse sopra gli elementi interessati.
    Ciò viene implementato tramite gli attributi onmouseover e onmouseleave di HTML, che chiamano i metodi OnHoverOp() e OnHoverExitOp()(nel caso delle operazioni), e OnHoverVar() e OnHoverExitVar()(nel caso delle variabili).
    I sopracitati metodi hanno il compito di far comparire i bottoni di rimozione, sostituendoli agli elementi HTML esistenti, e di rimuoverli una volta che il cursore lasci l'area interessata.
    La rimozione spetta ai metodi RemoveInstruction() e RemMemVar(), vederne il codice per maggiori dettagli.
  
  
• ESECUZIONE: NOTA SU "op_index"
  Una volta terminata la fase di inserimento, si procede all'esecuzione, premendo il bottone Start, e cerco qui di riassumere lo schema del flusso di esecuzione.
  
  Prima di procedere, è necessario descrivere il funzionamento della variabile op_index, ossia l'indice operazione. Tale variabile ha infatti il compito di tenere traccia dell'operazione attualmente in esecuzione, ed è possibile gestire il passaggio tra operazioni solo modificandola. Nel metodo Phase(), infatti, si controlla per prima cosa se op_index sia stata modificata, e in caso la risposta sia affermativa, si procede allora alla decodifica della nuova istruzione, con relativo ri-settaggio di tutte le variabili.
  La variabile viene modificata solo se si supera l'ultimo passo dell'operazione, o al contrario, se si procede verso passi precedenti, superando il primo passo (vedere i metodi Next() e Prev()).
  
  
• ESECUZIONE: CONTROLLO ERRORI
  L'esecuzione parte dal metodo Execute(), che setta tutte le variabili inerenti l'esecuzione, gestisce lo stato dei bottoni e delle label, e che effettua un primo controllo di errori:
  
  • Errori sulla memoria
  • Errori sulla sintassi delle operazioni inserite
  Il controllo errori viene effettuato simulando l'esecuzione del programma, in particolar modo, simulando il continuo aumento dell'indice operazione, che forza il metodo Phase() a controllare la sintassi.
  Inoltre è presente una variabile flag check_error, che limita le istruzioni eseguite da Phase() unicamente a quelle necessarie per il controllo errori.
  
  Questo è l'unico modo, in quanto i controlli di sintassi vengono eseguiti unicamente al cambio operazione.
  In caso di errore, si evidenzia l'operazione che lo genera, permettendo all'utente la correzione.
  
  
• DECODIFICA OPERAZIONI
  Superato il controllo errori, rimane ancora qualcosa da fare, prima di poter proseguire all'esecuzione dei passi. Ossia il riconoscimento dell'operazione da eseguire:
  La decodifica delle operazioni, ossia l'associazione tra una stringa in input, e un indice, che rappresenta un tipo di operazione riconosciuta dal simulatore, è affidata alle espressioni regolari. Il metodo OpDecoder, prende infatti una stringa, e vi applica diverse espressioni regolari. Se la ricerca ha esito positivo, la variabile op_type indicherà il tipo di operazione.
  Si può quindi proseguire effettuando il passo.
  
  
• GESTIONE PASSI
  affidata al metodo PhaseProgress(), grazie al contatore OC e a op_type che definiscono univocamente il passo corrente.
  Il passo, ricordiamo, è la più piccola azione degna di nota ai fini del programma,
  viene gestito in 3 diversi metodi:
  • PhaseProcess():
    Probabilmente è il metodo più ostico da comprendere, preferisco quindi spendervi qualche parola in più.
    Il compito di questo metodo è quello di aggiornare i contenuti delle variabili, espresse come registri e come variabili utente, aggiornandone il contenuto nella pagina HTML. Vengono infatti eseguiti tutti i controlli e le operazioni necessarie. Il fattore che complica il tutto è la variabile reverse_step, ossia quella variabile che assume valore true quando si preme il tasto PREV, ossia quando si procede verso passi precedenti.
    Il "passo inverso", infatti, viene gestito accoppiando ad ogni variabile rappresentante valori, una variabile _chrono, un array che conserva tutti i valori assunti dalla variabile nel tempo, sotto forma di pila
    All'aggiunta di ogni nuovo valore, si effettua un push sul relativo array di appoggio, e quando si torna indietro, dovendo ritornare al valore precedente, si effettua il pop e si prende il valore. concettualmente è tutto qui, e per quanto il codice possa sembrare articolato, non fa nient'altro che questo.
    NOTA: l'operazione inversa del passo 3 (come esempio), viene eseguita sul passo 2!
    Ecco perchè sono presenti le op.inverse su passi precedenti.
  • PhaseUIUpdate():
    Associa, ad ogni valore del contatore OC, e al tipo di operazione una descrizione, e relativa fase di appartenenza.
    Presenta anche qualche riga di codice che avvia un'animazione di uscita e di ingresso delle descrizioni.
  • UpdateImg():
    Associa, ad ogni valore del contatore OC, e al tipo di operazione un'immagine di sfondo diversa, che ne rappresenta graficamente il passo.
  Il passaggio da un passo ad un altro, è affidato ai bottoni PREV e NEXT (OP+ e OP- si basano su questi, guardare il codice per i dettagli), che sostanzialmente conoscono il numero di passi in cui è suddivisa un'operazione, permettendo quindi di poter aggiornare l'indice operazione (op_index), qualora si superi la seguente.
  
  
  
• MEMORIA: la memoria contiene, prima dell'esecuzione, le variabili che l'utente inserisce manualmente, ma successivamente all'esecuzione, il contenuto viene sostituito con elementi HTML non più modificabili, che rappresentano le operazioni e le variabili utente.
  A questo punto non è più possibile modificare in alcun modo i contenuti manualmente, fino alla fine dell'esecuzione.
  
  
• SALVATAGGIO/CARICAMENTO SU FILE: Per il salvataggio, si riempiono gli array relativi alle operazioni e alle variabili, tramite SetMemoryVar. Successivamente si convertono gli array appena generati, tramite JSON, e si passano come parametro per la creazione di un nuovo blob, ossia l'oggetto che genera il file. Per ultimo, si crea un elemento HTML "a", impostandone gli attributi in modo da permettere il download del file, e simulandone il click, avviando così l'immediato passaggio alla finestra del download.
  Per il caricamento dei file, invece, si consiglia la lettura diretta sul codice, attenzionando il metodo LoadFromFile, alla riga 3197.

Collaudi

Attualmente testato su

• Windows 10:
  • Google Chrome ver78.0.3904.87
  • Microsoft EDGE ver44.18362.387.0
• Arch Linux:
  • Firefox Browser ver70.0(64-bit)
• Ubuntu:
  • Firefox Browser ver70.0(64-bit)

Idee per sviluppi futuri:

Si dà una lista indicativa delle future modifiche da voler apportare:

• Prevenire la cancellazione delle variabili inserite dall'utente, tra un'esecuzione ed un'altra. FATTO!
  
• Verificare la presenza di errori su operazioni load e store, che utilizzino il metodo di indirizzamento con le label, PRIMA dell'avvio dell'esecuzione. Evitando così interruzioni del programma in fase di esecuzione.
  Ciò andrebbe fatto modificando Phase(), facendo in modo che anche con il flag check_error esegua i calcoli sulle variabili.
• Ampliare il repertorio delle operazioni che il simulatore può eseguire.
• Operandi immediati negativi.
• Salvataggio del programma scritto su un file, con conseguente caricamento. FATTO!

Novità della versione 1.3:

• Documentazione

  • Guida Utente

    • Correzione generale del testo.

  • Note di rilascio

    • Correzione generale del testo.

• Simulatore

  • Adesso il simulatore non elimina più le variabili al termine dell'esecuzione del programma.

Novità della versione 1.2:

• Documentazione

  • Guida Utente

    • Correzione generale del testo.
    • Aggiunta nuova sezione: 5. Sezione si Salvataggio/Caricamento

  • Note di rilascio

    • Correzione generale del testo.
  • Aggiunta la documentazione interattiva con Natural Docs, guardala!

• Simulatore

  • Aggiunta la possibilità di poter salvare le operazioni e le variabili scritte, in un file che verrà scaricato. Inoltre è possibile anche caricare questi file, tramite apposito form, per riprendere tutto il lavoro precedentemente salvato.
  • Cambiata la struttura di tutti i commenti nel file src/js/myJS.js, al fine di poter sfruttare la domuntazione di Natural Docs.

Novità della versione 1.1:

• Documentazione

  • Note d'installazione

    • Corrette le descrizioni sull'installazione, nei file "installation" e "installation-en".

  • Guida Utente

    • Aggiunta una nota accanto al formato dell'istruzione branch_if_. Dopo vari tentativi, tra grandezza font, spazi multipli e altro, si è deciso di proseguire unicamente con questa nota a fianco.
    • Aggiunta breve descrizione, corredata di immagine, per l'aspetto della finestra di memoria dopo aver avviato l'esecuzione.
    • Correzione generale del testo.

  • Note di rilascio

    • Modifica sulla struttura del testo, diviso in sezioni.
    • Correzione generale del testo.
    • Corretto il testo sulla rimozione delle variabili, rispecchiando adesso la nuova funzionalità che permette l'eliminazione delle variabili singolarmente.
    • Aggiunta descrizione sul funzionamento di "op_index" variabile attorno a cui ruota l'intera esecuzione (vedi sez. ESECUZIONE: NOTA SU "op_index").
    • Aggiunta breve descrizione sul processo di decodifica delle operazioni da parte del simulatore (vedi sez. DECODIFICA OPERAZIONI).
    • Nuove aggiunte alla sezione "idee per sviluppi futuri".
    • Aggiunta la sezione sulla novità della versione corrente (QUESTA!).

• Simulatore

  • Come per le operazioni, è adesso possibile rimuovere singolarmente ogni variabile dalla finestra MEMORIA, passando sopra il cursore del mouse.
  • Corretto l'errore che restituiva valori di salto errati nelle istruzioni branch_if_ .