CabalFormEditor.java

// Copyright (c) 2008 by Leif Frenzel - see http://leiffrenzel.de
// This code is made available under the terms of the Eclipse Public License,
// version 1.0 (EPL). See http://www.eclipse.org/legal/epl-v10.html
package net.sf.eclipsefp.haskell.ui.internal.editors.cabal;

import net.sf.eclipsefp.haskell.core.cabalmodel.CabalSyntax;
import net.sf.eclipsefp.haskell.core.cabalmodel.PackageDescription;
import net.sf.eclipsefp.haskell.core.cabalmodel.PackageDescriptionStanza;
import net.sf.eclipsefp.haskell.ui.HaskellUIPlugin;
import net.sf.eclipsefp.haskell.ui.internal.editors.cabal.forms.overview.OverviewPage;
import net.sf.eclipsefp.haskell.ui.internal.editors.cabal.forms.stanzas.BenchmarksPage;
import net.sf.eclipsefp.haskell.ui.internal.editors.cabal.forms.stanzas.ExecutablesPage;
import net.sf.eclipsefp.haskell.ui.internal.editors.cabal.forms.stanzas.LibraryPage;
import net.sf.eclipsefp.haskell.ui.internal.editors.cabal.forms.stanzas.TestSuitesPage;
import net.sf.eclipsefp.haskell.ui.internal.util.UITexts;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.text.IDocument;
import org.eclipse.osgi.util.NLS;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.IFileEditorInput;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.forms.editor.FormEditor;
import org.eclipse.ui.ide.FileStoreEditorInput;
import org.eclipse.ui.texteditor.IStatusField;
import org.eclipse.ui.texteditor.ITextEditorExtension;

/** <p>an editor for Cabal package description files.</p>
  *
  * <p>Note: this class is declared in <code>plugin.xml</code>.</p>
  *
  * @author Leif Frenzel
  */
public class CabalFormEditor extends FormEditor implements ITextEditorExtension{
  public static final String ID="net.sf.eclipsefp.haskell.ui.internal.editors.cabal.CabalFormEditor";
  private CabalEditor cabalSourceEditor;
  private PackageDescription packageDescription;
  private OverviewPage overview;
  private LibraryPage library;
  private ExecutablesPage executables;
  private TestSuitesPage testSuites;
  private BenchmarksPage benchmarks;
  private IFileEditorInput fileInput;

  public PackageDescription getPackageDescription() {
    return packageDescription;
  }


  public void setPackageDescription( final PackageDescription packageDescription ) {
    this.packageDescription = packageDescription;
    cabalSourceEditor.setPackageDescription( packageDescription );
    if (overview!=null){
      overview.setPackageDescription( packageDescription );
      library.setPackageDescription( packageDescription );
      executables.setPackageDescription( packageDescription );
      testSuites.setPackageDescription( packageDescription );
      benchmarks.setPackageDescription( packageDescription );
    }
  }

  public IDocument getModel() {
    IDocument result = null;
    if( cabalSourceEditor != null ) {
      result = cabalSourceEditor.getDocument();
    }
    return result;
  }


  public CabalEditor getCabalSourceEditor() {
    return cabalSourceEditor;
  }

  public OverviewPage getOverview() {
    return overview;
  }

  public LibraryPage getLibrary() {
    return library;
  }

  public ExecutablesPage getExecutables() {
    return executables;
  }

  public TestSuitesPage getTestSuites() {
    return testSuites;
  }


  public BenchmarksPage getBenchmarks() {
    return benchmarks;
  }

  // interface methdods of FormEditor
  ///////////////////////////////////

  @Override
  protected void addPages() {
    try {
      IProject project = null;
      if (fileInput!=null){
        project = fileInput.getFile().getProject();
        if (project!=null){
          overview = new OverviewPage( this, project );
          addPage(overview);
          library = new LibraryPage( this, project );
          addPage(library);
          executables = new ExecutablesPage( this, project );
          addPage(executables);
          testSuites = new TestSuitesPage( this, project );
          addPage(testSuites);
          benchmarks = new BenchmarksPage( this, project );
          addPage(benchmarks);
        }
      }
      cabalSourceEditor = new CabalEditor(this);
      addPage( cabalSourceEditor, getEditorInput() );
      setPageText(project!=null? 5 : 0, UITexts.cabalFormEditor_tabSource );
    } catch( final CoreException cex ) {
      HaskellUIPlugin.log( "Unable to create form pages.", cex ); //$NON-NLS-1$
    }
  }


  @Override
  public void doSave( final IProgressMonitor monitor ) {
    if( cabalSourceEditor != null ) {
      cabalSourceEditor.doSave( monitor );
    }
  }

  @Override
  public void doSaveAs() {
    if( cabalSourceEditor != null ) {
      cabalSourceEditor.doSaveAs();
    }
  }

  @Override
  public boolean isSaveAsAllowed() {
    boolean result = false;
    if( cabalSourceEditor != null ) {
      result = cabalSourceEditor.isSaveAsAllowed();
    }
    return result;
  }

  @Override
  public void init( final IEditorSite site,
                    final IEditorInput input ) throws PartInitException {
    super.init( site, input );
    if( input instanceof IFileEditorInput ) {
      fileInput = ( IFileEditorInput )input;
      setPartName( fileInput.getFile().getName() );
    } else if (input instanceof FileStoreEditorInput){
      // minimal support
      setPartName( input.getName() );
    } else {
      HaskellUIPlugin.log( NLS.bind( UITexts.unsupported_input, this.getClass().getName(),input.getClass().getName() ), IStatus.WARNING );
    }
  }

  /**
   * show the appropriate gui page in the form editor for the given stanza
   * @param stanza
   */
  public void selectAndReveal(final PackageDescriptionStanza stanza){
    if (CabalSyntax.SECTION_LIBRARY.equals( stanza.getType() )){
      setActivePage( library.getId() );
    } else if (CabalSyntax.SECTION_EXECUTABLE.equals( stanza.getType() )){
      setActivePage( executables.getId() );
      executables.selectStanza( stanza );
    } else if (CabalSyntax.SECTION_TESTSUITE.equals( stanza.getType() )){
      setActivePage( testSuites.getId() );
      testSuites.selectStanza( stanza );
    } else if (CabalSyntax.SECTION_BENCHMARK.equals( stanza.getType() )){
      setActivePage( benchmarks.getId() );
      benchmarks.selectStanza( stanza );
    } else {
      setActivePage(pages.size()-1);
      cabalSourceEditor.selectAndReveal( stanza );
    }
  }

  // interface methods of IAdaptable
  //////////////////////////////////

  @Override
  public Object getAdapter(
      @SuppressWarnings("rawtypes") final Class adapter ) {
    Object result = super.getAdapter( adapter );
    if( result == null && cabalSourceEditor != null ) {
      result = cabalSourceEditor.getAdapter( adapter );
    }
    return result;
  }

   @Override
  public void addRulerContextMenuListener( final IMenuListener paramIMenuListener ) {
     if (cabalSourceEditor!=null){
       cabalSourceEditor.addRulerContextMenuListener( paramIMenuListener );
     }
  }

   @Override
  public void removeRulerContextMenuListener( final IMenuListener paramIMenuListener ) {
     if (cabalSourceEditor!=null){
       cabalSourceEditor.removeRulerContextMenuListener( paramIMenuListener );
     }
  }

   @Override
  public boolean isEditorInputReadOnly() {
     if (cabalSourceEditor!=null){
       return cabalSourceEditor.isEditorInputReadOnly();
     }
    return false;
  }

   @Override
  public void setStatusField( final IStatusField paramIStatusField, final String paramString ) {
     if (cabalSourceEditor!=null){
       cabalSourceEditor.setStatusField( paramIStatusField, paramString );
     }
  }
}