Module syntax

Analyzing the syntax of a source file.

This module must hide all AST details from the rest of the codebase.

Modules

• comment
  Convenient utilities to match comment in code.
• def
• import
  Import resolution utilities.
• matcher
  Convenient utilities to match syntax structures of code.

Structs

• ApplyExpr
• ArgsExpr
• BinInst
  A binary operation type
• CommentGroupMatcher
  A matcher that groups comments.
• ContentRefExpr
• ContentSeqExpr
• DocCommentMatcher
  A matcher that collects documentation comments.
• DocsDecl
• ElementExpr
• ExprInfo
• ExprInfoRepr
• ForExpr
• FuncExpr
• GeneratedDecl
• IfExpr
• ImportExpr
• IncludeExpr
• IndexInfo
• InterpretModeIter
  An iterator over the variants of InterpretMode
• LetExpr
• ModuleDecl
• ModuleDependency
  The dependency information of a module (file).
• NameRangeDecl
• PatternSig
• RefExpr
• SelectExpr
• SetExpr
• ShowExpr
• SpanDecl
• SpannedDecl
• SurroundingSyntaxIter
  An iterator over the variants of SurroundingSyntax
• UnInst
  A unary operation type
• WhileExpr

Enums

• ArgClass
  Classes of arguments that can be operated on by IDE functionality.
• ArgExpr
• BadCompletionCursor
  The cursor is on an invalid position.
• CommentGroupSignal
  A signal raised by the comment group matcher.
• Decl
• DefClass
  Classes of def items that can be operated on by IDE functionality.
• DefKind
  Kind of a definition.
• Expr
• ExprScope
• FieldClass
  Classes of field syntax that can be operated on by IDE functionality.
• InterpretMode
  A mode in which a text document is interpreted.
• LexicalKind
• LexicalVarKind
• Pattern
• PreviousDecl
  A declaration that is an ancestor of the given node or the previous sibling of some ancestor.
• PreviousItem
  A node that is an ancestor of the given node or the previous sibling of some ancestor.
• SurroundingSyntax
  Classes of syntax context (outer syntax) that can be operated on by IDE
• SyntaxClass
  Classes of syntax that can be operated on by IDE functionality.
• SyntaxContext
  Classes of syntax context (outer syntax) that can be operated on by IDE functionality.
• UnaryOp
  The kind of unary operation
• VarClass
  Classes of variable (access) syntax that can be operated on by IDE functionality.

Functions

• bad_completion_cursor
  Checks if the cursor is on an invalid position for completion.
• cast_include_expr
  Casts node to a single include expression.
• classify_context
  Classifies node’s context (outer syntax) that can be operated on by IDE functionality.
• classify_context_outer
  Classifies node’s context (outer syntax) by outer node that can be operated on by IDE functionality.
• classify_def
  Classifies a definition strictly.
• classify_def_loosely
  Classifies a definition loosely.
• classify_syntax
  Classifies node’s syntax (inner syntax) that can be operated on by IDE functionality.
• construct_module_dependencies
  Construct the module dependencies of the given context.
• find_module_level_docs
  Extract the module-level documentation from a source.
• find_source_by_expr
  Find a source instance by its import node.
• first_ancestor_expr
  Finds the first ancestor node that is an expression.
• get_index_info
• interpret_mode_at
  Determine the interpretation mode at the given position (context-sensitive).
• is_ident_like
  Whether the node can be recognized as an identifier.
• is_mark
  Whether the node can be recognized as a mark.
• node_ancestors
  Returns the ancestor iterator of the given node.
• previous_decls
  Finds the previous declarations starting from the given position. It checks PreviousItem and returns the found declarations.
• previous_items
  Finds the previous items (in the scope) starting from the given position inclusively. See PreviousItem for the possible items.
• resolve_id_by_path
  Resolve a file id by its import path.
• surrounding_syntax
  Determines the surrounding syntax of the node at the position.

Type Aliases

• BinExpr
• BinaryOp
  The kind of binary operation
• DeclExpr
• ExportMap
• ExprRoute
• LexicalScope
• UnExpr