ac26fe7554
Also, updates some of the mzlib files to point at `racket/*' libraries rather than to `scheme/*' ones.
36 lines
1.4 KiB
Racket
36 lines
1.4 KiB
Racket
#lang scribble/doc
|
|
@(require "common.rkt" (for-label syntax/modcollapse))
|
|
|
|
@title[#:tag "modcollapse"]{Simplifying Module Paths}
|
|
|
|
@defmodule[syntax/modcollapse]
|
|
|
|
@defproc[(collapse-module-path [module-path-v module-path?]
|
|
[rel-to-module-path-v any/c])
|
|
(or/c path? module-path?)]{
|
|
|
|
Returns a ``simplified'' module path by combining
|
|
@racket[module-path-v] with @racket[rel-to-module-path-v], where the
|
|
latter must have the form @racket['(lib ....)] or a symbol,
|
|
@racket['(file <string>)], @racket['(planet ....)], a @techlink[#:doc
|
|
refman]{path}, or a thunk to generate one of those.
|
|
|
|
The result can be a path if @racket[module-path-v] contains a path
|
|
element that is needed for the result, or if
|
|
@racket[rel-to-module-path-v] is a non-string path that is needed for
|
|
the result; otherwise, the result is a module path in the sense of
|
|
@racket[module-path?].
|
|
|
|
When the result is a @racket['lib] or @racket['planet] module path, it
|
|
is normalized so that equivalent module paths are represented by
|
|
@racket[equal?] results.}
|
|
|
|
@defproc[(collapse-module-path-index [module-path-index module-path-index?]
|
|
[rel-to-module-path-v any/c])
|
|
(or/c path? module-path?)]{
|
|
|
|
Like @racket[collapse-module-path], but the input is a @techlink[#:doc
|
|
refman]{module path index}; in this case, the
|
|
@racket[rel-to-module-path-v] base is used where the module path index
|
|
contains the ``self'' index.}
|