AScript syntax and variable reference

Syntax

Rule

Comment

Any text on a line that follows a pound sign (#) is considered a comment. For example: # this is annotation.

Identifier

• An identifier can contain letters, digits, and underscores (_), but cannot start with a digit. Identifiers are case-sensitive.

• This rule applies to the names of both built-in and custom variables and functions.

Data type

• String

  Literal constant: A value enclosed in single quotes, for example: 'hello, AScript'.

• Number

  Literal constant: A decimal number. For example: 10, -99, or 1.1.

• Boolean

  Literal constant: true or false.

• Dictionary

  The following are examples of literal constants:

  • []: An empty dictionary.

  • ['key1', 'key2', 100]:

    • 1 -> 'key1'

    • 2 -> 'key2'

    • 3 -> 100

  • ['key1' = 'value1', 'key2' = 1000]

    • 'key1' -> 'value1'

    • 'key2' -> 1000

Variable

• Definition

  A variable is defined when a value is assigned to it.

• Usage

  • Reference built-in and custom variables by their names.

    • Referencing a built-in variable: host.

    • Referencing a custom variable: seckey.

  • You can use the $ symbol to reference the built-in properties of a variable.

    Referencing a built-in variable: $host.

  • A custom variable cannot have the same name as a built-in variable.

    For a list of built-in variables, see the Built-in variables table below.

Operator

• = : The assignment operator.

  • For example: seckey = 'ASDLFJ234dxvf34sDF'

  • For example: seckeys = ['key1', 'key2']

• - : The unary minus operator.

  For example: inum = -10

• AScript does not support other operators. Instead, operations on data types are handled by built-in functions. For more information, see Overview of AScript built-in functions.

Statement

• Conditional statement

  if condition {   
     ...
  }
  
  if condition1 {   
     if condition2 {
          ...
     }
  }
  
  if condition {
     ...
  } else {
     ...
  }

• Explanation

  • A condition can consist of the following syntax elements:

    • Literal value

    • Variable

    • Function call

  • Body

    • The body can be empty.

    • Multiple statements are allowed. Write one statement per line.

  • Multi-level nesting is supported.

  • Coding Style

    The syntax requires the opening curly brace to follow the if condition on the same line.

Function

• Definition syntax

  def function_name(parameter_list) {
      ...
  }

• Definition details

  • Parameter list

    • Functions can be defined without parameters.

    • Separate multiple parameters with commas.

  • Function body

    • The body can be empty.

    • Multiple statements are allowed. Write one statement per line.

    • Return value: The return statement is supported.

  • Coding Style

    The syntax requires the opening curly brace to follow the def function name (parameter list) and be on the same line.

• Function call

  Both built-in and custom functions are called by using function_name(parameter_list).