org.walkmod.sonar.visitors.RemoveCodeComment Maven / Gradle / Ivy

Go to download
/*
 * SYSTEMi Copyright © 2015, MetricStream, Inc. All rights reserved.
 * 
 * Walkmod is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Walkmod 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Walkmod.  If not, see .
 * 
 * @author Mohanasundar N([email protected])
 * created 05/01/2015
 */

package org.walkmod.sonar.visitors;

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

import org.walkmod.javalang.ASTManager;
import org.walkmod.javalang.ast.Comment;
import org.walkmod.javalang.ast.CompilationUnit;
import org.walkmod.javalang.ast.LineComment;
import org.walkmod.javalang.ast.stmt.Statement;
import org.walkmod.javalang.visitors.VoidVisitorAdapter;
import org.walkmod.walkers.VisitorContext;

/**
 * The Class RemoveCodeComment.
 *
 * @author mohanasundar.n
 */
public class RemoveCodeComment extends VoidVisitorAdapter {

   /** The start with list. */
   private List startWithList;

   /**
    * Instantiates a new removes the code comment.
    */
   public RemoveCodeComment() {
      this.startWithList = new ArrayList();
   }

   /**
    * Sets the start with list.
    *
    * @param startWithList
    *           the new start with list
    */
   public void setStartWithList(String startWithList) {
      if (startWithList != null) {
         String[] startWithLists = startWithList.split(",");
         for (int i = 0; i < startWithLists.length; i++) {
            this.startWithList.add(startWithLists[i].trim());
         }
      }
   }

   /*
    * (non-Javadoc)
    * 
    * @see org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.
    * CompilationUnit, java.lang.Object)
    */
   @Override
   public void visit(CompilationUnit n, VisitorContext arg) {
      List comments = n.getComments();
      if (comments != null) {
         for (int i = 0; i < comments.size();) {
            Comment comment = comments.get(i);
            if (canRemoved(comment)) {
               comments.remove(i);
               continue;
            }
            i++;
         }
      }
      n.setComments(comments);
   }

   private boolean requiresToDelete(String code) {
      try {
         if(code.trim().endsWith("{")){
            return true;
         }
         if (!code.startsWith("{")) {
            code = "{" + code + "}";
         }
         ASTManager.parse(Statement.class, code);

         return true;
      } catch (Throwable e) {
      }
      return false;
   }

   /**
    * Can removed.
    *
    * @param comment
    *           the comment
    * @return true, if successful
    */
   private boolean canRemoved(Comment comment) {
      String str = comment.getContent();

      if (requiresToDelete(str)) {
         return true;
      }
      if (comment instanceof LineComment) {
         for (String string : startWithList) {
            if (str.trim().startsWith(string)) {
               return true;
            }
         }
      }
      return false;
   }
}