1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-07-06 09:11:47 +02:00

libutil: Document hacks and problems around Pos class

This should provide context for follow-up commits in
the patch series.
This commit is contained in:
Sergei Zimmerman 2025-03-13 12:55:42 +00:00
parent a53b184e63
commit bf12aedf2e
3 changed files with 20 additions and 0 deletions

View file

@ -76,6 +76,17 @@ public:
return PosIdx(1 + origin.offset + offset);
}
/**
* Convert a byte-offset PosIdx into a Pos with line/column information.
*
* @param p Byte offset into the virtual concatenation of all parsed contents
* @return Position
*
* @warning Very expensive to call, as this has to read the entire source
* into memory each time. Call this only if absolutely necessary. Prefer
* to keep PosIdx around instead of needlessly converting it into Pos by
* using this lookup method.
*/
Pos operator[](PosIdx p) const;
Pos::Origin originOf(PosIdx p) const