docstringsprefpage.java

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

package org.python.pydev.editor.correctionassist.docstrings;

import java.util.StringTokenizer;

import org.eclipse.core.runtime.Preferences;
import org.eclipse.core.runtime.Preferences.IPropertyChangeListener;
import org.eclipse.core.runtime.Preferences.PropertyChangeEvent;
import org.eclipse.jface.dialogs.InputDialog;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.jface.preference.RadioGroupFieldEditor;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.python.pydev.plugin.PydevPlugin;
import org.python.pydev.plugin.PydevPrefs;

/**
 * Preferences related to docstrings. These preferences are used by the
 * docstring content assistant.
 */

public class DocstringsPrefPage extends FieldEditorPreferencePage implements
		IWorkbenchPreferencePage, IPropertyChangeListener {

	/* Preference identifiers */
	public static final String P_DOCSTRINGCHARACTER = "DOCSTRING CHARACTER";

	public static final String DEFAULT_P_DOCSTRINGCHARACTER = "'";

	public static final String TYPETAG_GENERATION_NEVER = "Never";

	public static final String TYPETAG_GENERATION_ALWAYS = "Always";

	public static final String TYPETAG_GENERATION_CUSTOM = "Custom";

	public static final String P_TYPETAGGENERATION = "TYPETAGGENERATION";

	public static final String DEFAULT_P_TYPETAGGENERATION = TYPETAG_GENERATION_NEVER;

	public static final String P_DONT_GENERATE_TYPETAGS = "DONT_GENERATE_TYPETAGS_PREFIXES";

	public static final String DEFAULT_P_DONT_GENERATE_TYPETAGS = "sz\0n\0f";

	public DocstringsPrefPage() {
		super(GRID);
		setPreferenceStore(PydevPlugin.getDefault().getPreferenceStore());
		setDescription("Docstring preferences");
	}

	/**
	 * Getter for the preferred docstring character. Only a shortcut.
	 * 
	 * @return
	 */
	public static String getPreferredDocstringCharacter() {
        PydevPlugin plugin = PydevPlugin.getDefault();
        if(plugin == null){
            return "'";//testing...
            
        }
		Preferences preferences = PydevPrefs.getPreferences();
        return preferences.getString(P_DOCSTRINGCHARACTER);
	}

	/**
	 * 
	 * @return The string that should be used to mark the beginning or end of a
	 *         docstring. (""") or (''')
	 */
	public static String getDocstringMarker() {
		String docstringChar = getPreferredDocstringCharacter();
		return docstringChar + docstringChar + docstringChar;
	}

	/**
	 * Determines, from the preferences, whether a type tag should be generated
	 * for a function / method parameter.
	 * 
	 * @param parameterName The name of the parameter.
	 * @return true if it should be generated and false otherwise
	 */
	public static boolean getTypeTagShouldBeGenerated(String parameterName) {
        if(PydevPlugin.getDefault() == null){
            //on tests
            return true;
        }
		String preference = PydevPrefs.getPreferences().getString(P_TYPETAGGENERATION);
		if (preference.equals(TYPETAG_GENERATION_NEVER)) {
			return false;
		} else if (preference.equals(TYPETAG_GENERATION_ALWAYS)) {
			return true;
		} else {// TYPETAG_GENERATION_CUSTOM - check prefix.
			String prefixesString = PydevPrefs.getPreferences().getString(P_DONT_GENERATE_TYPETAGS);
			StringTokenizer st = new StringTokenizer(prefixesString, "\0"); // "\0" is the separator
			
			while (st.hasMoreTokens())
			{
				if (parameterName.startsWith(st.nextToken()))
				{
					return false;
				}
			}
			
			return true; // No match
		}
	}

	/**
	 * Creates the field editors. Field editors are abstractions of the common
	 * GUI blocks needed to manipulate various types of preferences. Each field
	 * editor knows how to save and restore itself.
	 */
	public void createFieldEditors() {
		Composite p = getFieldEditorParent();
		
		Composite p2 = new Composite(p, 0);
		p2.setLayout(new RowLayout());
		
		RadioGroupFieldEditor docstringCharEditor = 
			new RadioGroupFieldEditor(P_DOCSTRINGCHARACTER,
				"Docstring character", 1, new String[][] {
						{ "Quotation mark (\")", "\"" },
						{ "Apostrophe (')", "'" } }, p2, true);
		addField(docstringCharEditor);
		
		Group typeDoctagGroup = new Group(p2, 0);
		typeDoctagGroup.setText("Type doctag generation (@type x:...)");
		typeDoctagEditor = new RadioGroupFieldEditor(P_TYPETAGGENERATION,
				"", 1, new String[][] {
						{ "&Always", TYPETAG_GENERATION_ALWAYS },
						{ "&Never", TYPETAG_GENERATION_NEVER},
						{ "&Custom", TYPETAG_GENERATION_CUSTOM } }, typeDoctagGroup);


		addField(typeDoctagEditor);
		typeDoctagEditor.setPropertyChangeListener(this);
		addField(new ParameterNamePrefixListEditor(P_DONT_GENERATE_TYPETAGS,
				"Don't create for parameters with prefix", typeDoctagGroup));
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
	 */
	public void init(IWorkbench workbench) {
	}
	

	public void propertyChange(PropertyChangeEvent event) {
		InputDialog d = new InputDialog(getShell(), 
				"Type doctag generation", 
				"Enter a parameter prefix",
				null, 
				null);
		d.open();
	}


	private RadioGroupFieldEditor typeDoctagEditor;
}