blob: 3b1b3c37c440cfe631e643feb27e6078df09657f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/*******************************************************************************
* Copyright (c) 2009, 2011 Alena Laskavaia
*
* 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:
* Alena Laskavaia - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.codan.examples.checkers;
import java.util.regex.Pattern;
import org.eclipse.cdt.codan.core.cxx.model.AbstractCIndexChecker;
import org.eclipse.cdt.codan.core.model.IProblem;
import org.eclipse.cdt.codan.core.model.IProblemWorkingCopy;
import org.eclipse.cdt.codan.core.param.BasicProblemPreference;
import org.eclipse.cdt.codan.core.param.IProblemPreference;
import org.eclipse.cdt.core.model.ICElement;
import org.eclipse.cdt.core.model.ICElementVisitor;
import org.eclipse.cdt.core.model.ITranslationUnit;
/**
* Example demonstrate how to write checked using "C Model"
*
* @author Alena
*
*/
public class NamingConventionFunctionIIndexChecker extends AbstractCIndexChecker {
private static final String DEFAULT_PATTERN = "^[a-z]"; // name starts with english lowercase letter //$NON-NLS-1$
public static final String PARAM_KEY = "pattern"; //$NON-NLS-1$
private static final String ER_ID = "org.eclipse.cdt.codan.examples.checkers.NamingConventionFunctionProblem"; //$NON-NLS-1$
@Override
public void processUnit(ITranslationUnit unit) {
final IProblem pt = getProblemById(ER_ID, getFile());
try {
unit.accept(new ICElementVisitor() {
@Override
public boolean visit(ICElement element) {
if (element.getElementType() == ICElement.C_FUNCTION) {
String parameter = (String) getPreference(pt, PARAM_KEY);
Pattern pattern = Pattern.compile(parameter);
String name = element.getElementName();
if (!pattern.matcher(name).find()) {
// TODO: line number
reportProblem(ER_ID, getFile(), 1, name, parameter);
}
return false;
}
return true;
}
});
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public void initPreferences(IProblemWorkingCopy problem) {
super.initPreferences(problem);
IProblemPreference info = new BasicProblemPreference(PARAM_KEY, "Name Pattern");
addPreference(problem, info, DEFAULT_PATTERN);
}
@Override
public boolean runInEditor() {
return false;
}
}
|