12.3 Syntax Object Bindings

“Same module binding” means that the identifiers refer to the same original definition site, and not necessarily to the same require or provide site. Due to renaming in require and provide, or due to a transformer binding to a rename transformer, the identifiers may return distinct results with syntax-e.

• The result is 'lexical if id-stx has a local binding.

• The result is a list of seven items when id-stx has a module binding: (list from-mod from-sym nominal-from-mod nominal-from-sym from-phase import-phase+space-shift nominal-export-phase).

  • from-mod is a module path index (see Compiled Modules and References) that indicates the defining module. It is the “self” module path index if the binding refers to a definition in the enclosing module of id-stx.

  • from-sym is a symbol for the identifier’s name at its definition site in the originating module. This can be different from the local name returned by syntax->datum for several reasons: the identifier is renamed on import, it is renamed on export, or it is implicitly renamed because the binding site was generated by a macro invocation. In that last case, it may be an unreadable symbol, and it may be different from the result of syntax->datum on the identifier in the original source definition.

  • nominal-from-mod is a module path index (see Compiled Modules and References) that indicates the binding’s module as it appears locally in the source around id-stx: it indicates a module required into the context of id-stx to provide its binding, or it is the same “self” as from-mod for a binding that refers to a definition in the enclosing module of id-stx. It can be different from from-mod due to a re-export in nominal-from-mod of some imported identifier. If the same binding is imported in multiple ways, an arbitrary representative is chosen.

  • nominal-from-sym is a symbol for the binding’s identifier as it appears locally in the source around id-stx: it is the identifier’s name as exported by nominal-from-mod, or it is the source identifier’s symbol for a definition within the enclosing module of id-stx. It can be different from from-sym due to a renaming provide, even if from-mod and nominal-from-mod are the same, or due to a definition that was introduced by a macro expansion.

  • from-phase is an exact non-negative integer representing the originating phase. For example, it is 1 if the definition is for-syntax.

  • import-phase+space-shift is 0 if the binding import of nominal-from-mode is from a definition or a plain require, 1 if it is from a for-syntax import, a phase combined with a space name if it is from a for-space import, etc.

  • nominal-export-phase+space is the phase level and binding space of the export from nominal-from-mod for an imported binding, or it is the phase level of the definition for a binding from the enclosing module of id-stx.

• The result is (list top-sym) if id-stx has a top-level binding and top-level-symbol? is true. The top-sym can different from the name returned by syntax->datum when the binding definition was generated by a macro invocation.

• The result is #f if id-stx has a top-level binding and top-level-symbol? is #f or if id-stx is unbound. An unbound identifier is typically treated the same as an identifier whose top-level binding is a variable.

If id-stx is bound to a rename-transformer, the result from identifier-binding is for the identifier in the transformer, so that identifier-binding is consistent with free-identifier=?.

If exact-scopes? is a true value, then the result is #f unless the binding for id-stx has exactly the scopes of id-stx. An exact-scopes check is useful for detecting whether an identifier is already bound in a specific definition context, for example.

Changed in version 6.6.0.4 of package base: Added the top-level-symbol? argument to report information on top-level bindings.
Changed in version 8.2.0.3: Generalized phase results to phase–space combinations.
Changed in version 8.6.0.9: Added the exact-scopes? argument.

Changed in version 8.2.0.3 of package base: Generalized phase results to phase–space combinations.

Changed in version 8.2.0.3 of package base: Generalized phase results to phase–space combinations.

Changed in version 8.2.0.3 of package base: Generalized phase results to phase–space combinations.

Added in version 8.3.0.8 of package base.

When identifier-binding would produce a list, then the second element of that list is the result that identifier-binding-symbol produces.

Added in version 8.3.0.8 of package base.

Added in version 8.6.0.6 of package base.
Changed in version 8.6.0.9: Added the exact-scopes? argument.

Added in version 8.6.0.8 of package base.