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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
/*******************************************************************************
* Copyright (c) 2009, 2010 Alena Laskavaia
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Alena Laskavaia - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.codan.core.model;
import org.eclipse.cdt.codan.core.CodanRuntime;
import org.eclipse.cdt.codan.internal.core.CheckersRegistry;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
/**
* Convenience implementation of IChecker interface. Has a default
* implementation for common methods.
*
*/
public abstract class AbstractChecker implements IChecker {
protected String name;
/**
* Default constructor
*/
public AbstractChecker() {
}
/**
* @return true if checker is enabled in context of resource, if returns
* false checker's "processResource" method won't be called
*/
public boolean enabledInContext(IResource res) {
return true;
}
/**
* Reports a simple problem for given file and line
*
* @param id
* - problem id
* @param file
* - file
* @param lineNumber
* - line
* @param args
* - problem arguments, if problem does not define error message
* it will be error message (not recommended because of
* internationalization)
*/
public void reportProblem(String id, IFile file, int lineNumber,
Object... args) {
getProblemReporter().reportProblem(id,
createProblemLocation(file, lineNumber), args);
}
/**
* Finds an instance of problem by given id, in user profile registered for
* specific file
*
* @param id
* - problem id
* @param file
* - file in scope
* @return problem instance
*/
public IProblem getProblemById(String id, IResource file) {
IProblem problem = CheckersRegistry.getInstance()
.getResourceProfile(file).findProblem(id);
if (problem == null)
throw new IllegalArgumentException("Id is not registered"); //$NON-NLS-1$
return problem;
}
/**
* Reports a simple problem for given file and line, error message comes
* from problem definition
*
* @param id
* - problem id
* @param file
* - file
* @param lineNumber
* - line
*/
public void reportProblem(String id, IFile file, int lineNumber) {
getProblemReporter().reportProblem(id,
createProblemLocation(file, lineNumber), new Object[] {});
}
/**
* @return problem reporter for given checker
*/
protected IProblemReporter getProblemReporter() {
return CodanRuntime.getInstance().getProblemReporter();
}
/**
* Convenience method to return codan runtime
*
* @return
*/
protected CodanRuntime getRuntime() {
return CodanRuntime.getInstance();
}
/**
* Convenience method to create and return instance of IProblemLocation
*
* @param file
* - file where problem is found
* @param line
* - line number 1-relative
* @return instance of IProblemLocation
*/
protected IProblemLocation createProblemLocation(IFile file, int line) {
return getRuntime().getProblemLocationFactory().createProblemLocation(
file, line);
}
/**
* Convenience method to create and return instance of IProblemLocation
*
* @param file
* - file where problem is found
* @param startChar
* - start char of the problem in the file, is zero-relative
* @param endChar
* - end char of the problem in the file, is zero-relative and
* exclusive.
* @return instance of IProblemLocation
*/
protected IProblemLocation createProblemLocation(IFile file, int startChar,
int endChar) {
return getRuntime().getProblemLocationFactory().createProblemLocation(
file, startChar, endChar);
}
/**
* Defines if checker should be run as user type in C editor. Override this
* method is checker is too heavy for that (runs too long)
*/
public boolean runInEditor() {
return this instanceof IRunnableInEditorChecker;
}
/**
* report a problem
*
* @param problemId - id of a problem
* @param loc - problem location
* @param args - extra problem arguments
*/
public void reportProblem(String problemId, IProblemLocation loc,
Object... args) {
getProblemReporter().reportProblem(problemId, loc, args);
}
}
|
