eu.cqse.check.framework.util.variable.CSVariableUseExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamscale-check-api Show documentation

The Teamscale Custom Check API allows users to extend Teamscale by writing custom analyses that create findings.

There is a newer version: 2024.7.2

/*
 * Copyright (c) CQSE GmbH
 *
 * Licensed 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 eu.cqse.check.framework.util.variable;

import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;

import eu.cqse.check.framework.scanner.ETokenType;
import eu.cqse.check.framework.scanner.IToken;
import eu.cqse.check.framework.util.cs.CsCheckUtils;

/**
 * A variable use extractor that considers string interpolation, feature that is specific for C#.
 */
public class CSVariableUseExtractor extends CLikeVariableUseExtractor {

	/** Constructor. */
	public CSVariableUseExtractor(ETokenType accessOperator, Set noVariableSuccessorTypes) {
		super(EnumSet.of(accessOperator), noVariableSuccessorTypes);
	}

	/** {@inheritDoc} */
	@Override
	public List extractVariableReads(List tokens, String variableName, boolean isField,
			boolean isShadowed) {
		List uses = super.extractVariableReads(tokens, variableName, isField, isShadowed);
		List usesWithInterpolation = new ArrayList<>();

		usesWithInterpolation.addAll(CsCheckUtils.checkForVariableUseInStringInterpolation(tokens, variableName));
		usesWithInterpolation.addAll(uses);
		return usesWithInterpolation;
	}
}