ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/HasEncodingErrorColumnConstraint.java
/* ###
 * IP: GHIDRA
 *
 * 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 ghidra.app.plugin.core.strings;

import docking.widgets.table.constraint.ColumnData;
import docking.widgets.table.constraint.TableFilterContext;
import docking.widgets.table.constrainteditor.ColumnConstraintEditor;
import docking.widgets.table.constrainteditor.DoNothingColumnConstraintEditor;
import ghidra.program.model.data.StringDataInstance;
import ghidra.util.StringUtilities;

/**
 * Tests if a string value contains any Unicode {@link StringUtilities#UNICODE_REPLACEMENT} chars,
 * which indicate that there was a decoding error
 */
public class HasEncodingErrorColumnConstraint extends StringDataInstanceColumnConstraint {

	@Override
	public boolean accepts(StringDataInstance value, TableFilterContext context) {
		String s = value.getStringValue();
		return (s != null) && s.chars().anyMatch(
			codePoint -> codePoint == StringUtilities.UNICODE_REPLACEMENT);
	}

	@Override
	public String getName() {
		return "Has Encoding Error";
	}

	@Override
	public ColumnConstraintEditor<StringDataInstance> getEditor(
			ColumnData<StringDataInstance> columnDataSource) {
		return new DoNothingColumnConstraintEditor<>(this);
	}

}
