racket/collects/syntax/scribblings/modresolve.scrbl
Matthew Flatt f6c4108af1 syntax collection scribbled
svn: r8670
2008-02-15 13:29:35 +00:00

28 lines
1.1 KiB
Racket

#lang scribble/doc
@(require "common.ss"
(for-label syntax/modresolve))
@title{Resolving Module Paths to File Paths}
@defmodule[syntax/modresolve]
@defproc[(resolve-module-path [module-path-v module-path?]
[rel-to-path-v (or/c path-string? (-> any) false/c)])
path?]{
Resolves a module path to filename path. The module path is resolved
relative to @scheme[rel-to-path-v] if it is a path string (assumed to
be for a file), to the directory result of calling the thunk if it is
a thunk, or to the current directory otherwise.}
@defproc[(resolve-module-path-index [module-path-index module-path-index?]
[rel-to-path-v (or/c path-string? (-> any) false/c)])
path?]{
Like @scheme[resolve-module-path] but the input is a @techlink[#:doc
refman]{module path index}; in this case, the @scheme[rel-to-path-v]
base is used where the module path index contains the ``self'' index.
If @scheme[module-path-index] depends on the ``self'' module path
index, then an exception is raised unless @scheme[rel-to-path-v] is a
path string.}