Hetu Script

https://pub.dev/documentation/hetu_script/latest
Admin
A lightweight scripting language written in Dart for embedding in Flutter apps, enabling hotfix and...
Tokens:484,699
Snippets:3,393
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Hetu Script REPL Mode Examples

Source: https://pub.dev/documentation/hetu_script/latest/index

Shows examples of interacting with the Hetu script command-line REPL. It demonstrates variable assignment, function definition, and function calls, including multi-line input using the backslash character.

```bash
>>>var a = 42
null // repl print
>>>a
42 // repl print
>>>fun meaning {\
return a }
null // repl print
>>>meaning
meaning() -> any // repl print
>>>hello()
42 // repl print
```

--------------------------------

### Initialize AnalyzerConfig

Source: https://pub.dev/documentation/hetu_script/latest/analyzer_analyzer/HTAnalyzer/config

Demonstrates the initialization of an AnalyzerConfig object. This is a basic setup for the configuration.

```java
AnalyzerConfig config;

```

--------------------------------

### HETU Script: Get functionParameterStart Property (String)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/functionParameterStart

This snippet shows how to get the 'functionParameterStart' property in HETU script. It is declared as a String and its implementation is provided.

```HETU Script
String get functionParameterStart;
```

--------------------------------

### GET /help

Source: https://pub.dev/documentation/hetu_script/latest/hetu_hetu/Hetu/help

Retrieves help information based on the provided ID and optional module name.

```APIDOC
## GET /help

### Description
Retrieves help information for a given ID, optionally filtered by a module name.

### Method
GET

### Endpoint
/help

### Parameters
#### Query Parameters
- **id** (dynamic) - Required - The identifier for which help information is requested.
- **moduleName** (String) - Optional - The name of the module to filter the help information.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **String?** - A string containing the help information, or null if not found.

#### Response Example
{
  "example": "Help information for the specified ID and module."
}
```

--------------------------------

### HETU Script: createContext Method Implementation Example

Source: https://pub.dev/documentation/hetu_script/latest/resource_resource_manager/HTSourceManager/createContext

Provides an example implementation of the createContext method in HETU Script. This method is expected to return a CT object and accepts a root path string.

```HETU Script
CT createContext(String root);
```

--------------------------------

### Group Expression Start Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/groupExprStart

Retrieves the 'groupExprStart' property, which is a String.

```APIDOC
## GET /websites/pub_dev_hetu_script/groupExprStart

### Description
Retrieves the value of the `groupExprStart` property.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/groupExprStart

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **groupExprStart** (String) - The value of the group expression start property.

#### Response Example
```json
{
  "groupExprStart": "example_value"
}
```
```

--------------------------------

### GET /websites/pub_dev_hetu_script/help

Source: https://pub.dev/documentation/hetu_script/latest/value_namespace_namespace/HTNamespace/help

Retrieves documentation for a given variable name. It checks local symbols, imported symbols, and closure members.

```APIDOC
## GET /websites/pub_dev_hetu_script/help

### Description
Retrieves documentation for a given variable name. It checks local symbols, imported symbols, and closure members.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/help

### Parameters
#### Query Parameters
- **varName** (String) - Required - The name of the variable or symbol to get help for.

### Request Example
```
GET /websites/pub_dev_hetu_script/help?varName=myVariable
```

### Response
#### Success Response (200)
- **documentation** (String) - The documentation string for the requested variable or symbol.

#### Response Example
```json
{
  "documentation": "This is the documentation for myVariable."
}
```

#### Error Response (404)
- **error** (String) - Indicates that the variable or symbol was not found.

#### Error Response Example
```json
{
  "error": "HTError.undefined(myVariable)"
}
```
```

--------------------------------

### GET /websites/pub_dev_hetu_script/listStart

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/listStart

Retrieves the value of the listStart property from the hetu_script project.

```APIDOC
## GET /websites/pub_dev_hetu_script/listStart

### Description
Retrieves the value of the listStart property, which is a String, from the hetu_script project.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/listStart

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **listStart** (String) - The value of the listStart property.

#### Response Example
```json
{
  "listStart": "example_value"
}
```
```

--------------------------------

### LineInfo Constructor

Source: https://pub.dev/documentation/hetu_script/latest/source_line_info/LineInfo/LineInfo

Initializes a new LineInfo object with a list of line start indices. Throws an ArgumentError if the provided list is empty.

```APIDOC
## LineInfo Constructor

### Description
Initializes a newly created set of line information to represent the data encoded in the given list of `lineStarts`.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **lineStarts** (List<int>) - Required - A list of integers representing the start index of each line.

### Request Example
```dart
// Example of how to call the constructor
final lineInfo = LineInfo([0, 10, 25, 40]);
```

### Response
#### Success Response (Initialization)
* **LineInfo object**: A new instance of the LineInfo class is created.

#### Response Example
```dart
// Successful initialization
final lineInfo = LineInfo([0, 10, 25, 40]); 
// lineInfo object is now ready to be used
```

#### Error Response (200)
* **ArgumentError**: Thrown if the `lineStarts` list is empty.

#### Error Example
```dart
// This will throw an ArgumentError
try {
  final lineInfo = LineInfo([]);
} catch (e) {
  print(e); // Output: ArgumentError: lineStarts must be non-empty
}
```
```

--------------------------------

### identifierStart Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/identifierStart

Retrieves the starting identifier for the script.

```APIDOC
## GET /websites/pub_dev_hetu_script/identifierStart

### Description
Retrieves the starting identifier for the Hetu script.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/identifierStart

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **identifierStart** (String) - The starting identifier string.

#### Response Example
{
  "identifierStart": "some_identifier"
}
```

--------------------------------

### Hetu Class Constructor and Properties

Source: https://pub.dev/documentation/hetu_script/latest/hetu_hetu/Hetu-class

Details on how to create a Hetu environment and access its core properties.

```APIDOC
## Hetu Class

A wrapper class for sourceContext, lexicon, parser, bundler, analyzer, compiler and interpreter to make them work together.

### Constructor

`Hetu({HetuConfig? config, HTResourceContext<HTSource>? sourceContext, HTLexicon? lexicon, String parserName = 'default', HTParser? parser})`
    Create a Hetu environment.

### Properties

- **analyzer** (HTAnalyzer) - latefinal
- **bundler** (HTBundler) - latefinal
- **compiler** (HTCompiler) - latefinal
- **config** (HetuConfig) - getter/setter pair
- **hashCode** (int) - The hash code for this object. (inherited)
- **interpreter** (HTInterpreter) - latefinal
- **isInitted** (bool) - no setter
- **lexicon** (HTLexicon) - latefinal
- **parser** (HTParser) - no setter
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)
- **sourceContext** (HTResourceContext<HTSource>) - final
- **verison** (Version?) - getter/setter pair
```

--------------------------------

### Get Variadic Arguments Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/variadicArgs

This snippet demonstrates how to declare and get the 'variadicArgs' property in Dart. It returns a String and has no explicit dependencies shown in this example.

```dart
String get variadicArgs;

```

--------------------------------

### Get External Function Type Definition Start Property (String)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/externalFunctionTypeDefStart

Retrieves the string value representing the start of an external function's type definition. This is a fundamental property for defining function signatures.

```string
String get externalFunctionTypeDefStart;
```

--------------------------------

### Implement Hetu Script Init Method

Source: https://pub.dev/documentation/hetu_script/latest/resource_resource_context/HTResourceContext/init

This snippet shows the implementation of the 'init' method in Hetu script. It is a void function with no parameters and an empty body, indicating a basic initialization structure.

```hetu
void init() {}
```

--------------------------------

### Get documentationCommentStart Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/documentationCommentStart

Retrieves the character sequence that marks the start of a documentation comment. This property is essential for parsing and processing documentation comments within code.

```dart
String get documentationCommentStart;
```

--------------------------------

### ASTComment Constructor

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/ASTComment/ASTComment

This section details the ASTComment constructor, its parameters, and provides an implementation example.

```APIDOC
## ASTComment Constructor

### Description
Constructs a new ASTComment object with specified properties.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **content** (String) - Required - The content of the comment.
- **isDocumentation** (bool) - Required - Indicates if the comment is a documentation comment.
- **isMultiLine** (bool) - Required - Indicates if the comment spans multiple lines.
- **isTrailing** (bool) - Required - Indicates if the comment is a trailing comment.
- **source** (HTSource?) - Optional - The source information for the comment.
- **line** (int) - Optional - The starting line number of the comment (default: 0).
- **column** (int) - Optional - The starting column number of the comment (default: 0).
- **offset** (int) - Optional - The starting offset of the comment (default: 0).
- **length** (int) - Optional - The length of the comment (default: 0).

### Request Example
```dart
ASTComment(
  content: "// This is a comment",
  isDocumentation: false,
  isMultiLine: false,
  isTrailing: false,
  source: someSourceInfo,
  line: 10,
  column: 5,
  offset: 100,
  length: 20,
)
```

### Response
#### Success Response (200)
N/A (This is a constructor)

#### Response Example
N/A
```

--------------------------------

### Hetu Constructor

Source: https://pub.dev/documentation/hetu_script/latest/hetu_hetu/Hetu/Hetu

Initializes a new Hetu environment with optional configuration parameters.

```APIDOC
## Hetu Constructor

### Description
Creates a Hetu environment with customizable configuration options.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```dart
Hetu myHetu = Hetu(
  config: HetuConfig(),
  sourceContext: HTOverlayContext(),
  lexicon: HTDefaultLexicon(),
  parserName: 'customParser',
  parser: HTDefaultParser()
);
```

### Response
#### Success Response (200)
N/A (Constructor returns an instance of Hetu)

#### Response Example
```dart
// Hetu instance is created and ready for use.
```
```

--------------------------------

### Hetu Script: Get Type List Start Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/typeListStart

This code snippet shows the declaration of the `typeListStart` property in Hetu Script. It is a getter method that returns a String, indicating the starting point for type lists within the script.

```hetu
String get typeListStart;
```

--------------------------------

### Get Single Line Comment Start Property in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/singleLineCommentStart

Retrieves the string that marks the start of a single-line comment in Hetu Script. This property is essential for parsing and interpreting comment syntax within the script.

```Hetu Script
String get singleLineCommentStart;
```

--------------------------------

### UI Mode Switching

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/DestructuringDecl/accept

Provides methods to switch between dark and light modes for the UI.

```APIDOC
## PUT /websites/pub_dev_hetu_script/mode

### Description
Switches the UI theme between dark mode and light mode.

### Method
PUT

### Endpoint
/websites/pub_dev_hetu_script/mode

### Parameters
#### Query Parameters
- **mode** (string) - Required - The desired mode ('dark_mode' or 'light_mode').

### Request Example
```
PUT /websites/pub_dev_hetu_script/mode?mode=dark_mode
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the mode switch operation (e.g., "Mode switched to dark_mode").

#### Response Example
```json
{
  "status": "Mode switched to dark_mode"
}
```
```

--------------------------------

### Get Range (Hetu Script)

Source: https://pub.dev/documentation/hetu_script/latest/binding_instance_binding/ListBinding/htFetch

Retrieves a range of elements from a collection. It requires two positional arguments: the start index and the end index of the range.

```dart
getRange(positionalArgs[0], positionalArgs[1])
```

--------------------------------

### typeListStart Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon_default_impl/HTDefaultLexicon/typeListStart

Provides the starting character for a type list, used in the Hetu Script for website elements.

```APIDOC
## GET /websites/pub_dev_hetu_script/typeListStart

### Description
Retrieves the starting character for a type list.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/typeListStart

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **typeListStart** (String) - The starting character for the type list.

#### Response Example
{
  "typeListStart": "<"
}
```

--------------------------------

### Theme Switching API

Source: https://pub.dev/documentation/hetu_script/latest/resource_overlay_overlay_context/HTOverlayContext/addResource

Provides endpoints for switching between dark and light modes.

```APIDOC
## POST /websites/pub_dev_hetu_script/dark_modelight_mode

### Description
Switches the application theme between dark and light modes.

### Method
POST

### Endpoint
/websites/pub_dev_hetu_script/dark_modelight_mode

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **mode** (String) - Required - The desired mode, either 'dark' or 'light'.

### Request Example
```json
{
  "mode": "dark"
}
```

### Response
#### Success Response (200)
- **status** (String) - The current status of the theme mode.

#### Response Example
```json
{
  "status": "Theme set to dark mode."
}
```
```

--------------------------------

### Get IdentifierStart Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/identifierStart

This snippet shows the Dart getter for the identifierStart property. It returns a String representing the start of an identifier. No specific dependencies are mentioned.

```dart
String get identifierStart;
```

--------------------------------

### Choice Constructor

Source: https://pub.dev/documentation/hetu_script/latest/grammar_element/Choice/Choice

This section details the constructor for the Choice class, outlining its required parameters and providing an implementation example.

```APIDOC
## Choice Constructor

### Description
Initializes a new instance of the Choice class, requiring a list of SemanticElement objects.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **parts** (List<SemanticElement>) - Required - A list of SemanticElement objects that constitute the choice.

### Request Example
```dart
Choice({
  required List<SemanticElement> parts,
})
```

### Response
#### Success Response (200)
N/A

#### Response Example
```dart
Choice({required this.parts});
```
```

--------------------------------

### Get HTInstanceNamespace Property

Source: https://pub.dev/documentation/hetu_script/latest/value_instance_instance/HTInstance/namespace

Retrieves the HTInstanceNamespace for the current instance. This namespace is used to access variables, starting from the lowest class and searching through all superclasses. It is implemented using a map keyed by class ID.

```dart
HTInstanceNamespace get namespace => _namespaces[classId]!;
```

--------------------------------

### Mode Settings API

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/identifierStart

Allows for the configuration of dark and light modes for the script.

```APIDOC
## PUT /websites/pub_dev_hetu_script/mode

### Description
Sets the display mode (dark or light) for the Hetu script.

### Method
PUT

### Endpoint
/websites/pub_dev_hetu_script/mode

### Parameters
#### Query Parameters
None

#### Request Body
- **mode** (String) - Required - The desired mode, either 'dark_mode' or 'light_mode'.

### Request Example
{
  "mode": "dark_mode"
}

### Response
#### Success Response (200)
- **message** (String) - Confirmation message indicating the mode has been set.

#### Response Example
{
  "message": "Mode set to dark_mode"
}
```

--------------------------------

### Implement subGetStart Property in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon_default_impl/HTDefaultLexicon/subGetStart

This code snippet demonstrates the implementation of the 'subGetStart' property in Hetu Script. It overrides the default getter to return a specific string value, '['. This property is likely used to define a starting character or delimiter within the script's parsing or rendering logic.

```hetuscript
@override
String get subGetStart => '[';

```

--------------------------------

### Get listStart Property Declaration - Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/listStart

This snippet shows the declaration of the 'listStart' property in Hetu script. It is a String type property used to define the starting point of a list.

```Hetu Script
String get listStart;
```

--------------------------------

### Get autoSemicolonInsertAtStart List (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/autoSemicolonInsertAtStart

Retrieves the list of tokens that trigger automatic semicolon insertion at the start of a line. This list includes characters like '{', '(', '[', '++', and '--' to resolve parser ambiguities.

```dart
List<String> get autoSemicolonInsertAtStart => [
      codeBlockStart,
      functionParameterStart,
      subGetStart,
      preIncrement,
      preDecrement,
    ];
```

--------------------------------

### Get namedParameterStart Property in HETU Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/namedParameterStart

This snippet shows the declaration of the 'namedParameterStart' property, which is of type String. It is used to retrieve the starting point for named parameters within the HETU scripting language.

```HETU Script
String get namedParameterStart;
```

--------------------------------

### Theme Management

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/ParamDecl/accept

Endpoints for managing the theme, specifically toggling between dark and light modes.

```APIDOC
## PUT /websites/pub_dev_hetu_script/theme

### Description
Allows toggling between dark and light modes for the theme.

### Method
PUT

### Endpoint
/websites/pub_dev_hetu_script/theme

### Parameters
#### Query Parameters
- **mode** (string) - Required - The desired theme mode ('dark' or 'light').

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the theme change.

#### Response Example
```json
{
  "status": "Theme changed to dark mode"
}
```
```

--------------------------------

### Theme Mode Settings

Source: https://pub.dev/documentation/hetu_script/latest/value_function_parameter/HTParameter/isInitialization

Allows control and retrieval of the theme mode (dark or light) for the Hetu script.

```APIDOC
## GET /websites/pub_dev_hetu_script/theme/mode

### Description
Retrieves the current theme mode (dark or light) of the Hetu script.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/theme/mode

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **mode** (string) - The current theme mode, either 'dark' or 'light'.

#### Response Example
{
  "mode": "dark"
}

## PUT /websites/pub_dev_hetu_script/theme/mode

### Description
Sets the theme mode (dark or light) for the Hetu script.

### Method
PUT

### Endpoint
/websites/pub_dev_hetu_script/theme/mode

### Parameters
#### Request Body
- **mode** (string) - Required - The desired theme mode, either 'dark' or 'light'.

### Request Example
{
  "mode": "light"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the theme mode has been updated.

#### Response Example
{
  "message": "Theme mode updated to light."
}
```

--------------------------------

### Get multiLineCommentStart Property in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/multiLineCommentStart

Retrieves the string value representing the start of a multiline comment in Hetu script. This property is essential for parsing and interpreting comment blocks within Hetu code.

```hetu
String get multiLineCommentStart;
```

--------------------------------

### HTFileSystemContext and HTOverlayContext Creation

Source: https://pub.dev/documentation/hetu_script/latest/resource_resource_context/HTResourceContext/root

This section describes how to create instances of HTFileSystemContext and HTOverlayContext using their factory constructors. It also outlines the 'root' property available in both contexts.

```APIDOC
## HTFileSystemContext and HTOverlayContext

### Description
This API provides factory constructors for creating `HTFileSystemContext` and `HTOverlayContext`. Both contexts expose a `root` property of type String.

### Factory Constructors

#### HTFileSystemContext
Creates a file system context.

```dart
factory HTContext.fileSystem({
  String? root,
  List<HTFilterConfig> includedFilter,
  List<HTFilterConfig> excludedFilter,
  Map<String, HTSource>? cache,
})
```

#### HTOverlayContext
Creates an overlay context.

```dart
factory HTResourceContext.overlay({
  String? root,
  Map<String, HTSource>? cache,
})
```

### Properties

#### root

- **root** (String) - The root path for the context. This property is available in both `HTFileSystemContext` and `HTOverlayContext`.

### Implementation Details

```dart
// For HTFileSystemContext
// factory HTContext.fileSystem(
//     {String? root,
//     List<HTFilterConfig> includedFilter,
//     List<HTFilterConfig> excludedFilter,
//     Map<String, HTSource>? cache}) = HTFileSystemContext;

// For HTOverlayContext
// factory HTResourceContext.overlay(
//     {String? root, Map<String, HTSource>? cache}) = HTOverlayContext;

String get root;
```
```

--------------------------------

### HETU Script: Get groupExprStart Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/groupExprStart

This snippet shows the declaration of the 'groupExprStart' property in HETU script. It is a String type, indicating it holds textual data representing the start of a group expression. No external dependencies are required for this declaration.

```HETU Script
String get groupExprStart;
```

--------------------------------

### Get Line Offset - Dart

Source: https://pub.dev/documentation/hetu_script/latest/source_line_info/LineInfo/getOffsetOfLine

Retrieves the character offset for the beginning of a given line number. It validates the input line number against the total line count and throws an ArgumentError for invalid inputs. The method relies on a pre-computed list of line start offsets.

```dart
int getOffsetOfLine(int lineNumber) {
  if (lineNumber < 0 || lineNumber >= lineCount) {
    throw ArgumentError(
        'Invalid line number: $lineNumber; must be between 0 and ${lineCount - 1}');
  }
  return lineStarts[lineNumber];
}
```

--------------------------------

### Create Context

Source: https://pub.dev/documentation/hetu_script/latest/resource_resource_manager/HTSourceManager/createContext

This method creates a new context with a specified root directory. It's a fundamental operation for initializing script environments.

```APIDOC
## POST /websites/pub_dev_hetu_script/createContext

### Description
Creates a new context with the specified root directory.

### Method
POST

### Endpoint
/websites/pub_dev_hetu_script/createContext

### Parameters
#### Query Parameters
- **root** (String) - Required - The root directory for the new context.

### Request Example
```json
{
  "root": "/path/to/your/root"
}
```

### Response
#### Success Response (200)
- **contextId** (String) - The unique identifier for the created context.

#### Response Example
```json
{
  "contextId": "ctx_12345abcde"
}
```
```

--------------------------------

### String Interpolation Start Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/stringInterpolationStart

Retrieves the character sequence that marks the start of interpolation in strings.

```APIDOC
## GET /websites/pub_dev_hetu_script/stringInterpolationStart

### Description
Retrieves the character sequence that marks the start of interpolation in strings.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/stringInterpolationStart

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **stringInterpolationStart** (String) - A character sequence that marked the start of interpolation in strings.

#### Response Example
{
  "stringInterpolationStart": "$"
}
```

--------------------------------

### Hetu Constructor Implementation in Dart

Source: https://pub.dev/documentation/hetu_script/latest/hetu_hetu/Hetu/Hetu

This Dart code snippet shows the implementation of the Hetu constructor. It initializes various components like the parser, bundler, analyzer, and interpreter, using provided or default configurations. Dependencies include HetuConfig, HTResourceContext, HTLexicon, HTParser, HTBundler, HTAnalyzer, and HTInterpreter.

```dart
Hetu(
    {HetuConfig? config,
    HTResourceContext<HTSource>? sourceContext,
    HTLexicon? lexicon,
    String parserName = 'default',
    HTParser? parser})
    : config = config ?? HetuConfig(),
      lexicon = lexicon ?? HTDefaultLexicon(),
      sourceContext = sourceContext ?? HTOverlayContext() {
  _currentParser = parser ??
      HTDefaultParser(
        config: this.config,
      );
  bundler = HTBundler(
    sourceContext: this.sourceContext,
  );
  _parsers[parserName] = _currentParser;
  analyzer = HTAnalyzer(
    config: this.config,
    sourceContext: this.sourceContext,
  );
  compiler = HTCompiler(
    config: this.config,
    lexicon: this.lexicon,
  );
  interpreter = HTInterpreter(
    config: this.config,
    sourceContext: this.sourceContext,
    lexicon: this.lexicon,
  );
}
```

--------------------------------

### Documentation Comment Start Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/documentationCommentStart

Retrieves the character sequence that marks the start of a documentation comment.

```APIDOC
## GET /websites/pub_dev_hetu_script/documentationCommentStart

### Description
Retrieves the character sequence that marks the start of a documentation comment.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/documentationCommentStart

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **documentationCommentStart** (String) - A character sequence that marked the start of documentation comment.

#### Response Example
{
  "documentationCommentStart": "//$"
}
```

--------------------------------

### HETU Script: Implement Accept Method for AST Visitor

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/WhenStmt/accept

This snippet demonstrates the implementation of the 'accept' method in HETU Script. It overrides the base method to delegate the visiting logic to the provided AbstractASTVisitor, specifically calling the 'visitWhen' method on the visitor.

```HETU Script
@override
dynamic accept(AbstractASTVisitor visitor) => visitor.visitWhen(this);
```

--------------------------------

### Single Line Comment Start Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/singleLineCommentStart

Retrieves the character sequence that marks the start of a single-line comment in Hetu Script.

```APIDOC
## GET /websites/pub_dev_hetu_script/singleLineCommentStart

### Description
This endpoint provides the string that signifies the beginning of a single-line comment within the Hetu scripting language.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/singleLineCommentStart

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **singleLineCommentStart** (String) - A character sequence that marked the start of single line comment.

#### Response Example
{
  "singleLineCommentStart": "#"
}
```

--------------------------------

### Implement visitDoStmt for DoStmt Nodes in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/ast_visitor_recursive_ast_visitor/RecursiveASTVisitor/visitDoStmt

This snippet shows the implementation of the visitDoStmt method, which is part of the visitor pattern for traversing and processing Abstract Syntax Trees (AST) in the Hetu scripting language. It takes a DoStmt node as input and recursively calls the accept method on its children.

```hetu
@override
T? visitDoStmt(
  DoStmt node
) {
  node.subAccept(this);
}
```

--------------------------------

### Compute Line Starts in Dart

Source: https://pub.dev/documentation/hetu_script/latest/source_computer/computeLineStarts

Calculates the starting indices of lines in a given string content. Lines are identified by \r, \n, or \r\n characters. This function is useful for text processing and editor implementations.

```dart
List<int> computeLineStarts(String content) {
  final lineStarts = <int>[0];
  final length = content.length;
  int unit;
  for (var index = 0; index < length; index++) {
    unit = content.codeUnitAt(index);
    // Special-case \r\n.
    if (unit == 0x0D /* \r */) {
      // Peek ahead to detect a following \n.
      if ((index + 1 < length) && content.codeUnitAt(index + 1) == 0x0A) {
        // Line start will get registered at next index at the \n.
      } else {
        lineStarts.add(index + 1);
      }
    }
    // \n
    if (unit == 0x0A) {
      lineStarts.add(index + 1);
    }
  }
  return lineStarts;
}
```

--------------------------------

### Get kDo Property

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/kDo

This snippet shows how to get the kDo property. It is a string getter. No specific dependencies are mentioned.

```dart
String get kDo;
```

--------------------------------

### Implement Help Method in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/hetu_hetu/Hetu/help

This snippet shows the Dart implementation of the 'help' method in the Hetu script. It takes a dynamic ID and an optional String moduleName as input. The method delegates the call to an underlying interpreter's help function, returning a String or null.

```dart
String? help(
  dynamic id, {
  String? moduleName,
}) =>
    interpreter.help(
      id,
      moduleName: moduleName,
    );
```

--------------------------------

### bundle Method

Source: https://pub.dev/documentation/hetu_script/latest/bundler_bundler/HTBundler-class

Parses a string content and generates a library, importing other files as needed.

```APIDOC
## POST /bundle

### Description
Parses a string content and generates a library, will import other files.

### Method
POST

### Endpoint
`/bundle`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **source** (HTSource) - Required - The source object to bundle.
- **parser** (HTParser) - Required - The parser to use for processing the source.
- **normalizePath** (bool) - Optional - Whether to normalize file paths. Defaults to true.
- **printPerformanceStatistics** (bool) - Optional - Whether to print performance statistics. Defaults to false.
- **version** (Version?) - Optional - The version of the library.

### Request Example
```json
{
  "source": "...",
  "parser": "...",
  "normalizePath": true,
  "printPerformanceStatistics": false,
  "version": "1.0.0"
}
```

### Response
#### Success Response (200)
- **ASTCompilation** - The resulting AST compilation object.

#### Response Example
```json
{
  "compilation": "..."
}
```
```

--------------------------------

### Line Starts Property

Source: https://pub.dev/documentation/hetu_script/latest/source_line_info/LineInfo/lineStarts

The lineStarts property is a list of integers representing the starting character offsets for each line in the source code.

```APIDOC
## Line Starts Property

### Description
A list containing the offsets of the first character of each line in the source code.

### Type
List<int>

### Implementation
```dart
final List<int> lineStarts;
```
```

--------------------------------

### Get Logical OR Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/logicalOr

This snippet demonstrates how to get the 'logicalOr' property, which is of type String. It shows the declaration of the getter.

```dart
String get logicalOr;
```

--------------------------------

### Theme Management API

Source: https://pub.dev/documentation/hetu_script/latest/hetu_hetu/Hetu/evalFile

Provides endpoints for switching between dark and light modes.

```APIDOC
## POST /websites/pub_dev_hetu_script/dark_modelight_mode

### Description
Switches the theme between dark mode and light mode.

### Method
POST

### Endpoint
`/websites/pub_dev_hetu_script/dark_modelight_mode`

### Parameters
#### Request Body
- **mode** (String) - Required - The desired theme mode. Accepts either 'dark' or 'light'.

### Request Example
```json
{
  "mode": "dark"
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the operation, e.g., "Theme switched to dark mode."
```

--------------------------------

### Get Assign Truncating Device Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/assignTruncatingDevide

This snippet shows how to get the 'assignTruncatingDevide' property. It is a String type property.

```dart
String get assignTruncatingDevide;

```

--------------------------------

### Initialize Method Implementation

Source: https://pub.dev/documentation/hetu_script/latest/declaration_function_parameter_declaration/HTParameterDeclaration/initialize

Provides the implementation for the initialize method in the HETU script. This method is typically an override of a base class method.

```dart
@override
void initialize() {}
```

--------------------------------

### Get isLexiconCaseSensitive Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/grammar_grammar/HTGrammarConfig/isLexiconCaseSensitive

This snippet shows how to get the boolean value of the 'isLexiconCaseSensitive' property. It is a direct property access and has no external dependencies.

```dart
bool get isLexiconCaseSensitive;
```

--------------------------------

### HETU Script Methods

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon_default_impl/HTDefaultLexicon-class

Documentation for available methods in HETU Script.

```APIDOC
## HETU Script Methods

### Description
Provides details on the methods available within the HETU Script environment.

### Methods

- **getBaseTypeId(String typeString)** (String) - Gets the base type ID from a type string.
- **isPrivate(String id)** (bool) - Checks if an identifier is private.
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed.
- **stringify(dynamic object, {bool asStringLiteral = false})** (String) - Marks group start/end and prints an object to a string.
- **toString()** (String) - Returns a string representation of the object.
```

--------------------------------

### Get errorReturnType Property Implementation (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/locale_locale/HTLocale/errorReturnType

This snippet shows the implementation of the get errorReturnType property in Dart. It defines a getter that returns a String.

```dart
String get errorReturnType;

```

--------------------------------

### Get redirectingConstructorCallKeywords - Dart

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/redirectingConstructorCallKeywords

This snippet demonstrates how to get the set of keywords for redirecting constructor calls in Dart. It returns a Set<String> containing 'this' and 'super'.

```dart
Set<String> get redirectingConstructorCallKeywords => {kThis, kSuper};
```

--------------------------------

### Implement 'addLeft' Constant - Static Example

Source: https://pub.dev/documentation/hetu_script/latest/bytecode_compiler/HTRegIdx/addLeft-constant

This snippet provides a static implementation example for the 'addLeft' constant. It assigns a value of 12 to the constant.

```JavaScript
static const addLeft = 12;
```

--------------------------------

### Activate Hetu Script Command Line Tool

Source: https://pub.dev/documentation/hetu_script/latest/index

Provides the command to globally activate the Hetu Script development tools, which includes a command-line REPL for testing Hetu scripts.

```bash
dart pub global activate hetu_script_dev_tools
```

--------------------------------

### Get errorMisplacedContinue Property Implementation

Source: https://pub.dev/documentation/hetu_script/latest/locale_locale/HTLocale/errorMisplacedContinue

This snippet shows the implementation of the get errorMisplacedContinue property. It declares the property as a String. No external dependencies are mentioned.

```dart
String get errorMisplacedContinue;

```

--------------------------------

### AbstractASTVisitor Constructors and Properties

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/AbstractASTVisitor-class

Details the constructors and properties available for the AbstractASTVisitor class.

```APIDOC
## Constructors

### AbstractASTVisitor()

## Properties

### hashCode → int
* Description: The hash code for this object.
* Inherited: Yes
* Setter: No

### runtimeType → Type
* Description: A representation of the runtime type of the object.
* Inherited: Yes
* Setter: No
```

--------------------------------

### Get Add Property - HETU Script (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/add

This snippet shows how to get the 'add property' in HETU Script. It is implemented in Dart and returns a String.

```dart
String get add;

```

--------------------------------

### HTOverlayContext Class Documentation

Source: https://pub.dev/documentation/hetu_script/latest/resource_overlay_overlay_context/HTOverlayContext-class

Detailed documentation for the HTOverlayContext class, including its constructors, properties, methods, and operators.

```APIDOC
## HTOverlayContext Class

### Description
HTOverlayContext represents a virtual set of files that do not necessarily exist as physical files. It does not scan the physical disk and relies on the `addResource` method to manage sources.

### Inheritance
* Object
* HTResourceContext<HTSource>
* HTOverlayContext

## Constructors

### HTOverlayContext

```dart
HTOverlayContext({String? root, Map<String, HTSource>? cache})
```

## Properties

### binaryFileExtensions

- **Type**: `List<String>`
- **Description**: The list of binary file extensions.
- **Access**: Read-only (inherited)

### hashCode

- **Type**: `int`
- **Description**: The hash code for this object.
- **Access**: Read-only (inherited)

### included

- **Type**: `Set<String>`
- **Description**: The set of included resource identifiers.
- **Access**: Read-only (final)

### root

- **Type**: `String`
- **Description**: The root directory for the context. Allows creating a `HTFileSystemContext` or an `HTOverlayContext`.
- **Access**: Read/Write (late, final, override getter)

### runtimeType

- **Type**: `Type`
- **Description**: A representation of the runtime type of the object.
- **Access**: Read-only (inherited)

## Methods

### addResource

- **Description**: Adds a resource to the context.
- **Method**: `void addResource(String fullName, HTSource resource)`
- **Access**: Override

### checkExtension

- **Description**: Checks the resource type based on the file extension.
- **Method**: `HTResourceType checkExtension(String ext)`
- **Access**: Inherited

### contains

- **Description**: Checks if a resource with the given key exists in the context.
- **Method**: `bool contains(String key)`
- **Access**: Override

### getAbsolutePath

- **Description**: Gets a unique absolute normalized path for a given key, directory, or file name.
- **Method**: `String getAbsolutePath({String key = '', String? dirName, String? fileName})`
- **Access**: Inherited

### getResource

- **Description**: Imports a resource with a specific key, ignoring those already imported.
- **Method**: `HTSource getResource(String key, {String? from})`
- **Access**: Override

### init

- **Description**: Initializes the resource context.
- **Method**: `void init()`
- **Access**: Inherited

### noSuchMethod

- **Description**: Invoked when a nonexistent method or property is accessed.
- **Method**: `dynamic noSuchMethod(Invocation invocation)`
- **Access**: Inherited

### removeResource

- **Description**: Removes a resource from the context.
- **Method**: `void removeResource(String fullName)`
- **Access**: Override

### toString

- **Description**: Returns a string representation of this object.
- **Method**: `String toString()`
- **Access**: Inherited

### updateResource

- **Description**: Updates an existing resource in the context.
- **Method**: `void updateResource(String fullName, HTSource resource)`
- **Access**: Override

## Operators

### operator ==

- **Description**: The equality operator. Checks if this object is equal to another object.
- **Method**: `bool operator ==(Object other)`
- **Access**: Inherited
```

--------------------------------

### HETU Script: Define Identifier Start Pattern

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon_default_impl/HTDefaultLexicon/identifierStartPattern

This code snippet defines the `identifierStartPattern` property in HETU Script. It uses a regular expression `r'[_$p{L}]'` to specify that identifiers must start with an underscore, a dollar sign, or any Unicode letter. This ensures valid naming conventions for variables and functions.

```hetuscript
@override
String get identifierStartPattern => r'[_$\p{L}]';
```

--------------------------------

### Theme Management

Source: https://pub.dev/documentation/hetu_script/latest/resource_resource_manager/HTSourceManager/createContext

API endpoints for managing the dark and light mode settings within the Hetu Script environment.

```APIDOC
## GET /websites/pub_dev_hetu_script/dark_mode

### Description
Retrieves the current dark mode status.

### Method
GET

### Endpoint
/websites/pub_dev_hetu_script/dark_mode

### Response
#### Success Response (200)
- **isDarkMode** (Boolean) - True if dark mode is enabled, false otherwise.

#### Response Example
```json
{
  "isDarkMode": true
}
```

## POST /websites/pub_dev_hetu_script/dark_mode

### Description
Sets the dark mode status.

### Method
POST

### Endpoint
/websites/pub_dev_hetu_script/dark_mode

### Parameters
#### Request Body
- **enableDarkMode** (Boolean) - Required - Set to true to enable dark mode, false to disable.

### Request Example
```json
{
  "enableDarkMode": true
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the operation (e.g., "success").

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### HETU Script: Get errorCircleInit Property

Source: https://pub.dev/documentation/hetu_script/latest/locale_locale/HTLocale/errorCircleInit

This snippet shows how to get the value of the errorCircleInit property in HETU Script. It is a string type property.

```HETU Script
String get errorCircleInit;
```

--------------------------------

### Implement listStart Property in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon_default_impl/HTDefaultLexicon/listStart

This snippet demonstrates how to implement the listStart property in Hetu Script. It overrides the default behavior to return a specific string literal representing the opening bracket for lists.

```dart
@override
String get listStart => '[';

```

--------------------------------

### HTSystemClassBinding Constructor Implementation (Hetu Script)

Source: https://pub.dev/documentation/hetu_script/latest/binding_class_binding/HTSystemClassBinding/HTSystemClassBinding

This snippet shows the implementation of the HTSystemClassBinding constructor in Hetu script. It initializes the class with the superclass 'OS'.

```Hetu Script
HTSystemClassBinding() : super('OS');
```

--------------------------------

### Get kWhen Property Implementation (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/kWhen

This snippet shows the Dart implementation for getting the kWhen property. It defines a getter for a String type property named kWhen.

```dart
String get kWhen;

```

--------------------------------

### Define Function Parameter Start Character in HETU Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon_default_impl/HTDefaultLexicon/functionParameterStart

This snippet shows how to define the character that signifies the start of a function parameter list in HETU scripts. It utilizes the '@override' annotation, common in Dart, to indicate that this property is overriding a base class definition. The implementation returns a single opening parenthesis character.

```dart
@override
String get functionParameterStart => '(';
```

--------------------------------

### HETU Script: Implement Accept Method with AbstractASTVisitor

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/CallExpr/accept

This snippet demonstrates the implementation of the 'accept' method in HETU Script. It overrides the base method to accept an AbstractASTVisitor and delegates the visiting logic to the visitor's 'visitCallExpr' method. This is a common pattern for implementing the visitor design pattern.

```HETU Script
@override
dynamic accept(AbstractASTVisitor visitor) => visitor.visitCallExpr(this);
```

--------------------------------

### AST Visitor Accept Method

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/ASTCompilation/accept

The `accept` method is used to allow an `AbstractASTVisitor` to visit the current node in the Abstract Syntax Tree (AST). This is a common pattern in compiler design for tree traversal and analysis.

```APIDOC
## POST /websites/pub_dev_hetu_script/accept

### Description
Accepts an AbstractASTVisitor to visit the current node. This method is part of the AST traversal mechanism.

### Method
POST

### Endpoint
/websites/pub_dev_hetu_script/accept

### Parameters
#### Request Body
- **visitor** (AbstractASTVisitor) - Required - An instance of an AbstractASTVisitor to process the current node.

### Request Example
```json
{
  "visitor": "<instance_of_AbstractASTVisitor>"
}
```

### Response
#### Success Response (200)
- **result** (dynamic) - The result returned by the visitor's visit method.

#### Response Example
```json
{
  "result": "<visitor_return_value>"
}
```
```

--------------------------------

### Get kBreak Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/kBreak

This snippet shows how to get the kBreak property. It is a String type property and does not require any specific dependencies or inputs. The output is the value of the kBreak property.

```dart
String get kBreak;
```

--------------------------------

### Retrieve Symbol Documentation in Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/value_namespace_namespace/HTNamespace/help

The `help` method in Hetu Script retrieves documentation for a given variable name. It checks local symbols, imported symbols, and closure members. If the symbol is not found, it throws an HTError.undefined exception.

```hetuscript
String? help(String varName) {
  if (symbols.containsKey(varName)) {
    final decl = symbols[varName]!;
    return decl.documentation;
  } else if (importedSymbols.containsKey(varName)) {
    final decl = importedSymbols[varName]!;
    return decl.documentation;
  } else if (closure != null) {
    final decl =
        closure!.memberGet(varName, isRecursive: true, throws: false);
    if (decl != null) {
      return (decl as HTDeclaration).documentation;
    }
  }
  throw HTError.undefined(varName);
}
```

--------------------------------

### Get importExportListEnd Property Implementation (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/importExportListEnd

This snippet shows the implementation of the `get importExportListEnd` property. It is a String type and is declared within the context of a Dart class or interface.

```dart
String get importExportListEnd;
```

--------------------------------

### String Interpolation Start Property Declaration

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/stringInterpolationStart

This code snippet shows the declaration of the `stringInterpolationStart` property. It is a String type and represents the character sequence used to begin string interpolation.

```dart
String get stringInterpolationStart;
```

--------------------------------

### Get Type Function Property (Dart)

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/typeFunction

This snippet demonstrates how to get the 'typeFunction' property, which returns a string representing the function's type. It is a simple getter declaration.

```dart
String get typeFunction;
```

--------------------------------

### Implement Accept Method for AST Visitor in HETU Script

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/ASTEmpty/accept

This snippet demonstrates the implementation of the 'accept' method in HETU Script. It overrides the base method to delegate the visiting logic to the provided AbstractASTVisitor, specifically calling the 'visitEmptyExpr' method on the visitor.

```HETU Script
@override
dynamic accept(AbstractASTVisitor visitor) => visitor.visitEmptyExpr(this);
```

--------------------------------

### ParamDecl Constructor Implementation (Hetu Script)

Source: https://pub.dev/documentation/hetu_script/latest/ast_ast/ParamDecl/ParamDecl

Provides the implementation of the ParamDecl constructor, initializing instance variables and calling the superclass constructor with relevant parameters. It sets default values for boolean flags and source information.

```hetu
ParamDecl(
  IdentifierExpr id, {
  TypeExpr? declType,
  ASTNode? initializer,
  this.isVariadic = false,
  this.isOptional = false,
  this.isNamed = false,
  this.isInitialization = false,
  super.source,
  super.line = 0,
  super.column = 0,
  super.offset = 0,
  super.length = 0,
})
: super(id,
          declType: declType,
          initializer: initializer,
          isMutable: true,
          isStatement: false);
```

--------------------------------

### Get Lexeme Length in HETU Script

Source: https://pub.dev/documentation/hetu_script/latest/parser_token/Token/length

This snippet demonstrates how to get the length of a lexeme using the 'length' property in HETU Script. It accesses the 'length' attribute of the 'lexeme' object.

```HETU Script
int get length => lexeme.length;
```

--------------------------------

### Get kFor Property - Hetu Script

Source: https://pub.dev/documentation/hetu_script/latest/lexer_lexicon/HTLexicon/kFor

This snippet shows how to get the 'kFor' property in the Hetu script. It is a String type property. No external dependencies are required for this operation.

```Hetu Script
String get kFor;
```
Tokens:
Raw