perl-parser-core 0.17.0

Core parser engine for perl-parser
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! PIR v0: a source-anchored tooling intermediate representation.
//!
//! PIR is lowered from [`HirFile`](crate::hir::HirFile). It models data access,
//! calls, and control flow for editor tooling and static analysis without
//! executing Perl. PIR v0 is a compiler-substrate data layer only: it does not
//! replace HIR, does not promote provider behavior, does not claim determinism,
//! and does not run real Perl.
//!
//! See [`PLSP-SPEC-0025`](../../../../docs/specs/PLSP-SPEC-0025-pir-v0.md) for
//! the authoritative contract.
//!
//! # Quick start
//!
//! ```rust
//! use perl_parser_core::Parser;
//! use perl_parser_core::hir::lower_ast;
//! use perl_parser_core::pir::lower_hir;
//!
//! let mut parser = Parser::new("my $x = foo();");
//! let output = parser.parse_with_recovery();
//! let hir = lower_ast(&output.ast);
//! let pir = lower_hir(&hir);
//!
//! // Every source-derived node preserves a source anchor.
//! assert!(pir.nodes.iter().all(|n| n.source_anchor.is_anchored()));
//! // Provider behavior never changes from lowering alone.
//! assert!(!pir.receipt.provider_behavior_changed);
//! ```

mod extractor;
mod lower;
mod model;

pub use extractor::{
    BodyExtractionResult, LEXICAL_EXTRACTOR_RECEIPT_VERSION, LexicalBindingFact,
    LexicalExtractorReceipt, LexicalRole, extract_lexical_facts,
};
pub use lower::{
    lower_hir, lower_hir_bodies, lower_hir_bodies_with_identity, lower_hir_with_identity,
    lower_single_body,
};
pub use model::{
    LexicalName, PIR_RECEIPT_VERSION, PirAnchorCoverage, PirAnchorKind, PirCallee, PirContext,
    PirDynamicBoundaryKind, PirEdge, PirEdgeKind, PirGraph, PirId, PirLoweringMode, PirMethod,
    PirNode, PirOperation, PirReceipt, PirReceiver, PirSourceAnchor, SymbolName,
};