GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
LaTeXML::Common::Locator(3) User Contributed Perl Documentation LaTeXML::Common::Locator(3)

"LaTeXML::Common::Locator" - represents a reference to a point or range in the source file.

"LaTeXML::Common::Locator" contains a reference to a point or range within a source file. This data structure is intended to be used both programtically (for "source references") and to display error messages to the user.

It extends LaTeXML::Common::Object.

"$locator = LaTeXML::Common::Locator->new($source, $fromLine, $fromCol, $toLine, $toCol);"
Creates a new locator. $source should be a string containing the full path of the source file, an empty string in case of a literal string, or undef in case of an anonymous string. $fromLine and $fromCol should be integers containing the line and column numbers of the start of the range in the source file, or undef if unknown. $toLine and $toCol should be the integers containing the line and column numbers of the end of the range, or undef if a point is being refered to.
"$locator = LaTeXML::Common::Locator->newRange($from, $to);"
Creates a new locator, starting at the locator $from and ending at the locator $to. Either locator may be undef, in which case the other one is returned.

"$str = $locator->toString;"
Turns this locator into a short string for output in user messages.
"$str = $locator->stringify;"
Turns this locator into a long string, including the full filename of the input.
"$attr = $locator->toAttribute;"
Turns this locator into an XPointer expression, for usage within an XML attribute.
"$isRange = $locator->isRange;"
Checks if this locator points to a range or a point.
"$source = $locator->getShortSource($stringSource);"
Gets a short string refering to the source of this locator. $stringSource will be used if the source refers to an anonymous or literal string input.
"$from = $locator->getFromLocator;"
Gets a locator pointing to the first point in the range of this locator. Works for both point and range locators.
"$from = $locator->getToLocator;"
Gets a locator pointing to the last point in the range of this locator. Does not work for point locators.

Bruce Miller <bruce.miller@nist.gov> Tom Wiesing <tom.wiesing@gmail.com>

Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.
2021-08-26 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.