nashorn/docs/genshelldoc.js
author sogoel
Fri, 15 May 2015 17:43:21 -0700
changeset 30724 0686b5ea7958
parent 26067 b32ccc3a76c9
permissions -rw-r--r--
8074514: Group 13d: golden files for tests in tools/javac/generics dir Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     1
/*
16151
97c1e756ae1e 8005663: Update copyright year to 2013
jlaskey
parents: 16147
diff changeset
     2
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26067
b32ccc3a76c9 8055199: Tidy up Nashorn codebase for code standards (August 2014)
attila
parents: 16151
diff changeset
     4
 *
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     7
 * published by the Free Software Foundation.
26067
b32ccc3a76c9 8055199: Tidy up Nashorn codebase for code standards (August 2014)
attila
parents: 16151
diff changeset
     8
 *
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    13
 * accompanied this code).
26067
b32ccc3a76c9 8055199: Tidy up Nashorn codebase for code standards (August 2014)
attila
parents: 16151
diff changeset
    14
 *
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26067
b32ccc3a76c9 8055199: Tidy up Nashorn codebase for code standards (August 2014)
attila
parents: 16151
diff changeset
    18
 *
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    21
 * questions.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    22
 */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    23
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    24
/**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    25
 * Generate HTML documentation for shell tool. Re-run this tool to regenerate
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    26
 * html doc when you change options.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    27
 *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    28
 * Usage:
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    29
 *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    30
 *     jjs -scripting genshelldoc.js > shell.html
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    31
 */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    32
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    33
var Options = Packages.jdk.nashorn.internal.runtime.options.Options;
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    34
var title = "Nashorn command line shell tool";
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    35
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    36
print(<<PREFIX
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    37
<html>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    38
<head>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    39
<title>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    40
${title}
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    41
</title>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    42
</head>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    43
<body>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    44
<h1>Usage</h1>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    45
<p>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    46
<code>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    47
<b>jjs &lt;options&gt; &lt;script-files&gt; [ -- &lt;script-arguments&gt; ]</b>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    48
</code>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    49
</p>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    50
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    51
<h1>${title} options</h1>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    52
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    53
<table border="0">
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    54
<tr>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    55
<th>name</th>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    56
<th>type</th>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    57
<th>default</th>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    58
<th>description</th>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    59
</tr>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    60
PREFIX);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    61
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    62
for each (opt in Options.validOptions) {
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    63
26067
b32ccc3a76c9 8055199: Tidy up Nashorn codebase for code standards (August 2014)
attila
parents: 16151
diff changeset
    64
var isTimezone = (opt.type == "timezone");
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    65
var defValue = opt.defaultValue;
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    66
if (defValue == null) {
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    67
    defValue = "&lt;none&gt;";
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    68
}
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    69
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    70
if (isTimezone) {
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    71
    // don't output current user's timezone
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    72
    defValue = "&lt;default-timezone&gt;"
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    73
}
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    74
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    75
print(<<ROW
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    76
  <tr>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    77
  <td><b>${opt.name} ${opt.shortName == null? "" : opt.shortName}</b></td>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    78
  <td>${opt.type}</td>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    79
  <td>${defValue}</td>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    80
  <td>${opt.description}</td>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    81
  </tr>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    82
ROW);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    83
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    84
}
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    85
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    86
print(<<SUFFIX
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    87
</table>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    88
</body>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    89
</html>
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    90
SUFFIX);