Overview & Setup of the Scripting System

Il sistema di scripting di Altium Designer fornisce tutti gli strumenti e le funzionalità necessari per creare script che automatizzano le attività nel software.

L'editor di script, il debugger e i pannelli di scripting lavorano insieme per aiutarti a scrivere ed eseguire il debug dei tuoi script con facilità. Uno script può essere eseguito direttamente dall'editor di script oppure assegnato a un menu, a una barra degli strumenti o a un tasto di scelta rapida, in modo da poter essere applicato al documento corrente, ad esempio un layout PCB, in qualsiasi momento.

Altium Designer che mostra le finestre Script Code e Form con i pannelli Object Inspector, Code Explorer e Tool Palette .

Funzionalità del sistema di scripting

Il sistema di scripting è composto da due parti principali: l'editor e il debugger. Le funzionalità principali sono le seguenti:

• Project access – Gli script possono essere salvati in un progetto di script o di progettazione. Le routine di qualsiasi script in un progetto sono accessibili ad altri script all'interno dello stesso progetto.

• Scripting Editor – L'editor di scripting include un editor di testo dedicato con una gamma di opzioni per configurare l'ambiente di modifica e la colorazione della sintassi.

• Scripting Panels – Il sistema di scripting include diversi pannelli che aiutano a scrivere codice ed eseguire rapidamente il debug degli script.

• Scripting Debugger – Se uno script contiene un errore durante l'esecuzione, viene visualizzata una finestra di dialogo con un messaggio di errore conciso. Hai la possibilità di visualizzare in anteprima le variabili nella finestra Watches, tracciare il codice e controllare l'esecuzione dello script con Script Debugger.

• Scripting Languages – Gli script possono essere creati in DelphiScript e, se abilitato come linguaggio legacy, in VBScript.

Unità e form di script

I progetti di script supportano due tipi di documento di script: Script Units e Script Forms. Le Script Units consentono di scrivere procedure e funzioni autonome. Le Script Forms consentono di creare finestre di dialogo con controlli e gestori di eventi, oltre a procedure e funzioni.

• Una Script Unit può utilizzare la X2 Application Programming Interface (API) per modificare o manipolare gli oggetti di progettazione in un documento di progetto. Una Script Form ospita controlli come interfaccia utente e sfrutta la X2 API per fornire finestre di dialogo di script che agiscono sui documenti di progettazione attivi.
• Una Script Form è un'unità di form visiva supportata dallo script. Quando una form è attiva, rappresenta una finestra di dialogo.
• Una Script Form ha due viste: la vista Script Code e la vista Script Form. La vista Script Code contiene gestori di eventi e procedure/funzioni. La vista Script Form rappresenta una finestra di dialogo (di diversi tipi) e contiene controlli insieme ai relativi gestori di eventi.
• Una Script Form ha due file associati. Un file *.pas che contiene i gestori di eventi e le procedure/funzioni, e un file *.dfm che contiene i dettagli della Script Form stessa insieme ai suoi componenti e alle loro posizioni.
• Un componente è un oggetto di controllo visivo o non visivo (inserito dal pannello Tool Palette panel) che accetta input da un utente, come un clic del mouse o una sequenza di caratteri immessi. Durante la progettazione, il pannello Object Inspector panel può essere utilizzato per manipolare i componenti in una Script Form. I componenti possono essere utilizzati in qualsiasi Script Form in qualsiasi set di linguaggi supportato dal sistema di scripting.
• Un componente (oggetto di controllo) ha metodi, proprietà ed eventi che possono essere utilizzati da una Script Form.
  • I metodi sono le azioni che un oggetto può eseguire.
  • Le proprietà rappresentano i dati contenuti nell'oggetto a cui è possibile accedere o che possono essere modificati.
  • Gli eventi sono condizioni a cui un componente in una Script Form può reagire.
• Una Script Form dispone di gestori di eventi che elaborano le condizioni rilevate, ad esempio quando si fa clic su un pulsante della form.

Esempi di script di Altium Designer

Gli script di esempio e di riferimento sono una risorsa utile per comprendere come interfacce oggetto, metodi, processi, proprietà e componenti vengono applicati negli script. Possono anche essere utilizzati come base per i tuoi progetti di script.

Esecuzione di un esempio

Per eseguire rapidamente un esempio di script in Altium Designer, apri prima un progetto di esempio o un singolo file di script da una delle cartelle degli script di esempio, ad esempio il semplice progetto 'Hello World' (HelloWorld.PRJSCR) dalla cartella Scripts\Delphiscript Scripts\General.

Il progetto DelphiScript Hello World aperto nel pannello Projects .

Il progetto contiene due versioni dello script 'Hello World', dove la seconda (HelloWorlDialog.pas) dimostra l'uso di base di un'unità Form. Fai doppio clic sul nome di uno script per aprirlo e ispezionarlo nell'editor; nota che uno script può essere eseguito senza essere aperto nell'editor.

Per eseguire uno degli script, seleziona File » Run Script dai menu principali, quindi scegli una procedura di script disponibile dalla finestra di dialogo Select Item To Run. Quando viene eseguita una versione, si aprirà una finestra di dialogo per visualizzare il messaggio.

Il modo rapido e semplice per eseguire uno script di esempio.

Configurazione del sistema di scripting

Preferenze

Le impostazioni di preferenza predefinite per il sistema di scripting possono essere configurate nella finestra di dialogo Preferences, a cui si accede facendo clic sul pulsante di controllo in alto a destra dell'area di progettazione.

Preferenze generali

La pagina Text Editors – General della finestra di dialogo Preferences consente di configurare i requisiti di modifica degli script, come il comportamento della ricerca di stringhe, il modo in cui le righe vengono tabulate e rientrate, come vengono mappati i tasti e una serie di altre opzioni avanzate.

La pagina Text Editors – General della finestra di dialogo Preferences

Preferenze colore

La pagina Text Editors – Colors della finestra di dialogo Preferences consente di configurare la colorazione della sintassi dell'editor di script per il linguaggio di scripting desiderato e di impostare il colore degli elementi all'interno dell'editor di script. Ad esempio, nero per lo sfondo, bianco per le parole chiave dei commenti e così via.

La pagina Text Editors – Colors della finestra di dialogo Preferences

Preferenze di visualizzazione

La pagina Text Editors – Display della finestra di dialogo Preferences consente di configurare le caratteristiche visive degli script, come la visualizzazione dei margini destri e dei numeri di riga, l'evidenziazione della sintassi e la struttura del codice.

La pagina Text Editors – Display della finestra di dialogo Preferences

Preferenze globali dei progetti

La pagina Scripting System – Global Projects della finestra di dialogo Preferences elenca i progetti di script disponibili (installati). I progetti di script possono essere installati, rimossi o riordinati.

La pagina Scripting System – Global Projects della finestra di dialogo Preferences

Preferenze del Form Designer

La pagina Scripting System – Form Designer della finestra di dialogo Preferences fornisce le opzioni della griglia e del designatore dei componenti per un documento form di scripting.

La pagina Scripting System – Form Designer della finestra di dialogo Preferences