IRegexRunner.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.regex;

/**
 * @author Kevin Lindsey
 */
public interface IRegexRunner
{
	/**
	 * Returns the accept state associated with the last match. Typically, this is the token type index
	 * 
	 * @return Returns the accept state from the last execution of match
	 */
	int getAcceptState();

	/**
	 * match
	 * 
	 * @param source
	 *            The source text to test against this regular expression
	 * @param startPosition
	 *            The starting position where to begin testing for a match
	 * @param endPosition
	 *            The ending position where to stop testing for a match
	 * @return Returns the final position of the match. If the return value is -1, then no match was found
	 */
	int match(String source, int startPosition, int endPosition);

	/**
	 * See if a this regex matches the given source in the given range
	 * 
	 * @param source
	 *            The source text to test against this regular expression
	 * @param startPosition
	 *            The starting position where to begin testing for a match
	 * @param endPosition
	 *            The ending position where to stop testing for a match
	 * @return Returns the final position of the match. If the return value is -1, then no match was found
	 */
	int match(char[] source, int startPosition, int endPosition);
}