IOffsetMapper.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.parsing;

import com.aptana.ide.lexer.Lexeme;
import com.aptana.ide.lexer.LexemeList;

/**
 * @author IOffsetMapper
 */
public interface IOffsetMapper
{

	/**
	 * getLexemeList
	 * 
	 * @return LexemeList
	 */
	LexemeList getLexemeList();

	/**
	 * Calculates the index and lexeme that the given offset is within and caches it. This accounts for whitespace areas
	 * by setting the result to the previous lexeme if available.
	 * 
	 * @param offset
	 */
	void calculateCurrentLexeme(int offset);

	/**
	 * Gets the cached current Lexeme based on the current offset of the document.
	 * 
	 * @return Returns the current lexeme.
	 */
	Lexeme getCurrentLexeme();

	/**
	 * Gets the lexeme at the specified index.
	 * 
	 * @param index
	 * @return Returns the current lexeme at that index, or null if not found.
	 */
	Lexeme getLexemeAtIndex(int index);

	/**
	 * Gets the cached current Lexeme index based on the offset in the current document.
	 * 
	 * @return Returns the current lexeme index.
	 */
	int getCurrentLexemeIndex();

	/**
	 * With a name this long you don't really need a comment.
	 * 
	 * @param offset
	 * @return returns the LexemeIndexFromDocumentOffset
	 */
	int getLexemeIndexFromDocumentOffset(int offset);

	/**
	 * findTarget
	 * 
	 * @param lexeme
	 * @return ICodeLocation
	 */
	ICodeLocation findTarget(Lexeme lexeme);

	/**
	 * Disposes the object.
	 */
	void dispose();

}