pypreviewconfiguration.java

Python Development Environment (Python IDE plugin for Eclipse). Features editor, code completion, re

package org.python.pydev.refactoring.ui.controls.preview;

import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.DefaultInformationControl;
import org.eclipse.jface.text.IAutoEditStrategy;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.ITextDoubleClickStrategy;
import org.eclipse.jface.text.ITextHover;
import org.eclipse.jface.text.TextPresentation;
import org.eclipse.jface.text.presentation.IPresentationReconciler;
import org.eclipse.jface.text.presentation.PresentationReconciler;
import org.eclipse.jface.text.rules.DefaultDamagerRepairer;
import org.eclipse.jface.text.source.IAnnotationHover;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.StyleRange;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.python.pydev.core.IPythonPartitions;
import org.python.pydev.editor.PyCodeScanner;
import org.python.pydev.editor.PyColoredScanner;
import org.python.pydev.editor.PyDoubleClickStrategy;
import org.python.pydev.editor.autoedit.PyAutoIndentStrategy;
import org.python.pydev.editor.hover.PyAnnotationHover;
import org.python.pydev.editor.hover.PyTextHover;
import org.python.pydev.plugin.PydevPlugin;
import org.python.pydev.plugin.PydevPrefs;
import org.python.pydev.ui.ColorCache;

public class PyPreviewConfiguration extends SourceViewerConfiguration {

	private ColorCache colorCache;

	private PyAutoIndentStrategy autoIndentStrategy;

	private String[] indentPrefixes = { "    ", "\t", "" };

	private PresentationReconciler reconciler;

	private PyCodeScanner codeScanner;

	private PyColoredScanner commentScanner, stringScanner, backquotesScanner;

	public PyPreviewConfiguration(ColorCache colorManager) {
		colorCache = colorManager;
	}

	@Override
	public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
		return new PyAnnotationHover(sourceViewer);
	}

	@Override
	public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
		return new PyTextHover(sourceViewer, contentType);
	}

	/**
	 * Has to return all the types generated by partition scanner.
	 * 
	 * The SourceViewer will ignore double-clicks and any other configuration behaviors inside any partition not declared here
	 */
	public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) {
		return new String[] { IDocument.DEFAULT_CONTENT_TYPE, IPythonPartitions.PY_COMMENT, IPythonPartitions.PY_SINGLELINE_STRING1,
				IPythonPartitions.PY_SINGLELINE_STRING2, IPythonPartitions.PY_MULTILINE_STRING1, IPythonPartitions.PY_MULTILINE_STRING2 };
	}

	@Override
	public String getConfiguredDocumentPartitioning(ISourceViewer sourceViewer) {
		return IPythonPartitions.PYTHON_PARTITION_TYPE;
	}

	/**
	 * Cache the result, because we'll get asked for it multiple times Now, we always return the PyAutoIndentStrategy. (even on commented
	 * lines).
	 * 
	 * @return PyAutoIndentStrategy which deals with spaces/tabs
	 */
	public IAutoEditStrategy[] getAutoEditStrategies(ISourceViewer sourceViewer, String contentType) {
		return new IAutoEditStrategy[] { getPyAutoIndentStrategy() };
	}

	/**
	 * Cache the result, because we'll get asked for it multiple times Now, we always return the PyAutoIndentStrategy. (even on commented
	 * lines).
	 * 
	 * @return PyAutoIndentStrategy which deals with spaces/tabs
	 */
	public PyAutoIndentStrategy getPyAutoIndentStrategy() {
		if (autoIndentStrategy == null) {
			autoIndentStrategy = new PyAutoIndentStrategy();
		}
		return autoIndentStrategy;
	}

	/**
	 * Recalculates indent prefixes based upon preferences
	 * 
	 * we hold onto the same array SourceViewer has, and write directly into it. This is because there is no way to tell SourceViewer that
	 * indent prefixes have changed. And we need this functionality when user resets the tabs vs. spaces preference
	 */
	public void resetIndentPrefixes() {
		Preferences prefs = PydevPlugin.getDefault().getPluginPreferences();
		int tabWidth = prefs.getInt(PydevPrefs.TAB_WIDTH);
		StringBuffer spaces = new StringBuffer(8);

		for (int i = 0; i < tabWidth; i++) {
			spaces.append(" ");
		}

		boolean spacesFirst = prefs.getBoolean(PydevPrefs.SUBSTITUTE_TABS) && !(getPyAutoIndentStrategy()).getIndentPrefs().getForceTabs();

		if (spacesFirst) {
			indentPrefixes[0] = spaces.toString();
			indentPrefixes[1] = "\t";
		} else {
			indentPrefixes[0] = "\t";
			indentPrefixes[1] = spaces.toString();
		}
	}

	/**
	 * Prefixes used in shift-left/shift-right editor operations
	 * 
	 * shift-right uses prefix[0] shift-left removes a single instance of the first prefix from the array that matches
	 * 
	 * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getIndentPrefixes(org.eclipse.jface.text.source.ISourceViewer,
	 *      java.lang.String)
	 */
	public String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType) {
		resetIndentPrefixes();
		sourceViewer.setIndentPrefixes(indentPrefixes, contentType);
		return indentPrefixes;
	}

	/**
	 * Just the default double-click strategy for now. But we should be smarter.
	 * 
	 * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getDoubleClickStrategy(org.eclipse.jface.text.source.ISourceViewer,
	 *      java.lang.String)
	 */
	public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType) {
		if (contentType.equals(IDocument.DEFAULT_CONTENT_TYPE))
			return new PyDoubleClickStrategy();
		else
			return super.getDoubleClickStrategy(sourceViewer, contentType);
	}

	/**
	 * TabWidth is defined inside pydev preferences.
	 * 
	 * Python uses its own tab width, since I think that its standard is 8
	 */
	public int getTabWidth(ISourceViewer sourceViewer) {
		return PydevPlugin.getDefault().getPluginPreferences().getInt(PydevPrefs.TAB_WIDTH);
	}

	public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) {

		if (reconciler == null) {
			reconciler = new PresentationReconciler();
			reconciler.setDocumentPartitioning(IPythonPartitions.PYTHON_PARTITION_TYPE);

			DefaultDamagerRepairer dr;

			// DefaultDamagerRepairer implements both IPresentationDamager,
			// IPresentationRepairer
			// IPresentationDamager::getDamageRegion does not scan, just
			// returns the intersection of document event, and partition region
			// IPresentationRepairer::createPresentation scans
			// gets each token, and sets text attributes according to token

			// We need to cover all the content types from PyPartitionScanner

			IPreferenceStore preferences = PydevPlugin.getChainedPrefStore();
			// Comments have uniform color
			commentScanner = new PyColoredScanner(colorCache, PydevPrefs.COMMENT_COLOR, preferences.getInt(PydevPrefs.COMMENT_STYLE));
			dr = new DefaultDamagerRepairer(commentScanner);
			reconciler.setDamager(dr, IPythonPartitions.PY_COMMENT);
			reconciler.setRepairer(dr, IPythonPartitions.PY_COMMENT);

			// Backquotes have uniform color
			backquotesScanner = new PyColoredScanner(colorCache, PydevPrefs.BACKQUOTES_COLOR, preferences
					.getInt(PydevPrefs.BACKQUOTES_STYLE));
			dr = new DefaultDamagerRepairer(backquotesScanner);
			reconciler.setDamager(dr, IPythonPartitions.PY_BACKQUOTES);
			reconciler.setRepairer(dr, IPythonPartitions.PY_BACKQUOTES);

			// Strings have uniform color
			stringScanner = new PyColoredScanner(colorCache, PydevPrefs.STRING_COLOR, preferences.getInt(PydevPrefs.STRING_STYLE));
			dr = new DefaultDamagerRepairer(stringScanner);
			reconciler.setDamager(dr, IPythonPartitions.PY_SINGLELINE_STRING1);
			reconciler.setRepairer(dr, IPythonPartitions.PY_SINGLELINE_STRING1);
			reconciler.setDamager(dr, IPythonPartitions.PY_SINGLELINE_STRING2);
			reconciler.setRepairer(dr, IPythonPartitions.PY_SINGLELINE_STRING2);
			reconciler.setDamager(dr, IPythonPartitions.PY_MULTILINE_STRING1);
			reconciler.setRepairer(dr, IPythonPartitions.PY_MULTILINE_STRING1);
			reconciler.setDamager(dr, IPythonPartitions.PY_MULTILINE_STRING2);
			reconciler.setRepairer(dr, IPythonPartitions.PY_MULTILINE_STRING2);

			// Default content is code, we need syntax highlighting
			codeScanner = new PyCodeScanner(colorCache);
			dr = new DefaultDamagerRepairer(codeScanner);
			reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE);
			reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE);
		}

		return reconciler;
	}

	// The presenter instance for the information window
	private static final DefaultInformationControl.IInformationPresenter presenter = new DefaultInformationControl.IInformationPresenter() {
		public String updatePresentation(Display display, String infoText, TextPresentation presentation, int maxWidth, int maxHeight) {
			int start = -1;
			// Loop over all characters of information text
			// These will have to be tailored for the appropriate Python
			for (int i = 0; i < infoText.length(); i++) {
				switch (infoText.charAt(i)) {
				case '<':
					// Remember start of tag
					start = i;
					break;
				case '>':
					if (start >= 0) {
						// We have found a tag and create a new style range
						StyleRange range = new StyleRange(start, i - start + 1, null, null, SWT.BOLD);
						// Add this style range to the presentation
						presentation.addStyleRange(range);
						// Reset tag start indicator
						start = -1;
					}
					break;
				}
			}
			// Return the information text
			return infoText;
		}
	};

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getInformationControlCreator(org.eclipse.jface.text.source.ISourceViewer)
	 */
	public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer) {
		return new IInformationControlCreator() {
			public IInformationControl createInformationControl(Shell parent) {
				return new DefaultInformationControl(parent, presenter);
			}
		};
	}

	// updates the syntax highlighting for the specified preference
	// assumes that that editor colorCache has been updated with the
	// new named color
	public void updateSyntaxColorAndStyle() {
		if (reconciler != null) {
			// always update all (too much work in keeping this synchronized by
			// type)
			codeScanner.updateColors();

			IPreferenceStore preferences = PydevPlugin.getChainedPrefStore();

			commentScanner.setStyle(preferences.getInt(PydevPrefs.COMMENT_STYLE));
			commentScanner.updateColorAndStyle();

			stringScanner.setStyle(preferences.getInt(PydevPrefs.STRING_STYLE));
			stringScanner.updateColorAndStyle();

			backquotesScanner.setStyle(preferences.getInt(PydevPrefs.BACKQUOTES_STYLE));
			backquotesScanner.updateColorAndStyle();
		}
	}

}