1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta http-equiv="Content-Language" content="en">
<title>Hook Script API</title>
</head>
<body>
<h1>Hook Script API</h1>
<dl>
<dt>get_config(<var>key</var>) -> String</dt>
<dt>config(<var>key</var>) -> String</dt>
<dd><p>
get a configuration. (e.g. config('prefix') for --prefix)
</p>
</dd>
<dt>set_config(<var>key</var>, <var>val</var>)</dt>
<dd><p>
set a configuration KEY to VAL. (e.g. set_config("prefix", "/usr"))
</p>
</dd>
<dt>curr_srcdir -> String</dt>
<dd><p>
the current srcdir.
</p>
</dd>
<dt>curr_objdir -> String</dt>
<dd><p>
the current objdir.
</p>
</dd>
<dt>srcdir_root -> String</dt>
<dd><p>
the root directory of srcdir.
When the hook script is called from setup.rb, this method
returns the top directory of each package directory
(ARCHIVE_TOP/packages/*/).
</p>
</dd>
<dt>objdir_root -> String</dt>
<dd><p>
the root directory of objdir.
When the hook script is called from setup.rb, this method
returns the top directory of each package directory
(OBJDIR/packages/*/).
</p>
</dd>
<dt>srcfile(<var>filename</var>) -> String</dt>
<dd><p>
expands relational path FNAME which is in the current srcdir,
into the absolute path.
</p>
</dd>
<dt>srcexist?(<var>filename</var>)</dt>
<dd><p>
true if a file FNAME exists in the current srcdir.
</p>
</dd>
<dt>srcdirectory?(<var>filename</var>)</dt>
<dd><p>
true if a directory FNAME exists in the current srcdir.
</p>
</dd>
<dt>srcfile?(<var>filename</var>)</dt>
<dd><p>
true if a normal file FNAME exists in the current srcdir.
</p>
</dd>
<dt>srcentries(<var>relative_path</var> = '.') -> [String]</dt>
<dd><p>
returns the list of file entiries in the directory
"current srcdir + '/' + relpath"
</p>
</dd>
<dt>srcfiles(<var>relative_path</var> = '.') -> [String]</dt>
<dd><p>
returns the list of file names in the directory
"current srcdir + '/' + relpath"
</p>
</dd>
<dt>srcdirectories(<var>relative_path</var> = '.') -> [String]</dt>
<dd><p>
returns the list of directory names in the directory
"current srcdir + '/' + relpath"
</p>
</dd>
</dl>
</body>
</html>
|