ShiftOutOfRangeCleanUpCore.java

/*******************************************************************************
 * Copyright (c) 2026 Carsten Hammer.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Carsten Hammer
 *******************************************************************************/
package org.sandbox.jdt.internal.ui.fix;

import static org.sandbox.jdt.internal.corext.fix2.MYCleanUpConstants.SHIFT_OUT_OF_RANGE_CLEANUP;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.internal.corext.fix.CompilationUnitRewriteOperationsFixCore;
import org.eclipse.jdt.internal.corext.fix.CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation;
import org.eclipse.jdt.internal.ui.fix.AbstractCleanUp;
import org.eclipse.jdt.ui.cleanup.CleanUpContext;
import org.eclipse.jdt.ui.cleanup.CleanUpRequirements;
import org.eclipse.jdt.ui.cleanup.ICleanUpFix;
import org.sandbox.jdt.internal.corext.fix.ShiftOutOfRangeFixCore;

/**
 * CleanUp for shift out of range detection using TriggerPattern hints.
 *
 * <p>This cleanup detects shift operations with out-of-range shift amounts
 * and replaces them with the effective masked value.</p>
 *
 * @since 1.2.5
 */
public class ShiftOutOfRangeCleanUpCore extends AbstractCleanUp {

	public ShiftOutOfRangeCleanUpCore(final Map<String, String> options) {
		super(options);
	}

	public ShiftOutOfRangeCleanUpCore() {
	}

	@Override
	public CleanUpRequirements getRequirements() {
		return new CleanUpRequirements(requireAST(), false, false, null);
	}

	public boolean requireAST() {
		return isEnabled(SHIFT_OUT_OF_RANGE_CLEANUP);
	}

	@Override
	public ICleanUpFix createFix(final CleanUpContext context) throws CoreException {
		CompilationUnit compilationUnit = context.getAST();
		if (compilationUnit == null) {
			return null;
		}

		if (!isEnabled(SHIFT_OUT_OF_RANGE_CLEANUP)) {
			return null;
		}

		Set<CompilationUnitRewriteOperation> operations = new LinkedHashSet<>();
		ShiftOutOfRangeFixCore.findOperations(compilationUnit, operations);

		if (operations.isEmpty()) {
			return null;
		}

		CompilationUnitRewriteOperation[] array = operations.toArray(
				new CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation[0]);
		return new CompilationUnitRewriteOperationsFixCore(
				MultiFixMessages.ShiftOutOfRangeCleanUpFix_refactor,
				compilationUnit,
				array);
	}

	@Override
	public String[] getStepDescriptions() {
		List<String> result = new ArrayList<>();
		if (isEnabled(SHIFT_OUT_OF_RANGE_CLEANUP)) {
			result.add(MultiFixMessages.ShiftOutOfRangeCleanUp_description);
		}
		return result.toArray(new String[0]);
	}

	@Override
	public String getPreview() {
		if (isEnabled(SHIFT_OUT_OF_RANGE_CLEANUP)) {
			return """
				int mask = 1 << 0;  // was: 1 << 32 (no-op for int)
				long flag = 1L << 32; // OK for long
				"""; //$NON-NLS-1$
		}
		return """
			int mask = 1 << 32;  // BUG: equivalent to 1 << 0
			long flag = 1L << 32; // OK for long
			"""; //$NON-NLS-1$
	}
}