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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
package org.eclipse.ui.externaltools.internal.ant.editor;
/**********************************************************************
This file is made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/cpl-v10.html
**********************************************************************/
//
// Copyright:
// GEBIT Gesellschaft fuer EDV-Beratung
// und Informatik-Technologien mbH,
// Berlin, Duesseldorf, Frankfurt (Germany) 2002
// All rights reserved.
//
import java.io.File;
import javax.xml.parsers.ParserConfigurationException;
import org.eclipse.ui.externaltools.internal.model.ExternalToolsPlugin;
import org.w3c.dom.Element;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
* SAX Parsing Handler that determines the enclosing target task element in
* respect to a specified cursor position.
*
* @version 19.11.2002
* @author Alf Schiefelbein
*/
public class EnclosingTargetSearchingHandler extends PlantySaxDefaultHandler {
/**
* Whether the enclosing target element has been determined.
* <P>
* This is the case if the method
* <code>determineEnclosingTargetTaskElement</code> has been called once.
*/
protected boolean enclosingTargetElementDetermined;
/**
* Creates an EnclosingTargetSearchingHandler, with the specified parameters.
*
* @param aRowOfCursorPosition the startingRow where the cursor is located in the
* document. The first startingRow is refered to with an index of '0'.
* @param aColumnOfCursorPosition the startingColumn where the cursor is located in
* the document. The first startingColumn is refered to with an index of '0'.
*/
public EnclosingTargetSearchingHandler(File mainFileContainer, int aRowOfCursorPosition, int aColumnOfCursorPosition) throws ParserConfigurationException {
super(mainFileContainer, aRowOfCursorPosition, aColumnOfCursorPosition);
}
/* (non-Javadoc)
* @see org.xml.sax.ContentHandler#endElement(String, String, String)
*/
public void endElement(String aUri, String aLocalName, String aQualifiedName)
throws SAXException {
if (ExternalToolsPlugin.getDefault() != null && ExternalToolsPlugin.getDefault().isDebugging()) {
ExternalToolsPlugin.getDefault().log("PlantySaxDefaultHandler.endElement(" +aUri+ ", " +aLocalName+ ", "+aQualifiedName+ ")", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
}
if(parsingFinished) {
return;
}
// Checks wether we know the parent for sure
boolean tempParentKnown = checkForParentElement();
String tempTagName = aLocalName.length() > 0 ? aLocalName : aQualifiedName;
if(tempTagName.equals("target")) { //$NON-NLS-1$
if(!stillOpenElements.isEmpty()) {
Element tempLastStillOpenElement = (Element)stillOpenElements.peek();
if(tempLastStillOpenElement != null && tempLastStillOpenElement.getTagName().equals(tempTagName)) {
stillOpenElements.pop();
if(!stillOpenElements.empty()) {
Element tempSecondLastStillOpenElement = (Element)stillOpenElements.peek();
tempSecondLastStillOpenElement.appendChild(tempLastStillOpenElement);
}
if(tempParentKnown && parentElement != null && parentElement.getTagName().equals(tempTagName)) {
parsingFinished = true;
}
}
}
}
}
/* (non-Javadoc)
* @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes)
*/
public void startElement(
String aUri,
String aLocalName,
String aQualifiedName,
Attributes anAttributes)
throws SAXException {
/*
* While the crimson parser passes the tag name as local name, apache's
* xerces parser, passes the tag name as qualilfied name and an empty
* string as local name.
*/
if (ExternalToolsPlugin.getDefault() != null && ExternalToolsPlugin.getDefault().isDebugging()) {
ExternalToolsPlugin.getDefault().log("PlantySaxDefaultHandler.startElement(" +aUri+ ", " +aLocalName+ ", "+aQualifiedName+ ", "+anAttributes+ ")", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
}
if(parsingFinished) {
return;
}
// Checks wether we know the parent for sure
checkForParentElement();
// Create a Dom Element
String tempTagName = aLocalName.length() > 0 ? aLocalName : aQualifiedName;
if(tempTagName == null || tempTagName.length() == 0) {
throw new PlantyException(AntEditorMessages.getString("EnclosingTargetSearchingHandler.Error_parsing")); //$NON-NLS-1$
}
if(tempTagName.equals("target")) { //$NON-NLS-1$
Element tempElement = document.createElement(tempTagName);
String tempTargetName = anAttributes.getValue("name"); //$NON-NLS-1$
if(tempTargetName != null && tempTargetName.length() > 0) {
tempElement.setAttribute("name", tempTargetName); //$NON-NLS-1$
}
stillOpenElements.push(tempElement);
}
}
/**
* Checks whether the enclosing task element, that we are searching for can
* be or has already been determined.
* <P>
* This will be done by comparing the current parsing position with the
* cursor position. If we just passed the cursor position and the enclosing
* task element has not been set yet, it will be set.
*
* @return <code>true</code> if the enclosing task element is known
* otherwise <code>false</code>
*/
protected boolean checkForParentElement() {
if(parentElement == null && !enclosingTargetElementDetermined) {
if(locator != null) {
/*
* The locator's numbers are 1-based though, we do everything
* 0-based.
*/
int tempLineNr = locator.getLineNumber() -1;
int tempColumnNr = locator.getColumnNumber() -1;
if(tempLineNr> rowOfCursorPosition ||
(tempLineNr == rowOfCursorPosition && tempColumnNr > columnOfCursorPosition)) {
determineEnclosingTargetTaskElement();
return true;
}
}
return false;
}
// Parent element has been set already before
return true;
}
/**
* Determines the enclosing target task element.
* <P>
* This Method shall only be called if the parser has passed the cursor
* position allready.
*/
protected void determineEnclosingTargetTaskElement() {
while(parentElement == null && !stillOpenElements.empty()) {
Element tempElement = (Element)stillOpenElements.pop();
if(tempElement.getTagName().equals("target")) { //$NON-NLS-1$
parentElement = tempElement;
if (ExternalToolsPlugin.getDefault() != null && ExternalToolsPlugin.getDefault().isDebugging()) {
ExternalToolsPlugin.getDefault().log("EnclosingTargetSearchingHandler.checkForParentElement(): Enclosing target element found: " +parentElement, null); //$NON-NLS-1$
}
}
}
enclosingTargetElementDetermined = true;
}
/**
* Returns the enclosing target task element that has been determined
* during a prior parsing.
* <P>
* It is quite common that parsing stopped before the current cursor
* position. That happens when the parser finds an error within the parsed
* document before. In that case the parent element might be guessed to be
* the one that opened last. To tell the handler wether the parent should
* be guessed, <code>aGuessParentFlag</code> may be specified.
*
* @param aGuessParentFlag wether the parent should be guessed
* @return the parent element or <code>null</code> if not known.
*/
public Element getParentElement(boolean aGuessParentFlag) {
if(enclosingTargetElementDetermined) {
return parentElement;
}
if(aGuessParentFlag) {
if(!stillOpenElements.empty()) {
determineEnclosingTargetTaskElement();
return parentElement;
}
}
return null;
}
}
|
