blob: 8647b46a373f99fd855e5c41691bea04bb6556dc [file] [log] [blame]
#!/usr/bin/env python
# Copyright (c) 2013 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Creates simple HTML for running a NaCl module.
This script is designed to make the process of creating running
Native Client executables in the browers simple by creating
boilderplate a .html (and optionally a .nmf) file for a given
Native Client executable (.nexe).
If the script if given a .nexe file it will produce both html
the nmf files. If it is given an nmf it will only create
the html file.
import argparse
import os
import sys
import subprocess
SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
<!DOCTYPE html>
Sample html container for embedded NaCl module. This file was auto-generated
by the create_html tool which is part of the NaCl SDK.
The embed tag is setup with PS_STDOUT, PS_STDERR and PS_TTY_PREFIX attributes
which, for applications linked with ppapi_simple, will cause stdout and stderr
to be sent to javascript via postMessage. Also, the postMessage listener
assumes that all messages sent via postMessage are strings to be displayed in
the output textarea.
<meta http-equiv="Pragma" content="no-cache">
<meta http-equiv="Expires" content="-1">
<h2>Native Client Module: %(module_name)s</h2>
<p>Status: <code id="status">Loading</code></p>
<div id="listener">
<embed id="nacl_module" name="%(module_name)s" src="%(nmf)s"
type="application/x-nacl" width=640 height=480
PS_STDERR="/dev/tty" >/
<p>Standard output/error:</p>
<textarea id="stdout" rows="25" cols="80">
listenerDiv = document.getElementById("listener")
stdout = document.getElementById("stdout")
nacl_module = document.getElementById("nacl_module")
function updateStatus(message) {
document.getElementById("status").innerHTML = message
function addToStdout(message) {
stdout.value += message;
stdout.scrollTop = stdout.scrollHeight;
function handleMessage(message) {
var payload =;
var prefix = "tty:";
if (typeof(payload) == 'string' && payload.indexOf(prefix) == 0) {
function handleCrash(event) {
updateStatus("Crashed/exited with status: " + nacl_module.exitStatus)
function handleLoad(event) {
listenerDiv.addEventListener("load", handleLoad, true);
listenerDiv.addEventListener("message", handleMessage, true);
listenerDiv.addEventListener("crash", handleCrash, true);
class Error(Exception):
def Log(msg):
if Log.enabled:
sys.stderr.write(str(msg) + '\n')
Log.enabled = False
def CreateHTML(filenames, options):
nmf = None
for filename in filenames:
if not os.path.exists(filename):
raise Error('file not found: %s' % filename)
if not os.path.isfile(filename):
raise Error('specified input is not a file: %s' % filename)
basename, ext = os.path.splitext(filename)
if ext not in ('.nexe', '.pexe', '.nmf'):
raise Error('input file must be .nexe, .pexe or .nmf: %s' % filename)
if ext == '.nmf':
if len(filenames) > 1:
raise Error('Only one .nmf argument can be specified')
nmf = filename
elif len(filenames) > 1 and not options.output:
raise Error('When specifying muliple input files -o must'
' also be specified.')
htmlfile = options.output
if not htmlfile:
htmlfile = basename + '.html'
basename = os.path.splitext(os.path.basename(htmlfile))[0]
if not nmf:
nmf = os.path.splitext(htmlfile)[0] + '.nmf'
Log('creating nmf: %s' % nmf)
create_nmf = os.path.join(SCRIPT_DIR, '')
staging = os.path.dirname(nmf)
if not staging:
staging = '.'
cmd = [create_nmf, '-s', staging, '-o', nmf] + filenames
if options.verbose:
if options.debug_libs:
except subprocess.CalledProcessError:
raise Error('create_nmf failed')
Log('creating html: %s' % htmlfile)
with open(htmlfile, 'w') as outfile:
args = {}
args['title'] = basename
args['module_name'] = basename
args['nmf'] = os.path.basename(nmf)
outfile.write(HTML_TEMPLATE % args)
def main(argv):
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('-v', '--verbose', action='store_true',
help='Verbose output')
parser.add_argument('-d', '--debug-libs', action='store_true',
help='When calling create_nmf request debug libaries')
parser.add_argument('-o', '--output', dest='output',
help='Name of html file to write (default is '
'input name with .html extension)',
parser.add_argument('exe', metavar='EXE_OR_NMF', nargs='+',
help='Executable (.nexe/.pexe) or nmf file to generate '
'html for.')
# To enable bash completion for this command first install optcomplete
# and then add this line to your .bashrc:
# complete -F _optcomplete
import optcomplete
except ImportError:
options = parser.parse_args(argv)
if options.verbose:
Log.enabled = True
CreateHTML(options.exe, options)
return 0
if __name__ == '__main__':
rtn = main(sys.argv[1:])
except Error, e:
sys.stderr.write('%s: %s\n' % (os.path.basename(__file__), e))
rtn = 1
except KeyboardInterrupt:
sys.stderr.write('%s: interrupted\n' % os.path.basename(__file__))
rtn = 1