def do_deprecated_compile(self, subcmd, opts, udl_path):
"""${cmd_name}: compile a .udl file into lang resources
Note: This has been deprecated in favour of `luddite just_compile'
and the more generic functionality of the 'koext' tool.
${cmd_usage}
${cmd_option_list}
If you specify '--skel' to build a skeleton Language Service
then you must also specify one of the -G or -g|--guid options.
The Language Service is a Python file that controls language
support in Komodo. It requires a unique GUID (for the XPCOM
component's class id).
If you are just building the skeleton language service for every
build (you can get away with this for minimal language support)
the using a GUIDs text file to ensure the same GUID is used for
your component from build to build is recommended. This file
must be of the form (one entry per line):
<lang> <guid>
"""
log.warn("the 'skel' generation facilities of 'luddite compile' "
"have been deprecated in favour of (a) the simpler "
"'luddite just_compile' and (b) the more generic support "
"of the 'koext' tool")
guid = guid_from_lang = None
if not opts.skel:
if opts.add_missing:
raise Luddite("cannot specify --add-missing without --skel")
elif opts.new_guid and opts.guid:
raise LudditeError("cannot specify both -G and -g|--guid "
"options at the same time")
elif opts.new_guid:
guid = None
elif opts.guid:
if guid_pat.match(opts.guid):
guid = norm_guid(opts.guid)
else:
if not exists(opts.guid):
raise LudditeError("`%s' is not a GUID and does not "
"exist" % opts.guid)
guid_from_lang = {} #dict((lang, g) for lang, g in)
for line in file(opts.guid):
if line.startswith("#"): continue
if not line.strip(): continue
lang, g = line.strip().split(None, 1)
guid_from_lang[lang] = norm_guid(g)
else:
raise LudditeError("must specify one of -G or -g|--guid")
if opts.force and opts.add_missing:
raise LudditeError("cannot specify both -f|--force and "
"--add-missing options at the same time")
return commands.deprecated_compile(udl_path,
skel=opts.skel,
guid=guid,
guid_from_lang=guid_from_lang,
ext=opts.ext,
force=opts.force,
add_missing=opts.add_missing,
log=log)
def do_lexhtml(self, subcmd, opts, lang, path):
"""${cmd_name}: lex the given file to styled HTML (for debugging)
${cmd_usage}
${cmd_option_list}
"""
from ludditelib.debug import lex_to_html
content = open(path, 'r').read()
html = lex_to_html(content, lang)
if opts.output == '-':
output_path = None
output_file = sys.stdout
else:
if opts.output:
output_path = opts.output
else:
output_path = path + ".html"
if exists(output_path):
os.remove(output_path)
output_file = open(output_path, 'w')
if output_file:
output_file.write(html)
if output_path:
output_file.close()
if opts.browse:
if not output_path:
raise LudditeError("cannot open in browser if stdout used "
"for output")
import webbrowser
url = _url_from_local_path(output_path)
webbrowser.open_new(url)
def compile(udl_path, output_dir=None, include_path=None, log=None):
"""Compile the given .udl file to a Komodo lexer resource.
If not given, the output dir will be the same as the input .udl file.
The output filename is "${safe_lang}.lexres", where "safe_lang" is a
slightly massaged version of the language name defined in the .udl
file with the "language" UDL statement.
"include_path" is a list of directories from which support .udl files
can be included (by default the current dir, the dir of the input .udl
file is alway part of the include path).
"""
log = log or _log
if output_dir is None:
output_dir = dirname(udl_path) or os.curdir
# Clean up after PLY. It leaves some turds that can break subsequent
# parsing if the parser source is changed.
turds = ["parser.out", "parsetab.py", "parsetab.pyc"]
for turd in turds:
if exists(turd):
log.debug("remove `%s'", turd)
os.remove(turd)
# Parse and load the UDL definition.
log.debug("parse `%s'", udl_path)
parse_tree = parse(udl_path, include_path=include_path)
if parse_tree is None:
raise LudditeError("parse failed")
mainObj = gen.MainObj()
analyzer = gen.Analyzer(mainObj)
analyzer.processTree(parse_tree)
mainObj.calcUniqueStates()
#XXX Grr. Crappy error handling again. This should be changed to
# raise a LudditeError if the semanticCheck fails then just call:
# analyzer.semanticCheck()
if analyzer.semanticCheck() is None:
return 1
# Make sure don't trounce files before generating outputs and setup
# output dir.
lang_name = mainObj.languageName
safe_lang_name = mainObj.safeLangName
lexres_path = join(output_dir, safe_lang_name + ".lexres")
log.info("compile `%s' to `%s'", udl_path, lexres_path)
if exists(lexres_path):
log.debug("rm `%s'", lexres_path)
os.remove(lexres_path)
# Generate all outputs.
if not exists(dirname(lexres_path)):
os.makedirs(dirname(lexres_path))
log.debug("create `%s'", lexres_path)
mainObj.dumpAsTable(constants.vals, lexres_path)
def _wrap_read_file(fname, include_path):
# Read in the file contents.
if fname == '-':
fin = sys.stdin
s = fin.read()
else:
for p in [os.curdir] + include_path:
fpath = join(p, fname)
if exists(fpath):
break
else:
raise LudditeError("`%s' does not exist on include path: '%s'" %
(fname, "', '".join(include_path)))
fin = open(fpath, 'r')
try:
s = fin.read()
finally:
fin.close()
return s
def parse(udl_path, include_path=None, log=None):
"""Parse the given .udl file.
PLY (i.e. yacc.py and lex.py) are messy. They leave 'parser.out' and
'parsetab.py' turds in the current directory. Attempting to hack around
this by cd'ing into the build dir to run. However this breaks the parse
for a reason I don't understand. It would be good to fix that at some
point.
Notes on the above analysis: The 'parser.out' debug file can be
suppressed with `yaccdebug = 0` in yacc.py. The 'parsetab.py' file
is generated by yacc.py::lr_write_tables() and can be suppressed
with the `yacc(..., write_tables=0)` argument. TODO: Try this and
see if can remove the above-mentioned hacking around.
"""
log = log or _log
log.debug("parse('%s')", udl_path)
parse_tree = parser.parse_udl_path(udl_path, include_path=include_path)
# Ick. This modules uses a global for an error count.
if parser.num_errs:
raise LudditeError("could not parse '%s': %d error(s)" %
(udl_path, parser.num_errs))
return parse_tree
def raise_force_error(path):
raise LudditeError("`%s' already exists: use "
"-f|--force option to allow it to be "
"overwritten" % path)
def deprecated_compile(udl_path,
skel=False,
guid=None,
guid_from_lang=None,
ext=None,
force=False,
add_missing=False,
log=None,
version=None,
creator=None,
ext_id=None,
description=None):
"""Compile the given .udl file to Komodo language resources.
DEPRECATED: The 'skel' generation in luddite has been deprecated in
favour of the more generic support of the 'koext' tool.
One of "guid" or "guid_from_lang" can be given to specify the XPCOM
language service GUID. If neither is given then a new one will be
generated.
"""
# Dev Notes:
# - Compiling builds into build/$languange/... and creates:
# ${language}.lexres lexer resource
# - If skel is True then also build skeletons for:
# ko${language}_UDL_Language.py language component
# ${language}.${ext} empty Komodo template
# - Add support for other options that Eric had in the preceding
# luddite.py?
log = log or _log
log.debug("compile('%s', ...)", udl_path)
# Clean up after PLY. It leaves some turds that can break subsequent
# parsing if the parser source is changed.
turds = ["parser.out", "parsetab.py", "parsetab.pyc"]
for turd in turds:
if exists(turd):
log.debug("remove `%s'", turd)
os.remove(turd)
# Parse and load the UDL definition.
parse_tree = parse(udl_path)
if parse_tree is None:
raise LudditeError("parse failed")
mainObj = gen.MainObj()
analyzer = gen.Analyzer(mainObj)
analyzer.processTree(parse_tree)
mainObj.calcUniqueStates()
#XXX Grr. Crappy error handling again. This should be changed to
# raise a LudditeError if the semanticCheck fails then just call:
# analyzer.semanticCheck()
if analyzer.semanticCheck() is None:
return 1
def raise_force_error(path):
raise LudditeError("`%s' already exists: use "
"-f|--force option to allow it to be "
"overwritten" % path)
# Make sure don't trounce files before generating outputs and setup
# output dir.
lang_name = mainObj.languageName
safe_lang_name = mainObj.safeLangName
build_dir = _get_build_dir(safe_lang_name)
if not exists(build_dir):
log.debug("mkdir `%s'", build_dir)
os.makedirs(build_dir)
# Generate all outputs.
lexres_path = join(build_dir, "lexers", safe_lang_name + ".lexres")
lexres_exists = exists(lexres_path)
if lexres_exists and not force:
if not add_missing:
raise_force_error(lexres_path)
else:
if lexres_exists:
log.debug("rm `%s'", lexres_path)
os.remove(lexres_path)
elif not exists(dirname(lexres_path)):
os.makedirs(dirname(lexres_path))
log.info("create lexres `%s'", lexres_path)
mainObj.dumpAsTable(constants.vals, lexres_path)
if skel:
lang_service_path \
= join(build_dir, "components", "ko%s_UDL_Language.py" % safe_lang_name)
lang_service_exists = exists(lang_service_path)
if lang_service_exists and not force:
if not add_missing:
raise_force_error(lang_service_path)
else:
if lang_service_exists:
log.debug("rm `%s'", lang_service_path)
os.remove(lang_service_path)
elif not exists(dirname(lang_service_path)):
os.makedirs(dirname(lang_service_path))
log.info("create lang service `%s'", lang_service_path)
if guid is not None:
assert guid_pat.match(guid)
guid = norm_guid(guid)
elif guid_from_lang:
try:
guid = guid_from_lang[mainObj.languageName]
except KeyError:
if not add_missing:
raise LudditeError(
"could not find `%s' in GUIDs text file" %
mainObj.languageName)
else:
log.warn(
"generating new GUID for `%s' language service: it is "
"recommended that you use the -g|--guid option to ensure "
"a constant GUID from build to build",
mainObj.languageName)
guid = generate_guid()
if guid is not None:
mainObj.dumpLanguageService(lang_service_path,
guid,
ext=ext,
add_missing=add_missing)
if not ext:
log.warn("no file extension was given: no skeleton "
"Komodo templates will be created")
else:
template_paths = [
join(build_dir, "templates", "All Languages",
safe_lang_name + ext),
join(build_dir, "templates", "Common", safe_lang_name + ext),
]
for template_path in template_paths:
template_exists = exists(template_path)
if template_exists and not force:
if not add_missing:
raise_force_error(template_path)
else:
if template_exists:
log.debug("rm `%s'", template_path)
os.remove(template_path)
elif not exists(dirname(template_path)):
os.makedirs(dirname(template_path))
log.info("create template `%s'", template_path)
mainObj.generateKomodoTemplateFile(template_path)
# Create the extension's install.rdf if necessary.
install_rdf_path = join(build_dir, "install.rdf")
if not exists(install_rdf_path):
name = lang_name + " Language"
codename = _codename_from_name(name)
if ext_id is None:
ext_id = "*****@*****.**" % codename
if version is None:
version = "1.0.0"
log.warn("defaulting 'version' to '%s' (use version option)",
version)
#else:
# XXX validate version
if description is None:
description = "%s language support for Komodo (UDL-based)" % lang_name
if creator is None:
creator = "Anonymous Coward"
log.warn("defaulting 'creator' to '%s' (use creator option)",
creator)
install_rdf_in = join(dirname(constants.__file__), "install.rdf.in")
log.debug("reading 'install.rdf' template from '%s'", install_rdf_in)
install_rdf_template = string.Template(
open(install_rdf_in, 'r').read())
install_rdf = install_rdf_template.substitute(id=ext_id,
name=name,
codename=codename,
version=version,
description=description,
creator=creator)
log.info("create `%s'", install_rdf_path)
fout = open(install_rdf_path, 'w')
fout.write(install_rdf)
fout.close()
# Clean up after PLY. It leaves some turds that can break subsequent
# parsing if the parser source is changed.
for turd in turds:
if exists(turd):
log.debug("remove `%s'", turd)
os.remove(turd)
def deprecated_package(language_name,
version=None,
creator=None,
name=None,
description=None,
id=None,
force=False,
log=None):
"""Package the (built) resources for the given languages into a Komodo
extension.
Note: This is DEPRECATED in favour of the more general Komodo extension
packaging support in the "koext" tool (also in the Komodo SDK).
"language_name" is the language name for which to build a package.
The resources for this language must already have been built via
"luddite.py compile ...".
These arguments are optional, but should be specified:
"version" (optional, default "1.0.0") is the version number for this
package.
"creator" (optional, default "Anonymous Coward") is the name of the
person creating/maintaining this package.
These arguments are optional and it is generally fine to not specify them
because they have reasonable defaults:
"name" (optional) is the name for the extension.
"description" (optional) is a short description of the extension.
"id" (optional) is the extension's id -- an internal short string used
as a key to identify the extension. It is used in the extension's
install path.
Dev Notes:
- For now packaging requires a 'zip' executable somewhere on the
PATH. This *could* be removed (by using Python's zlib) if too
burdensome.
"""
log = log or _log
safe_lang_name = gen.getSafeName(language_name)
build_dir = _get_build_dir(safe_lang_name)
if not exists(build_dir):
raise LudditeError(
"`%s': the build dir does not exist: you must first "
"build the language resources with "
"'luddite compile ...'" % build_dir)
# Determine package info and create the extension's install.rdf.
if name is None:
name = language_name + " Language"
codename = _codename_from_name(name)
if id is None:
id = "*****@*****.**" % codename
if version is None:
version = "1.0.0"
log.warn("defaulting 'version' to '%s' (use version option)", version)
#else:
# XXX validate version
if description is None:
description = "%s language support for Komodo (UDL-based)" % language_name
if creator is None:
creator = "Anonymous Coward"
log.warn("defaulting 'creator' to '%s' (use creator option)", creator)
install_rdf_in = join(dirname(constants.__file__), "install.rdf.in")
log.debug("reading 'install.rdf' template from '%s'", install_rdf_in)
install_rdf_template = string.Template(open(install_rdf_in, 'r').read())
install_rdf = install_rdf_template.substitute(id=id,
name=name,
codename=codename,
version=version,
description=description,
creator=creator)
install_rdf_path = join(build_dir, "install.rdf")
log.info("create `%s'", install_rdf_path)
fout = open(install_rdf_path, 'w')
fout.write(install_rdf)
fout.close()
# Register components
chrome_manifest_path = join(build_dir, "chrome.manifest")
for dirpath, dirnames, filenames in os.walk(join(build_dir, "components")):
for name in filenames:
if name.endswith(".py"):
chromereg.register_file(join(dirpath, name),
chrome_manifest_path, "components/")
elif name == ".consign":
pass # komodo build artifact; these can be safely ignored
else:
log.warn("Unexpected file '%s'; consider using koext.py" %
join(dirpath, name))
# Create the xpi.
xpi_name = "%s-%s-ko.xpi" % (codename, version)
xpi_path = xpi_name # put in top-level dir for now
if exists(xpi_path):
if not force:
raise LudditeError("`%s' exists: use force option to overwrite" %
xpi_path)
log.debug("rm `%s'", xpi_path)
os.remove(xpi_path)
zip_opts = ""
if not log.isEnabledFor(logging.DEBUG):
zip_opts += "-q"
cmd = 'zip -r %s "%s" *' % (zip_opts, abspath(xpi_path))
_run_in_dir(cmd, build_dir, log.debug)
log.info("`%s' successfully created", xpi_path)
def deprecated_compile(udl_path,
skel=False,
guid=None,
guid_from_lang=None,
ext=None,
force=False,
log=None):
"""Compile the given .udl file to Komodo language resources.
DEPRECATED: The 'skel' generation in luddite has been deprecated in
favour of the more generic support of the 'koext' tool.
One of "guid" or "guid_from_lang" can be given to specify the XPCOM
language service GUID. If neither is given then a new one will be
generated.
"""
# Dev Notes:
# - Compiling builds into build/$languange/... and creates:
# ${language}.lexres lexer resource
# - If skel is True then also build skeletons for:
# ko${language}_UDL_Language.py language component
# ${language}.${ext} empty Komodo template
# - Add support for other options that Eric had in the preceding
# luddite.py?
log = log or _log
log.debug("compile('%s', ...)", udl_path)
# Clean up after PLY. It leaves some turds that can break subsequent
# parsing if the parser source is changed.
turds = ["parser.out", "parsetab.py", "parsetab.pyc"]
for turd in turds:
if exists(turd):
log.debug("remove `%s'", turd)
os.remove(turd)
# Parse and load the UDL definition.
parse_tree = parse(udl_path)
if parse_tree is None:
raise LudditeError("parse failed")
mainObj = gen.MainObj()
analyzer = gen.Analyzer(mainObj)
analyzer.processTree(parse_tree)
mainObj.calcUniqueStates()
#XXX Grr. Crappy error handling again. This should be changed to
# raise a LudditeError if the semanticCheck fails then just call:
# analyzer.semanticCheck()
if analyzer.semanticCheck() is None:
return 1
def raise_force_error(path):
raise LudditeError("`%s' already exists: use "
"-f|--force option to allow it to be "
"overwritten" % path)
# Make sure don't trounce files before generating outputs and setup
# output dir.
lang_name = mainObj.languageName
safe_lang_name = mainObj.safeLangName
build_dir = _get_build_dir(safe_lang_name)
if not exists(build_dir):
log.debug("mkdir `%s'", build_dir)
os.makedirs(build_dir)
# Generate all outputs.
lexres_path = join(build_dir, "lexers", safe_lang_name + ".lexres")
if exists(lexres_path):
if not force: raise_force_error(lexres_path)
log.debug("rm `%s'", lexres_path)
os.remove(lexres_path)
if not exists(dirname(lexres_path)):
os.makedirs(dirname(lexres_path))
log.info("create lexres `%s'", lexres_path)
mainObj.dumpAsTable(constants.vals, lexres_path)
if skel:
lang_service_path \
= join(build_dir, "components", "ko%s_UDL_Language.py" % safe_lang_name)
if exists(lang_service_path):
if not force: raise_force_error(lang_service_path)
log.debug("rm `%s'", lang_service_path)
os.remove(lang_service_path)
if not exists(dirname(lang_service_path)):
os.makedirs(dirname(lang_service_path))
log.info("create lang service `%s'", lang_service_path)
if guid is not None:
assert guid_pat.match(guid)
guid = norm_guid(guid)
elif guid_from_lang:
try:
guid = guid_from_lang[mainObj.languageName]
except KeyError:
raise LudditeError("could not find `%s' in GUIDs text file" %
mainObj.languageName)
else:
log.warn(
"generating new GUID for `%s' language service: it is "
"recommended that you use the -g|--guid option to ensure "
"a constant GUID from build to build", mainObj.languageName)
guid = generate_guid()
mainObj.dumpLanguageService(lang_service_path, guid, ext=ext)
if not ext:
log.warn("no file extension was given: no skeleton "
"Komodo templates will be created")
else:
template_paths = [
join(build_dir, "templates", "All Languages",
safe_lang_name + ext),
join(build_dir, "templates", "Common", safe_lang_name + ext),
]
for template_path in template_paths:
if exists(template_path):
if not force: raise_force_error(template_path)
log.debug("rm `%s'", template_path)
os.remove(template_path)
if not exists(dirname(template_path)):
os.makedirs(dirname(template_path))
log.info("create template `%s'", template_path)
mainObj.generateKomodoTemplateFile(template_path)
# Clean up after PLY. It leaves some turds that can break subsequent
# parsing if the parser source is changed.
for turd in turds:
if exists(turd):
log.debug("remove `%s'", turd)
os.remove(turd)