ABSSyntaxColoring.java

/** 
 * Copyright (c) 2009-2011, The HATS Consortium. All rights reserved. 
 * This file is licensed under the terms of the Modified BSD License.
 */
package org.absmodels.abs.plugin.preferences;

import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.ColorFieldEditor;
import org.eclipse.jface.preference.PreferencePage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;

import static org.absmodels.abs.plugin.util.Constants.*;
import static org.absmodels.abs.plugin.util.UtilityFunctions.*;

/**
 * Preference page for syntax highlighting of the ABS editor.
 * @author tfischer
 */
public class ABSSyntaxColoring extends PreferencePage implements IWorkbenchPreferencePage{

	private ColorFieldEditor color;
	
	private BooleanFieldEditor styleBold;
	private BooleanFieldEditor styleItalic;
	private BooleanFieldEditor styleUnderline;
	private BooleanFieldEditor styleStrikethrough;
	
	/**
	 * Selection listener handling selection events on the list of elements
	 * which can be highlighted differently
	 */
	private final class SomeSelectionListener implements SelectionListener {
		private final List list;

		private SomeSelectionListener(List list) {
			this.list = list;
		}

		@Override
		public void widgetSelected(SelectionEvent e) {
			performOk();
			switch(list.getSelectionIndex()){
			case 0: updateEditors(SYNTAXCOLOR_KEYWORD);  	break;
			case 1: updateEditors(SYNTAXCOLOR_STRING);   	break;
			case 2: updateEditors(SYNTAXCOLOR_COMMENT);  	break;
			case 3: updateEditors(SYNTAXCOLOR_FUNCTION); 	break;
			case 4: updateEditors(SYNTAXCOLOR_DATATYPE); 	break;
			case 5: updateEditors(SYNTAXCOLOR_VAR);     	break;
			case 6: updateEditors(SYNTAXCOLOR_PARAM);		break;
			case 7: updateEditors(SYNTAXCOLOR_FIELD);    	break;
			case 8: updateEditors(SYNTAXCOLOR_INTERFACE);	break;
			case 9: updateEditors(SYNTAXCOLOR_CONSTRUCTOR); break;
			}
		}

		@Override
		public void widgetDefaultSelected(SelectionEvent e) {
			widgetSelected(e);
		}
	}
	
	@Override
	public void init(IWorkbench workbench) {
		setPreferenceStore(getDefaultPreferenceStore());		
		setDescription("Choose colors of syntax highlighting here");
	}

	@Override
	protected Control createContents(Composite parent) {
		Composite container = new Composite(parent, SWT.NONE);
		
		GridLayout gridLayout = new GridLayout(2, false);
				
		container.setLayout(gridLayout);
		
		//Initialize and populate list
		final List list = new List(container, SWT.NONE);
		list.setLayoutData(new GridData(SWT.FILL));
		populateList(list);
		list.setSelection(0);
		list.setSize(10, 20);
		list.addSelectionListener(new SomeSelectionListener(list));
		
		Composite selectorContainer = new Composite(container, SWT.NONE);
		selectorContainer.setLayout(new GridLayout(1, false));
		
		//Add color editor
		Composite colorContainer = new Composite(selectorContainer, SWT.NONE);
		color = new ColorFieldEditor(SYNTAXCOLOR_COLOR + SYNTAXCOLOR_KEYWORD, "Color", colorContainer);

		//Create and add style group
		Group styleContainer = new Group(selectorContainer, SWT.NONE);
		styleContainer.setText("Style");
		
		GridLayout gridLayout2 = new GridLayout(1, false);
		styleContainer.setLayout(gridLayout2);
		
		Composite styleBoldContainer          = new Composite(styleContainer, SWT.NONE);
		Composite styleItalicContainer        = new Composite(styleContainer, SWT.NONE);
		Composite styleUnderlineContainer     = new Composite(styleContainer, SWT.NONE);
		Composite styleStrikethroughContainer = new Composite(styleContainer, SWT.NONE);
		
		styleBold          = new BooleanFieldEditor(SYNTAXCOLOR_BOLD + SYNTAXCOLOR_KEYWORD, "Bold", styleBoldContainer);
		styleItalic        = new BooleanFieldEditor(SYNTAXCOLOR_ITALIC + SYNTAXCOLOR_KEYWORD, "Italic", styleItalicContainer);
		styleUnderline     = new BooleanFieldEditor(SYNTAXCOLOR_UNDERLINE + SYNTAXCOLOR_KEYWORD, "Underline", styleUnderlineContainer);
		styleStrikethrough = new BooleanFieldEditor(SYNTAXCOLOR_STRIKETHROUGH + SYNTAXCOLOR_KEYWORD, "Strike through", styleStrikethroughContainer);
		
		//Link editors with the default preferenceStore
		color.setPreferenceStore(getDefaultPreferenceStore());
		styleBold.setPreferenceStore(getDefaultPreferenceStore());
		styleItalic.setPreferenceStore(getDefaultPreferenceStore());
		styleUnderline.setPreferenceStore(getDefaultPreferenceStore());
		styleStrikethrough.setPreferenceStore(getDefaultPreferenceStore());
		
		//Load values for keyword
		updateEditors(SYNTAXCOLOR_KEYWORD);
		return container;
	}

	/**
	 * Populates a given list with a predefined set of elements which
	 * can be highlighted differently
	 * @param list The list to be populated
	 */
	private void populateList(final List list) {
		if(list != null){
			list.add("Keywords");
			list.add("Strings");
			list.add("Comments");
			list.add("Functions");
			list.add("Datatypes");
			list.add("Variables");
			list.add("Parameters");
			list.add("Fields");
			list.add("Interfaces");
			list.add("Typeconstructors");
		}
	}
	
	private void updateEditors(String s){
		//Link editors with new values of preferenceStore
		color.setPreferenceName(SYNTAXCOLOR_COLOR+s);
		styleBold.setPreferenceName(SYNTAXCOLOR_BOLD+s);
		styleItalic.setPreferenceName(SYNTAXCOLOR_ITALIC+s);
		styleUnderline.setPreferenceName(SYNTAXCOLOR_UNDERLINE+s);
		styleStrikethrough.setPreferenceName(SYNTAXCOLOR_STRIKETHROUGH+s);
		
		//Load currently stored values for those
		color.load();
		styleBold.load();
		styleItalic.load();
		styleUnderline.load();
		styleStrikethrough.load();
	}
	
	@Override
	protected void performDefaults() {		
		color.loadDefault();				
		styleBold.loadDefault();
		styleItalic.loadDefault();
		styleUnderline.loadDefault();
		styleStrikethrough.loadDefault();
		
		super.performDefaults();
	}
	
	@Override
	public boolean performOk() {
		color.store();		
		styleBold.store();
		styleItalic.store();
		styleUnderline.store();
		styleStrikethrough.store();
				
		return super.performOk();
	}
	
}