1920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson/* 2920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * Copyright (C) 2010 Google Inc. 3920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * 4920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * Licensed under the Apache License, Version 2.0 (the "License"); 5920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * you may not use this file except in compliance with the License. 6920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * You may obtain a copy of the License at 7920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * 8920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * http://www.apache.org/licenses/LICENSE-2.0 9920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * 10920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * Unless required by applicable law or agreed to in writing, software 11920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * distributed under the License is distributed on an "AS IS" BASIS, 12920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * See the License for the specific language governing permissions and 14920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * limitations under the License. 15920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson */ 16920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 17920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonpackage com.google.doclava; 18920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 19920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport com.google.clearsilver.jsilver.JSilver; 20920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport com.google.clearsilver.jsilver.data.Data; 21920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 22f959ed158599686910af990654d6c84d262868ffAndrew Sappersteinimport java.io.BufferedWriter; 23920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.io.File; 24920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.io.FileInputStream; 25920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.io.FileOutputStream; 26920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.io.IOException; 27f959ed158599686910af990654d6c84d262868ffAndrew Sappersteinimport java.io.OutputStreamWriter; 28f959ed158599686910af990654d6c84d262868ffAndrew Sappersteinimport java.io.Writer; 29920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.util.ArrayList; 30920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.util.List; 31920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 32920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonpublic class ClearPage { 33920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson /* 34920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * public ClearPage() { String templ = "templates/index.cs"; String filename = "docs/index.html"; 35920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * 36920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * data.setValue("A.B.C", "1"); data.setValue("A.B.D", "2"); } 37920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson */ 38920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 39920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson private static ArrayList<String> mTemplateDirs = new ArrayList<String>(); 40920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson private static boolean mTemplateDirSet = false; 41920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 42920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson private static ArrayList<String> mBundledTemplateDirs = new ArrayList<String>(); 43920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 44920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static String outputDir = "docs"; 454bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier public static List<String> htmlDirs = new ArrayList<String>(); 46920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static String toroot = null; 47920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 48920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void addTemplateDir(String dir) { 49920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson mTemplateDirSet = true; 50920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson mTemplateDirs.add(dir); 51920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 52920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 53920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static List<String> getTemplateDirs() { 54920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return mTemplateDirs; 55920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 56920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 57920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void addBundledTemplateDir(String dir) { 58920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson mTemplateDirSet = true; 59920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson mBundledTemplateDirs.add(dir); 60920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 61920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 62920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static List<String> getBundledTemplateDirs() { 63920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return mBundledTemplateDirs; 64920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 65920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 66920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson private static int countSlashes(String s) { 67920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson final int N = s.length(); 68920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int slashcount = 0; 69920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson for (int i = 0; i < N; i++) { 70920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (s.charAt(i) == '/') { 71920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson slashcount++; 72920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 73920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 74920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return slashcount; 75920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 76920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 77920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void write(Data data, String templ, String filename, JSilver cs) { 78920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson write(data, templ, filename, false, cs); 79920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 80920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 81920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void write(Data data, String templ, String filename) { 82920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson write(data, templ, filename, false, Doclava.jSilver); 83920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 84920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 85920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void write(Data data, String templ, String filename, boolean fullPath) { 86920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson write(data, templ, filename, false, Doclava.jSilver); 87920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 88920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 89920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void write(Data data, String templ, String filename, boolean fullPath, JSilver cs) { 904bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier if (!htmlDirs.isEmpty()) { 91920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson data.setValue("hasindex", "true"); 92920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 93920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 94920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String toroot; 95920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (ClearPage.toroot != null) { 96920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson toroot = ClearPage.toroot; 97920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 98920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int slashcount = countSlashes(filename); 99920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (slashcount > 0) { 100920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson toroot = ""; 101920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson for (int i = 0; i < slashcount; i++) { 102920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson toroot += "../"; 103920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 104920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 105920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson toroot = "./"; 106920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 107920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 108920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson data.setValue("toroot", toroot); 109920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 110920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson data.setValue("filename", filename); 111920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 112920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (!fullPath) { 113920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson filename = outputDir + "/" + filename; 114920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 115920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 116920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int i = 0; 1174bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier if (!htmlDirs.isEmpty()) { 1184bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier for (String dir : htmlDirs) { 1194bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier data.setValue("hdf.loadpaths." + i, dir); 1204bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier i++; 1214bac50adef51d339bb967369f9aca0de7f6c1b2fBill Napier } 122920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 123920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (mTemplateDirSet) { 124920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson for (String dir : mTemplateDirs) { 125920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson data.setValue("hdf.loadpaths." + i, dir); 126920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson i++; 127920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 128920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 129920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson data.setValue("hdf.loadpaths." + i, "templates"); 130920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 131920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 132920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson File file = new File(outputFilename(filename)); 133920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 134920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson ensureDirectory(file); 135920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 136f959ed158599686910af990654d6c84d262868ffAndrew Sapperstein Writer stream = null; 137920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 138f959ed158599686910af990654d6c84d262868ffAndrew Sapperstein stream = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), "UTF-8")); 139920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String rendered = cs.render(templ, data); 140920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson stream.write(rendered, 0, rendered.length()); 141920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) { 142920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.out.println("error: " + e.getMessage() + "; when writing file: " + filename); 143920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } finally { 144920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (stream != null) { 145920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 146920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson stream.close(); 147920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) {} 148920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 149920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 150920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 151920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 152920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // recursively create the directories to the output 153920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void ensureDirectory(File f) { 154920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson File parent = f.getParentFile(); 155920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (parent != null) { 156920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson parent.mkdirs(); 157920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 158920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 159920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 160920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static void copyFile(File from, String toPath) { 161920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson File to = new File(outputDir + "/" + toPath); 162920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson FileInputStream in; 163920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson FileOutputStream out; 164920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 165920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (!from.exists()) { 166920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson throw new IOException(); 167920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 168920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson in = new FileInputStream(from); 169920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) { 170920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.err.println(from.getAbsolutePath() + ": Error opening file"); 171920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return; 172920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 173920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson ensureDirectory(to); 174920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 175920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson out = new FileOutputStream(to); 176920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) { 177920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.err.println(from.getAbsolutePath() + ": Error opening file"); 178920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return; 179920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 180920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 181920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson long sizel = from.length(); 182920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson final int maxsize = 64 * 1024; 183920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int size = sizel > maxsize ? maxsize : (int) sizel; 184920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson byte[] buf = new byte[size]; 185920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson while (true) { 186920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 187920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson size = in.read(buf); 188920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) { 189920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.err.println(from.getAbsolutePath() + ": error reading file"); 190920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson break; 191920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 192920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (size > 0) { 193920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 194920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson out.write(buf, 0, size); 195920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) { 196920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.err.println(from.getAbsolutePath() + ": error writing file"); 197920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 198920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 199920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson break; 200920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 201920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 202920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 203920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson in.close(); 204920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) {} 205920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 206920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson out.close(); 207920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) {} 208920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 209920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 210920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson /** Takes a string that ends w/ .html and changes the .html to htmlExtension */ 211920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static String outputFilename(String htmlFile) { 212920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (!Doclava.htmlExtension.equals(".html") && htmlFile.endsWith(".html")) { 213920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return htmlFile.substring(0, htmlFile.length() - 5) + Doclava.htmlExtension; 214920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 215920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return htmlFile; 216920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 217920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 218920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 219920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson} 220