|
1 /* |
|
2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 * Trace rule for automatically adding function parameters to a trace |
|
17 * |
|
18 */ |
|
19 package com.nokia.tracebuilder.engine.rules; |
|
20 |
|
21 import java.util.ArrayList; |
|
22 |
|
23 import com.nokia.tracebuilder.engine.TraceBuilderErrorMessages; |
|
24 import com.nokia.tracebuilder.engine.TraceBuilderGlobals; |
|
25 import com.nokia.tracebuilder.engine.TraceBuilderErrorCodes.StringErrorParameters; |
|
26 import com.nokia.tracebuilder.engine.TraceBuilderErrorCodes.TraceBuilderErrorCode; |
|
27 import com.nokia.tracebuilder.engine.source.TraceParameterFormattingRule; |
|
28 import com.nokia.tracebuilder.model.Trace; |
|
29 import com.nokia.tracebuilder.model.TraceBuilderException; |
|
30 import com.nokia.tracebuilder.model.TraceConstantTable; |
|
31 import com.nokia.tracebuilder.model.TraceObjectRuleCreateObject; |
|
32 import com.nokia.tracebuilder.model.TraceObjectRuleRemoveOnCreate; |
|
33 import com.nokia.tracebuilder.model.TraceParameter; |
|
34 import com.nokia.tracebuilder.source.SourceConstants; |
|
35 import com.nokia.tracebuilder.source.SourceContext; |
|
36 import com.nokia.tracebuilder.source.SourceParameter; |
|
37 import com.nokia.tracebuilder.source.SourceParserException; |
|
38 import com.nokia.tracebuilder.source.SourceUtils; |
|
39 import com.nokia.tracebuilder.source.TypeMapping; |
|
40 |
|
41 /** |
|
42 * Trace rule for automatically adding function parameters to a trace |
|
43 * |
|
44 */ |
|
45 public final class AutoAddFunctionParametersRule extends RuleBase implements |
|
46 TraceObjectRuleCreateObject, TraceObjectRuleRemoveOnCreate { |
|
47 |
|
48 /** |
|
49 * Warning about value-to-pointer conversion |
|
50 */ |
|
51 private static final String VALUE_TO_POINTER_WARNING = Messages |
|
52 .getString("AutoAddFunctionParametersRule.UnrecognizedTypeWarning"); //$NON-NLS-1$ |
|
53 |
|
54 /* |
|
55 * (non-Javadoc) |
|
56 * |
|
57 * @see |
|
58 * com.nokia.tracebuilder.model.TraceObjectRuleCreateObject#createObject() |
|
59 */ |
|
60 public void createObject() { |
|
61 SourceContext context = TraceBuilderGlobals.getSourceContextManager() |
|
62 .getContext(); |
|
63 Trace trace = (Trace) getOwner(); |
|
64 if (context != null) { |
|
65 boolean valid = true; |
|
66 ArrayList<SourceParameter> list = tokenizeParameters(context); |
|
67 if (list != null && list.size() > 0) { |
|
68 trace.getModel().startProcessing(); |
|
69 try { |
|
70 createParameters(trace, list); |
|
71 } finally { |
|
72 trace.getModel().processingComplete(); |
|
73 } |
|
74 // At least one parameter must be parsed from source |
|
75 valid = trace.getParameterCount() > 0; |
|
76 } else { |
|
77 valid = false; |
|
78 } |
|
79 if (!valid) { |
|
80 String msg = TraceBuilderErrorMessages.getErrorMessage( |
|
81 TraceBuilderErrorCode.CANNOT_PARSE_FUNCTION_PARAMETERS, |
|
82 null); |
|
83 TraceBuilderGlobals.getEvents().postWarningMessage(msg, trace); |
|
84 // Removes the complex rule -> Function is not generated and |
|
85 // source does not compile |
|
86 trace.removeExtensions(ComplexHeaderRule.class); |
|
87 } |
|
88 } else { |
|
89 String msg = TraceBuilderErrorMessages.getErrorMessage( |
|
90 TraceBuilderErrorCode.NO_CONTEXT_FOR_LOCATION, null); |
|
91 TraceBuilderGlobals.getEvents().postErrorMessage(msg, null, true); |
|
92 // Removes the complex rule -> Function is not generated and |
|
93 // source does not compile |
|
94 trace.removeExtensions(ComplexHeaderRule.class); |
|
95 } |
|
96 } |
|
97 |
|
98 /** |
|
99 * Creates the parameters to the trace |
|
100 * |
|
101 * @param owner |
|
102 * the trace |
|
103 * @param list |
|
104 * the parameter list parsed from source |
|
105 */ |
|
106 private void createParameters(Trace owner, ArrayList<SourceParameter> list) { |
|
107 |
|
108 // If any of the parameters is "...", clear the whole parameter list |
|
109 for (SourceParameter param : list) { |
|
110 String type = param.getType(); |
|
111 if (type != null |
|
112 && type.equals(SourceConstants.VARIABLE_ARG_LIST_INDICATOR)) { |
|
113 list.clear(); |
|
114 |
|
115 String msg = TraceBuilderErrorMessages.getErrorMessage( |
|
116 TraceBuilderErrorCode.VAR_ARG_LIST_PARAMETER_FOUND, |
|
117 null); |
|
118 TraceBuilderGlobals.getEvents().postWarningMessage(msg, owner); |
|
119 break; |
|
120 } |
|
121 } |
|
122 |
|
123 StringBuilder str = new StringBuilder(); |
|
124 for (SourceParameter param : list) { |
|
125 TraceParameter parameter = createParameter(owner, param); |
|
126 if (parameter != null) { |
|
127 str.append(SourceConstants.PARAMETER_SEPARATOR); |
|
128 TraceParameterFormattingRule rule = parameter |
|
129 .getExtension(TraceParameterFormattingRule.class); |
|
130 if (rule != null) { |
|
131 str.append(rule.mapNameToSource(param.getName())); |
|
132 } else { |
|
133 str.append(param.getName()); |
|
134 } |
|
135 } |
|
136 // The location will be referenced by event handlers if |
|
137 // they need it. Otherwise it will be removed from the |
|
138 // source |
|
139 param.getSourceLocation().dereference(); |
|
140 } |
|
141 // The header extension is stored in case of complex function entry |
|
142 // trace |
|
143 EntryTraceRule entryRule = owner.getExtension(EntryTraceRule.class); |
|
144 ComplexHeaderRuleImpl complex = owner |
|
145 .getExtension(ComplexHeaderRuleImpl.class); |
|
146 if (entryRule != null && complex != null) { |
|
147 complex.setTraceIDDefineExtension(str.toString()); |
|
148 } |
|
149 } |
|
150 |
|
151 /** |
|
152 * Processes the parameters of given source context |
|
153 * |
|
154 * @param context |
|
155 * the context |
|
156 * @return list of parameters |
|
157 */ |
|
158 private ArrayList<SourceParameter> tokenizeParameters(SourceContext context) { |
|
159 ArrayList<SourceParameter> list = new ArrayList<SourceParameter>(); |
|
160 try { |
|
161 context.parseParameters(list); |
|
162 } catch (SourceParserException e) { |
|
163 TraceBuilderGlobals.getEvents().postError( |
|
164 new TraceBuilderException( |
|
165 TraceBuilderErrorCode.UNEXPECTED_EXCEPTION, e)); |
|
166 list = null; |
|
167 } |
|
168 return list; |
|
169 } |
|
170 |
|
171 /** |
|
172 * Creates a TraceParameter based on parameter parsed from source |
|
173 * |
|
174 * @param owner |
|
175 * the owning trace object |
|
176 * @param param |
|
177 * the parameter found from source |
|
178 * @return the parameter |
|
179 */ |
|
180 private TraceParameter createParameter(Trace owner, SourceParameter param) { |
|
181 TraceConstantTable foundTable = RuleUtils.findConstantTableByType(owner |
|
182 .getModel(), param); |
|
183 TraceParameter parameter = null; |
|
184 if (foundTable == null) { |
|
185 TypeMapping type = SourceUtils.mapSymbianTypeToParameterType(param); |
|
186 if (type != null) { |
|
187 if (!type.isVoid()) { |
|
188 parameter = createParameter(owner, param, type); |
|
189 } |
|
190 } else { |
|
191 StringErrorParameters params = new StringErrorParameters(); |
|
192 params.string = param.getType(); |
|
193 TraceBuilderGlobals.getEvents().postError( |
|
194 new TraceBuilderException( |
|
195 TraceBuilderErrorCode.INVALID_PARAMETER_TYPE, |
|
196 params, param.getSourceLocation())); |
|
197 } |
|
198 } else { |
|
199 parameter = createParameter(owner, param, foundTable); |
|
200 } |
|
201 return parameter; |
|
202 } |
|
203 |
|
204 /** |
|
205 * Processes a non-void parameter type that was not associated with a |
|
206 * constant table |
|
207 * |
|
208 * @param owner |
|
209 * the owner for the parameter |
|
210 * @param param |
|
211 * the parameter found from source |
|
212 * @param type |
|
213 * the parameter type as parsed by source package |
|
214 * @return the parameter |
|
215 */ |
|
216 private TraceParameter createParameter(Trace owner, SourceParameter param, |
|
217 TypeMapping type) { |
|
218 String name = param.getName(); |
|
219 TraceParameter retval = null; |
|
220 if (name != null && name.length() != 0) { |
|
221 try { |
|
222 retval = RuleUtils.createParameterFromType(owner, name, type); |
|
223 if (retval != null && type.valueToPointer) { |
|
224 // Posts a warning about value-to-pointer conversion |
|
225 TraceBuilderGlobals.getEvents() |
|
226 .postWarningMessage(VALUE_TO_POINTER_WARNING, |
|
227 param.getSourceLocation()); |
|
228 } |
|
229 } catch (TraceBuilderException e) { |
|
230 // Changes the source of the error to the location that failed |
|
231 TraceBuilderGlobals.getEvents().postError( |
|
232 new TraceBuilderException(e.getErrorCode(), e |
|
233 .getErrorParameters(), param |
|
234 .getSourceLocation())); |
|
235 } |
|
236 } |
|
237 return retval; |
|
238 } |
|
239 |
|
240 /** |
|
241 * Processes a non-void parameter type that was associated with a constant |
|
242 * table |
|
243 * |
|
244 * @param owner |
|
245 * the owner for the parameter |
|
246 * @param param |
|
247 * the parameter found from source |
|
248 * @param table |
|
249 * the constant table the parameter was associated to |
|
250 * @return the parameter |
|
251 */ |
|
252 private TraceParameter createParameter(Trace owner, SourceParameter param, |
|
253 TraceConstantTable table) { |
|
254 String name = param.getName(); |
|
255 TraceParameter retval = null; |
|
256 if (name != null && name.length() != 0) { |
|
257 try { |
|
258 retval = RuleUtils.createParameterFromConstantTable(owner, |
|
259 name, table); |
|
260 } catch (TraceBuilderException e) { |
|
261 // Changes the source of the error to the location that failed |
|
262 TraceBuilderGlobals.getEvents().postError( |
|
263 new TraceBuilderException(e.getErrorCode(), e |
|
264 .getErrorParameters(), param |
|
265 .getSourceLocation())); |
|
266 } |
|
267 } |
|
268 return retval; |
|
269 } |
|
270 |
|
271 /* |
|
272 * (non-Javadoc) |
|
273 * |
|
274 * @see |
|
275 * com.nokia.tracebuilder.model.TraceObjectRuleRemoveOnCreate#canBeRemoved() |
|
276 */ |
|
277 public boolean canBeRemoved() { |
|
278 // This is not copied to exit trace -> Can be removed |
|
279 return true; |
|
280 } |
|
281 |
|
282 } |