/*
 * JBrowseParser.java - Java Parser interface for JBrowse
 *
 * Copyright (c) 1999 George Latkiewicz	(georgel@arvotek.net)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

import javax.swing.tree.TreePath;

//=============================================================================
/**
 * The interface that all JBrowse parsers must implement, independent of how
 * they obtain their data and the type of source that parser analyzes.
 */
public interface JBrowseParser
{

	//-------------------------------------------------------------------------
	/**
	 * The method that preforms the actual parsing. This is the method which builds
	 * the tree model that reflects the heirarchical structure of the Java code that
	 * the parser has been configured to analyze.
	 */
	public JBrowseParser.Results parse();
	// this should latter throw a parser not ready exception.

	public void setOptions(Options options);
	public String getSourceName();

	public void setRootNode(UMLTree.Node root);

	public boolean isReady();

	public static final String MISSING_LABEL = "";


	//=========================================================================
	public static class Results {

		// Parse Counters
		private int classCount     = 0;
		private int interfaceCount = 0;
		private int methodCount    = 0;
		private int objAttrCount   = 0;
		private int primAttrCount  = 0;
		private int errorCount     = 0;

		// Top-level (non-nested) public class/interface (or null)
		private TreePath topLevelPath = null;

		// Accessor Methods
		public int getClassCount() { return classCount; }
		public int getInterfaceCount() { return interfaceCount; }
		public int getMethodCount() { return methodCount; }
		public int getObjAttrCount() { return objAttrCount; }
		public int getPrimAttrCount() { return primAttrCount; }
		public int getErrorCount() { return errorCount; }

		public TreePath getTopLevelPath() { return topLevelPath; }

		void setErrorCount(int count) {
			errorCount = count;
		}

		public void setTopLevelPath(TreePath path)
		{
			topLevelPath = path;
		}

		// Increment
		public void incClassCount() {
			classCount++;
		}
		public void incInterfaceCount() {
			interfaceCount++;
		}
		public void incMethodCount() {
			methodCount++;
		}
		public void incObjAttrCount() {
			objAttrCount++;
		}
		public void incPrimAttrCount() {
			primAttrCount++;
		}
		public void incErrorCount() {
			errorCount++;
		}

		/**
		 * This method resets all the result variables to their initial state,
		 * i.e. all counts to 0, in anticipation of performing a new parse
		 * which will use the result object to count what it finds.
		  */
		void reset() {
			classCount     = 0;
			interfaceCount = 0;
			methodCount    = 0;
			objAttrCount   = 0;
			primAttrCount  = 0;
			errorCount     = 0;

			topLevelPath = null;
		}

	} // static class JBrowseParser.Results


	//=============================================================================
	public static interface LineSource {

		// Returns the total number of lines in the associated line source
		public int getTotalLines();	// remove from the interface ???

		public boolean isExhausted();

		// Returns the lines with the specified index from the associated line source,
		// or null if the index is out of range.
		public String getLine(int lineIndex);

		// Returns the offset of this line from the start
		public int getStartOffset();

		// Returns the name for this LineSource (e.g. file name)
		public String getName();

		// Setup to become a newly initialized LineSource for the current buffer
		public void reset();

		// Returns an object representing the position in the source
		// represented by the integer argument (offset)
		public Object createPosition(int offset);

	} // static interface JBrowseParser.LineSource

} // interface JBrowseParser