Struct SemanticBuilder 

pub struct SemanticBuilder<'a> { /* private fields */ }

Semantic analysis (scopes, symbols, references) Semantic Builder

Traverses a parsed AST and builds a Semantic representation of the program.

The main API is the build method.

Implementations

impl<'a> SemanticBuilder<'a>

pub fn new() -> SemanticBuilder<'a>

pub fn with_check_syntax_error(self, yes: bool) -> SemanticBuilder<'a>

Enable/disable additional syntax checks.

Set this to true to enable additional syntax checks. Without these, there is no guarantee that the parsed program follows the ECMAScript spec.

By default, this is false.

pub fn with_cfg(self, _cfg: bool) -> SemanticBuilder<'a>

pub fn with_scope_tree_child_ids(self, yes: bool) -> SemanticBuilder<'a>

pub fn with_stats(self, stats: Stats) -> SemanticBuilder<'a>

Provide statistics about AST to optimize memory usage of semantic analysis.

Accurate statistics can greatly improve performance, especially for large ASTs. If no stats are provided, SemanticBuilder::build will compile stats by performing a complete AST traversal. If semantic analysis has already been performed on this AST, get the existing stats with Semantic::stats, and pass them in with this method, to avoid the stats collection AST pass.

pub fn with_excess_capacity(self, excess_capacity: f64) -> SemanticBuilder<'a>

Request SemanticBuilder to allocate excess capacity for scopes, symbols, and references.

excess_capacity is provided as a fraction. e.g. to over-allocate by 20%, pass 0.2 as excess_capacity.

Has no effect if a Stats object is provided with SemanticBuilder::with_stats, only if SemanticBuilder is calculating stats itself.

This is useful when you intend to modify Semantic, adding more nodes, scopes, symbols, or references. Allocating excess capacity for these additions at the outset prevents Semantic’s data structures needing to grow later on which involves memory copying. For large ASTs with a lot of semantic data, re-allocation can be very costly.

pub fn build(self, program: &'a Program<'a>) -> SemanticBuilderReturn<'a>

Finalize the builder.

Panics

Trait Implementations

impl Default for SemanticBuilder<'_>

fn default() -> SemanticBuilder<'_>

Returns the “default value” for a type.

impl<'a> Visit<'a> for SemanticBuilder<'a>

fn enter_scope(&mut self, flags: ScopeFlags, scope_id: &Cell<Option<ScopeId>>)

fn leave_scope(&mut self)

fn enter_node(&mut self, kind: AstKind<'a>)

fn leave_node(&mut self, kind: AstKind<'a>)

fn visit_program(&mut self, program: &Program<'a>)

fn visit_break_statement(&mut self, stmt: &BreakStatement<'a>)

fn visit_class(&mut self, class: &Class<'a>)

fn visit_block_statement(&mut self, it: &BlockStatement<'a>)

fn visit_continue_statement(&mut self, stmt: &ContinueStatement<'a>)

fn visit_do_while_statement(&mut self, stmt: &DoWhileStatement<'a>)

fn visit_logical_expression(&mut self, expr: &LogicalExpression<'a>)

fn visit_assignment_expression(&mut self, expr: &AssignmentExpression<'a>)

fn visit_conditional_expression(&mut self, expr: &ConditionalExpression<'a>)

fn visit_for_statement(&mut self, stmt: &ForStatement<'a>)

fn visit_for_in_statement(&mut self, stmt: &ForInStatement<'a>)

fn visit_for_of_statement(&mut self, stmt: &ForOfStatement<'a>)

fn visit_if_statement(&mut self, stmt: &IfStatement<'a>)

fn visit_labeled_statement(&mut self, stmt: &LabeledStatement<'a>)

fn visit_return_statement(&mut self, stmt: &ReturnStatement<'a>)

fn visit_switch_statement(&mut self, stmt: &SwitchStatement<'a>)

fn visit_switch_case(&mut self, case: &SwitchCase<'a>)

fn visit_throw_statement(&mut self, stmt: &ThrowStatement<'a>)

fn visit_try_statement(&mut self, stmt: &TryStatement<'a>)

fn visit_while_statement(&mut self, stmt: &WhileStatement<'a>)

fn visit_with_statement(&mut self, stmt: &WithStatement<'a>)

fn visit_function(&mut self, func: &Function<'a>, flags: ScopeFlags)

fn visit_arrow_function_expression( &mut self, expr: &ArrowFunctionExpression<'a>, )

fn visit_update_expression(&mut self, it: &UpdateExpression<'a>)

fn visit_member_expression(&mut self, it: &MemberExpression<'a>)

fn visit_simple_assignment_target(&mut self, it: &SimpleAssignmentTarget<'a>)

fn visit_assignment_target_property_identifier( &mut self, it: &AssignmentTargetPropertyIdentifier<'a>, )

fn visit_export_default_declaration_kind( &mut self, it: &ExportDefaultDeclarationKind<'a>, )

fn visit_export_named_declaration(&mut self, it: &ExportNamedDeclaration<'a>)

fn visit_export_specifier(&mut self, it: &ExportSpecifier<'a>)

fn visit_ts_export_assignment(&mut self, it: &TSExportAssignment<'a>)

fn alloc<T>(&self, t: &T) -> &'a T

fn visit_expression(&mut self, it: &Expression<'a>)

fn visit_identifier_name(&mut self, it: &IdentifierName<'a>)

fn visit_identifier_reference(&mut self, it: &IdentifierReference<'a>)

fn visit_binding_identifier(&mut self, it: &BindingIdentifier<'a>)

fn visit_label_identifier(&mut self, it: &LabelIdentifier<'a>)

fn visit_this_expression(&mut self, it: &ThisExpression)

fn visit_array_expression(&mut self, it: &ArrayExpression<'a>)

fn visit_array_expression_element(&mut self, it: &ArrayExpressionElement<'a>)

fn visit_elision(&mut self, it: &Elision)

fn visit_object_expression(&mut self, it: &ObjectExpression<'a>)

fn visit_object_property_kind(&mut self, it: &ObjectPropertyKind<'a>)

fn visit_object_property(&mut self, it: &ObjectProperty<'a>)

fn visit_property_key(&mut self, it: &PropertyKey<'a>)

fn visit_template_literal(&mut self, it: &TemplateLiteral<'a>)

fn visit_tagged_template_expression( &mut self, it: &TaggedTemplateExpression<'a>, )

fn visit_template_element(&mut self, it: &TemplateElement<'a>)

fn visit_computed_member_expression( &mut self, it: &ComputedMemberExpression<'a>, )

fn visit_static_member_expression(&mut self, it: &StaticMemberExpression<'a>)

fn visit_private_field_expression(&mut self, it: &PrivateFieldExpression<'a>)

fn visit_call_expression(&mut self, it: &CallExpression<'a>)

fn visit_new_expression(&mut self, it: &NewExpression<'a>)

fn visit_meta_property(&mut self, it: &MetaProperty<'a>)

fn visit_spread_element(&mut self, it: &SpreadElement<'a>)

fn visit_argument(&mut self, it: &Argument<'a>)

fn visit_unary_expression(&mut self, it: &UnaryExpression<'a>)

fn visit_binary_expression(&mut self, it: &BinaryExpression<'a>)

fn visit_private_in_expression(&mut self, it: &PrivateInExpression<'a>)

fn visit_assignment_target(&mut self, it: &AssignmentTarget<'a>)

fn visit_assignment_target_pattern(&mut self, it: &AssignmentTargetPattern<'a>)

fn visit_array_assignment_target(&mut self, it: &ArrayAssignmentTarget<'a>)

fn visit_object_assignment_target(&mut self, it: &ObjectAssignmentTarget<'a>)

fn visit_assignment_target_rest(&mut self, it: &AssignmentTargetRest<'a>)

fn visit_assignment_target_maybe_default( &mut self, it: &AssignmentTargetMaybeDefault<'a>, )

fn visit_assignment_target_with_default( &mut self, it: &AssignmentTargetWithDefault<'a>, )

fn visit_assignment_target_property( &mut self, it: &AssignmentTargetProperty<'a>, )

fn visit_assignment_target_property_property( &mut self, it: &AssignmentTargetPropertyProperty<'a>, )

fn visit_sequence_expression(&mut self, it: &SequenceExpression<'a>)

fn visit_super(&mut self, it: &Super)

fn visit_await_expression(&mut self, it: &AwaitExpression<'a>)

fn visit_chain_expression(&mut self, it: &ChainExpression<'a>)

fn visit_chain_element(&mut self, it: &ChainElement<'a>)

fn visit_parenthesized_expression(&mut self, it: &ParenthesizedExpression<'a>)

fn visit_statement(&mut self, it: &Statement<'a>)

fn visit_directive(&mut self, it: &Directive<'a>)

fn visit_hashbang(&mut self, it: &Hashbang<'a>)

fn visit_declaration(&mut self, it: &Declaration<'a>)

fn visit_variable_declaration(&mut self, it: &VariableDeclaration<'a>)

fn visit_variable_declarator(&mut self, it: &VariableDeclarator<'a>)

fn visit_empty_statement(&mut self, it: &EmptyStatement)

fn visit_expression_statement(&mut self, it: &ExpressionStatement<'a>)

fn visit_for_statement_init(&mut self, it: &ForStatementInit<'a>)

fn visit_for_statement_left(&mut self, it: &ForStatementLeft<'a>)

fn visit_catch_clause(&mut self, it: &CatchClause<'a>)

fn visit_catch_parameter(&mut self, it: &CatchParameter<'a>)

fn visit_debugger_statement(&mut self, it: &DebuggerStatement)

fn visit_binding_pattern(&mut self, it: &BindingPattern<'a>)

fn visit_binding_pattern_kind(&mut self, it: &BindingPatternKind<'a>)

fn visit_assignment_pattern(&mut self, it: &AssignmentPattern<'a>)

fn visit_object_pattern(&mut self, it: &ObjectPattern<'a>)

fn visit_binding_property(&mut self, it: &BindingProperty<'a>)

fn visit_array_pattern(&mut self, it: &ArrayPattern<'a>)

fn visit_binding_rest_element(&mut self, it: &BindingRestElement<'a>)

fn visit_formal_parameters(&mut self, it: &FormalParameters<'a>)

fn visit_formal_parameter(&mut self, it: &FormalParameter<'a>)

fn visit_function_body(&mut self, it: &FunctionBody<'a>)

fn visit_yield_expression(&mut self, it: &YieldExpression<'a>)

fn visit_class_body(&mut self, it: &ClassBody<'a>)

fn visit_class_element(&mut self, it: &ClassElement<'a>)

fn visit_method_definition(&mut self, it: &MethodDefinition<'a>)

fn visit_property_definition(&mut self, it: &PropertyDefinition<'a>)

fn visit_private_identifier(&mut self, it: &PrivateIdentifier<'a>)

fn visit_static_block(&mut self, it: &StaticBlock<'a>)

fn visit_module_declaration(&mut self, it: &ModuleDeclaration<'a>)

fn visit_accessor_property(&mut self, it: &AccessorProperty<'a>)

fn visit_import_expression(&mut self, it: &ImportExpression<'a>)

fn visit_import_declaration(&mut self, it: &ImportDeclaration<'a>)

fn visit_import_declaration_specifier( &mut self, it: &ImportDeclarationSpecifier<'a>, )

fn visit_import_specifier(&mut self, it: &ImportSpecifier<'a>)

fn visit_import_default_specifier(&mut self, it: &ImportDefaultSpecifier<'a>)

fn visit_import_namespace_specifier( &mut self, it: &ImportNamespaceSpecifier<'a>, )

fn visit_with_clause(&mut self, it: &WithClause<'a>)

fn visit_import_attribute(&mut self, it: &ImportAttribute<'a>)

fn visit_import_attribute_key(&mut self, it: &ImportAttributeKey<'a>)

fn visit_export_default_declaration( &mut self, it: &ExportDefaultDeclaration<'a>, )

fn visit_export_all_declaration(&mut self, it: &ExportAllDeclaration<'a>)

fn visit_module_export_name(&mut self, it: &ModuleExportName<'a>)

fn visit_v_8_intrinsic_expression(&mut self, it: &V8IntrinsicExpression<'a>)

fn visit_boolean_literal(&mut self, it: &BooleanLiteral)

fn visit_null_literal(&mut self, it: &NullLiteral)

fn visit_numeric_literal(&mut self, it: &NumericLiteral<'a>)

fn visit_string_literal(&mut self, it: &StringLiteral<'a>)

fn visit_big_int_literal(&mut self, it: &BigIntLiteral<'a>)

fn visit_reg_exp_literal(&mut self, it: &RegExpLiteral<'a>)

fn visit_jsx_element(&mut self, it: &JSXElement<'a>)

fn visit_jsx_opening_element(&mut self, it: &JSXOpeningElement<'a>)

fn visit_jsx_closing_element(&mut self, it: &JSXClosingElement<'a>)

fn visit_jsx_fragment(&mut self, it: &JSXFragment<'a>)

fn visit_jsx_opening_fragment(&mut self, it: &JSXOpeningFragment)

fn visit_jsx_closing_fragment(&mut self, it: &JSXClosingFragment)

fn visit_jsx_element_name(&mut self, it: &JSXElementName<'a>)

fn visit_jsx_namespaced_name(&mut self, it: &JSXNamespacedName<'a>)

fn visit_jsx_member_expression(&mut self, it: &JSXMemberExpression<'a>)

fn visit_jsx_member_expression_object( &mut self, it: &JSXMemberExpressionObject<'a>, )

fn visit_jsx_expression_container(&mut self, it: &JSXExpressionContainer<'a>)

fn visit_jsx_expression(&mut self, it: &JSXExpression<'a>)

fn visit_jsx_empty_expression(&mut self, it: &JSXEmptyExpression)

fn visit_jsx_attribute_item(&mut self, it: &JSXAttributeItem<'a>)

fn visit_jsx_attribute(&mut self, it: &JSXAttribute<'a>)

fn visit_jsx_spread_attribute(&mut self, it: &JSXSpreadAttribute<'a>)

fn visit_jsx_attribute_name(&mut self, it: &JSXAttributeName<'a>)

fn visit_jsx_attribute_value(&mut self, it: &JSXAttributeValue<'a>)

fn visit_jsx_identifier(&mut self, it: &JSXIdentifier<'a>)

fn visit_jsx_child(&mut self, it: &JSXChild<'a>)

fn visit_jsx_spread_child(&mut self, it: &JSXSpreadChild<'a>)

fn visit_jsx_text(&mut self, it: &JSXText<'a>)

fn visit_ts_this_parameter(&mut self, it: &TSThisParameter<'a>)

fn visit_ts_enum_declaration(&mut self, it: &TSEnumDeclaration<'a>)

fn visit_ts_enum_body(&mut self, it: &TSEnumBody<'a>)

fn visit_ts_enum_member(&mut self, it: &TSEnumMember<'a>)

fn visit_ts_enum_member_name(&mut self, it: &TSEnumMemberName<'a>)

fn visit_ts_type_annotation(&mut self, it: &TSTypeAnnotation<'a>)

fn visit_ts_literal_type(&mut self, it: &TSLiteralType<'a>)

fn visit_ts_literal(&mut self, it: &TSLiteral<'a>)

fn visit_ts_type(&mut self, it: &TSType<'a>)

fn visit_ts_conditional_type(&mut self, it: &TSConditionalType<'a>)

fn visit_ts_union_type(&mut self, it: &TSUnionType<'a>)

fn visit_ts_intersection_type(&mut self, it: &TSIntersectionType<'a>)

fn visit_ts_parenthesized_type(&mut self, it: &TSParenthesizedType<'a>)

fn visit_ts_type_operator(&mut self, it: &TSTypeOperator<'a>)

fn visit_ts_array_type(&mut self, it: &TSArrayType<'a>)

fn visit_ts_indexed_access_type(&mut self, it: &TSIndexedAccessType<'a>)

fn visit_ts_tuple_type(&mut self, it: &TSTupleType<'a>)

fn visit_ts_named_tuple_member(&mut self, it: &TSNamedTupleMember<'a>)

fn visit_ts_optional_type(&mut self, it: &TSOptionalType<'a>)

fn visit_ts_rest_type(&mut self, it: &TSRestType<'a>)

fn visit_ts_tuple_element(&mut self, it: &TSTupleElement<'a>)

fn visit_ts_any_keyword(&mut self, it: &TSAnyKeyword)

fn visit_ts_string_keyword(&mut self, it: &TSStringKeyword)

fn visit_ts_boolean_keyword(&mut self, it: &TSBooleanKeyword)

fn visit_ts_number_keyword(&mut self, it: &TSNumberKeyword)

fn visit_ts_never_keyword(&mut self, it: &TSNeverKeyword)

fn visit_ts_intrinsic_keyword(&mut self, it: &TSIntrinsicKeyword)

fn visit_ts_unknown_keyword(&mut self, it: &TSUnknownKeyword)

fn visit_ts_null_keyword(&mut self, it: &TSNullKeyword)

fn visit_ts_undefined_keyword(&mut self, it: &TSUndefinedKeyword)

fn visit_ts_void_keyword(&mut self, it: &TSVoidKeyword)

fn visit_ts_symbol_keyword(&mut self, it: &TSSymbolKeyword)

fn visit_ts_this_type(&mut self, it: &TSThisType)

fn visit_ts_object_keyword(&mut self, it: &TSObjectKeyword)

fn visit_ts_big_int_keyword(&mut self, it: &TSBigIntKeyword)

fn visit_ts_type_reference(&mut self, it: &TSTypeReference<'a>)

fn visit_ts_type_name(&mut self, it: &TSTypeName<'a>)

fn visit_ts_qualified_name(&mut self, it: &TSQualifiedName<'a>)

fn visit_ts_type_parameter_instantiation( &mut self, it: &TSTypeParameterInstantiation<'a>, )

fn visit_ts_type_parameter(&mut self, it: &TSTypeParameter<'a>)

fn visit_ts_type_parameter_declaration( &mut self, it: &TSTypeParameterDeclaration<'a>, )

fn visit_ts_type_alias_declaration(&mut self, it: &TSTypeAliasDeclaration<'a>)

fn visit_ts_class_implements(&mut self, it: &TSClassImplements<'a>)

fn visit_ts_interface_declaration(&mut self, it: &TSInterfaceDeclaration<'a>)

fn visit_ts_interface_body(&mut self, it: &TSInterfaceBody<'a>)

fn visit_ts_property_signature(&mut self, it: &TSPropertySignature<'a>)

fn visit_ts_signature(&mut self, it: &TSSignature<'a>)

fn visit_ts_index_signature(&mut self, it: &TSIndexSignature<'a>)

fn visit_ts_call_signature_declaration( &mut self, it: &TSCallSignatureDeclaration<'a>, )

fn visit_ts_method_signature(&mut self, it: &TSMethodSignature<'a>)

fn visit_ts_construct_signature_declaration( &mut self, it: &TSConstructSignatureDeclaration<'a>, )

fn visit_ts_index_signature_name(&mut self, it: &TSIndexSignatureName<'a>)

fn visit_ts_interface_heritage(&mut self, it: &TSInterfaceHeritage<'a>)

fn visit_ts_type_predicate(&mut self, it: &TSTypePredicate<'a>)

fn visit_ts_type_predicate_name(&mut self, it: &TSTypePredicateName<'a>)

fn visit_ts_module_declaration(&mut self, it: &TSModuleDeclaration<'a>)

fn visit_ts_module_declaration_name(&mut self, it: &TSModuleDeclarationName<'a>)

fn visit_ts_module_declaration_body(&mut self, it: &TSModuleDeclarationBody<'a>)

fn visit_ts_global_declaration(&mut self, it: &TSGlobalDeclaration<'a>)

fn visit_ts_module_block(&mut self, it: &TSModuleBlock<'a>)

fn visit_ts_type_literal(&mut self, it: &TSTypeLiteral<'a>)

fn visit_ts_infer_type(&mut self, it: &TSInferType<'a>)

fn visit_ts_type_query(&mut self, it: &TSTypeQuery<'a>)

fn visit_ts_type_query_expr_name(&mut self, it: &TSTypeQueryExprName<'a>)

fn visit_ts_import_type(&mut self, it: &TSImportType<'a>)

fn visit_ts_import_type_qualifier(&mut self, it: &TSImportTypeQualifier<'a>)

fn visit_ts_import_type_qualified_name( &mut self, it: &TSImportTypeQualifiedName<'a>, )

fn visit_ts_function_type(&mut self, it: &TSFunctionType<'a>)

fn visit_ts_constructor_type(&mut self, it: &TSConstructorType<'a>)

fn visit_ts_mapped_type(&mut self, it: &TSMappedType<'a>)

fn visit_ts_template_literal_type(&mut self, it: &TSTemplateLiteralType<'a>)

fn visit_ts_as_expression(&mut self, it: &TSAsExpression<'a>)

fn visit_ts_satisfies_expression(&mut self, it: &TSSatisfiesExpression<'a>)

fn visit_ts_type_assertion(&mut self, it: &TSTypeAssertion<'a>)

fn visit_ts_import_equals_declaration( &mut self, it: &TSImportEqualsDeclaration<'a>, )

fn visit_ts_module_reference(&mut self, it: &TSModuleReference<'a>)

fn visit_ts_external_module_reference( &mut self, it: &TSExternalModuleReference<'a>, )

fn visit_ts_non_null_expression(&mut self, it: &TSNonNullExpression<'a>)

fn visit_decorator(&mut self, it: &Decorator<'a>)

fn visit_ts_namespace_export_declaration( &mut self, it: &TSNamespaceExportDeclaration<'a>, )

fn visit_ts_instantiation_expression( &mut self, it: &TSInstantiationExpression<'a>, )

fn visit_js_doc_nullable_type(&mut self, it: &JSDocNullableType<'a>)

fn visit_js_doc_non_nullable_type(&mut self, it: &JSDocNonNullableType<'a>)

fn visit_js_doc_unknown_type(&mut self, it: &JSDocUnknownType)

fn visit_span(&mut self, it: &Span)

fn visit_directives(&mut self, it: &Vec<'a, Directive<'a>>)

fn visit_statements(&mut self, it: &Vec<'a, Statement<'a>>)

fn visit_array_expression_elements( &mut self, it: &Vec<'a, ArrayExpressionElement<'a>>, )

fn visit_object_property_kinds(&mut self, it: &Vec<'a, ObjectPropertyKind<'a>>)

fn visit_template_elements(&mut self, it: &Vec<'a, TemplateElement<'a>>)

fn visit_expressions(&mut self, it: &Vec<'a, Expression<'a>>)

fn visit_arguments(&mut self, it: &Vec<'a, Argument<'a>>)

fn visit_assignment_target_properties( &mut self, it: &Vec<'a, AssignmentTargetProperty<'a>>, )

fn visit_variable_declarators(&mut self, it: &Vec<'a, VariableDeclarator<'a>>)

fn visit_switch_cases(&mut self, it: &Vec<'a, SwitchCase<'a>>)

fn visit_binding_properties(&mut self, it: &Vec<'a, BindingProperty<'a>>)

fn visit_formal_parameter_list(&mut self, it: &Vec<'a, FormalParameter<'a>>)

fn visit_decorators(&mut self, it: &Vec<'a, Decorator<'a>>)

fn visit_ts_class_implements_list( &mut self, it: &Vec<'a, TSClassImplements<'a>>, )

fn visit_class_elements(&mut self, it: &Vec<'a, ClassElement<'a>>)

fn visit_import_declaration_specifiers( &mut self, it: &Vec<'a, ImportDeclarationSpecifier<'a>>, )

fn visit_import_attributes(&mut self, it: &Vec<'a, ImportAttribute<'a>>)

fn visit_export_specifiers(&mut self, it: &Vec<'a, ExportSpecifier<'a>>)

fn visit_jsx_children(&mut self, it: &Vec<'a, JSXChild<'a>>)

fn visit_jsx_attribute_items(&mut self, it: &Vec<'a, JSXAttributeItem<'a>>)

fn visit_ts_enum_members(&mut self, it: &Vec<'a, TSEnumMember<'a>>)

fn visit_ts_types(&mut self, it: &Vec<'a, TSType<'a>>)

fn visit_ts_tuple_elements(&mut self, it: &Vec<'a, TSTupleElement<'a>>)

fn visit_ts_type_parameters(&mut self, it: &Vec<'a, TSTypeParameter<'a>>)

fn visit_ts_interface_heritages( &mut self, it: &Vec<'a, TSInterfaceHeritage<'a>>, )

fn visit_ts_signatures(&mut self, it: &Vec<'a, TSSignature<'a>>)

fn visit_ts_index_signature_names( &mut self, it: &Vec<'a, TSIndexSignatureName<'a>>, )

fn visit_spans(&mut self, it: &Vec<'a, Span>)