Bug 318784: DeclarationGenerator fails for some cases

https://bugs.eclipse.org/bugs/show_bug.cgi?id=318784

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/rewrite/DeclarationGeneratorImpl.java

@@ -11,80 +11,87 @@
 
 package org.eclipse.cdt.internal.core.dom.rewrite;
 
-import java.util.ArrayList;
+import java.util.HashMap;
-import java.util.List;
+import java.util.LinkedList;
+import java.util.Map;
 
+import org.eclipse.cdt.core.dom.ast.ASTTypeUtil;
 import org.eclipse.cdt.core.dom.ast.DOMException;
 import org.eclipse.cdt.core.dom.ast.IASTArrayDeclarator;
-import org.eclipse.cdt.core.dom.ast.IASTArrayModifier;
 import org.eclipse.cdt.core.dom.ast.IASTDeclSpecifier;
 import org.eclipse.cdt.core.dom.ast.IASTDeclarator;
 import org.eclipse.cdt.core.dom.ast.IASTExpression;
 import org.eclipse.cdt.core.dom.ast.IASTName;
 import org.eclipse.cdt.core.dom.ast.IASTNamedTypeSpecifier;
+import org.eclipse.cdt.core.dom.ast.IASTParameterDeclaration;
 import org.eclipse.cdt.core.dom.ast.IASTPointer;
 import org.eclipse.cdt.core.dom.ast.IASTPointerOperator;
 import org.eclipse.cdt.core.dom.ast.IASTSimpleDeclSpecifier;
+import org.eclipse.cdt.core.dom.ast.IASTStandardFunctionDeclarator;
 import org.eclipse.cdt.core.dom.ast.IArrayType;
 import org.eclipse.cdt.core.dom.ast.IBasicType;
 import org.eclipse.cdt.core.dom.ast.IBasicType.Kind;
 import org.eclipse.cdt.core.dom.ast.IBinding;
-import org.eclipse.cdt.core.dom.ast.ICompositeType;
 import org.eclipse.cdt.core.dom.ast.IFunctionType;
 import org.eclipse.cdt.core.dom.ast.INodeFactory;
 import org.eclipse.cdt.core.dom.ast.IPointerType;
 import org.eclipse.cdt.core.dom.ast.IQualifierType;
 import org.eclipse.cdt.core.dom.ast.IType;
-import org.eclipse.cdt.core.dom.ast.ITypedef;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPASTPointerToMember;
 import org.eclipse.cdt.core.dom.ast.cpp.ICPPASTQualifiedName;
 import org.eclipse.cdt.core.dom.ast.cpp.ICPPASTReferenceOperator;
 import org.eclipse.cdt.core.dom.ast.cpp.ICPPNodeFactory;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPPointerToMemberType;
 import org.eclipse.cdt.core.dom.ast.cpp.ICPPReferenceType;
 import org.eclipse.cdt.core.dom.rewrite.DeclarationGenerator;
-import org.eclipse.cdt.internal.core.dom.parser.cpp.CPPASTArrayDeclarator;
-import org.eclipse.cdt.internal.core.dom.parser.cpp.CPPASTDeclarator;
 import org.eclipse.cdt.internal.core.dom.parser.cpp.semantics.CPPVisitor;
 
 /**
  * 
  * @author Tomasz Wesolowski
- *
+ * 
  */
 public class DeclarationGeneratorImpl extends DeclarationGenerator {
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.dom.rewrite.IDeclarationGenerator#createDeclSpecFromType(org.eclipse.cdt.core.dom.ast.IType)
-	 */
-	
 	private INodeFactory factory;
-	
+
 	/**
 	 * Creates a new generator using the given factory.
-	 * @param factory a factory to use. If a C++ type is requested, it has to be an instance of {@link ICPPNodeFactory}. 
+	 * 
+	 * @param factory
+	 *            a factory to use. If a C++ type is requested, it has to be an instance of
+	 *            {@link ICPPNodeFactory}.
 	 */
 	public DeclarationGeneratorImpl(INodeFactory factory) {
 		this.factory = factory;
 	}
-	
+
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see
+	 * org.eclipse.cdt.core.dom.rewrite.IDeclarationGenerator#createDeclSpecFromType(org.eclipse.cdt.core.
+	 * dom.ast.IType)
+	 */
 	@Override
 	public IASTDeclSpecifier createDeclSpecFromType(IType type) {
-		
+
 		IASTDeclSpecifier returnedDeclSpec = null;
-		
+
 		if (type instanceof IPointerType) {
-			IType inner = ((IPointerType)type).getType();
+			IType inner = ((IPointerType) type).getType();
 			returnedDeclSpec = createDeclSpecFromType(inner);
 		} else if (type instanceof ICPPReferenceType) {
-			IType inner = ((ICPPReferenceType)type).getType();
+			IType inner = ((ICPPReferenceType) type).getType();
 			returnedDeclSpec = createDeclSpecFromType(inner);
 		} else if (type instanceof IArrayType) {
-			IType inner = ((IArrayType)type).getType();
+			IType inner = ((IArrayType) type).getType();
 			returnedDeclSpec = createDeclSpecFromType(inner);
 		} else if (type instanceof IFunctionType) {
-			IType inner = ((IFunctionType)type).getReturnType();
+			IType inner = ((IFunctionType) type).getReturnType();
 			returnedDeclSpec = createDeclSpecFromType(inner);
 		} else if (type instanceof IQualifierType) {
-			IType inner = ((IQualifierType)type).getType();
+			IType inner = ((IQualifierType) type).getType();
 			returnedDeclSpec = createDeclSpecFromType(inner);
 			if (((IQualifierType) type).isConst()) {
 				returnedDeclSpec.setConst(true);
@@ -93,16 +100,16 @@ public class DeclarationGeneratorImpl extends DeclarationGenerator {
 				returnedDeclSpec.setVolatile(true);
 			}
 		} else if (type instanceof IBasicType) {
-			Kind kind = ((IBasicType)type).getKind();
+			Kind kind = ((IBasicType) type).getKind();
 			IASTSimpleDeclSpecifier declSpec = factory.newSimpleDeclSpecifier();
 			declSpec.setType(kind);
 			returnedDeclSpec = declSpec;
-		} else if (type instanceof IBinding) { /* ITypedef, ICompositeType... */ 
+		} else if (type instanceof IBinding) { /* ITypedef, ICompositeType... */
 			// BTW - we need to distinguish (and fail explicitly) on literal composites like:
-			// struct {  } aSingleInstance;
+			// struct { } aSingleInstance;
 			returnedDeclSpec = getDeclSpecForBinding((IBinding) type);
 		}
-		
+
 		// Fallback...
 		if (returnedDeclSpec == null) {
 			IASTSimpleDeclSpecifier specifier = factory.newSimpleDeclSpecifier();
@@ -112,137 +119,184 @@ public class DeclarationGeneratorImpl extends DeclarationGenerator {
 		return returnedDeclSpec;
 	}
 
-	/* (non-Javadoc)
+	/*
-	 * @see org.eclipse.cdt.core.dom.rewrite.IDeclarationGenerator#createDeclaratorFromType(org.eclipse.cdt.core.dom.ast.IType, char[])
+	 * (non-Javadoc)
+	 * 
+	 * @see
+	 * org.eclipse.cdt.core.dom.rewrite.IDeclarationGenerator#createDeclaratorFromType(org.eclipse.cdt.core
+	 * .dom.ast.IType, char[])
 	 */
 	@Override
 	public IASTDeclarator createDeclaratorFromType(IType type, char[] name) {
-		
+
 		IASTDeclarator returnedDeclarator = null;
-	
+
 		try {
-	
+
-			if (type instanceof IPointerType || type instanceof IArrayType || type instanceof ICPPReferenceType) {
+			// Addition of pointer operators has to be in reverse order, so it's deferred until the end
-				
+			Map<IASTDeclarator, LinkedList<IASTPointerOperator>> pointerOperatorMap = new HashMap<IASTDeclarator, LinkedList<IASTPointerOperator>>();
-				IASTDeclarator declarator = createPointerOrArrayDeclarator(type, name);
+
-				returnedDeclarator = declarator;
+			IASTName newName = (name != null) ? factory.newName(name) : factory.newName();
-						
+
-			} else if (typeIrrelevantForDeclarator(type)) {
+			// If the type is an array of something, create a declaration of a pointer to something instead
-				IASTDeclarator declarator = factory.newDeclarator(null);
+			// (to allow assignment, etc)
-				IASTName astName = factory.newName(name);
+
-				declarator.setName(astName);
+			boolean replaceInitialArrayWithPointer = true;
-				
+
-				returnedDeclarator = declarator;
+			// If the type is a function, create a declaration of a pointer to this function
-				
+			// (shorthand notation for function address)
-			} else if (type instanceof IFunctionType) {
+
-				// TODO function pointers
+			boolean changeInitialFunctionToFuncPtr = true;
-				
+
-				
+			while (typeNeedsNontrivialDeclarator(type)) {
+				if (replaceInitialArrayWithPointer && type instanceof IArrayType) {
+					returnedDeclarator = factory.newDeclarator(newName);
+					returnedDeclarator.addPointerOperator(factory.newPointer());
+					type = ((IArrayType) type).getType();
+				} else if (changeInitialFunctionToFuncPtr && type instanceof IFunctionType) {
+					returnedDeclarator = factory.newDeclarator(newName);
+					returnedDeclarator.addPointerOperator(factory.newPointer());
+					// leave type as it is, next iteration will handle the function
+				} else if (type instanceof IArrayType) {
+					IArrayType arrayType = (IArrayType) type;
+					IASTArrayDeclarator arrayDeclarator = factory.newArrayDeclarator(null);
+					if (returnedDeclarator == null) {
+						arrayDeclarator.setName(newName);
+					} else {
+						arrayDeclarator.setNestedDeclarator(returnedDeclarator);
+						arrayDeclarator.setName(factory.newName());
+					}
+					// consume all immediately following array expressions
+					while (type instanceof IArrayType) {
+						arrayType = (IArrayType) type;
+						IASTExpression arraySizeExpression = arrayType.getArraySizeExpression();
+						arrayDeclarator.addArrayModifier(factory.newArrayModifier(arraySizeExpression == null
+								? null : arraySizeExpression.copy()));
+						type = arrayType.getType();
+					}
+					returnedDeclarator = arrayDeclarator;
+				} else if (isPtrOrRefType(type)) {
+					if (returnedDeclarator == null) {
+						returnedDeclarator = factory.newDeclarator(newName);
+					}
+					IASTPointerOperator ptrOp = createPointerOperator(type);
+					addPointerOperatorDeferred(pointerOperatorMap, returnedDeclarator, ptrOp);
+					type = getPtrOrRefSubtype(type);
+				} else if (type instanceof IFunctionType) {
+					IFunctionType funcType = (IFunctionType) type;
+					IASTStandardFunctionDeclarator func = factory.newFunctionDeclarator(null);
+					for (IType paramType : funcType.getParameterTypes()) {
+						IASTDeclSpecifier declspec = createDeclSpecFromType(paramType);
+						IASTDeclarator declarator = null;
+						if (typeNeedsNontrivialDeclarator(paramType)) {
+							declarator = createDeclaratorFromType(paramType, null);
+						} else {
+							declarator = factory.newDeclarator(factory.newName());
+						}
+						IASTParameterDeclaration parameterDeclaration = factory.newParameterDeclaration(
+								declspec, declarator);
+						func.addParameterDeclaration(parameterDeclaration);
+					}
+					if (returnedDeclarator == null) {
+						func.setName(newName);
+					} else {
+						func.setNestedDeclarator(returnedDeclarator);
+						func.setName(factory.newName());
+					}
+					returnedDeclarator = func;
+					type = funcType.getReturnType();
+				}
+				replaceInitialArrayWithPointer = false;
+				changeInitialFunctionToFuncPtr = false;
 			}
+			
+			finalizePointerOperators(pointerOperatorMap);
+
 		} catch (DOMException e) {
 			e.printStackTrace();
 		}
-		
+
 		// Fallback
 		if (returnedDeclarator == null) {
 			returnedDeclarator = factory.newDeclarator(factory.newName(name));
 		}
-		
+
 		return returnedDeclarator;
 	}
 
-	/**
+	private void finalizePointerOperators(
-	 * Checks if a given type isn't described by the {@link IASTDeclarator} (only by the {@link IASTDeclSpecifier}).
+			Map<IASTDeclarator, LinkedList<IASTPointerOperator>> pointerOperatorMap) {
-	 * @param type the type to check
+		for (IASTDeclarator declarator : pointerOperatorMap.keySet()) {
-	 * @return true if irrelevant
+			LinkedList<IASTPointerOperator> list = pointerOperatorMap.get(declarator);
-	 */
+			for (IASTPointerOperator op : list) {
-	private boolean typeIrrelevantForDeclarator(IType type) {
+				declarator.addPointerOperator(op);
-		return type instanceof IBasicType || type instanceof ICompositeType || type instanceof IQualifierType || type instanceof ITypedef;
+			}
+		}
 	}
 
-	/**
+	private void addPointerOperatorDeferred(
-	 * Handles the creation of declarators of pointers, references, arrays and arrays of pointers/references.
+			Map<IASTDeclarator, LinkedList<IASTPointerOperator>> pointerOperatorMap,
-	 * @param type the topmost type, expected {@link IPointerType}, {@link ICPPReferenceType} or {@link IArrayType}
+			IASTDeclarator returnedDeclarator, IASTPointerOperator ptrOp) {
-	 * @param name the declarator name
+		LinkedList<IASTPointerOperator> list;
-	 * @return Either a {@link CPPASTDeclarator} or a {@link CPPASTArrayDeclarator}, depending on what's needed
+		if (!pointerOperatorMap.containsKey(returnedDeclarator)) {
-	 * @throws DOMException
+			list = new LinkedList<IASTPointerOperator>();
-	 */
+			pointerOperatorMap.put(returnedDeclarator, list);
-	private IASTDeclarator createPointerOrArrayDeclarator(IType type, char[] name) throws DOMException {
-		List<IASTPointerOperator> ptrs = new ArrayList<IASTPointerOperator>();
-		List<IASTExpression> arrs = new ArrayList<IASTExpression>();
-		while (type instanceof IPointerType || type instanceof ICPPReferenceType) {
-			IASTPointerOperator astPtr;
-			if (type instanceof IPointerType) {
-				IASTPointer cppastPointer = factory.newPointer();
-				IPointerType ptrType = (IPointerType) type;
-				cppastPointer.setConst(ptrType.isConst());
-				cppastPointer.setVolatile(ptrType.isVolatile());
-				astPtr = cppastPointer;
-				type = ptrType.getType();
-			} else {
-				ICPPASTReferenceOperator cppastReferenceOperator = ((ICPPNodeFactory)factory).newReferenceOperator(false);
-				ICPPReferenceType refType = (ICPPReferenceType) type;
-				astPtr = cppastReferenceOperator;
-				type = refType.getType();
-	
-			}
-			ptrs.add(astPtr);
-		}
-		while (type instanceof IArrayType) {
-			IArrayType arrType = (IArrayType) type;
-			IASTExpression arraySizeExpression = arrType.getArraySizeExpression();
-			arrs.add(arraySizeExpression);
-			type = arrType.getType();
-		}
-	
-		IASTDeclarator decl;
-		if (!arrs.isEmpty()) {
-			IASTArrayDeclarator arrayDeclarator = factory.newArrayDeclarator(null);
-			for (IASTExpression exp : arrs) {
-				IASTArrayModifier arrayModifier = factory.newArrayModifier((exp == null) ? exp : exp.copy());
-				arrayDeclarator.addArrayModifier(arrayModifier);
-			}
-			decl = arrayDeclarator;
 		} else {
-			decl = factory.newDeclarator(null);
+			list = pointerOperatorMap.get(returnedDeclarator);
 		}
-		for (IASTPointerOperator ptr : ptrs) {
+		list.addFirst(ptrOp);
-			decl.addPointerOperator(ptr);
-		}
-	
-		createDeclaratorContent(decl, type, name);
-		
-		return decl;
 	}
 
-	/**
+	private IType getPtrOrRefSubtype(IType type) {
-	 * Fills a given declarator with either an ASTName or a proper nested declarator
+		if (type instanceof IPointerType) {
-	 * @param decl The declarator to fill
+			return ((IPointerType) type).getType();
-	 * @param type the content type of declarator
+		} else {
-	 * @param name the desired name of declarator tree
+			return ((ICPPReferenceType) type).getType();
-	 * @throws DOMException 
-	 */
-	private void createDeclaratorContent(IASTDeclarator decl, IType type, char[] name) throws DOMException {
-		if (type instanceof IPointerType || type instanceof IArrayType || type instanceof ICPPReferenceType) {
-			IASTDeclarator nested = createPointerOrArrayDeclarator(type, name);
-			decl.setNestedDeclarator(nested);
-		} else if (typeIrrelevantForDeclarator(type)) {
-			IASTName astName = factory.newName(name);
-			decl.setName(astName);
 		}
 	}
 
+	private IASTPointerOperator createPointerOperator(IType type) {
+		if (type instanceof ICPPPointerToMemberType) {
+			String classStr = ASTTypeUtil.getType(((ICPPPointerToMemberType) type).getMemberOfClass());
+			IASTName newName = factory.newName((classStr + "::").toCharArray()); //$NON-NLS-1$
+			// any better way of getting class name from ICPPPointerToMemberType?
+
+			ICPPASTPointerToMember member = ((ICPPNodeFactory) factory).newPointerToMember(newName);
+			member.setConst(((ICPPPointerToMemberType) type).isConst());
+			member.setVolatile(((ICPPPointerToMemberType) type).isVolatile());
+			return member;
+		} else if (type instanceof IPointerType) {
+			IASTPointer pointer = factory.newPointer();
+			pointer.setConst(((IPointerType) type).isConst());
+			pointer.setVolatile(((IPointerType) type).isVolatile());
+			return pointer;
+		} else {
+			ICPPReferenceType refType = (ICPPReferenceType) type;
+			ICPPASTReferenceOperator op = ((ICPPNodeFactory) factory).newReferenceOperator(refType
+					.isRValueReference());
+			return op;
+		}
+	}
+
+	private boolean isPtrOrRefType(IType type) {
+		return type instanceof IPointerType || type instanceof ICPPReferenceType;
+	}
+
+	private boolean typeNeedsNontrivialDeclarator(IType type) {
+		return isPtrOrRefType(type) || type instanceof IArrayType || type instanceof IFunctionType;
+	}
+
 	private IASTNamedTypeSpecifier getDeclSpecForBinding(IBinding binding) {
-	
+
 		char[][] qualifiedNameCharArray = CPPVisitor.getQualifiedNameCharArray(binding);
 		if (qualifiedNameCharArray.length > 1) {
-			
+
-			ICPPASTQualifiedName name = ((ICPPNodeFactory)factory).newQualifiedName();
+			ICPPASTQualifiedName name = ((ICPPNodeFactory) factory).newQualifiedName();
 			for (char[] cs : qualifiedNameCharArray) {
 				name.addName(factory.newName(cs));
 			}
 			return factory.newTypedefNameSpecifier(name);
-			
+
 		} else if (qualifiedNameCharArray.length == 1) {
 			IASTName name = factory.newName(qualifiedNameCharArray[0]);
 			return factory.newTypedefNameSpecifier(name);

core/org.eclipse.cdt.ui.tests/resources/refactoring/ExtractLocalVariable.rts

@@ -463,3 +463,20 @@ void foo(){
     i;
 }
 
+//!Bug 318784 DeclarationGenerator fails for some cases
+//#org.eclipse.cdt.ui.tests.refactoring.extractlocalvariable.ExtractLocalVariableRefactoringTest
+//@A.cpp
+
+void func() {
+    int *(*a)[2];
+    /*$*/a/*$$*/;
+}
+
+//=
+
+void func() {
+    int *(*a)[2];
+    int *(*a0)[2] = a;
+    a0;
+}
+