AbstractSrcUpdateCommand.java

/**
 * Copyright (C) 2005 - 2011  Eric Van Dewoestine
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.eclim.plugin.dltk.command.src;

import java.util.ArrayList;
import java.util.List;

import org.eclim.command.CommandLine;
import org.eclim.command.Error;
import org.eclim.command.Options;

import org.eclim.plugin.core.command.AbstractCommand;

import org.eclim.plugin.core.util.ProjectUtils;

import org.eclim.plugin.dltk.util.DltkUtils;

import org.eclim.util.file.FileOffsets;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IncrementalProjectBuilder;

import org.eclipse.core.runtime.NullProgressMonitor;

import org.eclipse.dltk.ast.parser.ISourceParser;
import org.eclipse.dltk.ast.parser.SourceParserManager;

import org.eclipse.dltk.compiler.env.IModuleSource;

import org.eclipse.dltk.compiler.problem.AbstractProblemReporter;
import org.eclipse.dltk.compiler.problem.IProblem;

/**
 * Abstract super class for dltk source update commands.
 *
 * @author Eric Van Dewoestine
 */
public abstract class AbstractSrcUpdateCommand
  extends AbstractCommand
{
  /**
   * {@inheritDoc}
   */
  public Object execute(CommandLine commandLine)
    throws Exception
  {
    String file = commandLine.getValue(Options.FILE_OPTION);
    String projectName = commandLine.getValue(Options.PROJECT_OPTION);

    IProject project = ProjectUtils.getProject(projectName, true);
    IFile ifile = ProjectUtils.getFile(project, file);

    // validate the src file.
    if(commandLine.hasOption(Options.VALIDATE_OPTION)){

      Reporter reporter = new Reporter();
      parse(project, ifile, reporter);

      String filepath = ProjectUtils.getFilePath(project, file);
      FileOffsets offsets = FileOffsets.compile(filepath);
      ArrayList<Error> errors = new ArrayList<Error>();
      for(IProblem problem : reporter.getProblems()){
        int[] lineColumn = offsets.offsetToLineColumn(problem.getSourceStart());
        errors.add(new Error(
            problem.getMessage(),
            filepath,
            lineColumn[0],
            lineColumn[1],
            problem.isWarning()
        ));
      }

      if(commandLine.hasOption(Options.BUILD_OPTION)){
        project.build(
            IncrementalProjectBuilder.INCREMENTAL_BUILD,
            new NullProgressMonitor());
      }
      return errors;
    }
    return null;
  }

  /**
   * Parse the supplied file.
   *
   * @param project The project.
   * @param file The IFile instance for the file.
   * @param reporter The problem reporter.
   */
  protected void parse(IProject project, IFile file, Reporter reporter)
    throws Exception
  {
    // lame cast, but we have to use the SourceModule for pdt.
    IModuleSource module = (IModuleSource)DltkUtils.getSourceModule(file);
    ISourceParser parser = SourceParserManager
      .getInstance().getSourceParser(project, getNature());
    parser.parse(module, reporter);
  }

  /**
   * Gets the nature to use for the validation of the file.
   *
   * @return The eclipse nature.
   */
  protected abstract String getNature();

  protected class Reporter
    extends AbstractProblemReporter
  {
    private List<IProblem> problems = new ArrayList<IProblem>();

    public void reportProblem(IProblem problem)
    {
      problems.add(problem);
    }

    public List<IProblem> getProblems()
    {
      return problems;
    }
  }
}