Diferencias entre DelphiScript y Delphi
De un vistazo
- Comprende las variables basadas en Variant, las conversiones de tipos en tiempo de ejecución y sus implicaciones para las pruebas y el rendimiento.
- Descubre qué características de Delphi no se admiten o se comportan de forma diferente, como los arrays, los operadores de conjuntos, las rutinas anidadas y la gestión de excepciones.
- Aprende a utilizar las clases existentes y las interfaces de objetos de Altium Designer, con un ejemplo que crea una vía en una PCB.
Diferencias entre DelphiScript y Delphi
Esta sección aborda las diferencias esenciales entre el lenguaje de scripting DelphiScript y el lenguaje de programación Delphi de Embarcadero, y cómo se aplican a la API de Altium Designer.
El sistema de scripting de Altium Designer utiliza el lenguaje DelphiScript sin tipado, por lo que no hay tipos de datos en los scripts. Aunque puede declarar variables y sus tipos, y especificar los tipos de las funciones, los procedimientos o los parámetros de los métodos para facilitar la lectura, DelphiScript convertirá las variables no declaradas durante la ejecución de un script. Por ejemplo, no puede definir registros ni clases.
Variables de DelphiScript
Todas las variables de un script son de tipo Variant, y los tipos indicados en una declaración de variable se ignoran y pueden omitirse. Por tanto, estas tres declaraciones son correctas:
Var
a : Integer;
Var
b : Integer;
Var
c, d;
Los tipos de los parámetros en una declaración de procedimiento o función también se ignoran y pueden omitirse. Por ejemplo, este código es correcto:
Function Sum(a, b) : Integer;
Begin
Result := a + b;
End;
En general, las variantes pueden utilizarse para almacenar cualquier tipo de datos y realizar numerosas operaciones y conversiones de tipos. La comprobación del tipo y el cálculo de una variante se realizan en tiempo de ejecución. El compilador no advertirá de los posibles errores del código, que solo pueden detectarse mediante pruebas exhaustivas. En conjunto, las partes del código que utilizan variantes pueden considerarse código interpretado, ya que muchas operaciones no pueden resolverse hasta el momento de la ejecución. Esto puede afectar a la velocidad del código.
Como resultado, una vez que se ha declarado una variable de tipo Variant y se le ha asignado un valor, este puede copiarse a cualquier tipo de datos compatible o incompatible :
Var
V;
Begin
// variable V can be assigned values of several different types:
V := 10;
V := 'Hello, World';
V := 45.55;
End;
Si se ha asignado un tipo de datos incompatible a una variable, el intérprete de DelphiScript realiza una conversión siempre que sea posible. De lo contrario, se genera un error en tiempo de ejecución. En la práctica, una variante almacena información del tipo junto con los datos, por lo que DelphiScript es más lento que el código compilado equivalente de Embarcadero Delphi.
Conjuntos en scripts
DelphiScript no dispone de tipos de conjunto ni admite operadores de conjuntos, a diferencia del lenguaje Delphi, que sí dispone de estos tipos y admite sus operadores.
Para utilizar conjuntos en los scripts de DelphiScript, utilice las funciones integradas que permiten manipular conjuntos en un script.
Consulte la entrada Uso de conjuntos en DelphiScript para obtener más información
Funciones o procedimientos internos
Al utilizar funciones y procedimientos inside de una función o un procedimiento, se recomienda escribir funciones o procedimientos independientes, aunque se permiten los procedimientos y las funciones recursivos.
No se recomienda el siguiente fragmento de función:
Function A
Function B
Begin
// blah
End;
Begin
B;
End;
Estructura de función recomendada:
Function B
Begin
// blah
End;
Function A
Begin
B;
End;
Palabra clave Result
Utilice la palabra clave Result para establecer el valor de retorno dentro de un bloque de función. Por ejemplo:
Function Foo : String;
Begin
Result := 'Foo Foo';
End;
Rutinas anidadas
Se admiten rutinas anidadas, pero las variables de la función de nivel superior no pueden utilizarse desde la rutina anidada.
Elementos de matrices
El tipo de los elementos de una matriz se ignora y puede omitirse, por lo que estas dos declaraciones son equivalentes:
Var
x : array [1..2] of double;
Var
x : array [1..2];
Tenga en cuenta que no puede declarar tipos de matriz, pero sí puede declarar variables de matriz.
Illegal example:
Type
TVertices = Array [1..50] Of TLocation;
Var
NewVertices : TVertices;
Legal example:
Var
NewVertices : Array [1..50] of TLocation;
Declaración de matrices abiertas
No se admite la declaración Open Array.
Palabra clave Case
La palabra clave Case puede utilizarse con cualquier tipo. Por tanto, lo siguiente es válido:
Case UserName of
'Alex', 'John' : IsAdministrator := true;
'Peter' : IsAdministrator := false;
Else
Raise('Unknown user');
End;
Declaraciones de clases
No se pueden definir clases nuevas en DelphiScript, pero puede utilizar clases existentes de DelphiScript y crear instancias de ellas. Por ejemplo, las clases TList y TStringList pueden instanciarse y utilizarse en sus scripts.
See also
TList
TStringList
Función CreateObject
La función CreateObject puede utilizarse para crear objetos que se liberarán de forma implícita cuando dejen de utilizarse.
Así, en lugar de:
Procedure Proc;
Var
l;
Begin
l := TList.Create;
Try
// do something with l
Finally
L.Free;
End;
...puede escribir:
Procedure Proc;
Var
l;
Begin
l := CreateObject(TList);
// Do something with l
End;
See also
Función CreateObject.
Lanzamiento de excepciones
La palabra clave Raise puede utilizarse sin parámetros para volver a lanzar la última excepción. Raise también puede utilizarse con un parámetro de cadena para lanzar la excepción con el mensaje especificado. Los objetos Exception no se admiten en DelphiScript, ya que no se admite la palabra clave On.
Example:
Raise(Format('Invalid value : %d', [Height]));
See also
Palabras clave Try, Finally y Raise.
ThreadVar
En DelphiScript, la palabra clave Threadvar se trata como Var. Tenga en cuenta que, en Embarcadero Delphi, las variables declaradas mediante la palabra clave Threadvar tienen valores distintos en cada hilo.
Operadores de conjuntos
No se admite el operador de conjuntos In. El operador InSet puede utilizarse para comprobar si un valor pertenece a un conjunto. Por ejemplo:
If InSet(fsBold, Font.Style) then
ShowMessage('Bold');
Tenga en cuenta que los operadores de conjuntos de Delphi +, -, *, <=, >= no funcionan correctamente. En su lugar, se utilizan las funciones integradas de DelphiScript MkSet, MkSetRange, SetUnion, SetDifference, SetIntersection, SubSet and InSet:
ASet := BSet + CSet; \\ should be changed to
ASet := SetUnion(BSet, CSet);
No se admiten los constructores de conjuntos [...]; utilice la función MkSet para crear un conjunto:
Font.Style := MkSet(fsBold, fsItalic);
See also
Palabra clave MkSet
Palabra clave MkSetRange
Palabra clave InSet
Palabra clave SetDifference
Palabra clave SetIntersection
Palabra clave SetUnion
Palabra clave SubSet
Palabra clave InSet
Operadores
No se admiten los operadores ^ y @.
Directivas
No se admiten las siguientes directivas (tenga en cuenta que algunas están obsoletas y tampoco se admiten en Embarcadero Delphi): absolute, abstract, assembler, automated, cdecl, contains, default, dispid, dynamic, export, external, far, implements, index, message, name, near, nodefault, overload, override, package, pascal, private protected, public, published, read, readonly, register, reintroduce, requires, resident, safecall, stdcall, stored, virtual, write, writeonly.
Además, tenga en cuenta que se ignora la directiva in de la cláusula Uses.
Palabras clave ignoradas
Las palabras clave interface, implementation, program y unit se ignoran en DelphiScript. Los scripts pueden contenerlas, pero no tienen ningún efecto; no obstante, estas palabras clave pueden mejorar la legibilidad de los scripts.
Palabras clave no admitidas
Las siguientes palabras clave no se admiten en DelphiScript:
-
as, asm, class, dispinterface, exports, finalization, inherited, initialization, inline, interface, is, library, object, out, property, record, resourcestring, set, supports, type.
Las siguientes funciones de la RTL de Delphi no se admiten en DelphiScript:
-
Abort, Addr, Assert, Dec, FillChar, Finalize, Hi, High, Inc, Initialize, Lo, Low, New, Ptr, SetString, SizeOf, Str, UniqueString, VarArrayRedim, VarArrayRef, VarCast, VarClear, VarCopy.
No se admiten las funciones de la unidad Windows de Delphi (el archivo windows.pas); por ejemplo, no se admite la función RGB.
Uso de la API de Altium Designer en scripts
No puede crear sus propios tipos de registro o clase mediante DelphiScript e instanciarlos en un script; sin embargo, puede utilizar determinadas clases de la API de Altium Designer. Por ejemplo, las clases TStringList y TList pueden instanciarse y utilizarse como contenedores de almacenamiento de datos (normalmente del mismo tipo) para satisfacer las necesidades de un script.
Las interfaces de objetos de la API que representan objetos de Altium Designer están disponibles para su uso en scripts. Por ejemplo, puede actualizar objetos de diseño en documentos de esquemáticos y de PCB mediante las interfaces de objetos de esquemáticos y las interfaces de objetos de PCB.
Por convención, se añade una «I» al principio de los nombres de las interfaces. Por ejemplo, IPCB_Board representa una interfaz para un documento de PCB existente.
Ejemplo de interfaces de PCB en un script:
Procedure ViaCreation;
Var
Board : IPCB_Board;
Via : IPCB_Via;
Begin
Board := PCBServer.GetCurrentPCBBoard;
If Board = Nil Then Exit;
(\* Create a Via object\* )
Via := PCBServer.PCBObjectFactory(eViaObject, eNoDimension, eCreate_Default);
Via.X := MilsToCoord(7500);
Via.Y := MilsToCoord(7500);
Via.Size := MilsToCoord(50);
Via.HoleSize := MilsToCoord(20);
Via.LowLayer := eTopLayer;
Via.HighLayer := eBottomLayer;
(* Put this via in the Board object*)
Board.AddPCBObject(Via);
End;
Las siguientes API pueden utilizarse en scripts:
- Determinadas funciones y clases de Embarcadero Delphi™, y extensiones de DelphiScript
- API de cliente
- API del servidor de PCB
- API del servidor de esquemáticos
- API del servidor del gestor del espacio de trabajo
- API de bibliotecas integradas
- Funciones de la API de Altium Designer
- Procesos paramétricos
Más información
Consulte los scripts de la colección de scripts descargable para ver cómo se utilizan en scripts las interfaces de objetos y las funciones de Altium Designer, así como los objetos y las funciones de Delphi.
Consulte la documentación principal sobre scripts para obtener información sobre cómo escribir scripts para Altium Designer.
Consulte la guía Uso de la API de Altium Designer para obtener detalles sobre cómo utilizar los objetos de diseño y sus interfaces en sus scripts.
Consulte la Referencia de la API de Altium Designer para obtener información sobre las distintas API de Altium Designer y sus objetos de interfaz para scripts.