com.google.eclipse.protobuf.ui/src/com/google/eclipse/protobuf/ui/util/Resources.java

/*
 * Copyright (c) 2011 Google Inc.
 *
 * All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse
 * Public License v1.0 which accompanies this distribution, and is available at
 *
 * http://www.eclipse.org/legal/epl-v10.html
 */
package com.google.eclipse.protobuf.ui.util;

import static com.google.eclipse.protobuf.ui.util.Workbenches.activeWorkbenchPage;

import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.emf.common.util.URI;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.ui.*;
import org.eclipse.ui.views.navigator.ResourceNavigator;

import com.google.inject.Singleton;

/**
 * Utility methods related to resources (e.g. files, directories.)
 *
 * @author alruiz@google.com (Alex Ruiz)
 */
@SuppressWarnings("deprecation")
@Singleton public class Resources {
  private static final IViewReference[] NO_VIEW_REFERENCES = new IViewReference[0];

  /**
   * Returns the project that contains the resource at the given URI.
   * @param resourceUri the given URI.
   * @return the project that contains the resource at the given URI, or {@code null} if the resource at the given URI
   * is not in a workspace.
   */
  public IProject project(URI resourceUri) {
    IFile file = file(resourceUri);
    return (file != null) ? file.getProject() : null;
  }

  public IProject activeProject() {
    for (IViewReference reference : viewReferencesInActivePage()) {
      IViewPart part = reference.getView(false);
      if (part instanceof ResourceNavigator) {
        ResourceNavigator navigator = (ResourceNavigator) part;
        StructuredSelection selection = (StructuredSelection) navigator.getTreeViewer().getSelection();
        IResource resource = (IResource) selection.getFirstElement();
        return resource.getProject();
      }
    }
    return null;
  }

  private IViewReference[] viewReferencesInActivePage() {
    IWorkbenchPage page = activeWorkbenchPage();
    if (page == null) {
      return NO_VIEW_REFERENCES;
    }
    IViewReference[] references = page.getViewReferences();
    return (references == null) ? NO_VIEW_REFERENCES : references;
  }

  /**
   * Indicates whether the given URI belongs to an existing file.
   * @param fileUri the URI to check, as a {@code String}.
   * @return {@code true} if the given URI belongs to an existing file, {@code false} otherwise.
   */
  public boolean fileExists(URI fileUri) {
    IFile file = file(fileUri);
    return (file != null) ? file.exists() : false;
  }

  /**
   * Returns a handle to a workspace file identified by the given URI.
   * @param uri the given URI.
   * @return a handle to a workspace file identified by the given URI or
   * {@code null} if the URI does not belong to a workspace file.
   */
  public IFile file(URI uri) {
    IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
    IPath path = pathOf(uri);
    return (path != null) ? root.getFile(path) : null;
  }

  /**
   * Returns the project owning the file displayed in the given editor.
   * @param editor the given editor.
   * @return the project owning the file displayed in the given editor.
   */
  public IProject project(IEditorPart editor) {
    IResource resource = resourceFrom(editor);
    return (resource == null) ? null : resource.getProject();
  }

  private IResource resourceFrom(IEditorPart editor) {
    if (editor == null) {
      return null;
    }
    Object adapter = editor.getEditorInput().getAdapter(IResource.class);
    return (adapter == null) ? null : (IResource) adapter;
  }

  private IPath pathOf(URI uri) {
    String platformUri = uri.toPlatformString(true);
    return (platformUri != null) ? new Path(platformUri) : null;
  }
}