/*

  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

  *

  * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

  *

  * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

  * Other names may be trademarks of their respective owners.

  *

  * The contents of this file are subject to the terms of either the GNU

  * General Public License Version 2 only ("GPL") or the Common

  * Development and Distribution License("CDDL") (collectively, the

  * "License"). You may not use this file except in compliance with the

  * License. You can obtain a copy of the License at

  * http://www.netbeans.org/cddl-gplv2.html

  * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

  * specific language governing permissions and limitations under the

  * License.  When distributing the software, include this License Header

  * Notice in each file and include the License file at

  * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

  * particular file as subject to the "Classpath" exception as provided

  * by Oracle in the GPL Version 2 section of the License file that

  * accompanied this code. If applicable, add the following below the

  * License Header, with the fields enclosed by brackets [] replaced by

  * your own identifying information:

  * "Portions Copyrighted [year] [name of copyright owner]"

  *

  * Contributor(s):

  *

  * The Original Software is NetBeans. The Initial Developer of the Original

  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

  * Microsystems, Inc. All Rights Reserved.

  *

  * If you wish your version of this file to be governed by only the CDDL

  * or only the GPL Version 2, indicate your decision by adding

  * "[Contributor] elects to include this software in this distribution

  * under the [CDDL or GPL Version 2] license." If you do not indicate a

  * single choice of license, a recipient has the option to distribute

  * your version of this file under either the CDDL, the GPL Version 2 or

  * to extend the choice of license to its licensees as provided above.

  * However, if you add GPL Version 2 code and therefore, elected the GPL

  * Version 2 license, then the option applies only if the new code is

  * made subject to such option by the copyright holder.

  */

 package org.netbeans.modules.ruby;

 import java.util.Collections;

 import java.util.HashSet;

 import java.util.Set;

 import org.jrubyparser.ast.ArgsNode;

 import org.jrubyparser.ast.ArgumentNode;

 import org.jrubyparser.ast.BlockArgNode;

 import org.jrubyparser.ast.ListNode;

 import org.jrubyparser.ast.LocalAsgnNode;

 import org.jrubyparser.ast.LocalVarNode;

 import org.jrubyparser.ast.MethodDefNode;

 import org.jrubyparser.ast.Node;

 import org.jrubyparser.ast.NodeType;

 import org.jrubyparser.ast.INameNode;

 import org.jrubyparser.SourcePosition;

 import org.jrubyparser.ast.AssignableNode;

 import org.jrubyparser.ast.ILocalScope;

 import org.jrubyparser.ast.ILocalVariable;

 import org.netbeans.modules.csl.api.InstantRenamer;

 import org.netbeans.modules.csl.api.OffsetRange;

 import org.netbeans.modules.csl.spi.ParserResult;

 import org.netbeans.modules.ruby.lexer.LexUtilities;

 import org.openide.util.NbBundle;

 /**

  * Handle renaming of local elements

  * @todo I should be able to rename top-level methods as well since they

  *   are private

  * @todo Rename |j| in the following will only rename "j" inside the block!

  * <pre>

 i = 50

 j = 200

 k = 100

 x = [1,2,3]

 x.each do |j|

   puts j

 end

 puts j

  * </pre>

  * @todo When you fix, make sure BlockarReuse is also fixed!

  * @todo Try renaming "hello" in the exception here; my code is confused

  *   about what I'm renaming (aliases method name) and the refactoring dialog

  *   name is wrong! This is happening because it's also changing GlobalAsgnNode for $!

  *   but its parent is LocalAsgnNode, and -its- -grand- parent is a RescueBodyNode! 

  *   I should special case this!

  * <pre>

 def hello

   begin

     ex = 50

     puts "test"

   rescue Exception => hello

     puts hello

   end

 end

  *

  * </pre>

  *

  * @author Tor Norbye

  */

 public class RubyRenameHandler implements InstantRenamer {

     public RubyRenameHandler() {

     }

     @Override

     public boolean isRenameAllowed(ParserResult info, int caretOffset, String[] explanationRetValue) {

         Node root = AstUtilities.getRoot(info);

         if (root == null) {

             explanationRetValue[0] = NbBundle.getMessage(RubyRenameHandler.class, "NoRenameWithErrors");

             return false;

         }

         Node closest = root.getNodeAt(AstUtilities.getAstOffset(info, caretOffset));

         if (closest == null) return false;

         if (closest instanceof ILocalVariable) return true;  // All local block/method vars can be renamed

         switch (closest.getNodeType()) {

         case INSTASGNNODE: case INSTVARNODE: case CLASSVARDECLNODE: case CLASSVARNODE: case CLASSVARASGNNODE:

         case GLOBALASGNNODE: case GLOBALVARNODE: case CONSTDECLNODE: case CONSTNODE: case DEFNNODE: case DEFSNODE:

         case FCALLNODE: case CALLNODE: case VCALLNODE: case COLON2NODE: case COLON3NODE: case ALIASNODE:

         case SYMBOLNODE: // TODO - what about the string arguments in an alias node? Gotta check those

             return true;

         }

         return false;

     }

     @Override

     public Set<OffsetRange> getRenameRegions(ParserResult info, int caretOffset) {

         Node root = AstUtilities.getRoot(info);

         if (root == null) return Collections.emptySet();

         Set<OffsetRange> regions = new HashSet<OffsetRange>();

         int astOffset = AstUtilities.getAstOffset(info, caretOffset);

         if (astOffset == -1) return Collections.emptySet();

         AstPath path = new AstPath(root, astOffset);

         Node closest = path.leaf();

         if (closest == null) return Collections.emptySet();

         if (closest.isBlockParameter()) {

             ILocalVariable blockParameter = (ILocalVariable) closest;

             for (ILocalVariable occurrence: blockParameter.getOccurrences()) {

                 OffsetRange range = LexUtilities.getLexerOffsets(info, 

                         AstUtilities.offsetRangeFor(occurrence.getLexicalNamePosition()));

                 if (range != OffsetRange.NONE) regions.add(range);

             }         

         } else if (closest instanceof LocalVarNode || closest instanceof LocalAsgnNode) {

             // A local variable read or a parameter read, or an assignment to one of these

             String name = ((INameNode)closest).getName();

             Node localScope = AstUtilities.findLocalScope(closest, path);

             if (localScope == null) {

                 // Use parent, possibly Grand Parent if we have a newline node in the way

                 localScope = path.leafParent();

                 if (localScope.getNodeType() == NodeType.NEWLINENODE) localScope = path.leafGrandParent();

                 if (localScope == null) localScope = closest;

             }

             addLocals(info, localScope, name, regions);

         } else if (closest.getNodeType() == NodeType.DVARNODE || closest.getNodeType() == NodeType.DASGNNODE) {

             // 1.8-style block declaration: iter { dasgn }

             String name = ((INameNode)closest).getName();

             for (Node block : AstUtilities.getApplicableBlocks(path, true)) {

                 addDynamicVars(info, block, name, regions);

             }

         } else if (closest.getNodeType() == NodeType.ARGUMENTNODE || closest.getNodeType() == NodeType.BLOCKARGNODE) {

             // A method name (if under a DefnNode or DefsNode) or a parameter (if indirectly under an ArgsNode)

             String name = ((INameNode)closest).getName();

             Node parent = path.leafParent();

             if (parent != null) {

                 // Make sure it's a parameter, not a method

                 if (!(parent instanceof MethodDefNode)) {

                     // Parameter (check to see if its under ArgumentNode)

                     Node method = AstUtilities.findMethodAtOffset(root, astOffset);

                     if (method == null) method = AstUtilities.findBlock(path);

                     if (method == null) {

                         // Use parent, possibly Grand Parent if we have a newline node in the way

                         method = path.leafParent();

                         if (method.getNodeType() == NodeType.NEWLINENODE) method = path.leafGrandParent();

                         if (method == null) method = closest;

                     }

                     addLocals(info, method, name, regions);

                 }

             }

         }

         return regions;

     }

     private void addLocals(ParserResult info, Node node, String name, Set<OffsetRange> ranges) {

         if (node.getNodeType() == NodeType.LOCALVARNODE) {

             if (((INameNode)node).getName().equals(name)) {

                 OffsetRange range = AstUtilities.getRange(node);

                 range = LexUtilities.getLexerOffsets(info, range);

                 if (range != OffsetRange.NONE) ranges.add(range);

             }

         } else if (node.getNodeType() == NodeType.LOCALASGNNODE) {

             if (((INameNode)node).getName().equals(name)) {

                 OffsetRange range = AstUtilities.getRange(node);

                 // Adjust end offset to only include the left hand size

                 range = new OffsetRange(range.getStart(), range.getStart() + name.length());

                 range = LexUtilities.getLexerOffsets(info, range);

                 if (range != OffsetRange.NONE) ranges.add(range);

             }

         } else if (node.getNodeType() == NodeType.ARGSNODE) {

             addArgsNode(node, name, info, ranges);

         }

         for (Node child : node.childNodes()) {

             addLocals(info, child, name, ranges);

         }

     }

     // TODO: Check

     //  quick tip renaming

     //  unused detection

     //  occurrences marking

     //  code completion

     //  live code templates

     // ...anyone else who calls findBlock

     //

     // Test both parent blocks, sibling blocks and descendant blocks

     // Make sure the "isUsed" detection is smarter too.

     private void addDynamicVars(ParserResult info, Node node, String name, Set<OffsetRange> ranges) {

         switch (node.getNodeType()) {

         case DVARNODE:

             if (((INameNode)node).getName().equals(name)) {

                 OffsetRange range = LexUtilities.getLexerOffsets(info, AstUtilities.getRange(node));

                 if (range != OffsetRange.NONE) ranges.add(range);

             }

             break;

         case DASGNNODE:

             if (((INameNode)node).getName().equals(name)) {

                 OffsetRange range = AstUtilities.offsetRangeFor(((AssignableNode) node).getLeftHandSidePosition());

                 range = LexUtilities.getLexerOffsets(info, range);

                 if (range != OffsetRange.NONE) ranges.add(range);

             }

             break;

         case ARGSNODE:

             addArgsNode(node, name, info, ranges);

         }

         for (Node child : node.childNodes()) {

             if (child instanceof ILocalScope || child.getNodeType() == NodeType.ITERNODE) continue;

             addDynamicVars(info, child, name, ranges);

         }

     }

     private void addArgsNode(Node node, String name, ParserResult info, Set<OffsetRange> ranges) {

         ArgsNode an = (ArgsNode)node;

         if (an.getRequiredCount() > 0) {

             for (Node arg : an.childNodes()) {

                 if (!(arg instanceof ListNode)) continue;

                 for (Node arg2 : arg.childNodes()) {

                     if (arg2.getNodeType() == NodeType.ARGUMENTNODE) {

                         if (((ArgumentNode)arg2).getName().equals(name)) {

                             OffsetRange range = AstUtilities.getRange(arg2);

                             range = LexUtilities.getLexerOffsets(info, range);

                             if (range != OffsetRange.NONE) ranges.add(range);

                         }

                     } else if (arg2.getNodeType() == NodeType.LOCALASGNNODE) {

                         if (((LocalAsgnNode)arg2).getName().equals(name)) {

                             OffsetRange range = AstUtilities.getRange(arg2);

                             // Adjust end offset to only include the left hand size

                             range = new OffsetRange(range.getStart(), range.getStart() + name.length());

                             range = LexUtilities.getLexerOffsets(info, range);

                             if (range != OffsetRange.NONE) ranges.add(range);

                         }

                     }

                 }

             }

         }

         // Rest args

         if (an.getRest() != null) {

             ArgumentNode bn = an.getRest();

             if (bn.getName().equals(name)) {

                 SourcePosition pos = bn.getPosition();

                 // +1: Skip "*" and "&" prefix

                 OffsetRange range = new OffsetRange(pos.getStartOffset() + 1, pos.getEndOffset());

                 range = LexUtilities.getLexerOffsets(info, range);

                 if (range != OffsetRange.NONE) ranges.add(range);

             }

         }

         if (an.getBlock() != null) {

             BlockArgNode bn = an.getBlock();

             if (bn.getName().equals(name)) {

                 SourcePosition pos = bn.getPosition();

                 // +1: Skip "*" and "&" prefix

                 OffsetRange range = new OffsetRange(pos.getStartOffset() + 1, pos.getEndOffset());

                 range = LexUtilities.getLexerOffsets(info, range);

                 if (range != OffsetRange.NONE) ranges.add(range);

             }

         }

     }

 }