brighterscript 1.0.0-alpha.5 → 1.0.0-alpha.50

package/dist/parser/SGTypes.d.ts

@@ -1,19 +1,25 @@
 import { SourceNode } from 'source-map';
-import type { Range } from 'vscode-languageserver';
+import type { Location } from 'vscode-languageserver';
 import type { FileReference } from '../interfaces';
 import type { TranspileState } from './TranspileState';
 export interface SGToken {
     text: string;
-    range?: Range;
+    location?: Location;
 }
 export declare class SGAttribute {
-    constructor(key: SGToken, equals?: SGToken, openingQuote?: SGToken, value?: SGToken, closingQuote?: SGToken);
-    tokens: {
+    constructor(options: {
         key: SGToken;
         equals?: SGToken;
         openingQuote?: SGToken;
         value?: SGToken;
         closingQuote?: SGToken;
+    });
+    readonly tokens: {
+        readonly key: SGToken;
+        equals?: SGToken;
+        openingQuote?: SGToken;
+        value?: SGToken;
+        closingQuote?: SGToken;
     };
     get key(): string;
     /**
@@ -21,48 +27,58 @@ export declare class SGAttribute {
      */
     get value(): string | undefined;
     set value(val: string | undefined);
-    get range(): Range;
-    private _range;
+    get location(): Location;
+    private _location;
     transpile(state: TranspileState): SourceNode;
+    clone(): SGAttribute;
 }
-export declare class SGTag {
-    constructor(startTagOpen: SGToken, startTagName: SGToken, attributes?: SGAttribute[], startTagClose?: SGToken, childNodes?: SGTag[], endTagOpen?: SGToken, endTagName?: SGToken, endTagClose?: SGToken);
-    tokens: {
+export declare class SGElement {
+    constructor(options: {
+        startTagOpen?: SGToken;
+        startTagName: SGToken;
+        attributes?: SGAttribute[];
+        startTagClose?: SGToken;
+        elements?: SGElement[];
+        endTagOpen?: SGToken;
+        endTagName?: SGToken;
+        endTagClose?: SGToken;
+    });
+    readonly tokens: {
         /**
-        * The first portion of the startTag. (i.e. `<` or `<?`)
-        */
-        startTagOpen: SGToken;
+         * The first portion of the startTag. (i.e. `<` or `<?`)
+         */
+        readonly startTagOpen?: SGToken;
         /**
          * The name of the opening tag (i.e. CoolTag in `<CoolTag>`).
          */
-        startTagName: SGToken;
+        readonly startTagName: SGToken;
         /**
-         * The last bit of the startTag (i.e. `/>` for self-closing, `?>` for xml prologue, or `>` for tag with children)
+         * The last bit of the startTag (i.e. `/>` for self-closing, `?>` for xml prolog, or `>` for tag with children)
          */
-        startTagClose?: SGToken;
+        readonly startTagClose?: SGToken;
         /**
          * The endTag opening char `<`
          */
-        endTagOpen?: SGToken;
+        readonly endTagOpen?: SGToken;
         /**
          * The name of the ending tag (i.e. CoolTag in `</CoolTag>`)
          */
-        endTagName?: SGToken;
+        readonly endTagName?: SGToken;
         /**
          * The endTag closing char `>`
          */
-        endTagClose?: SGToken;
+        readonly endTagClose?: SGToken;
     };
     /**
      * Array of attributes found on this tag
      */
-    attributes: SGAttribute[];
+    readonly attributes: SGAttribute[];
     /**
      * The array of direct children AST elements of this AST node
      */
-    childNodes: SGTag[];
-    get range(): Range;
-    private _range;
+    readonly elements: SGElement[];
+    get location(): Location;
+    private _location;
     /**
      * Is this a self-closing tag?
      */
@@ -70,7 +86,7 @@ export declare class SGTag {
     get id(): string;
     set id(value: string);
     /**
-     * Get the lower-case name of this tag.
+     * Get the name of this tag.
      */
     get tagName(): string;
     /**
@@ -78,22 +94,22 @@ export declare class SGTag {
      * This does not step into children's children.
      *
      */
-    getChildNodesByTagName<T extends SGTag>(tagName: string): readonly T[];
+    getElementsByTagName<T extends SGElement>(tagName: string): readonly T[];
     /**
      * Add a child to the end of the children array
      */
-    addChild<T extends SGTag>(tag: T): T;
+    addChild<T extends SGElement>(tag: T): T;
     /**
      * Remove a child from the children array.
      * @returns true if node was found and removed, false if the node wasn't there and thus nothing was done
      */
-    removeChild(tag: SGTag): boolean;
+    removeChild(tag: SGElement): boolean;
     /**
      * Does this node have the specified attribute?
      */
     hasAttribute(name: string): boolean;
     /**
-     * Get an SGAttribute by its name
+     * Get an SGAttribute by its name (case INsensitive)
      */
     getAttribute(name: string): SGAttribute | undefined;
     /**
@@ -105,7 +121,7 @@ export declare class SGTag {
      */
     setAttributeValue(name: string, value: string): void;
     /**
-     * Remove an attribute by its name
+     * Remove an attribute by its name. DO NOT USE this to edit AST (use ASTEditor)
      * @returns true if an attribute was found and removed. False if no attribute was found
      */
     removeAttribute(name: string): boolean;
@@ -113,13 +129,15 @@ export declare class SGTag {
     protected transpileBody(state: TranspileState): SourceNode;
     protected transpileAttributes(state: TranspileState, attributes: SGAttribute[]): SourceNode;
 }
-export declare class SGProlog extends SGTag {
+export declare class SGProlog extends SGElement {
+}
+export declare class SGNode extends SGElement {
 }
-export declare class SGNode extends SGTag {
+export declare class SGChildren extends SGElement {
 }
-export declare class SGChildren extends SGTag {
+export declare class SGCustomization extends SGElement {
 }
-export declare class SGScript extends SGTag {
+export declare class SGScript extends SGElement {
     cdata?: SGToken;
     get type(): string;
     set type(value: string);
@@ -128,7 +146,7 @@ export declare class SGScript extends SGTag {
     protected transpileBody(state: TranspileState): SourceNode;
     protected transpileAttributes(state: TranspileState, attributes: SGAttribute[]): SourceNode;
 }
-export declare class SGInterfaceField extends SGTag {
+export declare class SGInterfaceField extends SGElement {
     get type(): string;
     set type(value: string);
     get alias(): string;
@@ -140,13 +158,41 @@ export declare class SGInterfaceField extends SGTag {
     get alwaysNotify(): string;
     set alwaysNotify(value: string);
 }
+export declare enum SGFieldType {
+    integer = "integer",
+    int = "int",
+    longinteger = "longinteger",
+    float = "float",
+    string = "string",
+    str = "str",
+    boolean = "boolean",
+    bool = "bool",
+    vector2d = "vector2d",
+    color = "color",
+    time = "time",
+    uri = "uri",
+    node = "node",
+    floatarray = "floatarray",
+    intarray = "intarray",
+    boolarray = "boolarray",
+    stringarray = "stringarray",
+    vector2darray = "vector2darray",
+    colorarray = "colorarray",
+    timearray = "timearray",
+    nodearray = "nodearray",
+    assocarray = "assocarray",
+    array = "array",
+    roarray = "roarray",
+    rect2d = "rect2d",
+    rect2darray = "rect2darray"
+}
 export declare const SGFieldTypes: string[];
-export declare class SGInterfaceFunction extends SGTag {
+export declare class SGInterfaceFunction extends SGElement {
     get name(): string;
     set name(value: string);
 }
 export declare type SGInterfaceMember = SGInterfaceField | SGInterfaceFunction;
-export declare class SGInterface extends SGTag {
+export declare class SGInterface extends SGElement {
     get fields(): readonly SGInterfaceField[];
     get functions(): readonly SGInterfaceFunction[];
     get members(): readonly SGInterfaceMember[];
@@ -185,21 +231,59 @@ export declare class SGInterface extends SGTag {
      */
     removeFunction(name: string): boolean;
 }
-export declare class SGComponent extends SGTag {
+/**
+ * The `<component>` element in SceneGraph. Not to be confused about usages of components like `<Rectangle>`, those are considered `SGNode` instances.
+ */
+export declare class SGComponent extends SGElement {
     /**
      * Get all the <Field> and <Function> elements across all <Interface> nodes in this component
      */
     get interfaceMembers(): readonly SGInterfaceMember[];
-    get scripts(): readonly SGScript[];
+    get scriptElements(): readonly SGScript[];
+    /**
+     * Get the <interface> element from this component (if present), or undefined if not.
+     * NOTE: Roku supports and merges multiple <interface> elements in a component, but this
+     * property points to the FIRST one. If you need to check whether a member exists,
+     * look through `this.interfaceMemebers` instead.
+     */
+    get interfaceElement(): SGInterface | undefined;
     /**
-     * Get the `<children>` element of this component. (not to be confused with the AST `childNodes` property).
+     * Get the `<children>` element of this component. (not to be confused with the AST `childTags` property).
      * If there are multiope `<children>` elements, this function will return the last `<children>` tag because that's what Roku devices do.
      */
-    get children(): SGChildren;
+    get childrenElement(): SGChildren;
+    get customizationElements(): readonly SGCustomization[];
+    /**
+     * Specifies the name of the component, that allows you to create the component in your application.
+     * For example, if the name of the component is `CastMemberInfo`, you could create instances of the component declaratively
+     * in a child node element of a component `<children>` element (`<CastMemberInfo/>`), or using BrightScript in a `<script>`
+     * element (`createObject("roSGNode","CastMemberInfo")`).
+     *
+     * The name attribute is case-sensitive. You cannot successfully create or declare a component unless the component name exactly
+     *  matches the name attribute, including case. Also be aware that two components with the exact same name in the same application
+     * components directory will have undefined and generally undesirable results if you attempt to create a component object with that name in the application.
+     */
     get name(): string;
     set name(value: string);
+    /**
+     * Specifies the name of the built-in or extended SceneGraph scene or node class whose functionality is extended by this component.
+     *
+     * For example, `extends="Group"` specifies that the component has all of the functionality of the Group node class (it can have child nodes, has translation/scale/rotation fields, and so forth).
+     *
+     * By default, a component extends the Group node class.
+     */
     get extends(): string;
     set extends(value: string);
+    /**
+     * Specifies the ID of a node declared in the XML file to have the initial remote control focus when the component is instantiated.
+     */
+    get initialFocus(): string;
+    set initialFocus(value: string);
+    /**
+     * Specifies the version of the SceneGraph API. The default is 1.0 if not specified.
+     */
+    get version(): string;
+    set version(value: string);
     /**
      * Does the specified field exist in the component interface?
      */
@@ -232,8 +316,8 @@ export declare class SGComponent extends SGTag {
      */
     removeInterfaceField(id: string): boolean;
     /**
-    * Get an interface field with the specified name
-    */
+     * Get an interface field with the specified name
+     */
     getInterfaceFunction(name: string): SGInterfaceFunction | undefined;
     /**
      * Remove an interface function.
@@ -244,12 +328,16 @@ export declare class SGComponent extends SGTag {
 export interface SGReferences {
     name?: SGToken;
     extends?: SGToken;
-    scriptTagImports: Pick<FileReference, 'pkgPath' | 'text' | 'filePathRange'>[];
+    scriptTagImports: Pick<FileReference, 'destPath' | 'text' | 'filePathRange'>[];
 }
 export declare class SGAst {
-    prolog?: SGProlog;
-    root?: SGTag;
-    component?: SGComponent;
-    constructor(prolog?: SGProlog, root?: SGTag, component?: SGComponent);
+    constructor(options?: {
+        prologElement?: SGProlog;
+        rootElement?: SGElement;
+        componentElement?: SGComponent;
+    });
+    readonly prologElement?: SGProlog;
+    readonly rootElement?: SGElement;
+    readonly componentElement?: SGComponent;
     transpile(state: TranspileState): SourceNode;
 }