package ppxlib

  1. Overview
  2. Docs
Standard infrastructure for ppx rewriters

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (24)

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. O
    opensource@janestreet.com

Sources

a6fadbd212f3cd7d5d8dcfefc46c884f710fedc0.tar.gz
sha256=25e81f2085ad19688f7056c6df49ca48b3df4cea8304ba3be2550e172d59bfec
sha512=cfdaa06fd32d206f72de05a5289d33ec85fa6bdf7c5be7c85874a16d9e154cdc080465453b60fe7f6c01589eb92e4296b18067413ac2d8dec47b9539f55e301e

doc/ppxlib/Ppxlib/Code_path/index.html

Module Ppxlib.Code_pathSource

This module contains type and functions for representing and manipulating path to AST nodes.

Sourcetype t

Type for path to AST nodes

Sourceval file_path : t -> string

Return the path to the .ml or .mli file for this code path.

Sourceval main_module_name : t -> string

Return the module name corresponding to the file to which this code path leads to.

Sourceval submodule_path : t -> string list

Return the path within the main module this code path represents as a list of module names.

Sourceval enclosing_module : t -> string

Return the nearest enclosing module name. Does descend into expressions.

Sourceval value : t -> string option

Return the name of the value to which this code path leads or None if it leads to the toplevel of a module or submodule.

Sourceval enclosing_value : t -> string option

Like value, returns the name of an enclosing value definition. Unlike value, includes names inside expressions, not just names that the code path can reach from the toplevel module.

Sourceval fully_qualified_path : t -> string

Return the fully qualified path to the module or value this code path leads to, eg "Some_main_module.Some_submodule.some_value". Note that the fully qualified path doesn't descend into expressions which means it will always stop at the first value description or value binding.

Sourceval to_string_path : t -> string

Return the string version of this code path as built by Ast_traverse.map_with_path. Used for compatibility with path from version 0.5.0 and lower.