perl-builtins 0.11.0

Builtin symbol metadata for Perl parser and LSP tooling
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

# perl-builtins

Builtin function signatures and metadata for Perl parser and LSP tooling.

Part of the [tree-sitter-perl-rs](https://github.com/EffortlessMetrics/perl-lsp) workspace.

## Overview

Provides two complementary lookup mechanisms for 200+ Perl built-in functions (including file test operators):

- **`builtin_signatures`** -- `HashMap`-based store with `OnceLock` lazy init. Each entry carries multiple signature variants and a documentation string (`BuiltinSignature`). Used for signature help and hover.
- **`builtin_signatures_phf`** -- Re-export of the `perl-builtins-phf` microcrate, which provides compile-time `phf::Map` tables (`BUILTIN_SIGS`, `BUILTIN_FULL_SIGS`) for O(1) lookups with zero runtime allocation. Exposes `get_param_names`, `is_builtin`, and `builtin_count` helpers. Used for inlay hints and completion.

## Categories covered

I/O, strings, arrays, hashes, file/directory ops, file test operators (`-e`, `-f`, ...), processes, math, sockets/network, IPC, user/group, time, modules, control flow, tied variables, and more.

## Usage

```rust
use perl_builtins::builtin_signatures_phf::{is_builtin, get_param_names};

assert!(is_builtin("print"));
assert_eq!(get_param_names("open"), &["FILEHANDLE", "MODE", "FILENAME"]);
```

## License

MIT OR Apache-2.0