locate -- locate source code

Usage:

locate f
Inputs:
- x, a function, a sequence, a symbol, a list, or an integer,
Outputs:
- a file position, a list, or null, {filename, start,startcol, stop,stopcol, pos,poscol}, respectively

Description

For a symbol interpreted function f, returns a FilePosition{n,i,c,j,d,k,e} describing the location of the definition in the source code:

The name of the source file is n;

the code occupies line i column c through line j column d;

the central point of interest located at line k column e.

i1 : locate needs

o1 = /usr/share/Macaulay2/Core/Core.m2:148:8-148:68

o1 : FilePosition

i2 : code needs

o2 = /usr/share/Macaulay2/Core/Core.m2:148:8-148:68:
     --source code:
     needs = filename -> (loadPath(path, filename, simpleNeeds, notify);)

If f is a sequence, then lookup is applied first, and the location of the resulting function is provided.

i3 : locate(jacobian, Matrix)

o3 = /usr/share/Macaulay2/Core/matrix.m2:550:29-550:66

o3 : FilePosition

In particular, the output of methods can be used as an input to locate.

i4 : locate methods jacobian

o4 = {0 => (/usr/share/Macaulay2/Core/matrix.m2:550:29-550:66) }
     {1 => (/usr/share/Macaulay2/Core/matrix.m2:551:27-551:62) }
     {2 => (/usr/share/Macaulay2/Core/matrix.m2:552:34-552:60) }
     {3 => (/usr/share/Macaulay2/Core/matrix1.m2:510:28-510:56)}

o4 : NumberedVerticalList

i5 : methods doc

o5 = {0 => (doc, String)}

o5 : NumberedVerticalList

i6 : locate 0

o6 = /usr/share/Macaulay2/SimpleDoc.m2:42:14-49:83

o6 : FilePosition

i7 : peek oo

o7 = FilePosition{/usr/share/Macaulay2/SimpleDoc.m2, 42, 14, 49, 83, 42, 14}

If the function f is compiled, or if f is null, then a location is not available and null is returned.

Ways to use locate:

locate(DocumentTag) -- see DocumentTag -- the class of all document tags
locate(Command)
locate(Error)
locate(Function)
locate(FunctionBody)
locate(List)
locate(Nothing)
locate(Package)
locate(Pseudocode)
locate(Sequence)
locate(Symbol)
locate(ZZ)
locate(TestInput) -- see tests -- locate a package's tests

For the programmer

The object locate is a method function with a single argument.

The source of this document is in Macaulay2Doc/functions/locate-doc.m2:60:0.