prepare maven deploy

add mvn_install (requires https://github.com/parrt/bild/pull/2)
add mksrc
improve javadoc
This commit is contained in:
ericvergnaud 2014-11-09 22:09:34 +08:00
parent 7d19889ab2
commit df61f040c4
2 changed files with 201 additions and 120 deletions

12
.gitignore vendored
View File

@ -31,3 +31,15 @@ nbactions*.xml
# Playground # Playground
#/tool/playground/ #/tool/playground/
# Generated files
out/
doc/
gen3/
gen4/
tmp/
# Configurable build files
bild.py
bild*

179
bild.py
View File

@ -1,4 +1,4 @@
#!/usr/bin/env python # !/usr/bin/env python
import os import os
import string import string
@ -41,68 +41,72 @@ CSHARP_TARGET = "../antlr4-csharp"
# Properties needed to run Python[23] tests # Properties needed to run Python[23] tests
test_properties = { test_properties = {
"antlr-python2-python":"/usr/local/Cellar/python/2.7.5/bin/python2.7", "antlr-python2-python": "/usr/local/bin/python2.7",
"antlr-python2-runtime":uniformpath(PYTHON2_TARGET)+"/src", "antlr-python2-runtime": uniformpath(PYTHON2_TARGET) + "/src",
"antlr-python3-python":"/usr/local/Cellar/python3/3.4.1/bin/python3", "antlr-python3-python": "/usr/local/bin/python3.4",
"antlr-python3-runtime":uniformpath(PYTHON3_TARGET)+"/src", "antlr-python3-runtime": uniformpath(PYTHON3_TARGET) + "/src",
}
TARGETS = {"Java": uniformpath(JAVA_TARGET),
"Python2": uniformpath(PYTHON2_TARGET),
"Python3": uniformpath(PYTHON3_TARGET), #"CSharp":uniformpath(CSHARP_TARGET)
} }
TARGETS = {"Java":uniformpath(JAVA_TARGET),
"Python2":uniformpath(PYTHON2_TARGET),
"Python3":uniformpath(PYTHON3_TARGET),
#"CSharp":uniformpath(CSHARP_TARGET)
}
def parsers(): def parsers():
antlr3("tool/src/org/antlr/v4/parse", "gen3", package="org.antlr.v4.parse") antlr3("tool/src/org/antlr/v4/parse", "gen3", package="org.antlr.v4.parse")
antlr3("tool/src/org/antlr/v4/codegen", "gen3", package="org.antlr.v4.codegen", args=["-lib",uniformpath("gen3/org/antlr/v4/parse")]) antlr3("tool/src/org/antlr/v4/codegen", "gen3", package="org.antlr.v4.codegen",
args=["-lib", uniformpath("gen3/org/antlr/v4/parse")])
antlr4("runtime/Java/src/org/antlr/v4/runtime/tree/xpath", "gen4", package="org.antlr.v4.runtime.tree.xpath") antlr4("runtime/Java/src/org/antlr/v4/runtime/tree/xpath", "gen4", package="org.antlr.v4.runtime.tree.xpath")
def compile(): def compile():
require(parsers) require(parsers)
cp = uniformpath("out")+os.pathsep+ \ cp = uniformpath("out") + os.pathsep + \
os.path.join(JARCACHE,"antlr-3.5.1-complete.jar")+os.pathsep+ \ os.path.join(JARCACHE, "antlr-3.5.1-complete.jar") + os.pathsep + \
"runtime/Java/lib/org.abego.treelayout.core.jar"+os.pathsep "runtime/Java/lib/org.abego.treelayout.core.jar" + os.pathsep
if os.path.exists(JARCACHE+"/antlr-4.4-complete.jar"): if os.path.exists(JARCACHE + "/antlr-" + VERSION + "-complete.jar"):
cp += JARCACHE+"/antlr-4.4-complete.jar" cp += JARCACHE + "/antlr-" + VERSION + "-complete.jar"
srcpath = ["gen3", "gen4", "runtime/JavaAnnotations/src", "runtime/Java/src", "tool/src"] srcpath = ["gen3", "gen4", "runtime/JavaAnnotations/src", "runtime/Java/src", "tool/src"]
args = ["-Xlint", "-Xlint:-serial", "-g", "-sourcepath", string.join(srcpath, os.pathsep)] args = ["-Xlint", "-Xlint:-serial", "-g", "-sourcepath", string.join(srcpath, os.pathsep)]
for sp in srcpath: for sp in srcpath:
javac(sp, "out", version="1.6", cp=cp, args=args) javac(sp, "out", version="1.6", cp=cp, args=args)
# pull in targets # pull in targets
for t in TARGETS: for t in TARGETS:
javac(TARGETS[t]+"/tool/src", "out", version="1.6", cp=cp, args=args) javac(TARGETS[t] + "/tool/src", "out", version="1.6", cp=cp, args=args)
def mkjar_complete(): def mkjar_complete():
require(compile) require(compile)
copytree(src="tool/resources", trg="out") # messages, Java code gen, etc... copytree(src="tool/resources", trg="out") # messages, Java code gen, etc...
manifest = \ manifest = \
"""Main-Class: org.antlr.v4.Tool """Main-Class: org.antlr.v4.Tool
Implementation-Vendor: ANTLR Implementation-Vendor: ANTLR
Implementation-Title: ANTLR 4 Tool Implementation-Title: ANTLR 4 Tool
Implementation-Version: %s Implementation-Version: %s
Built-By: %s Built-By: %s
Build-Jdk: 1.6 Build-Jdk: 1.6
Created-By: http://www.bildtool.org Created-By: http://www.bildtool.org
""" % (VERSION,os.getlogin()) """ % (VERSION, os.getlogin())
# unjar required libraries # unjar required libraries
unjar("runtime/Java/lib/org.abego.treelayout.core.jar", trgdir="out") unjar("runtime/Java/lib/org.abego.treelayout.core.jar", trgdir="out")
unjar(os.path.join(JARCACHE,"antlr-3.5.1-complete.jar"), trgdir="out") unjar(os.path.join(JARCACHE, "antlr-3.5.1-complete.jar"), trgdir="out")
# pull in target templates # pull in target templates
for t in TARGETS: for t in TARGETS:
trgdir = "out/org/antlr/v4/tool/templates/codegen/"+t trgdir = "out/org/antlr/v4/tool/templates/codegen/" + t
mkdir(trgdir) mkdir(trgdir)
copyfile(TARGETS[t]+"/tool/resources/org/antlr/v4/tool/templates/codegen/"+t+"/"+t+".stg", copyfile(TARGETS[t] + "/tool/resources/org/antlr/v4/tool/templates/codegen/" + t + "/" + t + ".stg",
trgdir) trgdir)
jarfile = "dist/antlr-"+VERSION+"-complete.jar" jarfile = "dist/antlr4-" + VERSION + "-complete.jar"
jar(jarfile, srcdir="out", manifest=manifest) jar(jarfile, srcdir="out", manifest=manifest)
print "Generated "+jarfile print "Generated " + jarfile
def mkjar_runtime(): def mkjar_runtime():
# out/... dir is full of tool-related stuff, make special dir out/runtime # out/... dir is full of tool-related stuff, make special dir out/runtime
# unjar required library # unjar required library
unjar("runtime/Java/lib/org.abego.treelayout.core.jar", trgdir="out/runtime") unjar("runtime/Java/lib/org.abego.treelayout.core.jar", trgdir="out/runtime")
cp = uniformpath("out/runtime")+os.pathsep+ \ cp = uniformpath("out/runtime") + os.pathsep + \
"runtime/Java/lib/org.abego.treelayout.core.jar" "runtime/Java/lib/org.abego.treelayout.core.jar"
args = ["-Xlint", "-Xlint:-serial", "-g"] args = ["-Xlint", "-Xlint:-serial", "-g"]
srcpath = ["gen4", "runtime/JavaAnnotations/src", "runtime/Java/src"] srcpath = ["gen4", "runtime/JavaAnnotations/src", "runtime/Java/src"]
@ -110,69 +114,134 @@ def mkjar_runtime():
for sp in srcpath: for sp in srcpath:
javac(sp, "out", version="1.6", cp=cp, args=args) javac(sp, "out", version="1.6", cp=cp, args=args)
manifest = \ manifest = \
"""Implementation-Vendor: ANTLR """Implementation-Vendor: ANTLR
Implementation-Title: ANTLR 4 Runtime Implementation-Title: ANTLR 4 Runtime
Implementation-Version: %s Implementation-Version: %s
Built-By: %s Built-By: %s
Build-Jdk: 1.6 Build-Jdk: 1.6
Created-By: http://www.bildtool.org Created-By: http://www.bildtool.org
""" % (VERSION,os.getlogin()) """ % (VERSION, os.getlogin())
jarfile = "dist/antlr-runtime-" + VERSION + ".jar" jarfile = "dist/antlr4-" + VERSION + ".jar"
jar(jarfile, srcdir="out/runtime", manifest=manifest) jar(jarfile, srcdir="out/runtime", manifest=manifest)
print "Generated "+jarfile print "Generated " + jarfile
def mkjar(): def mkjar():
mkjar_complete() mkjar_complete()
# put it in JARCARCHE too so bild can find it during antlr4() # put it in JARCARCHE too so bild can find it during antlr4()
copyfile(src="dist/antlr-4.4-complete.jar", trg=JARCACHE) copyfile(src="dist/antlr4-" + VERSION + "-complete.jar", trg=JARCACHE)
# rebuild/bootstrap XPath with 4.4 so it can use 4.4 runtime (gen'd with 4.3 at this point) # rebuild/bootstrap XPath with 4.4 so it can use 4.4 runtime (gen'd with 4.3 at this point)
rmdir("gen4/org/antlr/v4/runtime/tree/xpath") # kill 4.3-generated version rmdir("gen4/org/antlr/v4/runtime/tree/xpath") # kill 4.3-generated version
antlr4("runtime/Java/src/org/antlr/v4/runtime/tree/xpath", "gen4", version="4.4", package="org.antlr.v4.runtime.tree.xpath") antlr4("runtime/Java/src/org/antlr/v4/runtime/tree/xpath", "gen4", version=VERSION,
package="org.antlr.v4.runtime.tree.xpath")
compile() compile()
mkjar_complete() # make it again with up to date XPath lexer mkjar_complete() # make it again with up to date XPath lexer
mkjar_runtime() # now build the runtime jar mkjar_runtime() # now build the runtime jar
def tests(): def tests():
require(mkjar) require(mkjar)
junit_jar, hamcrest_jar = load_junitjars() junit_jar, hamcrest_jar = load_junitjars()
cp = uniformpath("dist/antlr-"+VERSION+"-complete.jar")+os.pathsep+ \ cp = uniformpath("dist/antlr4-" + VERSION + "-complete.jar") + os.pathsep + \
uniformpath("out/test/Java")+os.pathsep+ \ uniformpath("out/test/Java") + os.pathsep + \
junit_jar+os.pathsep+hamcrest_jar junit_jar + os.pathsep + hamcrest_jar
properties = ["-D%s=%s" % (p, test_properties[p]) for p in test_properties] properties = ["-D%s=%s" % (p, test_properties[p]) for p in test_properties]
args = ["-Xlint", "-Xlint:-serial", "-g"] args = ["-Xlint", "-Xlint:-serial", "-g"]
javac("tool/test", "out/test/Java", version="1.6", cp=cp, args=args) # all targets can use org.antlr.v4.test.* javac("tool/test", "out/test/Java", version="1.6", cp=cp, args=args) # all targets can use org.antlr.v4.test.*
for t in TARGETS: for t in TARGETS:
print "Test %7s --------------" % t print "Test %7s --------------" % t
# Prefix CLASSPATH with individual target tests # Prefix CLASSPATH with individual target tests
cp = uniformpath(TARGETS[t]+"/tool/test") + os.pathsep + cp cp = uniformpath(TARGETS[t] + "/tool/test") + os.pathsep + cp
javac(TARGETS[t]+"/tool/test", "out/test/"+t, version="1.6", cp=cp, args=args) javac(TARGETS[t] + "/tool/test", "out/test/" + t, version="1.6", cp=cp, args=args)
junit("out/test/"+t, cp=cp, verbose=False, args=properties) junit("out/test/" + t, cp=cp, verbose=False, args=properties)
def all(): def all():
clean(True)
mkjar() mkjar()
tests() tests()
mkdoc() mkdoc()
mksrc()
install()
clean()
def clean(): def install():
mvn_install("dist/antlr4-" + VERSION + "-complete.jar",
"dist/antlr4-" + VERSION + "-complete-sources.jar",
"dist/antlr4-" + VERSION + "-complete-javadoc.jar",
"org.antlr",
"antlr4",
VERSION)
mvn_install("dist/antlr4-" + VERSION + ".jar",
"dist/antlr4-" + VERSION + "-sources.jar",
"dist/antlr4-" + VERSION + "-javadoc.jar",
"org.antlr",
"antlr4-runtime",
VERSION)
def clean(dist=False):
if dist:
rmdir("dist")
rmdir("out") rmdir("out")
rmdir("gen3") rmdir("gen3")
rmdir("gen4") rmdir("gen4")
rmdir("doc") rmdir("doc")
def mksrc():
srcpath = "runtime/Java/src/org"
jarfile = "dist/antlr4-" + VERSION + "-sources.jar"
zip(jarfile, srcpath)
print "Generated " + jarfile
jarfile = "dist/antlr4-" + VERSION + "-complete-sources.jar"
srcpaths = [ srcpath, "gen3/org", "gen4/org", "runtime/JavaAnnotations/src/org", "tool/src/org"]
zip(jarfile, srcpaths)
print "Generated " + jarfile
def mkdoc(): def mkdoc():
# add a few source dirs to reduce the number of javadoc errors
# JavaDoc needs antlr annotations source code
mkdir("out/Annotations")
download("http://search.maven.org/remotecontent?filepath=org/antlr/antlr4-annotations/4.3/antlr4-annotations-4.3-sources.jar", "out/Annotations")
unjar("out/Annotations/antlr4-annotations-4.3-sources.jar", trgdir="out/Annotations")
# JavaDoc needs abego treelayout source code
mkdir("out/TreeLayout")
download("http://search.maven.org/remotecontent?filepath=org/abego/treelayout/org.abego.treelayout.core/1.0.1/org.abego.treelayout.core-1.0.1-sources.jar", "out/TreeLayout")
unjar("out/TreeLayout/org.abego.treelayout.core-1.0.1-sources.jar", trgdir="out/TreeLayout")
# JavaDoc needs antlr runtime 3.5.2 source code
mkdir("out/Antlr352Runtime")
download("http://search.maven.org/remotecontent?filepath=org/antlr/antlr-runtime/3.5.2/antlr-runtime-3.5.2-sources.jar", "out/Antlr352Runtime")
unjar("out/Antlr352Runtime/antlr-runtime-3.5.2-sources.jar", trgdir="out/Antlr352Runtime")
# JavaDoc needs antlr ST4 source code
mkdir("out/ST4")
download("http://search.maven.org/remotecontent?filepath=org/antlr/ST4/4.0.8/ST4-4.0.8-sources.jar", "out/ST4")
unjar("out/ST4/ST4-4.0.8-sources.jar", trgdir="out/ST4")
# go!
mkdir("doc/Java") mkdir("doc/Java")
mkdir("doc/JavaTool") mkdir("doc/JavaTool")
javadoc(srcdir="runtime/Java/src", trgdir="doc/Java", packages="org.antlr.v4.runtime") dirs = ["runtime/Java/src"]
toolsrc = [TARGETS[t]+"/tool/src" for t in TARGETS] dirs += ["out/Annotations"]
toolsrc = string.join(toolsrc, ":") dirs += ["out/TreeLayout"]
javadoc(srcdir=toolsrc, trgdir="doc/JavaTool", packages="org.antlr.v4") exclude = ["org/antlr/runtime",
"org/abego",
"org/stringtemplate",
"org/antlr/stringtemplate"]
javadoc(srcdir=dirs, trgdir="doc/Java", packages="org.antlr.v4.runtime", exclude=exclude)
dirs += ["gen3"]
dirs += [TARGETS[t] + "/tool/src" for t in TARGETS]
dirs += ["out/Antlr352Runtime"]
dirs += ["out/ST4"]
javadoc(srcdir=dirs, trgdir="doc/JavaTool", packages="org.antlr.v4", exclude=exclude)
# build stack merge PredictionContext and ATNState images from DOT # build stack merge PredictionContext and ATNState images from DOT
# DOT Images are in runtime/Java/src/main/dot/org/antlr/v4/runtime/atn/images/ # DOT Images are in runtime/Java/src/main/dot/org/antlr/v4/runtime/atn/images/
# Gen into E.g., doc/Java/org/antlr/v4/runtime/atn/images/SingletonMerge_DiffRootSamePar.svg # Gen into E.g., doc/Java/org/antlr/v4/runtime/atn/images/SingletonMerge_DiffRootSamePar.svg
mkdir("doc/Java/org/antlr/v4/runtime/atn/images") mkdir("doc/Java/org/antlr/v4/runtime/atn/images")
for f in glob.glob("runtime/Java/src/main/dot/org/antlr/v4/runtime/atn/images/*.dot"): for f in glob.glob("runtime/Java/src/main/dot/org/antlr/v4/runtime/atn/images/*.dot"):
dot(f, "doc/Java/org/antlr/v4/runtime/atn/images", format="svg") dot(f, "doc/Java/org/antlr/v4/runtime/atn/images", format="svg")
zip("doc/antlr4-runtime.zip", "doc/Java") zip("dist/antlr4-" + VERSION + "-javadoc.jar", "doc/Java")
zip("doc/antlr4-tool.zip", "doc/JavaTool") zip("dist/antlr4-" + VERSION + "-complete-javadoc.jar", "doc/JavaTool")
processargs(globals()) # E.g., "python bild.py all" processargs(globals()) # E.g., "python bild.py all"