Przegląd i konfiguracja systemu skryptów

System skryptów w Altium Designer zapewnia wszystkie narzędzia i funkcje potrzebne do tworzenia skryptów automatyzujących zadania w oprogramowaniu.

Edytor skryptów, debuger oraz panele skryptowe współpracują ze sobą, aby ułatwić pisanie i debugowanie skryptów. Skrypt można uruchomić bezpośrednio z edytora skryptów albo przypisać do menu, paska narzędzi lub skrótu klawiszowego, dzięki czemu można go w dowolnym momencie zastosować do bieżącego dokumentu – na przykład układu PCB (PCB Layout).

Altium Designer pokazujący okna Script Code i Form wraz z panelami Object Inspector, Code Explorer i Tool Palette .

Funkcje systemu skryptów

System skryptów składa się z dwóch głównych części – edytora i debugera. Najważniejsze funkcje są następujące:

• Project access – Skrypty można zapisywać w projekcie skryptowym lub projektowym. Procedury z dowolnego skryptu w projekcie są dostępne dla innych skryptów w tym samym projekcie.

• Scripting Editor – Edytor skryptów zawiera dedykowany edytor tekstu z szeregiem opcji konfiguracji środowiska edycji oraz kolorowania składni.

• Scripting Panels – System skryptów oferuje szereg paneli, które pomagają szybko pisać kod i debugować skrypty.

• Scripting Debugger – Jeśli podczas wykonywania skryptu wystąpi błąd, pojawi się okno dialogowe ze zwięzłym komunikatem. Masz możliwość podglądu zmiennych w oknie Watches, śledzenia kodu oraz kontrolowania wykonywania skryptu za pomocą Script Debugger.

• Scripting Languages – Skrypty można tworzyć w DelphiScript oraz – jeśli włączony jako język legacy – w VBScript.

Jednostki i formularze skryptów

Projekty skryptowe obsługują dwa typy dokumentów skryptowych – Script Units oraz Script Forms. Script Units pozwalają pisać samodzielne procedury i funkcje. Script Forms umożliwiają budowanie okien dialogowych z kontrolkami i procedurami obsługi zdarzeń, a także procedurami i funkcjami.

• Script Unit może używać interfejsu X2 Application Programming Interface (API) do modyfikowania lub manipulowania obiektami projektu w dokumencie projektowym. Script Form hostuje kontrolki jako interfejs użytkownika i wykorzystuje X2 API do dostarczania okien dialogowych skryptu, które działają na aktywnych dokumentach projektowych.
• Script Form to wizualna jednostka formularza obsługiwana przez skrypt. Gdy formularz jest aktywny, reprezentuje okno dialogowe.
• Script Form ma dwa widoki – Script Code oraz Script Form. Widok Script Code zawiera procedury obsługi zdarzeń oraz procedury/funkcje. Widok Script Form reprezentuje formularz dialogowy (różnych typów) i zawiera kontrolki wraz z powiązanymi procedurami obsługi zdarzeń.
• Script Form ma dwa powiązane pliki. Plik *.pas zawiera procedury obsługi zdarzeń oraz procedury/funkcje, a plik *.dfm zawiera szczegóły samego formularza skryptu wraz z jego komponentami i ich położeniem.
• Komponent to wizualny lub niewizualny obiekt kontrolki (umieszczany z panelu Tool Palette panel), który przyjmuje dane wejściowe od użytkownika, takie jak kliknięcie myszą lub sekwencja wprowadzonych znaków. Podczas projektowania panel Object Inspector panel może służyć do manipulowania komponentami na Script Form. Komponenty mogą być używane w dowolnym Script Form w dowolnym zestawie językowym obsługiwanym przez system skryptów.
• Komponent (obiekt kontrolki) ma metody, właściwości i zdarzenia, które mogą być używane przez Script Form.
  • Metody to działania, które obiekt może wykonywać.
  • Właściwości reprezentują dane zawarte w obiekcie, do których można uzyskać dostęp lub je modyfikować.
  • Zdarzenia to warunki, na które może reagować komponent na Script Form.
• Script Form ma procedury obsługi zdarzeń, które przetwarzają przechwycone warunki, na przykład kliknięcie przycisku formularza.

Przykłady skryptów Altium Designer

Skrypty przykładowe i referencyjne są pomocnym zasobem do zrozumienia, jak w skryptach stosuje się interfejsy obiektów, metody, procesy, właściwości i komponenty. Mogą też posłużyć jako baza dla własnych projektów skryptowych.

Uruchamianie przykładu

Aby szybko uruchomić przykład skryptu w Altium Designer, najpierw otwórz przykładowy projekt lub pojedynczy plik skryptu z jednego z folderów z przykładami skryptów – na przykład prosty projekt „Hello World” (HelloWorld.PRJSCR) z folderu Scripts\Delphiscript Scripts\General.

Projekt DelphiScript Hello World otwarty w panelu Projects .

Projekt zawiera dwie wersje skryptu „Hello World”, gdzie druga (HelloWorlDialog.pas) demonstruje podstawowe użycie jednostki Form. Kliknij dwukrotnie nazwę skryptu, aby otworzyć go i przejrzeć w edytorze – pamiętaj, że skrypt można uruchomić, nawet jeśli nie jest otwarty w edytorze.

Aby uruchomić jeden ze skryptów, wybierz File » Run Script z menu głównego, a następnie wskaż dostępną procedurę skryptu w oknie dialogowym Select Item To Run. Po uruchomieniu danej wersji otworzy się okno dialogowe z wyświetloną wiadomością.

Szybki i prosty sposób uruchomienia przykładowego skryptu.

Konfiguracja systemu skryptów

Preferencje

Domyślne ustawienia preferencji dla systemu skryptów można skonfigurować w oknie Preferences, do którego uzyskuje się dostęp, klikając przycisk sterujący w prawym górnym rogu obszaru projektowego.

Preferencje ogólne

Strona Text Editors – General w oknie Preferences pozwala skonfigurować wymagania dotyczące edycji skryptów, takie jak zachowanie wyszukiwania ciągów, sposób tabulacji i wcięć w wierszach, mapowanie klawiszy oraz szereg innych opcji zaawansowanych.

Strona Text Editors – General w oknie Preferences

Preferencje kolorów

Strona Text Editors – Colors w oknie Preferences dialog pozwala skonfigurować kolorowanie składni w Edytorze skryptów dla wybranego języka skryptowego oraz ustawić kolory elementów w edytorze skryptów. Na przykład czarny dla tła, biały dla słów kluczowych komentarzy itd.

Strona Text Editors – Colors w oknie Preferences

Preferencje wyświetlania

Strona Text Editors – Display w oknie Preferences dialog pozwala skonfigurować wizualne cechy skryptów, takie jak wyświetlanie prawego marginesu i numerów linii, podświetlanie składni oraz zwijanie/rozszerzanie struktury kodu (code outlining).

Strona Text Editors – Display w oknie Preferences

Preferencje globalnych projektów

Strona Scripting System – Global Projects w oknie Preferences dialog wyświetla listę dostępnych (zainstalowanych) projektów skryptowych. Projekty skryptowe można instalować, usuwać lub zmieniać ich kolejność.

Strona Scripting System – Global Projects w oknie Preferences dialog

Preferencje projektanta formularzy

Strona Scripting System – Form Designer w oknie Preferences dialog udostępnia opcje siatki oraz oznaczeń komponentów dla dokumentu formularza skryptowego.

Strona Scripting System – Form Designer w oknie Preferences dialog