156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/* 256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Copyright (C) 2010 Google Inc. 356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Licensed under the Apache License, Version 2.0 (the "License"); 556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * you may not use this file except in compliance with the License. 656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * You may obtain a copy of the License at 756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * http://www.apache.org/licenses/LICENSE-2.0 956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 1056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Unless required by applicable law or agreed to in writing, software 1156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * distributed under the License is distributed on an "AS IS" BASIS, 1256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * See the License for the specific language governing permissions and 1456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * limitations under the License. 1556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 1656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpackage com.google.clearsilver.jsilver.syntax; 1856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.autoescape.EscapeMode; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.exceptions.JSilverIOException; 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.syntax.analysis.DepthFirstAdapter; 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.syntax.node.EOF; 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.syntax.node.Node; 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.syntax.node.Start; 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.syntax.node.Token; 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.BufferedReader; 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.FileReader; 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.IOException; 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.Reader; 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/** 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Dumps the syntax tree to text. Useful for debugging and understanding how the tree is structured. 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpublic class SyntaxTreeDumper extends DepthFirstAdapter { 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final Appendable out; 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final String newLine = System.getProperty("line.separator"); 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private int indent; 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public SyntaxTreeDumper(Appendable out) { 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.out = out; 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Dumps to System.out. 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public SyntaxTreeDumper() { 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this(System.out); 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void defaultIn(Node node) { 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson write(nodeName(node) + " {"); 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson indent++; 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 6156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void defaultOut(Node node) { 6256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson indent--; 6356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson write("}"); 6456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 6556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 6756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void defaultCase(Node node) { 6856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson write(nodeName(node)); 6956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private String nodeName(Node node) { 7256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (node instanceof Start || node instanceof EOF) { 7356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return node.getClass().getSimpleName(); 7456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } else if (node instanceof Token) { 7556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Token token = (Token) node; 7656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String tokenType = token.getClass().getSimpleName().substring(1); 7756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return tokenType + " [line:" + token.getLine() + ",pos:" + token.getPos() + "] \"" 7856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson + escape(token.getText()) + "\""; 7956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } else { 8056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // Turn PSomeProduction, AConcreteSomeProduction 8156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // Into SomeProduction, Concrete 8256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String p = node.getClass().getSuperclass().getSimpleName().substring(1); 8356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String a = node.getClass().getSimpleName().substring(1); 8456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson a = a.substring(0, a.length() - p.length()); 8556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return "<" + a + ">" + p; 8656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 8856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 9056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private String escape(String text) { 9156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson StringBuilder result = new StringBuilder(); 9256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson for (int i = 0; i < text.length(); i++) { 9356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson char c = text.charAt(i); 9456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson switch (c) { 9556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson case '\\': 9656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson result.append("\\\\"); 9756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson break; 9856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson case '"': 9956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson result.append("\\\""); 10056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson break; 10156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson case '\n': 10256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson result.append("\\n"); 10356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson break; 10456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson case '\r': 10556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson result.append("\\r"); 10656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson break; 10756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson case '\t': 10856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson result.append("\\t"); 10956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson break; 11056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson default: 11156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson result.append(c); 11256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return result.toString(); 11556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 11756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private void write(String text) { 11856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson try { 11956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // Write to temp string in case output isn't buffered. 12056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson StringBuilder line = new StringBuilder(); 12156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson for (int i = 0; i < indent; i++) { 12256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson line.append(" "); 12356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 12456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson line.append(text); 12556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson line.append(newLine); 12656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson out.append(line); 12756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } catch (IOException e) { 12856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new JSilverIOException(e); 12956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 13056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 13156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 13256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 13356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Simple command line tool for parsing a template and dumping out the AST. 13456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 13556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public static void main(String[] args) throws IOException { 13656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (args.length == 0) { 13756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson System.err.println("Provide filename of template."); 13856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return; 13956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 14056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String filename = args[0]; 14156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Reader reader = new BufferedReader(new FileReader(filename)); 14256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson try { 14356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson SyntaxTreeBuilder builder = new SyntaxTreeBuilder(); 14456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson TemplateSyntaxTree tree = builder.parse(reader, filename, EscapeMode.ESCAPE_NONE); 14556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson tree.apply(new SyntaxTreeDumper(System.out)); 14656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } finally { 14756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson reader.close(); 14856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 14956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 15156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 152