Overview & Setup of the Scripting System

O sistema de scripting do Altium Designer disponibiliza todas as ferramentas e funcionalidades necessárias para criar scripts que automatizam tarefas no software.

O editor de scripts, o depurador e os painéis de scripting funcionam em conjunto para o ajudar a escrever e depurar os seus scripts com facilidade. Um script pode ser executado diretamente a partir do editor de scripts ou atribuído a um menu, barra de ferramentas ou tecla de atalho, para que possa ser aplicado ao documento atual – como, por exemplo, um layout PCB – em qualquer altura.

Altium Designer a mostrar as janelas Script Code e Form com os painéis Object Inspector, Code Explorer e Tool Palette .

Funcionalidades do Sistema de Scripting

O sistema de scripting é composto por duas partes principais – o editor e o depurador. As principais funcionalidades são as seguintes:

• Project access – Os scripts podem ser guardados num projeto de scripts ou de design. As rotinas de qualquer script num projeto estão acessíveis a outros scripts dentro do mesmo projeto.

• Scripting Editor – O editor de scripting inclui um editor de texto dedicado com um conjunto de opções para configurar o ambiente de edição e a coloração de sintaxe.

• Scripting Panels – O sistema de scripting inclui vários painéis que o ajudam a programar e depurar scripts rapidamente.

• Scripting Debugger – Se um script tiver um erro durante a execução, é apresentada uma caixa de diálogo com uma mensagem de erro concisa. Tem a possibilidade de pré-visualizar variáveis na janela Watches, seguir o código e controlar a execução do script com o Script Debugger.

• Scripting Languages – Os scripts podem ser criados em DelphiScript e, se ativado como linguagem legada, VBScript.

Script Units e Forms

Os Script Projects suportam dois tipos de documentos de script – Script Units e Script Forms. As Script Units permitem-lhe escrever procedimentos e funções autónomos. As Script Forms permitem-lhe criar caixas de diálogo com controlos e manipuladores de eventos, bem como procedimentos e funções.

• Uma Script Unit pode utilizar a Application Programming Interface (API) X2 para modificar ou manipular objetos de design num documento de design. Uma Script Form aloja controlos como interface do utilizador e tira partido da API X2 para fornecer caixas de diálogo de script que atuam sobre documentos de design ativos.
• Uma Script Form é uma unidade de formulário visual suportada pelo script. Quando um formulário está ativo, representa uma janela de diálogo.
• Uma Script Form tem duas vistas – a vista Script Code e a vista Script Form. A vista Script Code contém manipuladores de eventos e procedimentos/funções. A vista Script Form representa um formulário de diálogo (de diferentes tipos) e inclui controlos, juntamente com os respetivos manipuladores de eventos.
• Uma Script Form tem dois ficheiros associados. Um ficheiro *.pas que contém manipuladores de eventos e procedimentos/funções, e um ficheiro *.dfm que contém os detalhes do próprio formulário de script, juntamente com os seus componentes e respetivas localizações.
• Um componente é um objeto de controlo visual ou não visual (colocado a partir do painel Tool Palette panel) que aceita entrada de um utilizador, como um clique do rato ou uma sequência de caracteres introduzidos. Durante o design, o painel Object Inspector panel pode ser utilizado para manipular componentes numa Script Form. Os componentes podem ser utilizados em qualquer Script Form em qualquer conjunto de linguagens suportado pelo sistema de scripting.
• Um componente (objeto de controlo) tem métodos, propriedades e eventos que podem ser utilizados por uma Script Form.
  • Os métodos são as ações que um objeto pode executar.
  • As propriedades representam os dados contidos no objeto aos quais se pode aceder ou que podem ser modificados.
  • Os eventos são condições às quais um componente numa Script Form pode reagir.
• Uma Script Form tem manipuladores de eventos que processam condições captadas, como quando se clica num botão do formulário.

Exemplos de Scripts do Altium Designer

Os scripts de exemplo e de referência são um recurso útil para compreender como as interfaces de objetos, métodos, processos, propriedades e componentes são aplicados em scripts. Também podem ser usados como base para os seus próprios projetos de script.

Executar um Exemplo

Para executar rapidamente um exemplo de script no Altium Designer, abra primeiro um projeto de exemplo ou um ficheiro de script individual de uma das pastas de scripts de exemplo – por exemplo, o projeto simples 'Hello World' (HelloWorld.PRJSCR) da pasta Scripts\Delphiscript Scripts\General.

O projeto DelphiScript Hello World aberto no painel Projects .

O projeto contém duas versões do script 'Hello World', em que a segunda (HelloWorlDialog.pas) demonstra a utilização básica de uma unidade Form. Faça duplo clique no nome de um script para o abrir e analisar no editor – note que um script pode ser executado sem estar aberto no editor.

Para executar um dos scripts, selecione File » Run Script nos menus principais e, em seguida, escolha um procedimento de script disponível na caixa de diálogo Select Item To Run. Quando uma versão é executada, será aberta uma caixa de diálogo para apresentar a mensagem.

A forma rápida e simples de executar um script de exemplo.

Configuração do Sistema de Scripting

Preferências

As definições de preferências predefinidas para o sistema de scripting podem ser configuradas na caixa de diálogo Preferences, à qual se acede clicando no botão de controlo no canto superior direito da área de design.

Preferências Gerais

A página Text Editors – General da caixa de diálogo Preferences permite-lhe configurar os requisitos de edição dos seus scripts, tais como o comportamento da pesquisa de cadeias de caracteres, a forma como as linhas são tabuladas e indentadas, a forma como as teclas são mapeadas, e várias outras opções avançadas.

A página Text Editors – General da caixa de diálogo Preferences

Preferências de Cor

A página Text Editors – Colors da caixa de diálogo Preferences permite-lhe configurar a coloração de sintaxe do Script Editor para a linguagem de scripting da sua escolha e definir a cor dos elementos dentro do editor de scripts. Por exemplo, preto para o fundo, branco para as palavras-chave de comentários, e assim sucessivamente.

A página Text Editors – Colors da caixa de diálogo Preferences

Preferências de Apresentação

A página Text Editors – Display da caixa de diálogo Preferences permite-lhe configurar as funcionalidades visuais dos scripts, como a apresentação das margens direitas e dos números de linha, o realce de sintaxe e o contorno de código.

A página Text Editors – Display da caixa de diálogo Preferences

Preferências de Projetos Globais

A página Scripting System – Global Projects da caixa de diálogo Preferences lista os projetos de script que estão disponíveis (instalados). Os projetos de script podem ser instalados, removidos ou reordenados.

A página Scripting System – Global Projects da caixa de diálogo Preferences

Preferências do Form Designer

A página Scripting System – Form Designer da caixa de diálogo Preferences fornece as opções de grelha e de designador de componentes para um documento de formulário de scripting.

A página Scripting System – Form Designer da caixa de diálogo Preferences