---
name: "XML::SAX::DocumentLocator"
section: "3pm"
platform: "linux"
package: "perl-xml-sax"
version: "1.02-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/XML::SAX::DocumentLocator"
---

# XML::SAX::DocumentLocator(3pm)

Helper class for document locators

## NAME

XML::SAX::DocumentLocator - Helper class for document locators

## SYNOPSIS

```
  my $locator = XML::SAX::DocumentLocator->new(
      sub { $object->get_public_id },
      sub { $object->get_system_id },
      sub { $reader->current_line },
      sub { $reader->current_column },
      sub { $reader->get_encoding },
      sub { $reader->get_xml_version },
  );
```

## DESCRIPTION

This module gives you a tied hash reference that calls the specified closures when asked for PublicId, SystemId, LineNumber and ColumnNumber.

It is useful for writing SAX Parsers so that you don't have to constantly update the line numbers in a hash reference on the object you pass to **set\_document\_locator()**. See the source code for XML::SAX::PurePerl for a usage example.

## API

There is only 1 method: `"new"`. Simply pass it a list of closures that when called will return the PublicId, the SystemId, the LineNumber, the ColumnNumber, the Encoding  and the XMLVersion respectively.

The closures are passed a single parameter, the key being requested. But you're free to ignore that.