IColorizerHandler.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 Eclipse Public Licensed 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.editors.unified.colorizer;

import org.eclipse.swt.custom.StyleRange;
import org.eclipse.swt.graphics.Color;

import com.aptana.ide.lexer.Lexeme;
import com.aptana.ide.parsing.IParseState;

/**
 * This interface is to allow dynamic re-colorization on the fly. Implementors of this class will register via extension
 * point for a language and then be queried to handle foreground and background colorizations.
 * 
 * @author Kevin Sawicki (ksawicki@aptana.com)
 */
public interface IColorizerHandler
{

	/**
	 * Gets the language that this handler is providing customizations for
	 * 
	 * @return - mime type
	 */
	String getLanguage();

	/**
	 * Gets the color of the line if the lexeme is the first one on the line
	 * 
	 * @param parseState
	 * @param lexeme
	 * @return - color of the line background
	 */
	Color getBackground(IParseState parseState, Lexeme lexeme);

	/**
	 * Gets the color of an empty line
	 * 
	 * @param parseState
	 * @param offset
	 * @return - color of empty line
	 */
	Color getEmptyLineColor(IParseState parseState, int offset);

	/**
	 * Gets the style range for the lexeme
	 * 
	 * @param parseState
	 * @param lexeme
	 * @return - style range for this lexeme
	 */
	StyleRange getStyleRange(IParseState parseState, Lexeme lexeme);
}