Repository: subchen/javadoc.chm Branch: master Commit: 35962199b32a Files: 40 Total size: 54.8 KB Directory structure: gitextract_wgl9zdc4/ ├── .classpath ├── .gitignore ├── .project ├── .settings/ │ └── org.eclipse.core.resources.prefs ├── CHANGELOG.md ├── LICENSE ├── NOTICE ├── README.md ├── build.gradle ├── build.properties ├── build.xml ├── dist/ │ └── javadoc.chm-2.1.0.jar ├── lib/ │ ├── commons-collections-3.2.1.jar │ ├── commons-io-2.4.jar │ ├── commons-lang-2.6.jar │ ├── commons-logging-1.1.1.jar │ ├── log4j-1.2.17.jar │ └── velocity-1.7.jar ├── run.bat └── src/ └── main/ ├── java/ │ └── jetbrick/ │ └── tools/ │ └── chm/ │ ├── Application.java │ ├── Config.java │ ├── TemplateWriter.java │ ├── model/ │ │ ├── ClassInfo.java │ │ ├── FieldInfo.java │ │ ├── MethodInfo.java │ │ └── PackageInfo.java │ ├── reader/ │ │ ├── AnchorNameManager.java │ │ ├── ApiReader.java │ │ ├── IndexesReader.java │ │ ├── JavaInfoReader.java │ │ └── KeyManager.java │ └── style/ │ ├── Javadoc7Style.java │ ├── Javadoc8Style.java │ └── JavadocStyle.java └── resources/ ├── log4j.properties └── template/ ├── build.vm ├── hhc.vm ├── hhk.vm ├── hhp.vm └── redir.vm ================================================ FILE CONTENTS ================================================ ================================================ FILE: .classpath ================================================ ================================================ FILE: .gitignore ================================================ *.class # Package Files # *.war *.ear # Build Directorys # /.gradle /build /bin *.log ================================================ FILE: .project ================================================ javadoc.chm org.eclipse.jdt.core.javabuilder org.eclipse.jdt.core.javanature ================================================ FILE: .settings/org.eclipse.core.resources.prefs ================================================ eclipse.preferences.version=1 encoding/=UTF-8 ================================================ FILE: CHANGELOG.md ================================================ Version 2.1.0 (2014-03-25) ----------------------------- * javadoc 8 support Version 2.0.0 (2013-11-16) ----------------------------- * rename package * add license Version 1.0.0 (2013-04-17) ----------------------------- * support java 6 & 7 style * first public release ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: NOTICE ================================================ javadoc.chm http://subchen.github.io/javadoc.chm/ Copyright 2010-2014 Guoqiang Chen. All rights reserved. Email: subchen@gmail.com Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # What's this? This software generates an Microsoft HTML Help(CHM) from generic javadoc style API documents. It's a easy way to search something from javadoc with pre-compiled full text index. Javadoc.chm can identify the new doc style for java 8.0+. # Requirements * [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) * [HTML Help Workshop](http://msdn.microsoft.com/en-us/library/ms669985.aspx) # How to Download binary jar https://github.com/subchen/javadoc.chm/raw/master/dist/javadoc.chm-2.1.0.jar Generates HTML Help project files ``` java -Xms256m -Xmx512m -jar javadoc.chm-xxx.jar ``` Compile the HTML Help ``` build.bat ``` To change the default language option of hhp file, modify htmlhelp.hhp. ``` "Language=0x409 English (U.S.)" ``` ================================================ FILE: build.gradle ================================================ apply plugin: 'java' sourceCompatibility = 1.6 targetCompatibility = 1.6 version = '2.1.0' defaultTasks 'runtimejar' tasks.withType(Compile) { options.encoding = "utf-8" } dependencies { compile fileTree(dir: 'lib', include: '**/*.jar') } jar { manifest { attributes 'Main-Class': 'jetbrick.tools.chm.Application' } } task runtimejar(dependsOn: jar) { def outputFile = 'build/libs/javadoc.chm.jar' doLast { new File(outputFile).delete() ant.jar( destfile: outputFile, filesetmanifest: 'merge', duplicate: 'preserve' ) { fileTree(dir: 'lib', include: '**/*.jar').each { zipfileset(src: it, includes: '**/*.class') } //zipgroupfileset(dir: 'lib', includes: '*.jar') zipgroupfileset(dir: 'build/libs', includes: '**/*.jar') } } } ================================================ FILE: build.properties ================================================ maven.group.id = com.github.subchen maven.artifact.id = javadoc.chm maven.version = 2.1.0 product.name = ${maven.artifact.id} product.version = ${maven.version} product.author = Guoqiang Chen product.vendor = subchen@gmail.com build.dir = ${basedir}/build classes.dir = ${build.dir}/classes dist.dir = ${build.dir} ant.build.javac.source = 1.6 ant.build.javac.target = 1.6 javac.encoding = utf-8 dist.jar = ${dist.dir}/${product.name}-${product.version}.jar ================================================ FILE: build.xml ================================================ ================================================ FILE: run.bat ================================================ set classpath=%classpath%;lib/commons-collections-3.2.1.jar set classpath=%classpath%;lib/commons-io-2.4.jar set classpath=%classpath%;lib/commons-lang-2.6.jar set classpath=%classpath%;lib/commons-logging-1.1.1.jar set classpath=%classpath%;lib/log4j-1.2.17.jar set classpath=%classpath%;lib/velocity-1.7.jar set classpath=%classpath%;dist/javadoc.chm-2.1.0.jar java -Xms512m -Xmx512m jetbrick.tools.chm.Application %* ================================================ FILE: src/main/java/jetbrick/tools/chm/Application.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm; import java.io.File; import java.io.IOException; import java.util.Map; import jetbrick.tools.chm.reader.ApiReader; import jetbrick.tools.chm.style.*; import org.apache.commons.io.FileUtils; public class Application { public static void main(String[] args) throws Exception { if (args.length > 0) { Config.apiLocation = new File(args[0]); } if (args.length > 1) { Config.encoding = args[1]; } if (new File(Config.apiLocation, "resources/fonts").exists()) { Config.style = new Javadoc8Style(); } else if (new File(Config.apiLocation, "resources/background.gif").exists()) { Config.style = new Javadoc7Style(); } else { Config.style = new JavadocStyle(); } clean(); ApiReader api = new ApiReader(); Map apiContext = api.getApiContext(); TemplateWriter writer = new TemplateWriter(); writer.apply(apiContext); } private static void clean() throws IOException { File f = new File(Config.apiLocation, "htmlhelp.hhp"); if (f.exists()) f.delete(); f = new File(Config.apiLocation, "htmlhelp.hhc"); if (f.exists()) f.delete(); f = new File(Config.apiLocation, "htmlhelp.hhk"); if (f.exists()) f.delete(); f = new File(Config.apiLocation, "build.bat"); if (f.exists()) f.delete(); f = new File(Config.apiLocation, "hhc.exe"); if (f.exists()) f.delete(); f = new File(Config.apiLocation, "hha.dll"); if (f.exists()) f.delete(); f = new File(Config.apiLocation, "redirs/"); if (f.exists()) FileUtils.deleteDirectory(f); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/Config.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm; import java.io.File; import java.nio.charset.Charset; import jetbrick.tools.chm.style.JavadocStyle; public class Config { public static File apiLocation = new File("."); public static String encoding = Charset.defaultCharset().name(); public static JavadocStyle style = new JavadocStyle(); } ================================================ FILE: src/main/java/jetbrick/tools/chm/TemplateWriter.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm; import java.io.*; import java.util.Collection; import java.util.Map; import jetbrick.tools.chm.reader.KeyManager; import org.apache.commons.io.IOUtils; import org.apache.velocity.VelocityContext; import org.apache.velocity.app.VelocityEngine; public class TemplateWriter { private final VelocityEngine ve; public TemplateWriter() { ve = new VelocityEngine(); ve.init(); } public void apply(Map context) throws Exception { context.put("encoding", Config.encoding); // write redir html. @SuppressWarnings("unchecked") Collection keyManagers = (Collection) context.get("keyManagers"); for (KeyManager keyManager : keyManagers) { if (keyManager.isRepeat()) { keyManager.sort(); context.put("keyManager", keyManager); renderTemplate(keyManager.getUrl(), context, "/template/redir.vm"); } } // write project files. renderTemplate("htmlhelp.hhp", context, "/template/hhp.vm"); renderTemplate("htmlhelp.hhk", context, "/template/hhk.vm"); renderTemplate("htmlhelp.hhc", context, "/template/hhc.vm"); renderTemplate("build.bat", context, "/template/build.vm"); // write hhc.exe, hha.dll outputBinaryFile("hhc.exe", "/bin/hhc.exe"); outputBinaryFile("hha.dll", "/bin/hha.dll"); } private void renderTemplate(String fileName, Map context, String templateName) throws Exception { File file = new File(Config.apiLocation, fileName); if (!file.getParentFile().exists()) { file.getParentFile().mkdirs(); } System.out.println(file); String templateContent = IOUtils.toString(getClass().getResourceAsStream(templateName), "utf-8"); VelocityContext ctx = new VelocityContext(context); Writer writer = new OutputStreamWriter(new FileOutputStream(file), Config.encoding); ve.evaluate(ctx, writer, "", templateContent); writer.close(); } private void outputBinaryFile(String fileName, String templateName) throws Exception { File file = new File(Config.apiLocation, fileName); if (!file.getParentFile().exists()) { file.getParentFile().mkdirs(); } System.out.println(file); InputStream is = getClass().getResourceAsStream(templateName); OutputStream os = new FileOutputStream(file); IOUtils.copy(is, os); IOUtils.closeQuietly(is); IOUtils.closeQuietly(os); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/model/ClassInfo.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.model; import java.util.ArrayList; import java.util.List; import org.apache.commons.lang.StringUtils; public class ClassInfo { private String fullName; private String shortName; private String url; private List fields = new ArrayList(); private List methods = new ArrayList(); public String getFullName() { return fullName; } public void setFullName(String fullName) { this.fullName = fullName; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public void setShortName(String shortName) { this.shortName = shortName; } public String getShortName() { return this.shortName; } public String getPackageName() { return StringUtils.remove(this.fullName, "." + this.shortName); } public void addField(FieldInfo info) { fields.add(info); } public void addMethod(MethodInfo info) { methods.add(info); } public List getFields() { return fields; } public List getMethods() { return methods; } } ================================================ FILE: src/main/java/jetbrick/tools/chm/model/FieldInfo.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.model; public class FieldInfo { private String name; private String url; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } } ================================================ FILE: src/main/java/jetbrick/tools/chm/model/MethodInfo.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.model; public class MethodInfo { private String name; private String fullName; private String url; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public void setFullName(String fullName) { this.fullName = fullName; } public String getFullName() { return this.fullName; } } ================================================ FILE: src/main/java/jetbrick/tools/chm/model/PackageInfo.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.model; import java.util.ArrayList; import java.util.List; public class PackageInfo { private String name; private String url; private List classes = new ArrayList(); public List getClasses() { return classes; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public void addClass(ClassInfo classinfo) { classes.add(classinfo); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/reader/AnchorNameManager.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.reader; import java.io.File; import java.io.IOException; import java.util.regex.Matcher; import java.util.regex.Pattern; import jetbrick.tools.chm.Config; import org.apache.commons.io.FileUtils; import org.apache.commons.lang.StringUtils; public class AnchorNameManager { public static void addAnchor(File file, String encoding) throws IOException { String html = FileUtils.readFileToString(file, encoding); html = html.replace('$', '\uFFE5'); Pattern p = Config.style.getAnchorNameRegex(); Matcher m = p.matcher(html); int findCount = 0; StringBuffer sb = new StringBuffer(); while (m.find()) { findCount++; String anchor = m.group(1); // String oldAnchor = m.group(); String oldAnchor = ""; String newAnchor = ""; m.appendReplacement(sb, newAnchor + oldAnchor); } m.appendTail(sb); System.out.println("addAnchor(" + findCount + ") : " + file); if (findCount > 0) { html = sb.toString().replace('\uFFE5', '$'); FileUtils.writeStringToFile(file, html, encoding); } html = null; } public static String replaceAnchor(String url) { String anchor = StringUtils.substringAfter(url, "#"); if ("".equals(anchor)) return url; return StringUtils.substringBefore(url, "#") + "#" + getNewAnchorName(anchor); } public static String getNewAnchorName(String anchor) { return "HH_" + Math.abs(anchor.hashCode()); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/reader/ApiReader.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.reader; import java.io.File; import java.io.IOException; import java.util.*; import java.util.regex.Matcher; import java.util.regex.Pattern; import jetbrick.tools.chm.Config; import org.apache.commons.io.FileUtils; import org.apache.commons.lang.StringUtils; public class ApiReader { private JavaInfoReader javaInfoReader = new JavaInfoReader(); private IndexesReader indexesReader = new IndexesReader(); private Map context = new HashMap(); public Map getApiContext() throws Exception { // add all files Set files = getAllFiles(Config.apiLocation, new HashSet()); // replace anthor Iterator it = files.iterator(); while (it.hasNext()) { String file = it.next(); if (file.endsWith(".html")) { AnchorNameManager.addAnchor(new File(Config.apiLocation, file), Config.encoding); } } // add index url context.put("indexUrl", getIndexUrl(new File(Config.apiLocation, "index.html"))); // add title String doctitle = getApiTitle(new File(Config.apiLocation, "index.html")); context.put("title", doctitle); // add packages context.put("packages", javaInfoReader.getJavaInfo()); // add indexes File resource = new File(Config.apiLocation, "index-all.html"); if (resource.exists()) { Map indexesMap = indexesReader.getIndexes(resource); context.put("sortIndexes", sortIndexed(indexesMap)); } else { File resourceDir = new File(Config.apiLocation, "index-files/"); File resources[] = resourceDir.listFiles(); Map indexesMap = new HashMap(); for (File res : resources) { if (res.isDirectory()) continue; indexesMap.putAll(indexesReader.getIndexes(res)); } context.put("sortIndexes", sortIndexed(indexesMap)); } Collection keyManagers = indexesReader.getKeyManagers(); context.put("keyManagers", keyManagers); // add redir files for (KeyManager keyManager : keyManagers) { if (keyManager.isRepeat()) { files.add(keyManager.getUrl()); } } context.put("files", files); return context; } private List> sortIndexed(Map indexesMap) { List> sortIndexes = new ArrayList>(indexesMap.size()); sortIndexes.addAll(indexesMap.entrySet()); Collections.sort(sortIndexes, new Comparator>() { public int compare(Map.Entry o1, Map.Entry o2) { return o1.getKey().toLowerCase().compareTo(o2.getKey().toLowerCase()); } }); return sortIndexes; } private Set getAllFiles(File rootdir, Set files) { for (File resource : rootdir.listFiles()) { if (resource.isDirectory()) { getAllFiles(resource, files); } else { String filename = resource.getAbsolutePath(); filename = StringUtils.remove(filename, Config.apiLocation.getAbsolutePath() + "\\"); filename = filename.replace('\\', '/'); files.add(filename); } } return files; } private String getApiTitle(File resource) throws IOException { Pattern p = Config.style.getApiTitleRegex(); Matcher m = p.matcher(FileUtils.readFileToString(resource, Config.encoding)); if (m.find()) { return m.group(1).trim(); } return "Javadoc API"; } private String getIndexUrl(File resource) throws IOException { Pattern p = Config.style.getIndexUrlRegex(); Matcher m = p.matcher(FileUtils.readFileToString(resource, Config.encoding)); if (m.find()) { return m.group(1).trim(); } return "overview-summary.html"; } } ================================================ FILE: src/main/java/jetbrick/tools/chm/reader/IndexesReader.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.reader; import java.io.*; import java.util.*; import java.util.regex.Matcher; import java.util.regex.Pattern; import jetbrick.tools.chm.Config; import org.apache.commons.io.FileUtils; import org.apache.commons.lang.StringUtils; public class IndexesReader { private Map keyManagerMaps = new HashMap(256); public Map getIndexes(File resource) throws IOException { Pattern p = Config.style.getIndexRegex(); Matcher m = p.matcher(FileUtils.readFileToString(resource, Config.encoding)); Map indexMaps = new HashMap(1024); while (m.find()) { addIndex(indexMaps, m.group(2), m.group(1)); } return indexMaps; } private void addIndex(Map indexMaps, String text, String url) throws FileNotFoundException { String key; String urlToUse = url; urlToUse = StringUtils.remove(urlToUse, "../"); urlToUse = StringUtils.remove(urlToUse, "./"); if (url.indexOf('#') < 0) { key = text + " class"; } else { key = StringUtils.substringBefore(text, "("); if (text.indexOf('(') != -1) { key = key + "()"; } String textToUse = StringUtils.substringBefore(urlToUse, ".html"); textToUse = textToUse.replace('/', '.') + "." + text; KeyManager keyManager = keyManagerMaps.get(key); String urlRedir = "../" + urlToUse; if (keyManager == null) { keyManager = new KeyManager(key); keyManager.add(textToUse, AnchorNameManager.replaceAnchor(urlRedir)); keyManagerMaps.put(key, keyManager); } else { // repeat keyManager.add(textToUse, AnchorNameManager.replaceAnchor(urlRedir)); // redirect urlToUse = keyManager.getUrl(); } } indexMaps.put(key, AnchorNameManager.replaceAnchor(urlToUse)); } public Collection getKeyManagers() { return keyManagerMaps.values(); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/reader/JavaInfoReader.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.reader; import java.io.File; import java.io.IOException; import java.util.*; import java.util.regex.Matcher; import java.util.regex.Pattern; import jetbrick.tools.chm.Config; import jetbrick.tools.chm.model.*; import org.apache.commons.io.FileUtils; import org.apache.commons.lang.StringUtils; public class JavaInfoReader { public List getJavaInfo() throws IOException { return getAllPackages(new File(Config.apiLocation, "package-list")); } private List getAllPackages(File resource) throws IOException { List lines = FileUtils.readLines(resource, Config.encoding); Map packageMaps = new HashMap(32); List packages = new ArrayList(50); for (String line : lines) { line = line.trim(); if (line.length() != 0) { PackageInfo p = new PackageInfo(); p.setName(line); p.setUrl(line.replace('.', '/') + "/package-summary.html"); packageMaps.put(p.getName(), p); packages.add(p); } } // add all classes to package List classes = getAllClasses(new File(Config.apiLocation, "allclasses-frame.html")); for (ClassInfo classinfo : classes) { PackageInfo p = packageMaps.get(classinfo.getPackageName()); p.addClass(classinfo); } return packages; } private List getAllClasses(File resource) throws IOException { Pattern p = Config.style.getJavaClassRegex(); Matcher m = p.matcher(FileUtils.readFileToString(resource, Config.encoding)); List classes = new ArrayList(128); while (m.find()) { ClassInfo info = new ClassInfo(); info.setFullName(m.group(2).replace('/', '.')); info.setUrl(m.group(1)); info.setShortName(m.group(3)); classes.add(info); System.out.println("class: " + info.getUrl()); addClassFieldMethod(info); } return classes; } private void addClassFieldMethod(ClassInfo classinfo) throws IOException { File file = new File(Config.apiLocation, classinfo.getUrl()); String html = FileUtils.readFileToString(file, Config.encoding); Pattern p = Config.style.getJavaFieldRegex(); Matcher m = p.matcher(html); while (m.find()) { String name = m.group(2); String url = m.group(1); url = StringUtils.remove(url, "../"); url = StringUtils.remove(url, "./"); String anchor = StringUtils.substringAfter(url, "#"); String linkUrl = StringUtils.substringBefore(url, "#") + "#" + AnchorNameManager.getNewAnchorName(anchor); if (Config.style.isMethod(url)) { MethodInfo info = new MethodInfo(); info.setName(name); info.setFullName(Config.style.getMethodFullName(url)); info.setUrl(linkUrl); classinfo.addMethod(info); } else { FieldInfo info = new FieldInfo(); info.setName(name); info.setUrl(linkUrl); classinfo.addField(info); } } } } ================================================ FILE: src/main/java/jetbrick/tools/chm/reader/KeyManager.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.reader; import java.util.*; import org.apache.commons.lang.StringUtils; public class KeyManager { private String key; private String url; private List pairs = new ArrayList(); public KeyManager(String key) { this.key = key; this.url = "redirs/" + StringUtils.replace(key, "()", "_") + Math.abs(key.hashCode()) + ".html"; } public String getKey() { return key; } public void add(String name, String url) { String text; if (name.indexOf('(') >= 0) { text = StringUtils.replace(name, key + "(", "" + key + "("); } else { text = StringUtils.replace(name, "." + key, "." + key + ""); } text = "" + text + ""; pairs.add(text); } public boolean isRepeat() { return pairs.size() > 1; } public List getPairs() { return pairs; } public String getUrl() { return url; } public void sort() { Collections.sort(pairs); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/style/Javadoc7Style.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.style; import java.util.regex.Pattern; public class Javadoc7Style extends JavadocStyle { @Override public Pattern getAnchorNameRegex() { return Pattern.compile("]*>"); } @Override public Pattern getIndexRegex() { return Pattern.compile("
]*>([^<]*)"); } @Override public Pattern getJavaClassRegex() { return Pattern.compile("]*>(?:)?([^<]*)(?:)?"); } @Override public Pattern getJavaFieldRegex() { return Pattern.compile("]*>([^<]*)"); } @Override public Pattern getIndexUrlRegex() { return Pattern.compile("]*>"); } @Override public Pattern getApiTitleRegex() { return Pattern.compile("([^<]*)"); } } ================================================ FILE: src/main/java/jetbrick/tools/chm/style/Javadoc8Style.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.style; import java.util.regex.Pattern; import org.apache.commons.lang.StringUtils; public class Javadoc8Style extends JavadocStyle { @Override public Pattern getAnchorNameRegex() { return Pattern.compile("]*>"); } @Override public Pattern getIndexRegex() { return Pattern.compile("
(?:)?]*>(?:)?([^<]*)(?:)?"); } @Override public Pattern getJavaClassRegex() { return Pattern.compile("]*>(?:)?([^<]*)(?:)?"); } @Override public Pattern getJavaFieldRegex() { return Pattern.compile("]*>([^<]*)"); } @Override public Pattern getIndexUrlRegex() { return Pattern.compile("]*>"); } @Override public Pattern getApiTitleRegex() { return Pattern.compile("([^<]*)"); } @Override public boolean isMethod(String url) { return url.endsWith("-"); } @Override public String getMethodFullName(String url) { String name = StringUtils.substringAfter(url, "#"); int count = StringUtils.countMatches(name, "-"); name = StringUtils.replaceOnce(name, "-", "("); for (int i = 0; i < count - 2; i++) { name = StringUtils.replaceOnce(name, "-", ", "); } name = StringUtils.replaceOnce(name, "-", ")"); name = StringUtils.replace(name, ":A", "[]"); return name; } } ================================================ FILE: src/main/java/jetbrick/tools/chm/style/JavadocStyle.java ================================================ /** * javadoc.chm * http://subchen.github.io/javadoc.chm/ * * Copyright 2010-2014 Guoqiang Chen. All rights reserved. * Email: subchen@gmail.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package jetbrick.tools.chm.style; import java.util.regex.Pattern; import org.apache.commons.lang.StringUtils; public class JavadocStyle { public Pattern getAnchorNameRegex() { return Pattern.compile("]*>"); } public Pattern getIndexRegex() { return Pattern.compile("
]*>([^<]*)"); } public Pattern getJavaClassRegex() { return Pattern.compile("]*>(?:)?([^<]*)(?:)?"); } public Pattern getJavaFieldRegex() { return Pattern.compile("]*>([^<]*)"); } public Pattern getIndexUrlRegex() { return Pattern.compile("]*>"); } public Pattern getApiTitleRegex() { return Pattern.compile("([^<]*)"); } public boolean isMethod(String url) { return url.endsWith("("); } public String getMethodFullName(String url) { return StringUtils.substringAfter(url, "#"); } } ================================================ FILE: src/main/resources/log4j.properties ================================================ log4j.logger.jetbrick=DEBUG, stdout log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=(%F:%L) - %m%n ================================================ FILE: src/main/resources/template/build.vm ================================================ start hhc htmlhelp.hhp ================================================ FILE: src/main/resources/template/hhc.vm ================================================ #foreach ($package in $packages)
    • #foreach ($c in $package.classes)
    • #if ($c.methods.size() > 0)
        #foreach ($m in $c.methods)
      • #end
      #end #end
#end ================================================ FILE: src/main/resources/template/hhk.vm ================================================
    #foreach ($index in $sortIndexes)
  • ##
  • #end
================================================ FILE: src/main/resources/template/hhp.vm ================================================ [OPTIONS] Compatibility=1.1 or later Contents file=htmlhelp.hhc Index file=htmlhelp.hhk Title=${title} - by http://subchen.github.io/ Default topic=${indexUrl} Compiled file=${title}.chm Display compile progress=Yes Binary Index=Yes Full-text search=Yes Language=0x804 Default Window=main [WINDOWS] main=,"htmlhelp.hhc","htmlhelp.hhk","${indexUrl}","${indexUrl}",,,,,0x23420,,0x187e,,0x118b0000,,,,,,0 [FILES] #foreach ($f in $files) $f #end ================================================ FILE: src/main/resources/template/redir.vm ================================================ Occurences of ${keyManager.key}
${keyManager.key} occurences: #foreach ($m in $keyManager.pairs)
${m}
#end


Copyright 2010-2014 Guoqiang Chen. All rights reserved.
http://subchen.github.io/   subchen@gmail.com