Struct VariableReference 

pub struct VariableReference(/* private fields */);

A reference to a variable in the makefile, e.g. $(FOO) or ${BAR}.

This wraps an EXPR syntax node whose first token is $ followed by ( or {.

Implementations

impl VariableReference

pub fn cast(syntax: SyntaxNode<Lang>) -> Option<Self>

Try to cast a syntax node into a VariableReference.

Returns Some if the node is an EXPR whose first token is $ followed by (, {, or an identifier (for single-character variables like $X).

pub fn syntax(&self) -> &SyntaxNode<Lang>

Get the syntax node backing this variable reference.

pub fn name(&self) -> Option<String>

Get the name of the referenced variable.

For simple references like $(FOO), returns "FOO". For function calls like $(wildcard *.c), returns "wildcard".

Note: Variable references inside recipes are not parsed into the syntax tree (recipes are stored as raw text). This only finds references in variable values, prerequisites, and targets.

Example

use makefile_lossless::Makefile;
let makefile: Makefile = "CFLAGS = $(BASE_FLAGS) -Wall\n".parse().unwrap();
let refs: Vec<_> = makefile.variable_references().collect();
assert_eq!(refs[0].name(), Some("BASE_FLAGS".to_string()));

pub fn is_function_call(&self) -> bool

Check if this is a function call rather than a simple variable reference.

Returns true if the content after the function name contains whitespace or commas, indicating arguments (e.g. $(subst a,b,text) vs $(CC)).

Example

use makefile_lossless::Makefile;
let makefile: Makefile = "FILES = $(wildcard *.c)\n".parse().unwrap();
let refs: Vec<_> = makefile.variable_references().collect();
assert!(refs[0].is_function_call());

pub fn argument_count(&self) -> usize

Count the number of comma-separated arguments in a function call.

Returns 0 for simple variable references. For function calls, counts the commas at depth 0 (not inside nested parentheses) plus 1.

Example

use makefile_lossless::Makefile;
let makefile: Makefile = "X = $(subst a,b,text)\n".parse().unwrap();
let refs: Vec<_> = makefile.variable_references().collect();
assert_eq!(refs[0].argument_count(), 3);

pub fn argument_index_at_offset(&self, offset: usize) -> Option<usize>

Determine which argument (0-based) the given byte offset falls into.

Returns None if the offset is not inside this reference or if this is not a function call.

Example

use makefile_lossless::Makefile;
let makefile: Makefile = "X = $(subst a,b,text)\n".parse().unwrap();
let refs: Vec<_> = makefile.variable_references().collect();
// offset 12 is 'a' (first arg), offset 14 is 'b' (second arg), offset 16 is 't' (third arg)
assert_eq!(refs[0].argument_index_at_offset(12), Some(0));
assert_eq!(refs[0].argument_index_at_offset(14), Some(1));
assert_eq!(refs[0].argument_index_at_offset(16), Some(2));

pub fn line(&self) -> usize

Get the line number (0-indexed) where this reference starts.

pub fn column(&self) -> usize

Get the column number (0-indexed, in bytes) where this reference starts.

pub fn line_col(&self) -> (usize, usize)

Get both line and column (0-indexed) where this reference starts.

pub fn text_range(&self) -> TextRange

Get the text range of this reference in the source.

Trait Implementations

impl Clone for VariableReference

fn clone(&self) -> VariableReference

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for VariableReference

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for VariableReference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VariableReference

fn eq(&self, other: &VariableReference) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for VariableReference

impl StructuralPartialEq for VariableReference