ruta-ep-ide-ui/src/main/java/org/apache/uima/ruta/ide/formatter/RutaFormatter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.uima.ruta.ide.formatter;

import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import java.util.List;
import java.util.Map;

import org.antlr.runtime.BitSet;
import org.antlr.runtime.CommonToken;
import org.antlr.runtime.CommonTokenStream;
import org.apache.commons.lang3.StringUtils;
import org.apache.uima.ruta.engine.RutaEngine;
import org.apache.uima.ruta.ide.core.parser.RutaSourceParser;
import org.eclipse.dltk.ast.declarations.ModuleDeclaration;
import org.eclipse.dltk.ast.parser.IModuleDeclaration;
import org.eclipse.dltk.compiler.problem.IProblem;
import org.eclipse.dltk.compiler.problem.IProblemReporter;
import org.eclipse.dltk.formatter.AbstractScriptFormatter;
import org.eclipse.dltk.formatter.FormatterDocument;
import org.eclipse.dltk.ui.formatter.FormatterException;
import org.eclipse.text.edits.MultiTextEdit;
import org.eclipse.text.edits.ReplaceEdit;
import org.eclipse.text.edits.TextEdit;

public class RutaFormatter extends AbstractScriptFormatter {

  class DummyReporter implements IProblemReporter {

    private boolean gotProblems = false;

    public void reportProblem(IProblem problem) {
      setProblems(true);
    }

    public void setProblems(boolean gotProblems) {
      this.gotProblems = gotProblems;
    }

    public boolean gotProblems() {
      return gotProblems;
    }
  };

  protected static final String[] INDENTING = { RutaFormatterConstants.INDENT_BLOCK,
      RutaFormatterConstants.INDENT_STRUCTURE };

  // protected static final String[] BLANK_LINES = { };

  private final String lineDelimiter;

  public RutaFormatter(String lineDelimiter, Map preferences) {
    super(preferences);
    this.lineDelimiter = lineDelimiter;
  }

  public TextEdit format(String source, int offset, int length, int indent)
          throws FormatterException {
    String input = source;
    // TODO implement useful format for code snippets
    // final String input = source.substring(offset, offset + length);
    if (StringUtils.isEmpty(input)) {
      return null;
    }
    RutaSourceParser tmsp = new RutaSourceParser();

    DummyReporter reporter = new DummyReporter();
    IModuleDeclaration md = tmsp.parse("format" + RutaEngine.SCRIPT_FILE_EXTENSION, source,
            reporter);
    CommonTokenStream tokenStream = tmsp.getTokenStream();

    if (!reporter.gotProblems()) {

      BitSet bs = new BitSet();
      bs.add(org.apache.uima.ruta.parser.RutaParser.LINE_COMMENT);
      bs.add(org.apache.uima.ruta.parser.RutaParser.COMMENT);
      List<CommonToken> comments = (List<CommonToken>) tokenStream.getTokens(0, tokenStream.size(), bs);

      final String output = format(input, (ModuleDeclaration) md, comments, indent);
      if (output != null) {
        if (!input.equals(output)) {
          return new ReplaceEdit(0, source.length(), output);
          // return new ReplaceEdit(offset, length, output);
          // if (!equalsIgnoreBlanks(new StringReader(input), new StringReader(output))) {
          // // return new MultiTextEdit();
          // return new ReplaceEdit(offset, length, output);
          // } else {
          // // TODO reset throwing exception
          // return new MultiTextEdit();
          // // throw new IllegalArgumentException("illegal format context");
          // // System.err.println("illegal format context");
          // }
        } else {
          return new MultiTextEdit();
        }
      }
    }
    return null;
  }

  /**
   * @param input
   * @param md
   * @param indent
   * @return the formatted code
   */
  private String format(String input, ModuleDeclaration md, List<CommonToken> comments, int indent) {
    final FormatterDocument document = createDocument(input);

    // compute new (formatted) document structure
    RutaFormattedPrinter tmfp = new RutaFormattedPrinter(document, lineDelimiter,
            createIndentGenerator(), comments, this);
    try {
      md.traverse(tmfp);
    } catch (Exception e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
    }
    return tmfp.getOutput();

    // // compute new (formatted) document structure
    // final RutaFormatterNodeBuilder builder = new RutaFormatterNodeBuilder();
    // IFormatterContainerNode root = builder.build(md, document);
    // // new RutaFormatterNodeRewriter(result, document).rewrite(root);
    // IFormatterContext context = new FormatterContext(indent);
    // FormatterWriter writer = new FormatterWriter(document, lineDelimiter,
    // createIndentGenerator());
    // try {
    // root.accept(context, writer);
    // writer.flush(context);
    // return writer.getOutput();
    // } catch (Exception e) {
    // e.printStackTrace();
    // return null;
    // }
  }

  /**
   * Factory method for FormatterDocuments that represent the content with formatting options.<br>
   * No formatting operations done in this method and no formatting done with the content of the
   * formatterDocument in general.
   * 
   * @param input
   * @return
   */
  private FormatterDocument createDocument(String input) {
    FormatterDocument document = new FormatterDocument(input);
    for (int i = 0; i < INDENTING.length; ++i) {
      document.setBoolean(INDENTING[i], getBoolean(INDENTING[i]));
    }
    document.setInt(RutaFormatterConstants.FORMATTER_TAB_SIZE,
            getInt(RutaFormatterConstants.FORMATTER_TAB_SIZE));
    return document;
  }

  private boolean equalsIgnoreBlanks(Reader inputReader, Reader outputReader) {
    LineNumberReader input = new LineNumberReader(inputReader);
    LineNumberReader output = new LineNumberReader(outputReader);
    for (;;) {
      final String inputLine = readLine(input);
      final String outputLine = readLine(output);
      if (inputLine == null) {
        if (outputLine == null) {
          return true;
        } else {
          return false;
        }
      } else if (outputLine == null) {
        return false;
      } else if (!inputLine.equals(outputLine)) {
        return false;
      }
    }
  }

  private String readLine(LineNumberReader reader) {
    String line;
    do {
      try {
        line = reader.readLine();
      } catch (IOException e) {
        return null; // just doing sth.
      }
      if (line == null) {
        return line;
      }
      line = line.trim();
    } while (line.length() == 0);
    return line;
  }

  @Override
  public int getInt(String key) {
    return super.getInt(key);
  }

  @Override
  protected boolean getBoolean(String key) {
    return super.getBoolean(key);
  }

  @Override
  protected String getString(String key) {
    return super.getString(key);
  }

}