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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*******************************************************************************
* Copyright (c) 2014, 2015 École Polytechnique de Montréal
*
* 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:
* Florian Wininger - Initial API and implementation
*******************************************************************************/
package org.eclipse.tracecompass.tmf.analysis.xml.core.stateprovider;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.eclipse.core.runtime.IPath;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
import org.eclipse.tracecompass.tmf.analysis.xml.core.model.ITmfXmlModelFactory;
import org.eclipse.tracecompass.tmf.analysis.xml.core.model.TmfXmlEventHandler;
import org.eclipse.tracecompass.tmf.analysis.xml.core.model.TmfXmlLocation;
import org.eclipse.tracecompass.tmf.analysis.xml.core.model.readwrite.TmfXmlReadWriteModelFactory;
import org.eclipse.tracecompass.tmf.analysis.xml.core.module.IXmlStateSystemContainer;
import org.eclipse.tracecompass.tmf.analysis.xml.core.module.XmlUtils;
import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
import org.eclipse.tracecompass.tmf.core.statesystem.AbstractTmfStateProvider;
import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
/**
* This is the state change input plug-in for TMF's state system which handles
* the XML Format
*
* @author Florian Wininger
*/
public class XmlStateProvider extends AbstractTmfStateProvider implements IXmlStateSystemContainer {
private final IPath fFilePath;
@NonNull private final String fStateId;
/** List of all Event Handlers */
private final Set<TmfXmlEventHandler> fEventHandlers = new HashSet<>();
/** List of all Locations */
private final Set<TmfXmlLocation> fLocations;
/** Map for defined values */
private final Map<String, String> fDefinedValues = new HashMap<>();
// ------------------------------------------------------------------------
// Constructor
// ------------------------------------------------------------------------
/**
* Instantiate a new state provider plug-in.
*
* @param trace
* The trace
* @param stateid
* The state system id, corresponding to the analysis_id
* attribute of the state provider element of the XML file
* @param file
* Path to the XML file containing the state provider definition
*/
public XmlStateProvider(@NonNull ITmfTrace trace, @NonNull String stateid, IPath file) {
super(trace, stateid);
fStateId = stateid;
fFilePath = file;
Element doc = XmlUtils.getElementInFile(fFilePath.makeAbsolute().toOSString(), TmfXmlStrings.STATE_PROVIDER, fStateId);
if (doc == null) {
fLocations = new HashSet<>();
return;
}
ITmfXmlModelFactory modelFactory = TmfXmlReadWriteModelFactory.getInstance();
/* parser for defined Values */
NodeList definedStateNodes = doc.getElementsByTagName(TmfXmlStrings.DEFINED_VALUE);
for (int i = 0; i < definedStateNodes.getLength(); i++) {
Element element = (Element) definedStateNodes.item(i);
fDefinedValues.put(element.getAttribute(TmfXmlStrings.NAME), element.getAttribute(TmfXmlStrings.VALUE));
}
/* parser for the locations */
List<Element> childElements = XmlUtils.getChildElements(doc, TmfXmlStrings.LOCATION);
Set<TmfXmlLocation> locations = new HashSet<>();
for (Element element : childElements) {
if (element == null) {
continue;
}
TmfXmlLocation location = modelFactory.createLocation(element, this);
locations.add(location);
}
fLocations = Collections.unmodifiableSet(locations);
/* parser for the event handlers */
childElements = XmlUtils.getChildElements(doc, TmfXmlStrings.EVENT_HANDLER);
for (Element element : childElements) {
if (element == null) {
continue;
}
TmfXmlEventHandler handler = modelFactory.createEventHandler(element, this);
fEventHandlers.add(handler);
}
}
/**
* Get the state id of the state provider
*
* @return The state id of the state provider
*/
@NonNull
public String getStateId() {
return fStateId;
}
// ------------------------------------------------------------------------
// IStateChangeInput
// ------------------------------------------------------------------------
@Override
public int getVersion() {
Element ssNode = XmlUtils.getElementInFile(fFilePath.makeAbsolute().toOSString(), TmfXmlStrings.STATE_PROVIDER, fStateId);
if (ssNode != null) {
return Integer.parseInt(ssNode.getAttribute(TmfXmlStrings.VERSION));
}
/*
* The version attribute is mandatory and XML files that don't validate
* with the XSD are ignored, so this should never happen
*/
throw new IllegalStateException("The state provider XML node should have a version attribute"); //$NON-NLS-1$
}
@Override
public XmlStateProvider getNewInstance() {
return new XmlStateProvider(this.getTrace(), getStateId(), fFilePath);
}
@Override
protected void eventHandle(ITmfEvent event) {
for (TmfXmlEventHandler eventHandler : fEventHandlers) {
eventHandler.handleEvent(event);
}
}
@Override
public ITmfStateSystem getStateSystem() {
return getStateSystemBuilder();
}
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
@Override
public Iterable<TmfXmlLocation> getLocations() {
return fLocations;
}
/**
* Get the defined value associated with a constant
*
* @param constant
* The constant defining this value
* @return The actual value corresponding to this constant
*/
public String getDefinedValue(String constant) {
return fDefinedValues.get(constant);
}
@Override
public String getAttributeValue(String name) {
String attribute = name;
if (attribute.startsWith(TmfXmlStrings.VARIABLE_PREFIX)) {
/* search the attribute in the map without the fist character $ */
attribute = getDefinedValue(attribute.substring(1));
}
return attribute;
}
}
|
