@malloydata/malloy 0.0.1

package/dist/lang/parse-to-ast.d.ts

@@ -0,0 +1,156 @@
+import { ParserRuleContext } from "antlr4ts";
+import type { ParseTree } from "antlr4ts/tree";
+import { AbstractParseTreeVisitor } from "antlr4ts/tree/AbstractParseTreeVisitor";
+import { MalloyVisitor } from "./lib/Malloy/MalloyVisitor";
+import * as parse from "./lib/Malloy/MalloyParser";
+import * as ast from "./ast";
+import { MessageLogger } from "./parse-log";
+import { MalloyParseRoot } from "./parse-malloy";
+import { LogSeverity } from "./parse-log";
+/**
+ * ANTLR visitor pattern parse tree traversal. Generates a Malloy
+ * AST from an ANTLR parse tree.
+ */
+export declare class MalloyToAST extends AbstractParseTreeVisitor<ast.MalloyElement> implements MalloyVisitor<ast.MalloyElement> {
+    readonly parse: MalloyParseRoot;
+    readonly msgLog: MessageLogger;
+    constructor(parse: MalloyParseRoot, msgLog: MessageLogger);
+    /**
+     * Mostly used to flag a case where the grammar and the type system are
+     * no longer in sync. A visitor was written based on a grammar which
+     * apparently has changed and now an unexpected element type has appeared.
+     * This is a non recoverable error, since the parser and the grammar
+     * are not compatible.
+     * @returns an error object to throw.
+     */
+    protected internalError(cx: ParserRuleContext, msg: string): Error;
+    /**
+     * Log an error message relative to an AST node
+     */
+    protected astError(el: ast.MalloyElement, str: string, sev?: LogSeverity): void;
+    /**
+     * Log an error message relative to a parse node
+     */
+    protected contextError(cx: ParserRuleContext, msg: string, sev?: LogSeverity): void;
+    protected onlyExploreProperties(els: ast.MalloyElement[]): ast.ExploreProperty[];
+    protected onlyJoins(els: ast.MalloyElement[]): ast.Join[];
+    protected onlyDocStatements(els: ast.MalloyElement[]): ast.DocStatement[];
+    protected onlyNestedQueries(els: ast.MalloyElement[]): ast.NestedQuery[];
+    protected onlyQueryRefs(els: ast.MalloyElement[]): ast.QueryItem[];
+    protected getNumber(term: ParseTree): number;
+    protected getIdText(fromTerm: ParseTree): string;
+    protected getFieldName(cx: ParserRuleContext): ast.FieldName;
+    protected getModelEntryName(cx: ParserRuleContext): ast.ModelEntryReference;
+    protected stripQuotes(s: string): string;
+    protected optionalText(idCx: ParseTree | undefined): string | undefined;
+    defaultResult(): ast.MalloyElement;
+    protected astAt<MT extends ast.MalloyElement>(el: MT, cx: ParserRuleContext): MT;
+    protected getSourceCode(cx: ParserRuleContext): string;
+    protected getFilterElement(cx: parse.FieldExprContext): ast.FilterElement;
+    protected getFieldDefs(cxList: ParserRuleContext[], isAgg?: boolean): ast.FieldDeclaration[];
+    protected getFieldExpr(cx: parse.FieldExprContext): ast.ExpressionDef;
+    protected getSegments(segments: parse.PipeElementContext[]): ast.QOPDesc[];
+    protected getFilterShortcut(cx: parse.FilterShortcutContext): ast.Filter;
+    protected getExploreSource(pcx: parse.ExploreSourceContext): ast.Mallobj;
+    visitMalloyDocument(pcx: parse.MalloyDocumentContext): ast.Document;
+    visitDefineExploreStatement(pcx: parse.DefineExploreStatementContext): ast.DefineSourceList | ast.DefineExplore;
+    visitExploreDefinition(pcx: parse.ExploreDefinitionContext): ast.DefineExplore;
+    visitExplore(pcx: parse.ExploreContext): ast.Mallobj;
+    visitExploreProperties(pcx: parse.ExplorePropertiesContext): ast.ExploreDesc;
+    visitExploreTable(pcx: parse.ExploreTableContext): ast.TableSource;
+    visitTableSource(pcx: parse.TableSourceContext): ast.TableSource;
+    visitSQLSource(pcx: parse.SQLSourceContext): ast.SQLSource;
+    visitQuerySource(pcx: parse.QuerySourceContext): ast.Mallobj;
+    visitDefJoinMany(pcx: parse.DefJoinManyContext): ast.Joins;
+    visitDefJoinOne(pcx: parse.DefJoinOneContext): ast.Joins;
+    visitDefJoinCross(pcx: parse.DefJoinCrossContext): ast.Joins;
+    protected getJoinList(pcx: parse.JoinListContext): ast.MalloyElement[];
+    protected getJoinSource(name: ast.ModelEntryReference, ecx: parse.ExploreContext | undefined): ast.Mallobj;
+    visitJoinOn(pcx: parse.JoinOnContext): ast.Join;
+    visitJoinWith(pcx: parse.JoinWithContext): ast.Join;
+    visitFieldDef(pcx: parse.FieldDefContext): ast.FieldDeclaration;
+    visitDefExploreDimension(pcx: parse.DefExploreDimensionContext): ast.Dimensions;
+    visitDefExploreMeasure(pcx: parse.DefExploreMeasureContext): ast.Measures;
+    visitDeclareStatement(pcx: parse.DeclareStatementContext): ast.DeclareFields;
+    visitExploreRenameDef(pcx: parse.ExploreRenameDefContext): ast.RenameField;
+    visitDefExploreRename(pcx: parse.DefExploreRenameContext): ast.Renames;
+    visitFilterClauseList(pcx: parse.FilterClauseListContext): ast.Filter;
+    visitFilterByShortcut(pcx: parse.FilterByShortcutContext): ast.Filter;
+    visitWhereStatement(pcx: parse.WhereStatementContext): ast.Filter;
+    visitHavingStatement(pcx: parse.HavingStatementContext): ast.Filter;
+    visitSubQueryDefList(pcx: parse.SubQueryDefListContext): ast.Turtles;
+    visitDefExplorePrimaryKey(pcx: parse.DefExplorePrimaryKeyContext): ast.PrimaryKey;
+    visitFieldNameList(pcx: parse.FieldNameListContext): ast.FieldReferences;
+    visitDefExploreEditField(pcx: parse.DefExploreEditFieldContext): ast.FieldListEdit;
+    visitQueryProperties(pcx: parse.QueryPropertiesContext): ast.QOPDesc;
+    visitFieldPath(pcx: parse.FieldPathContext): ast.FieldReference;
+    visitQueryFieldDef(pcx: parse.QueryFieldDefContext): ast.QueryItem;
+    visitQueryFieldRef(pcx: parse.QueryFieldRefContext): ast.QueryItem;
+    protected getQueryItems(pcx: parse.QueryFieldListContext): ast.QueryItem[];
+    visitAggregateStatement(pcx: parse.AggregateStatementContext): ast.Aggregate;
+    visitGroupByStatement(pcx: parse.GroupByStatementContext): ast.GroupBy;
+    visitFieldCollection(pcx: parse.FieldCollectionContext): ast.ProjectStatement;
+    visitWildMember(pcx: parse.WildMemberContext): ast.FieldReferenceElement;
+    visitIndexFields(pcx: parse.IndexFieldsContext): ast.FieldReferences;
+    visitIndexStatement(pcx: parse.IndexStatementContext): ast.Index;
+    visitLimitStatement(pcx: parse.LimitStatementContext): ast.Limit;
+    visitOrderBySpec(pcx: parse.OrderBySpecContext): ast.OrderBy;
+    visitOrdering(pcx: parse.OrderingContext): ast.Ordering;
+    visitTopStatement(pcx: parse.TopStatementContext): ast.Top;
+    visitExploreName(pcx: parse.ExploreNameContext): ast.NamedSource;
+    protected buildPipelineFromName(pipe: ast.TurtleHeadedPipe, pipeCx: parse.PipelineFromNameContext): void;
+    visitExploreArrowQuery(pcx: parse.ExploreArrowQueryContext): ast.FullQuery;
+    visitArrowQuery(pcx: parse.ArrowQueryContext): ast.ExistingQuery;
+    visitTopLevelQueryDefs(pcx: parse.TopLevelQueryDefsContext): ast.DocStatement;
+    visitTopLevelQueryDef(pcx: parse.TopLevelQueryDefContext): ast.DefineQuery;
+    visitAnonymousQuery(pcx: parse.AnonymousQueryContext): ast.AnonymousQuery;
+    visitNestedQueryList(pcx: parse.NestedQueryListContext): ast.MalloyElement;
+    visitNestExisting(pcx: parse.NestExistingContext): ast.NestedQuery;
+    visitNestDef(pcx: parse.NestDefContext): ast.NestDefinition;
+    visitExploreQueryDef(pcx: parse.ExploreQueryDefContext): ast.TurtleDecl;
+    visitExprNot(pcx: parse.ExprNotContext): ast.ExprNot;
+    visitExprBool(pcx: parse.ExprBoolContext): ast.Boolean;
+    allFieldExpressions(exprList: parse.FieldExprContext[]): ast.ExpressionDef[];
+    visitExprLogical(pcx: parse.ExprLogicalContext): ast.ExprLogicalOp;
+    visitExprLogicalTree(pcx: parse.ExprLogicalTreeContext): ast.ExprAlternationTree;
+    visitExprNotPartial(pcx: parse.ExprNotPartialContext): ast.ExpressionDef;
+    visitExprPartialCompare(pcx: parse.ExprPartialCompareContext): ast.MalloyElement;
+    visitExprString(pcx: parse.ExprStringContext): ast.ExprString;
+    visitExprRegex(pcx: parse.ExprRegexContext): ast.ExprRegEx;
+    visitExprNow(_pcx: parse.ExprNowContext): ast.ExprNow;
+    visitExprNumber(pcx: parse.ExprNumberContext): ast.ExprNumber;
+    visitExprFieldPath(pcx: parse.ExprFieldPathContext): ast.ExprIdReference;
+    visitExprNULL(_pcx: parse.ExprNULLContext): ast.ExprNULL;
+    visitExprExpr(pcx: parse.ExprExprContext): ast.ExprParens;
+    visitExprMinus(pcx: parse.ExprMinusContext): ast.ExprMinus;
+    visitExprAddSub(pcx: parse.ExprAddSubContext): ast.ExprAddSub;
+    visitExprMulDiv(pcx: parse.ExprMulDivContext): ast.ExprMulDiv;
+    visitExprCompare(pcx: parse.ExprCompareContext): ast.ExprCompare;
+    visitExprCountDisinct(pcx: parse.ExprCountDisinctContext): ast.ExprCountDistinct;
+    visitExprUngroup(pcx: parse.ExprUngroupContext): ast.ExprUngroup;
+    visitExprAggregate(pcx: parse.ExprAggregateContext): ast.ExpressionDef;
+    visitExprApply(pcx: parse.ExprApplyContext): ast.Apply;
+    visitExprRange(pcx: parse.ExprRangeContext): ast.Range;
+    visitExprCast(pcx: parse.ExprCastContext): ast.ExpressionDef;
+    visitExprSafeCast(pcx: parse.ExprSafeCastContext): ast.ExpressionDef;
+    visitExprTimeTrunc(pcx: parse.ExprTimeTruncContext): ast.ExprGranularTime;
+    visitTimeframe(pcx: parse.TimeframeContext): ast.Timeframe;
+    visitExprForRange(pcx: parse.ExprForRangeContext): ast.ForRange;
+    visitExprFunc(pcx: parse.ExprFuncContext): ast.ExpressionDef;
+    visitExprDuration(pcx: parse.ExprDurationContext): ast.ExprDuration;
+    visitPickStatement(pcx: parse.PickStatementContext): ast.Pick;
+    visitNamedSource(pcx: parse.NamedSourceContext): ast.NamedSource;
+    visitExprFilter(pcx: parse.ExprFilterContext): ast.ExprFilter;
+    protected getLiteralTime(cx: ParserRuleContext): ast.ExpressionDef;
+    visitLiteralTimestamp(pcx: parse.LiteralTimestampContext): ast.ExpressionDef;
+    visitLiteralDay(pcx: parse.LiteralDayContext): ast.ExpressionDef;
+    visitLiteralWeek(pcx: parse.LiteralWeekContext): ast.ExpressionDef;
+    visitLiteralMonth(pcx: parse.LiteralMonthContext): ast.ExpressionDef;
+    visitLiteralQuarter(pcx: parse.LiteralQuarterContext): ast.ExpressionDef;
+    visitLiteralYear(pcx: parse.LiteralYearContext): ast.ExpressionDef;
+    visitImportStatement(pcx: parse.ImportStatementContext): ast.ImportStatement;
+    visitJustExpr(pcx: parse.JustExprContext): ast.ExpressionDef;
+    visitDefineSQLStatement(pcx: parse.DefineSQLStatementContext): ast.SQLStatement;
+    visitSQLStatementDef(pcx: parse.SqlStatementDefContext): ast.SQLStatement;
+    visitSampleStatement(pcx: parse.SampleStatementContext): ast.SampleProperty;
+}