DocFile.java revision e52f6d819e7d95e19e9b315f358bb7ac293413d8
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.data.Data; 20920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 21920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.io.*; 22920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.util.regex.Pattern; 23920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonimport java.util.regex.Matcher; 24920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 25920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 26920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodsonpublic class DocFile { 2771bf8d2ae787c28691910bb228a5d9efca9b153dScott Main public static final Pattern LINE = Pattern.compile("(.*)[\r]?\n", Pattern.MULTILINE); 2871bf8d2ae787c28691910bb228a5d9efca9b153dScott Main public static final Pattern PROP = Pattern.compile("([^=]+)=(.*)"); 29920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 30920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson public static String readFile(String filename) { 31920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson try { 32920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson File f = new File(filename); 33920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int length = (int) f.length(); 34920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson FileInputStream is = new FileInputStream(f); 35920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson InputStreamReader reader = new InputStreamReader(is, "UTF-8"); 36920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson char[] buf = new char[length]; 37920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int index = 0; 38920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int amt; 39920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson while (true) { 40920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson amt = reader.read(buf, index, length - index); 41920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 42920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (amt < 1) { 43920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson break; 44920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 45920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 46920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson index += amt; 47920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 48920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return new String(buf, 0, index); 49920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } catch (IOException e) { 50920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return null; 51920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 52920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 53920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 549b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty public static String[] DEVSITE_VALID_LANGS = {"en", "es","ja", "ko", "ru", "zh-cn"}; 559b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty 569b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty public static String getPathRoot(String filename) { 579b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty String[] stripStr = filename.split("\\/"); 589b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty String outFrag = stripStr[0]; 599b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty if (stripStr.length > 0) { 609b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty for (String t : DEVSITE_VALID_LANGS) { 619b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty if (stripStr[0].equals("intl")) { 629b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty if (stripStr[1].equals(t)) { 639b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty outFrag = stripStr[2]; 649b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty break; 659b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } 669b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (stripStr[0].equals(t)) { 679b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty outFrag = stripStr[1]; 689b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty break; 699b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } 709b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } 719b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } 729b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty return outFrag; 739b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } 749b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty 75e52f6d819e7d95e19e9b315f358bb7ac293413d8Dirk Dougherty public static void writePage(String docfile, String relative, String outfile, Data hdf) { 76920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 77920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson /* 78920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * System.out.println("docfile='" + docfile + "' relative='" + relative + "'" + "' outfile='" + 79920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson * outfile + "'"); 80920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson */ 81e52f6d819e7d95e19e9b315f358bb7ac293413d8Dirk Dougherty if (hdf == null) { 82e52f6d819e7d95e19e9b315f358bb7ac293413d8Dirk Dougherty hdf = Doclava.makeHDF(); 83e52f6d819e7d95e19e9b315f358bb7ac293413d8Dirk Dougherty } 84920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String filedata = readFile(docfile); 85920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 86920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // The document is properties up until the line "@jd:body". 87920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // Any blank lines are ignored. 88920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int start = -1; 89920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson int lineno = 1; 90920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson Matcher lines = LINE.matcher(filedata); 91920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String line = null; 92920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson while (lines.find()) { 93920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson line = lines.group(1); 94920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (line.length() > 0) { 95920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (line.equals("@jd:body")) { 96920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson start = lines.end(); 97920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson break; 98920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 99920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson Matcher prop = PROP.matcher(line); 100920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (prop.matches()) { 101920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String key = prop.group(1); 102920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String value = prop.group(2); 103920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson hdf.setValue(key, value); 104920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 105920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson break; 106920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 107920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 108920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson lineno++; 109920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 110920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (start < 0) { 111920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.err.println(docfile + ":" + lineno + ": error parsing docfile"); 112920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (line != null) { 113920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.err.println(docfile + ":" + lineno + ":" + line); 114920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 115920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson System.exit(1); 116920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 117920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 118920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // if they asked to only be for a certain template, maybe skip it 119920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String fromTemplate = hdf.getValue("template.which", ""); 120920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String fromPage = hdf.getValue("page.onlyfortemplate", ""); 121920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (!"".equals(fromPage) && !fromTemplate.equals(fromPage)) { 122920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson return; 123920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 124920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 125920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // and the actual text after that 126920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String commentText = filedata.substring(start); 127920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 128920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson Comment comment = new Comment(commentText, null, new SourcePositionInfo(docfile, lineno, 1)); 129920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson TagInfo[] tags = comment.tags(); 130920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 131920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson TagInfo.makeHDF(hdf, "root.descr", tags); 132920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 133920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson hdf.setValue("commentText", commentText); 134920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson 135920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // write the page using the appropriate root template, based on the 136920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // whichdoc value supplied by build 137920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson String fromWhichmodule = hdf.getValue("android.whichmodule", ""); 138920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson if (fromWhichmodule.equals("online-pdk")) { 139920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // leaving this in just for temporary compatibility with pdk doc 140920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson hdf.setValue("online-pdk", "true"); 141920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // add any conditional login for root template here (such as 142920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson // for custom left nav based on tab etc. 143920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson ClearPage.write(hdf, "docpage.cs", outfile); 144920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 1453c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main String filename = outfile; 1469b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty // Strip out the intl and lang id substr and get back just the 1479b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty // guide, design, distribute, etc. 1489b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty filename = getPathRoot(filename); 1499b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty if (filename.indexOf("design") == 0) { 1503352706b85f0c1aa8a0391b26c08c8b6f9e5746fRoman Nurik hdf.setValue("design", "true"); 1519b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("develop") == 0) { 1523c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("develop", "true"); 1539b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("guide") == 0) { 1543c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("guide", "true"); 1559b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("training") == 0) { 1563c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("training", "true"); 1579b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("more") == 0) { 1583c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("more", "true"); 1599b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("google") == 0) { 1603c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("google", "true"); 1611b45d1d08a4ff984e1d0741dd13f0759f6527ebfDirk Dougherty } else if (filename.indexOf("samples") == 0) { 1621b45d1d08a4ff984e1d0741dd13f0759f6527ebfDirk Dougherty hdf.setValue("samples", "true"); 1639b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("distribute") == 0) { 1643c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("distribute", "true"); 1659b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if (filename.indexOf("about") == 0) { 1663c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("about", "true"); 1679b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty } else if ((filename.indexOf("tools") == 0) || (filename.indexOf("sdk") == 0)) { 1683c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main hdf.setValue("tools", "true"); 1699b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty fromTemplate = hdf.getValue("page.template", ""); 17088c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly } else if (filename.indexOf("devices") == 0) { 17188c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly hdf.setValue("devices", "true"); 17288c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly } else if (filename.indexOf("source") == 0) { 17388c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly hdf.setValue("source", "true"); 17488c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly } else if (filename.indexOf("accessories") == 0) { 17588c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly hdf.setValue("accessories", "true"); 17688c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly } else if (filename.indexOf("compatibility") == 0) { 17788c435bb4d6c81c41107e23503b59af2e08acd8dRobert Ly hdf.setValue("compatibility", "true"); 1783c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main } 1799b316c84e2e15268db79772d9cef60da1df488ecDirk Dougherty if (fromTemplate.equals("sdk")) { 1803c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main ClearPage.write(hdf, "sdkpage.cs", outfile); 181920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } else { 1823c925b473212325cbf5f734cb5d1d57588ea83e3Scott Main ClearPage.write(hdf, "docpage.cs", outfile); 183920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 184920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } 185920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson } // writePage 186920dbbbaca6aa578f3b26d89e99d12754c26ed60Ben Dodson} 187