path: root/eclipse/Slice2javaPlugin/src/com/zeroc/slice2javaplugin/properties/ProjectProperties.java

// **********************************************************************
//
// Copyright (c) 2003-2010 ZeroC, Inc. All rights reserved.
//
// This plug-in is provided to you under the terms and conditions
// of the Eclipse Public License Version 1.0 ("EPL"). A copy of
// the EPL is available at http://www.eclipse.org/legal/epl-v10.html.
//
// **********************************************************************

package com.zeroc.slice2javaplugin.properties;

import java.io.IOException;
import java.util.Arrays;
import java.util.Iterator;

import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.preference.PreferencePage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.FocusListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.DirectoryDialog;
import org.eclipse.swt.widgets.FileDialog;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.dialogs.ContainerSelectionDialog;
import org.eclipse.ui.dialogs.PropertyPage;

import com.zeroc.slice2javaplugin.Activator;
import com.zeroc.slice2javaplugin.builder.Slice2JavaBuilder;
import com.zeroc.slice2javaplugin.internal.Configuration;

public class ProjectProperties extends PropertyPage
{
    private Button _iceInclude;

    public ProjectProperties()
    {
        super();
        setTitle("Slice2Java Settings");
        noDefaultAndApplyButton();
    }

    public void performApply()
    {
        super.performApply();
    }

    public boolean performOk()
    {
        final IProject project = getProject();

        try
        {
            _config.setGeneratedDir(_generatedDir.getText());
            _config.setSliceSourceDirs(Arrays.asList(_sourceDirectories.getItems()));
            _config.setIncludes(Arrays.asList(_includes.getItems()));
            _config.setJars(Arrays.asList(_jars.getItems()));
            _config.setDefines(Configuration.toList(_defines.getText()));
            _config.setMeta(Configuration.toList(_meta.getText()));
            _config.setStream(_stream.getSelection());
            _config.setTie(_tie.getSelection());
            _config.setIce(_ice.getSelection());
            _config.setIceInclude(_iceInclude.getSelection());
            _config.setConsole(_console.getSelection());

            if(_config.write())
            {
                // The configuration properties were changed. We need to rebuild
                // the slice files.
                Job job = new Job("Rebuild")
                {
                    protected IStatus run(IProgressMonitor monitor)
                    {
                        try
                        {
                            project.build(IncrementalProjectBuilder.FULL_BUILD, Slice2JavaBuilder.BUILDER_ID, null,
                                    monitor);
                        }
                        catch(CoreException e)
                        {
                            return new Status(Status.ERROR, Activator.PLUGIN_ID, 0, "rebuild failed", e);
                        }
                        return Status.OK_STATUS;
                    }
                };
                job.setPriority(Job.BUILD);
                job.schedule(); // start as soon as possible
            }
        }
        catch(CoreException e)
        {
            return false;
        }
        catch(IOException e)
        {
            ErrorDialog.openError(getShell(), "Error", "Error saving preferences",
                    new Status(Status.ERROR, Activator.PLUGIN_ID, 0, null, e));
            return false;
        }
        return true;
    }

    /**
     * @see PreferencePage#createContents(Composite)
     */
    protected Control createContents(Composite parent)
    {
        // Composite composite = new Composite(parent, SWT.NONE);

        TabFolder tabFolder = new TabFolder(parent, SWT.NONE);
        {
            TabItem tabItem = new TabItem(tabFolder, SWT.NONE);
            tabItem.setText("Source");
            Control source = createSource(tabFolder);
            tabItem.setControl(source);
        }
        {
            TabItem tabItem = new TabItem(tabFolder, SWT.NONE);
            tabItem.setText("Options");
            Control source = createOptions(tabFolder);
            tabItem.setControl(source);
        }
        {
            TabItem tabItem = new TabItem(tabFolder, SWT.NONE);
            tabItem.setText("Libraries");
            Control source = createLibraries(tabFolder);
            tabItem.setControl(source);
        }

        tabFolder.pack();

        loadPrefs();

        return tabFolder;
    }

    private void loadPrefs()
    {
        IProject project = getProject();
        _config = new Configuration(project);

        _generatedDir.setText(_config.getGeneratedDir());
        for(Iterator<String> iter = _config.getSliceSourceDirs().iterator(); iter.hasNext();)
        {
            _sourceDirectories.add(iter.next());
        }
        for(Iterator<String> iter = _config.getBareIncludes().iterator(); iter.hasNext();)
        {
            _includes.add(iter.next());
        }
        for(Iterator<String> iter = _config.getJars().iterator(); iter.hasNext();)
        {
            _jars.add(iter.next());
        }
        _defines.setText(Configuration.fromList(_config.getDefines()));
        _meta.setText(Configuration.fromList(_config.getMeta()));
        _stream.setSelection(_config.getStream());
        _tie.setSelection(_config.getTie());
        _ice.setSelection(_config.getIce());
        _iceInclude.setSelection(_config.getIceInclude());
        _console.setSelection(_config.getConsole());

        checkValid();
    }

    private void checkValid()
    {
        IProject project = getProject();
        IFolder folder = project.getFolder(_generatedDir.getText());
        if(!folder.exists())
        {
            setErrorMessage("Generated folder does not exist");
            setValid(false);
            return;
        }
        setValid(true);
        setErrorMessage(null);
    }

    private Control createLibraries(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        composite.setLayout(gridLayout);

        Group includesGroup = new Group(composite, SWT.NONE);
        includesGroup.setText("Jar Files to Reference");
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        includesGroup.setLayout(gridLayout);
        includesGroup.setLayoutData(new GridData(GridData.FILL_BOTH));

        createLinkList(includesGroup);

        return composite;
    }

    private Control createSource(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        composite.setLayout(gridLayout);

        Group sourceGroup = new Group(composite, SWT.NONE);
        sourceGroup.setText("Location of Slice Source Files");
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        sourceGroup.setLayout(gridLayout);
        sourceGroup.setLayoutData(new GridData(GridData.FILL_BOTH));

        Composite c1 = new Composite(sourceGroup, SWT.NONE);

        gridLayout = new GridLayout();
        gridLayout.numColumns = 2;
        c1.setLayout(gridLayout);
        c1.setLayoutData(new GridData(GridData.FILL_BOTH));

        _sourceDirectories = new List(c1, SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI | SWT.BORDER);
        _sourceDirectories.setLayoutData(new GridData(GridData.FILL_BOTH));

        Composite c2 = new Composite(c1, SWT.NONE);

        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        c2.setLayout(gridLayout);

        Button but1 = new Button(c2, SWT.PUSH);
        but1.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but1.setText("Add Folder");
        but1.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                IProject project = getProject();

                SourceSelectionDialog dialog = new SourceSelectionDialog(getShell(), project, "Select Source Location");
                String[] items = _sourceDirectories.getItems();
                IFolder[] resources = new IFolder[items.length];
                for(int i = 0; i < items.length; ++i)
                {
                    resources[i] = project.getFolder(items[i]);
                }
                dialog.setInitialSelections(resources);
                if(dialog.open() == ContainerSelectionDialog.OK)
                {
                    Object[] selection = dialog.getResult();
                    for(int i = 0; i < selection.length; ++i)
                    {
                        IFolder path = (IFolder) selection[i];
                        _sourceDirectories.add(path.getProjectRelativePath().toString());
                    }
                }
            }
        });

        Button but2 = new Button(c2, SWT.PUSH);
        but2.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but2.setText("Remove");
        but2.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                _sourceDirectories.remove(_sourceDirectories.getSelectionIndices());
            }
        });

        Group gclGroup = new Group(composite, SWT.NONE);
        gclGroup.setText("Generated Code Location");
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        gclGroup.setLayout(gridLayout);
        gclGroup.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

        Composite tc = new Composite(gclGroup, SWT.NONE);
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        tc.setLayout(gridLayout);
        tc.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

        Label l = new Label(tc, SWT.WRAP);
        l.setText("This subdirectory is used by the plugin to manage the source files generated from your Slice definitions. It should not be used for any other purpose.");
        GridData gridData = new GridData(GridData.FILL_BOTH);
        gridData.widthHint = 400;
        l.setLayoutData(gridData);

        Composite c = new Composite(tc, SWT.NONE);

        GridLayout gridLayout2 = new GridLayout();
        gridLayout2.numColumns = 2;
        gridLayout2.marginLeft = 0;
        gridLayout2.marginTop = 0;
        gridLayout2.marginBottom = 0;
        c.setLayout(gridLayout2);

        c.setLayoutData(new GridData(GridData.FILL_BOTH));

        _generatedDir = new Text(c, SWT.BORDER | SWT.READ_ONLY);
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        // gridData.horizontalSpan = 2;
        _generatedDir.setLayoutData(gridData);

        Button but3 = new Button(c, SWT.PUSH);
        but3.setText("Browse");
        but3.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                IProject project = getProject();

                SourceSelectionDialog dialog = new SourceSelectionDialog(getShell(), project,
                        "Select Generated Code Location");
                dialog.setMultiple(false);
                if(dialog.open() == ContainerSelectionDialog.OK)
                {
                    Object[] selection = dialog.getResult();
                    if(selection.length == 1)
                    {
                        IFolder path = (IFolder) selection[0];
                        _generatedDir.setText(path.getProjectRelativePath().toString());
                    }
                }
            }
        });

        return composite;
    }

    private Control createIncludes(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 2;
        composite.setLayout(gridLayout);
        composite.setLayoutData(new GridData(GridData.FILL_BOTH));

        _includes = new List(composite, SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI | SWT.BORDER);
        _includes.setLayoutData(new GridData(GridData.FILL_BOTH));

        Composite c2 = new Composite(composite, SWT.NONE);

        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        c2.setLayout(gridLayout);

        Button but1 = new Button(c2, SWT.PUSH);
        but1.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but1.setText("Add");
        but1.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                IProject project = getProject();
                DirectoryDialog dialog = new DirectoryDialog(getShell());
                String dir = dialog.open();
                if(dir != null)
                {
                    IPath projectLocation = project.getLocation();
                    IPath includeLocation = new Path(dir);
                    String dev1 = projectLocation.getDevice();
                    if(dev1 == null)
                    {
                        dev1 = "";
                    }
                    String dev2 = includeLocation.getDevice();
                    if(dev2 == null)
                    {
                        dev2 = "";
                    }
                    IPath result;

                    // If the directories are on different devices, then we have
                    // no choice but to use an absolute path.
                    if(!dev1.equals(dev2))
                    {
                        result = includeLocation;
                    }
                    else
                    {

                        // Convert the absolute path to a relative path.
                        int n = projectLocation.matchingFirstSegments(includeLocation);
                        result = includeLocation.removeFirstSegments(n);

                        IPath up = new Path("..");
                        for(n = projectLocation.segmentCount() - n; n > 0; --n)
                        {
                            result = up.append(result);
                        }
                        // The devices must match, so remove it.
                        result = result.setDevice(null);
                    }
                    _includes.add(result.toString());
                }
            }
        });
        Button but2 = new Button(c2, SWT.PUSH);
        but2.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but2.setText("Remove");
        but2.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                _includes.remove(_includes.getSelectionIndices());
            }
        });
        Button but3 = new Button(c2, SWT.PUSH);
        but3.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but3.setText("Up");
        but3.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                int index = _includes.getSelectionIndex();
                if(index > 0)
                {
                    String[] items = _includes.getItems();
                    String tmp = items[index-1];
                    items[index-1] = items[index];
                    items[index] = tmp;
                    _includes.setItems(items);
                    _includes.setSelection(index-1);
                }
            }
        });
        Button but4 = new Button(c2, SWT.PUSH);
        but4.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but4.setText("Down");
        but4.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                int index = _includes.getSelectionIndex();
                if(index != -1)
                {
                    String[] items = _includes.getItems();
                    if(index != items.length-1)
                    {
                        String tmp = items[index+1];
                        items[index+1] = items[index];
                        items[index] = tmp;
                        _includes.setItems(items);
                        _includes.setSelection(index+1);
                    }
                }
            }
        });

        return composite;
    }

    private Control createLinkList(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 2;
        composite.setLayout(gridLayout);
        composite.setLayoutData(new GridData(GridData.FILL_BOTH));

        _jars = new List(composite, SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI | SWT.BORDER);
        _jars.setLayoutData(new GridData(GridData.FILL_BOTH));

        Composite c2 = new Composite(composite, SWT.NONE);

        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        c2.setLayout(gridLayout);

        Button but1 = new Button(c2, SWT.PUSH);
        but1.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but1.setText("Add");
        but1.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                FileDialog dialog = new FileDialog(getShell());
                dialog.setFilterPath(_config.getJarDir());
                dialog.setFilterExtensions(new String[] { "*.jar" });
                String file = dialog.open();
                if(file != null)
                {
                    String selected[] = dialog.getFileNames();
                    for(int i = 0; i < selected.length; ++i)
                    {
                        Path p = new Path(selected[i]);
                        _jars.add(p.lastSegment());
                    }
                }
            }
        });
        Button but2 = new Button(c2, SWT.PUSH);
        but2.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        but2.setText("Remove");
        but2.addSelectionListener(new SelectionAdapter()
        {
            public void widgetSelected(SelectionEvent e)
            {
                _jars.remove(_jars.getSelectionIndices());
            }
        });

        return composite;
    }

    private String semiFilter(String text)
    {
        java.util.List<String> l = Arrays.asList(text.split(";"));
        StringBuffer sb = new StringBuffer();
        for(Iterator<String> p = l.iterator(); p.hasNext();)
        {
            String n = p.next().trim();
            if(n.length() > 0)
            {
                if(sb.length() != 0)
                {
                    sb.append(';');
                }
                sb.append(n);
            }
        }
        return sb.toString();
    }

    private Control createDefines(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        gridLayout.marginLeft = 0;
        gridLayout.marginTop = 0;
        gridLayout.marginBottom = 0;
        composite.setLayout(gridLayout);
        composite.setLayoutData(new GridData(GridData.FILL_BOTH));

        Label l = new Label(composite, SWT.WRAP);
        l.setText("Enter macros (';' separated). For example, enter FOO;BAR to define -DFOO -DBAR.");
        GridData gridData = new GridData(GridData.FILL_BOTH);
        gridData.widthHint = 400;
        l.setLayoutData(gridData);

        _defines = new Text(composite, SWT.BORDER);
        _defines.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        _defines.addFocusListener(new FocusListener()
        {
            public void focusGained(FocusEvent e)
            {
            }

            public void focusLost(FocusEvent e)
            {
                Text t = (Text)e.widget;
                String f = t.getText();
                String filtered = semiFilter(f);
                if(!f.equals(filtered))
                {
                    t.setText(filtered);
                }
            }

        });

        return composite;
    }

    private Control createMeta(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        gridLayout.marginLeft = 0;
        gridLayout.marginTop = 0;
        gridLayout.marginBottom = 0;
        composite.setLayout(gridLayout);
        composite.setLayoutData(new GridData(GridData.FILL_BOTH));

        Label l = new Label(composite, SWT.WRAP);
        l.setText("Enter metadata (';' separated). For example, enter java:java2 to define --meta=java:java2.");
        GridData gridData = new GridData(GridData.FILL_BOTH);
        gridData.widthHint = 400;
        l.setLayoutData(gridData);

        _meta = new Text(composite, SWT.BORDER);
        _meta.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        _meta.addFocusListener(new FocusListener()
        {
            public void focusGained(FocusEvent e)
            {
            }

            public void focusLost(FocusEvent e)
            {
                Text t = (Text)e.widget;
                String f = t.getText();
                String filtered = semiFilter(f);
                if(!f.equals(filtered))
                {
                    t.setText(filtered);
                }
            }
        });

        return composite;
    }

    private Control createOptions(Composite parent)
    {
        Composite composite = new Composite(parent, SWT.NONE);

        GridLayout gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        composite.setLayout(gridLayout);

        Group includesGroup = new Group(composite, SWT.NONE);
        includesGroup.setText("Location of Include Files");
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        includesGroup.setLayout(gridLayout);
        includesGroup.setLayoutData(new GridData(GridData.FILL_BOTH));

        createIncludes(includesGroup);

        Group definesGroup = new Group(composite, SWT.NONE);
        definesGroup.setText("Preprocessor Definitions");
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        definesGroup.setLayout(gridLayout);
        definesGroup.setLayoutData(new GridData(GridData.FILL_BOTH));

        createDefines(definesGroup);

        Group metaGroup = new Group(composite, SWT.NONE);
        metaGroup.setText("Metadata Definitions");
        gridLayout = new GridLayout();
        gridLayout.numColumns = 1;
        metaGroup.setLayout(gridLayout);
        metaGroup.setLayoutData(new GridData(GridData.FILL_BOTH));

        createMeta(metaGroup);

        Group optionsGroup = new Group(composite, SWT.NONE);

        gridLayout = new GridLayout();
        gridLayout.numColumns = 6;
        optionsGroup.setText("Options");
        optionsGroup.setLayout(gridLayout);
        optionsGroup.setLayoutData(new GridData(GridData.FILL_BOTH));

        _stream = new Button(optionsGroup, SWT.CHECK);
        _stream.setText("Enable streaming");
        _tie = new Button(optionsGroup, SWT.CHECK);
        _tie.setText("Enable tie");
        _ice = new Button(optionsGroup, SWT.CHECK);
        _ice.setText("Enable ice");
        _iceInclude = new Button(optionsGroup, SWT.CHECK);
        _iceInclude.setText("Include Ice Slice Files");
        _console = new Button(optionsGroup, SWT.CHECK);
        _console.setText("Enable console");

        return composite;
    }

    private IProject getProject()
    {
        IAdaptable a = getElement();
        if(a instanceof IProject)
        {
            return (IProject)a;
        }
        else if(a instanceof IJavaProject)
        {
            return ((IJavaProject)a).getProject();
        }
        else
        {
            assert(false);
            return null;
        }
    }

    private Configuration _config;
    private Button _console;
    private Text _generatedDir;
    private List _sourceDirectories;
    private List _includes;
    private List _jars;
    private Text _defines;
    private Button _stream;
    private Button _tie;
    private Button _ice;
    private Text _meta;
}