13447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein/* 23447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein [The "BSD license"] 33447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Copyright (c) 2005-2009 Terence Parr 43447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein All rights reserved. 53447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 63447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Redistribution and use in source and binary forms, with or without 73447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein modification, are permitted provided that the following conditions 83447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein are met: 93447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1. Redistributions of source code must retain the above copyright 103447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein notice, this list of conditions and the following disclaimer. 113447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 2. Redistributions in binary form must reproduce the above copyright 123447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein notice, this list of conditions and the following disclaimer in the 133447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein documentation and/or other materials provided with the distribution. 143447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 3. The name of the author may not be used to endorse or promote products 153447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein derived from this software without specific prior written permission. 163447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 173447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 183447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 193447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 203447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 213447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 223447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 233447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 243447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 253447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 263447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 273447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein */ 283447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinpackage org.antlr.runtime.debug; 293447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 303447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinimport org.antlr.runtime.tree.TreeAdaptor; 313447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinimport org.antlr.runtime.tree.TreeNodeStream; 323447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinimport org.antlr.runtime.TokenStream; 333447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 343447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein/** Debug any tree node stream. The constructor accepts the stream 353447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein * and a debug listener. As node stream calls come in, debug events 363447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein * are triggered. 373447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein */ 383447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinpublic class DebugTreeNodeStream implements TreeNodeStream { 393447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein protected DebugEventListener dbg; 403447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein protected TreeAdaptor adaptor; 413447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein protected TreeNodeStream input; 423447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein protected boolean initialStreamState = true; 433447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 443447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein /** Track the last mark() call result value for use in rewind(). */ 453447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein protected int lastMarker; 463447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 473447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public DebugTreeNodeStream(TreeNodeStream input, 483447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein DebugEventListener dbg) 493447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein { 503447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein this.input = input; 513447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein this.adaptor = input.getTreeAdaptor(); 523447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein this.input.setUniqueNavigationNodes(true); 533447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein setDebugListener(dbg); 543447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 553447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 563447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void setDebugListener(DebugEventListener dbg) { 573447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein this.dbg = dbg; 583447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 593447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 603447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public TreeAdaptor getTreeAdaptor() { 613447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return adaptor; 623447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 633447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 643447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void consume() { 653447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Object node = input.LT(1); 663447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein input.consume(); 673447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein dbg.consumeNode(node); 683447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 693447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 703447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public Object get(int i) { 713447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return input.get(i); 723447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 733447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 743447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public Object LT(int i) { 753447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Object node = input.LT(i); 763447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein int ID = adaptor.getUniqueID(node); 773447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein String text = adaptor.getText(node); 783447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein int type = adaptor.getType(node); 793447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein dbg.LT(i, node); 803447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return node; 813447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 823447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 833447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public int LA(int i) { 843447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Object node = input.LT(i); 853447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein int ID = adaptor.getUniqueID(node); 863447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein String text = adaptor.getText(node); 873447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein int type = adaptor.getType(node); 883447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein dbg.LT(i, node); 893447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return type; 903447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 913447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 923447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public int mark() { 933447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein lastMarker = input.mark(); 943447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein dbg.mark(lastMarker); 953447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return lastMarker; 963447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 973447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 983447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public int index() { 993447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return input.index(); 1003447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1013447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1023447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void rewind(int marker) { 1033447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein dbg.rewind(marker); 1043447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein input.rewind(marker); 1053447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1063447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1073447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void rewind() { 1083447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein dbg.rewind(); 1093447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein input.rewind(lastMarker); 1103447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1113447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1123447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void release(int marker) { 1133447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1143447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1153447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void seek(int index) { 1163447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein // TODO: implement seek in dbg interface 1173447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein // db.seek(index); 1183447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein input.seek(index); 1193447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1203447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1213447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public int size() { 1223447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return input.size(); 1233447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1243447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1253447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void reset() { ; } 1263447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1273447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public Object getTreeSource() { 1283447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return input; 1293447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1303447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1313447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public String getSourceName() { 1323447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return getTokenStream().getSourceName(); 1333447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1343447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1353447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public TokenStream getTokenStream() { 1363447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return input.getTokenStream(); 1373447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1383447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1393447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein /** It is normally this object that instructs the node stream to 1403447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein * create unique nav nodes, but to satisfy interface, we have to 1413447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein * define it. It might be better to ignore the parameter but 1423447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein * there might be a use for it later, so I'll leave. 1433447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein */ 1443447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void setUniqueNavigationNodes(boolean uniqueNavigationNodes) { 1453447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein input.setUniqueNavigationNodes(uniqueNavigationNodes); 1463447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1473447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1483447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public void replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t) { 1493447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein input.replaceChildren(parent, startChildIndex, stopChildIndex, t); 1503447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1513447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1523447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein public String toString(Object start, Object stop) { 1533447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein return input.toString(start,stop); 1543447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein } 1553447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein} 156