yukigo-ast 0.1.0

package/dist/paradigms/object.d.ts

@@ -0,0 +1,201 @@
+import { ASTNode, Equation, Expression, SourceLocation, SymbolPrimitive } from "../globals/generics.js";
+import { Operator } from "../globals/operators.js";
+import { Visitor } from "../visitor.js";
+/**
+ * Represents a method definition within a class or object.
+ *
+ * @example
+ * method exhaust() {
+ *    energy -= 5
+ * }
+ * @category OOP
+ */
+export declare class Method extends ASTNode {
+    /** @hidden */
+    equations: Equation[];
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, equations: Equation[], loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): {
+        type: string;
+        identifier: {
+            type: string;
+            value: string;
+        };
+        equations: any[];
+    };
+}
+/**
+ * Represents an attribute or instance variable of an object.
+ * @category OOP
+ */
+export declare class Attribute extends ASTNode {
+    /** @hidden */
+    expression: Expression;
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, expression: Expression, loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): any;
+}
+/**
+ * Represents an object definition or a singleton object.
+ *
+ * @example
+ * object pepita { ... }
+ * @category OOP
+ */
+export declare class Object extends ASTNode {
+    /** @hidden */
+    expression: Expression;
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, expression: Expression, loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): any;
+}
+/**
+ * Represents a class definition, a blueprint for objects.
+ *
+ * @example
+ * class Bird inherits Animal { ... }
+ * @category OOP
+ */
+export declare class Class extends ASTNode {
+    /** @hidden */
+    expression: Expression;
+    /** @hidden */
+    implementsNode: Implement | undefined;
+    /** @hidden */
+    extendsSymbol: SymbolPrimitive | undefined;
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, extendsSymbol: SymbolPrimitive | undefined, implementsNode: Implement | undefined, expression: Expression, loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): any;
+}
+/**
+ * Represents an interface or protocol definition.
+ * @category OOP
+ */
+export declare class Interface extends ASTNode {
+    /** @hidden */
+    expression: Expression;
+    /** @hidden */
+    extendsSymbol: SymbolPrimitive[];
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, extendsSymbol: SymbolPrimitive[], expression: Expression, loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): any;
+}
+/**
+ * Represents a message send or method invocation on an object.
+ *
+ * @example
+ * pepita.fly(10)
+ * @category OOP
+ */
+export declare class Send extends ASTNode {
+    /** @hidden */
+    args: Expression[];
+    /** @hidden */
+    selector: Expression;
+    /** @hidden */
+    receiver: Expression;
+    constructor(receiver: Expression, selector: Expression, args: Expression[], loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): any;
+}
+/**
+ * Represents the instantiation of a class.
+ *
+ * @example
+ * new Bird()
+ * @category OOP
+ */
+export declare class New extends ASTNode {
+    /** @hidden */
+    args: Expression[];
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, args: Expression[], loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): any;
+}
+/**
+ * Represents an implementation clause for an interface.
+ * @category OOP
+ */
+export declare class Implement extends ASTNode {
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): {
+        type: string;
+        identifier: {
+            type: string;
+            value: string;
+        };
+    };
+}
+/**
+ * Represents the inclusion of a module or mixin.
+ * @category OOP
+ */
+export declare class Include extends ASTNode {
+    /** @hidden */
+    identifier: SymbolPrimitive;
+    constructor(identifier: SymbolPrimitive, loc?: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): {
+        type: string;
+        identifier: {
+            type: string;
+            value: string;
+        };
+    };
+}
+/**
+ * Represents a reference to the current object instance (self/this).
+ * @category OOP
+ */
+export declare class Self extends ASTNode {
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): {
+        type: string;
+    };
+}
+/**
+ * Represents a reference to the superclass or parent object.
+ * @category OOP
+ */
+export declare class Super extends ASTNode {
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): {
+        type: string;
+    };
+}
+/**
+ * Declaration of custom primitive operators - also known as operator overriding.
+ * @category OOP
+ * @example
+ * def ==(other)
+ * end
+ * def hash
+ * end
+
+ */
+export declare class PrimitiveMethod extends ASTNode {
+    operator: Operator;
+    equations: Equation[];
+    constructor(operator: Operator, equations: Equation[], loc: SourceLocation);
+    accept<R>(visitor: Visitor<R>): R;
+    toJSON(): {
+        type: string;
+        operator: Operator;
+        equations: Equation[];
+    };
+}

package/dist/paradigms/object.js

@@ -0,0 +1,308 @@
+import { ASTNode, } from "../globals/generics.js";
+/**
+ * Represents a method definition within a class or object.
+ *
+ * @example
+ * method exhaust() {
+ *    energy -= 5
+ * }
+ * @category OOP
+ */
+export class Method extends ASTNode {
+    /** @hidden */
+    equations;
+    /** @hidden */
+    identifier;
+    constructor(identifier, equations, loc) {
+        super(loc);
+        this.identifier = identifier;
+        this.equations = equations;
+    }
+    accept(visitor) {
+        return visitor.visitMethod?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Method",
+            identifier: this.identifier.toJSON(),
+            equations: this.equations.map((eq) => eq.toJSON()),
+        };
+    }
+}
+/**
+ * Represents an attribute or instance variable of an object.
+ * @category OOP
+ */
+export class Attribute extends ASTNode {
+    /** @hidden */
+    expression;
+    /** @hidden */
+    identifier;
+    constructor(identifier, expression, loc) {
+        super(loc);
+        this.identifier = identifier;
+        this.expression = expression;
+    }
+    accept(visitor) {
+        return visitor.visitAttribute?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Attribute",
+            identifier: this.identifier.toJSON(),
+            expression: this.expression.toJSON(),
+        };
+    }
+}
+/**
+ * Represents an object definition or a singleton object.
+ *
+ * @example
+ * object pepita { ... }
+ * @category OOP
+ */
+export class Object extends ASTNode {
+    /** @hidden */
+    expression;
+    /** @hidden */
+    identifier;
+    constructor(identifier, expression, loc) {
+        super(loc);
+        this.identifier = identifier;
+        this.expression = expression;
+    }
+    accept(visitor) {
+        return visitor.visitObject?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Object",
+            identifier: this.identifier.toJSON(),
+            expression: this.expression.toJSON(),
+        };
+    }
+}
+/**
+ * Represents a class definition, a blueprint for objects.
+ *
+ * @example
+ * class Bird inherits Animal { ... }
+ * @category OOP
+ */
+export class Class extends ASTNode {
+    /** @hidden */
+    expression;
+    /** @hidden */
+    implementsNode;
+    /** @hidden */
+    extendsSymbol;
+    /** @hidden */
+    identifier;
+    constructor(identifier, extendsSymbol, implementsNode, expression, loc) {
+        super(loc);
+        this.identifier = identifier;
+        this.extendsSymbol = extendsSymbol;
+        this.implementsNode = implementsNode;
+        this.expression = expression;
+    }
+    accept(visitor) {
+        return visitor.visitClass?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Class",
+            identifier: this.identifier.toJSON(),
+            extends: this.extendsSymbol.toJSON(),
+            implements: this.implementsNode.toJSON(),
+            expression: this.expression.toJSON(),
+        };
+    }
+}
+/**
+ * Represents an interface or protocol definition.
+ * @category OOP
+ */
+export class Interface extends ASTNode {
+    /** @hidden */
+    expression;
+    /** @hidden */
+    extendsSymbol;
+    /** @hidden */
+    identifier;
+    constructor(identifier, extendsSymbol, expression, loc) {
+        super(loc);
+        this.identifier = identifier;
+        this.extendsSymbol = extendsSymbol;
+        this.expression = expression;
+    }
+    accept(visitor) {
+        return visitor.visitInterface?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Interface",
+            identifier: this.identifier.toJSON(),
+            extends: this.extendsSymbol.map((symbol) => symbol.toJSON()),
+            expression: this.expression.toJSON(),
+        };
+    }
+}
+/**
+ * Represents a message send or method invocation on an object.
+ *
+ * @example
+ * pepita.fly(10)
+ * @category OOP
+ */
+export class Send extends ASTNode {
+    /** @hidden */
+    args;
+    /** @hidden */
+    selector;
+    /** @hidden */
+    receiver;
+    constructor(receiver, selector, args, loc) {
+        super(loc);
+        this.receiver = receiver;
+        this.selector = selector;
+        this.args = args;
+    }
+    accept(visitor) {
+        return visitor.visitSend?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Send",
+            receiver: this.receiver.toJSON(),
+            selector: this.selector.toJSON(),
+            arguments: this.args.map((arg) => arg.toJSON()),
+        };
+    }
+}
+/**
+ * Represents the instantiation of a class.
+ *
+ * @example
+ * new Bird()
+ * @category OOP
+ */
+export class New extends ASTNode {
+    /** @hidden */
+    args;
+    /** @hidden */
+    identifier;
+    constructor(identifier, args, loc) {
+        super(loc);
+        this.identifier = identifier;
+        this.args = args;
+    }
+    accept(visitor) {
+        return visitor.visitNew?.(this);
+    }
+    toJSON() {
+        return {
+            type: "New",
+            identifier: this.identifier.toJSON(),
+            arguments: this.args.map((arg) => arg.toJSON()),
+        };
+    }
+}
+/**
+ * Represents an implementation clause for an interface.
+ * @category OOP
+ */
+export class Implement extends ASTNode {
+    /** @hidden */
+    identifier;
+    constructor(identifier, loc) {
+        super(loc);
+        this.identifier = identifier;
+    }
+    accept(visitor) {
+        return visitor.visitImplement?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Implement",
+            identifier: this.identifier.toJSON(),
+        };
+    }
+}
+/**
+ * Represents the inclusion of a module or mixin.
+ * @category OOP
+ */
+export class Include extends ASTNode {
+    /** @hidden */
+    identifier;
+    constructor(identifier, loc) {
+        super(loc);
+        this.identifier = identifier;
+    }
+    accept(visitor) {
+        return visitor.visitInclude?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Include",
+            identifier: this.identifier.toJSON(),
+        };
+    }
+}
+/**
+ * Represents a reference to the current object instance (self/this).
+ * @category OOP
+ */
+export class Self extends ASTNode {
+    accept(visitor) {
+        return visitor.visitSelf?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Self",
+        };
+    }
+}
+/**
+ * Represents a reference to the superclass or parent object.
+ * @category OOP
+ */
+export class Super extends ASTNode {
+    accept(visitor) {
+        return visitor.visitSuper?.(this);
+    }
+    toJSON() {
+        return {
+            type: "Super",
+        };
+    }
+}
+/**
+ * Declaration of custom primitive operators - also known as operator overriding.
+ * @category OOP
+ * @example
+ * def ==(other)
+ * end
+ * def hash
+ * end
+
+ */
+export class PrimitiveMethod extends ASTNode {
+    operator;
+    equations;
+    constructor(operator, equations, loc) {
+        super(loc);
+        this.operator = operator;
+        this.equations = equations;
+    }
+    accept(visitor) {
+        return visitor.visitPrimitiveMethod?.(this);
+    }
+    toJSON() {
+        return {
+            type: "PrimitiveMethod",
+            operator: this.operator,
+            equations: this.equations,
+        };
+    }
+}