1. /**

  2.  * Copyright: Copyright (c) 2002-2004

  3.  * Company: JavaResearch(http://www.javaresearch.org)

  4.  */

  5. 

  6. package org.jr.java2html;

  7. 

  8. import java.io.BufferedReader;

  9. import java.io.File;

  10. import java.io.FileInputStream;

  11. import java.io.FileNotFoundException;

  12. import java.io.IOException;

  13. import java.io.PrintStream;

  14. import java.io.StringWriter;

  15. import java.util.ArrayList;

  16. import java.util.Collections;

  17. import java.util.Enumeration;

  18. import java.util.HashMap;

  19. import java.util.Iterator;

  20. import java.util.Properties;

  21. import java.util.ResourceBundle;

  22. import java.util.TreeMap;

  23. 

  24. import org.jr.io.FileUtil;

  25. import org.jr.io.FileWriter;

  26. import org.jr.util.StringUtil;

  27. 

  28. /**

  29.  * 将一个目录下的源代码全部转换为类似javadoc生成的文档的结构的HTML版本源代码生成器。

  30.  * 这个类是应用的主类，如果你使用其他几个类并且模仿本类的代码可以生成你自己的应用，当然不局限于生成源代码文档，可能是其他的什么文档都可以。

  31.  * 底层的设计是没有针对性的，但是可能不能考虑所有的应用。

  32.  * 请注意这个根工具和javadoc的不同在于它没有javadoc那样的功能可以调用javac完成类的解析。

  33.  * 这个工具生成良好的文档需要依赖你的源代码的组织是良好的，例如符合JBuilder的源代码组织的强制要求（包名和源代码的组织应该一致）。

  34.  * <br>最后更新日期:2004年8月31日

  35.  * @author cherami@javaresearch.org

  36.  * @version  0.9

  37.  */

  38. 

  39. public class JavaToHTMLCreator {

  40.   /**

  41.    * 替换模版中CREATOR属性用的字符串。

  42.    */

  43.   static final String CREATOR =

  44.       "JavaToHTMLCreator(http://www.javaresearch.org)";

  45.   /**

  46.    * 替换模版中的其他区域相关的常量的资源束。

  47.    */

  48.   static final ResourceBundle resources = ResourceBundle.getBundle(

  49.       "org.jr.java2html.resources");

  50.   TemplatePropertyMap properties = Utility.convertTo(resources);

  51.   String templatePath="templates/";

  52.   public static final String INDEX_TEMPLATE = "index.html";

  53.   public static final String ALL_PACKAGES_TEMPLATE = "allpackages.html";

  54.   public static final String ALL_CLASSES_TEMPLATE = "allclasses.html";

  55.   public static final String COPYRIGHT_TEMPLATE = "copyright.html";

  56.   public static final String PACKAGE_TEMPLATE = "package.html";

  57.   public static final String CLASS_TEMPLATE = "class.html";

  58.   public static final String JAVA2HTML_JS = "java2html.js";

  59.   public static final String STYLESHEET_CSS = "stylesheet.css";

  60.   public static final String MAP_LIST = "maplist.txt";

  61.   public static final String CLASS_MAP = "classpath.map";

  62.   protected static final String HTML_EXT = ".java.html";

  63.   static LinkableJavaToHTML converter ;

  64.   String code = "gb2312";

  65.   String userPropertiesFile;

  66.   /**

  67.    * 构造一个JavaToHTMLCreator并添加共通的属性。

  68.    */

  69.   public JavaToHTMLCreator() {

  70.     addCommonProperties();

  71.   }

  72.   /**

  73.    * 应用的入口方法。

  74.    * @param args 命令行参数数组

  75.    */

  76.   public static void main(String[] args) {

  77.     if (args.length < 2) {

  78.       printUsage(System.out);

  79.       StringUtil.printStrings(args);

  80.       System.exit(1);

  81.     }

  82.     JavaToHTMLCreator htmlCreator = new JavaToHTMLCreator();

  83.     String sourcePath = args[0];

  84.     String destPath = args[1];

  85.     if (args.length > 2) {

  86.       htmlCreator.setUserPropertyFile(args[2]);

  87.     }

  88.     if (args.length > 3) {

  89.       htmlCreator.setTemplatePath(args[3]+"/");

  90.     }

  91.     String code=System.getProperty("java2html.code");

  92.     if (code!=null) {

  93.       htmlCreator.setCode(code);

  94.     }

  95.     String debug=System.getProperty("java2html.debugable");

  96.     if (debug!=null) {

  97.       boolean debugable=Boolean.getBoolean(debug);

  98.       Utility.setDebugable(debugable);

  99.     }

  100.     try {

  101.       File dest=new File(destPath);

  102.       if (!dest.exists()) {

  103.       	dest.mkdirs();

  104.       }

  105.       FileUtil.copy(htmlCreator.templatePath + JAVA2HTML_JS, (destPath + "/" + JAVA2HTML_JS).replace('\\','/'), true);

  106.       FileUtil.copy(htmlCreator.templatePath + STYLESHEET_CSS,

  107.                     (destPath + "/" + STYLESHEET_CSS).replace('\\','/'), true);

  108.       htmlCreator.createIndexFile(destPath);

  109.       htmlCreator.createCopyrightFile(destPath);

  110.       HashMap classMap=new HashMap();

  111.       TreeMap dirs = Utility.analyseDirectory(sourcePath,classMap);

  112.       FileWriter.writeObject(destPath+"/"+CLASS_MAP,classMap);

  113.       ClassLink classLink=ClassLink.getClassLink(MAP_LIST);

  114.       classLink.put(classMap,"");

  115.       converter = new LinkableJavaToHTML(classLink);

  116.       htmlCreator.createAllPackagesFile(destPath, dirs);

  117.       htmlCreator.createAllClassesFile(destPath, dirs);

  118.       htmlCreator.createPackageFiles(destPath, dirs);

  119.       htmlCreator.createClassFiles(sourcePath, destPath, dirs);

  120.     }

  121.     catch (IOException e) {

  122.       e.printStackTrace();

  123.     }

  124.   }

  125. 

  126.   public static void printUsage(PrintStream out) {

  127.     out.println(

  128.         "Usage:java [-Djava2html.code=code] [-Djava2html.debugable=false/true] org.jr.java2html.JavaToHTMLCreator sourceDir destDir [userPropertiesFile] [templatePath]");

  129.     out.println(

  130.         "   or java -jar [-Djava2html.code=code] [-Djava2html.debugable=false/true] java2html.jar sourceDir destDir [userPropertiesFile] [templatePath]");

  131.   }

  132.   /**

  133.    * 设置生成的HTML文件的编码方式。

  134.    * @param code 编码方式

  135.    */

  136.   public void setCode(String code) {

  137.     this.code = code;

  138.     properties.put("CODE", code);

  139.   }

  140.   /**

  141.    * 设置用户定义的属性文件的文件名

  142.    * @param fileName 属性文件文件名

  143.    */

  144.   public void setUserPropertyFile(String fileName) {

  145.     userPropertiesFile = fileName;

  146.     Properties userProperties=new Properties();

  147.     try {

  148.       userProperties.load(new FileInputStream(userPropertiesFile));

  149.       Enumeration keys=userProperties.propertyNames();

  150.       while (keys.hasMoreElements()) {

  151.         String key=(String)keys.nextElement();

  152.         String value=userProperties.getProperty(key);

  153.         properties.put(key,value);

  154.       }

  155.     }

  156.     catch (FileNotFoundException fe) {

  157.       System.err.println(fe.getMessage());

  158.     }

  159.     catch (IOException ioe) {

  160.       System.err.println(ioe.getMessage());

  161.     }

  162.   }

  163.   /**

  164.    * 设置模版文件的目录。

  165.    * 因此可以自己修改模版，但是还不能支持动态的设置模版的文件名。

  166.    * 文件名必须和自带的模版的文件名完全一致。

  167.    * @param templatePath 模版目录

  168.    */

  169.   public void setTemplatePath(String templatePath) {

  170.     this.templatePath = templatePath;

  171.   }

  172. 

  173.   private boolean createIndexFile(String destPath) throws IOException {

  174.     TemplateFile file = new TemplateFile(templatePath + INDEX_TEMPLATE);

  175.     file.setFile(destPath + "/" + INDEX_TEMPLATE);

  176.     file.setProperties(properties);

  177.     return file.createFile();

  178.   }

  179. 

  180.   private boolean createCopyrightFile(String destPath) throws

  181.       IOException {

  182.     TemplateFile file = new TemplateFile(templatePath +

  183.                                          COPYRIGHT_TEMPLATE);

  184.     file.setFile(destPath + "/" + COPYRIGHT_TEMPLATE);

  185.     file.setProperties(properties);

  186.     return file.createFile();

  187.   }

  188. 

  189.   private boolean createAllPackagesFile(String destPath,

  190.                                         TreeMap packages) throws

  191.       IOException {

  192.     TemplateFile file = new TemplateFile(templatePath +

  193.                                          ALL_PACKAGES_TEMPLATE);

  194.     file.setFile(destPath + "/" + ALL_PACKAGES_TEMPLATE);

  195.     TemplatePropertyMap loopProperties = new TemplatePropertyMap();

  196.     properties.put(TemplateFile.getLoopName(0), loopProperties);

  197.     int packageCount = packages.size() - 1;

  198.     loopProperties.put(TemplateFile.SIZE, String.valueOf(packageCount));

  199.     Iterator keys = packages.keySet().iterator();

  200.     keys.next(); //跳过全部类对应的那个元素

  201.     ArrayList packageNames = new ArrayList();

  202.     ArrayList packagePaths = new ArrayList();

  203.     while (keys.hasNext()) {

  204.       String packageName = (String) keys.next();

  205.       packageNames.add(packageName);

  206.       packagePaths.add(packageName.replace('.', '/'));

  207.     }

  208.     loopProperties.put("PACKAGE_PATH", packagePaths);

  209.     loopProperties.put("PACKAGE_NAME", packageNames);

  210.     file.setProperties(properties);

  211. 

  212.     return file.createFile();

  213.   }

  214. 

  215.   private boolean createAllClassesFile(String destPath, TreeMap packages) throws

  216.       IOException {

  217.     boolean result;

  218.     TemplateFile file = new TemplateFile(templatePath +

  219.                                          ALL_CLASSES_TEMPLATE);

  220.     file.setFile(destPath + "/" + ALL_CLASSES_TEMPLATE);

  221.     TemplatePropertyMap loopProperties = new TemplatePropertyMap();

  222.     properties.put(TemplateFile.getLoopName(0), loopProperties);

  223.     ArrayList fullClassNames = (ArrayList) packages.get(Utility.ALL_CLASSES);

  224.     Collections.sort(fullClassNames, new ClassNameComparator());

  225.     loopProperties.put(TemplateFile.SIZE,

  226.                              String.valueOf(fullClassNames.size()));

  227.     ArrayList packagePaths = new ArrayList();

  228.     ArrayList classFiles = new ArrayList();

  229.     ArrayList classNames = new ArrayList();

  230.     for (int i = 0; i < fullClassNames.size(); i++) {

  231.       String fullClassName = (String) fullClassNames.get(i);

  232.       int lastIndex = fullClassName.lastIndexOf(".");

  233.       if (lastIndex > 0) {

  234.         packagePaths.add(fullClassName.substring(0, lastIndex).replace('.', '/'));

  235.         classFiles.add(fullClassName.substring(lastIndex + 1) + HTML_EXT);

  236.         classNames.add(fullClassName.substring(lastIndex + 1));

  237.       }

  238.       else {

  239.         packagePaths.add(".");

  240.         classFiles.add(fullClassName + HTML_EXT);

  241.         classNames.add(fullClassName);

  242.       }

  243.     }

  244.     loopProperties.put("PACKAGE_PATH", packagePaths);

  245.     loopProperties.put("CLASS_FILE", classFiles);

  246.     loopProperties.put("CLASS_NAME", classNames);

  247.     file.setProperties(properties);

  248.     result = file.createFile();

  249.     return result;

  250.   }

  251. 

  252.   private boolean createPackageFiles(String destPath, TreeMap packages) throws

  253.       IOException {

  254.     boolean result = true;

  255.     TemplateFile file = new TemplateFile(templatePath +

  256.                                          PACKAGE_TEMPLATE);

  257.     file.setBufferable(true);

  258.     Iterator keys = packages.keySet().iterator();

  259.     keys.next(); //跳过全部类对应的那个元素

  260.     while (keys.hasNext()) {

  261.       String packageName = (String) keys.next();

  262.       String packagePath = packageName.replace('.', '/');

  263.       int packageDeep = 0;

  264.       if (packageName.length() > 0) {

  265.         packageDeep = 1;

  266.       }

  267.       String stylePath = Utility.fill("../",

  268.                                       StringUtil.getSubtringCount(packageName, ".") +

  269.                                       packageDeep);

  270.       stylePath = stylePath.substring(0, stylePath.length() - 1);

  271.       properties.put("PACKAGE_TITLE", packageName);

  272.       properties.put("PACKAGE_NAME", packageName);

  273.       properties.put("COMMONFILE_PATH", stylePath);

  274.       file.setFile(destPath + "/" + packagePath + "/" + PACKAGE_TEMPLATE);

  275.       file.setProperties(properties);

  276.       TemplatePropertyMap loopProperties = new TemplatePropertyMap();

  277.       properties.put(TemplateFile.getLoopName(0), loopProperties);

  278.       ArrayList classNames = (ArrayList) packages.get(packageName);

  279.       Collections.sort(classNames, new ClassNameComparator());

  280.       ArrayList classFiles = new ArrayList();

  281.       for (int i = 0; i < classNames.size(); i++) {

  282.         classFiles.add(classNames.get(i) + HTML_EXT);

  283.       }

  284. 

  285.       int classCount = classNames.size();

  286.       loopProperties.put(TemplateFile.SIZE, String.valueOf(classCount));

  287.       loopProperties.put("CLASS_FILE", classFiles);

  288.       loopProperties.put("CLASS_NAME", classNames);

  289. 

  290.       if (!file.createFile()) {

  291.         result = false;

  292.       }

  293.     }

  294.     return result;

  295. 

  296.   }

  297. 

  298.   private boolean createClassFiles(String sourcePath, String destPath,

  299.                                    TreeMap packages) throws

  300.       IOException {

  301.     boolean result = true;

  302.     TemplateFile file = new TemplateFile(templatePath +

  303.                                          CLASS_TEMPLATE);

  304.     file.setBufferable(true);

  305.     file.setProperties(properties);

  306.     ArrayList fullClassNames = (ArrayList) packages.get(Utility.ALL_CLASSES);

  307.     for (int i = 0; i < fullClassNames.size(); i++) {

  308.       String fullClassName = (String) fullClassNames.get(i);

  309.       String packagePath;

  310.       String className;

  311.       int lastIndex = fullClassName.lastIndexOf(".");

  312.       if (lastIndex > 0) {

  313.         packagePath = fullClassName.substring(0, lastIndex).replace('.', '/');

  314.         className = fullClassName.substring(lastIndex + 1);

  315.       }

  316.       else {

  317.         packagePath = ".";

  318.         className = fullClassName;

  319.       }

  320.       int packageDeep = 0;

  321.       if (!packagePath.equals(".")) {

  322.         packageDeep = 1;

  323.       }

  324.       String stylePath = Utility.fill("../",

  325.           StringUtil.getSubtringCount(packagePath, "/") +

  326.                                       packageDeep);

  327.       if (packageDeep != 0) {

  328.         stylePath = Utility.trimLastChar(stylePath);

  329.       }

  330.       else {

  331.         stylePath = ".";

  332.       }

  333.       properties.put("CLASS_TITLE", className);

  334.       properties.put("COMMONFILE_PATH", stylePath);

  335.       BufferedReader reader = new BufferedReader(new java.io.FileReader(sourcePath +

  336.           "/" + packagePath + "/" + className + ".java"));

  337.       StringWriter writer = new StringWriter();

  338.       converter.convert(reader, writer,packagePath);

  339.       properties.put("CLASS_SOURCE", writer.toString());

  340.       file.setFile(destPath + "/" + packagePath + "/" + className +

  341.                    HTML_EXT);

  342. 

  343.       if (!file.createFile()) {

  344.         result = false;

  345.       }

  346.     }

  347.     return result;

  348. 

  349.   }

  350. 

  351.   private void addCommonProperties() {

  352.     properties.put("CREATOR", CREATOR);

  353.     properties.put("CODE", code);

  354.   }

  355. 

  356. }