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
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Eclipse Public License, Version 1.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.eclipse.org/org/documents/epl-v10.php
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.ide.eclipse.adt.internal.refactorings.core;
import static com.android.SdkConstants.ANDROID_URI;
import static com.android.SdkConstants.ATTR_NAME;
import static com.android.xml.AndroidManifest.ATTRIBUTE_BACKUP_AGENT;
import static com.android.xml.AndroidManifest.ATTRIBUTE_MANAGE_SPACE_ACTIVITY;
import static com.android.xml.AndroidManifest.ATTRIBUTE_PARENT_ACTIVITY_NAME;
import static com.android.xml.AndroidManifest.ATTRIBUTE_TARGET_ACTIVITY;
import com.android.annotations.NonNull;
import com.android.annotations.Nullable;
import com.android.ide.eclipse.adt.AdtPlugin;
import com.android.xml.AndroidManifest;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.wst.sse.core.StructuredModelManager;
import org.eclipse.wst.sse.core.internal.provisional.IStructuredModel;
import org.eclipse.wst.sse.core.internal.provisional.IndexedRegion;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
/**
* The utility class for android refactoring
*
*/
@SuppressWarnings("restriction")
public class RefactoringUtil {
private static boolean sRefactorAppPackage = false;
/**
* Releases SSE read model; saves SSE model if exists edit model
* Called in dispose method of refactoring change classes
*
* @param model the SSE model
* @param document the document
*/
public static void fixModel(IStructuredModel model, IDocument document) {
if (model != null) {
model.releaseFromRead();
}
model = null;
if (document == null) {
return;
}
try {
model = StructuredModelManager.getModelManager().getExistingModelForEdit(document);
if (model != null) {
model.save();
}
} catch (UnsupportedEncodingException e1) {
// ignore
} catch (IOException e1) {
// ignore
} catch (CoreException e1) {
// ignore
} finally {
if (model != null) {
model.releaseFromEdit();
}
}
}
/**
* Logs the info message
*
* @param message the message
*/
public static void logInfo(String message) {
AdtPlugin.log(IStatus.INFO, AdtPlugin.PLUGIN_ID, message);
}
/**
* Logs the the exception
*
* @param e the exception
*/
public static void log(Throwable e) {
AdtPlugin.log(e, e.getMessage());
}
/**
* @return true if Rename/Move package needs to change the application package
* default is false
*
*/
public static boolean isRefactorAppPackage() {
return sRefactorAppPackage;
}
/**
* @param refactorAppPackage true if Rename/Move package needs to change the application package
*/
public static void setRefactorAppPackage(boolean refactorAppPackage) {
RefactoringUtil.sRefactorAppPackage = refactorAppPackage;
}
/**
* Returns the range of the attribute value in the given document
*
* @param attr the attribute to look up
* @param document the document containing the attribute
* @return the range of the value text, not including quotes, in the document
*/
public static int getAttributeValueRangeStart(
@NonNull Attr attr,
@NonNull IDocument document) {
IndexedRegion region = (IndexedRegion) attr;
int potentialStart = attr.getName().length() + 2; // + 2: add ="
String text;
try {
text = document.get(region.getStartOffset(),
region.getEndOffset() - region.getStartOffset());
} catch (BadLocationException e) {
return -1;
}
String value = attr.getValue();
int index = text.indexOf(value, potentialStart);
if (index != -1) {
return region.getStartOffset() + index;
} else {
return -1;
}
}
/**
* Returns the start of the tag name of the given element
*
* @param element the element to look up
* @param document the document containing the attribute
* @return the index of the start tag in the document
*/
public static int getTagNameRangeStart(
@NonNull Element element,
@NonNull IDocument document) {
IndexedRegion region = (IndexedRegion) element;
int potentialStart = 1; // add '<'
String text;
try {
text = document.get(region.getStartOffset(),
region.getEndOffset() - region.getStartOffset());
} catch (BadLocationException e) {
return -1;
}
int index = text.indexOf(element.getTagName(), potentialStart);
if (index != -1) {
return region.getStartOffset() + index;
} else {
return -1;
}
}
/**
* Returns whether the given manifest attribute should be considered to describe
* a class name. These will be eligible for refactoring when classes are renamed
* or moved.
*
* @param attribute the manifest attribute
* @return true if this attribute can describe a class
*/
public static boolean isManifestClassAttribute(@NonNull Attr attribute) {
return isManifestClassAttribute(
attribute.getOwnerElement().getTagName(),
attribute.getNamespaceURI(),
attribute.getLocalName());
}
/**
* Returns whether the given manifest attribute should be considered to describe
* a class name. These will be eligible for refactoring when classes are renamed
* or moved.
*
* @param tag the tag, if known
* @param uri the attribute namespace, if any
* @param name the attribute local name, if any
* @return true if this attribute can describe a class
*/
public static boolean isManifestClassAttribute(
@Nullable String tag,
@Nullable String uri,
@Nullable String name) {
if (name == null) {
return false;
}
if ((name.equals(ATTR_NAME)
&& (AndroidManifest.NODE_ACTIVITY.equals(tag)
|| AndroidManifest.NODE_APPLICATION.equals(tag)
|| AndroidManifest.NODE_INSTRUMENTATION.equals(tag)
|| AndroidManifest.NODE_PROVIDER.equals(tag)
|| AndroidManifest.NODE_SERVICE.equals(tag)
|| AndroidManifest.NODE_RECEIVER.equals(tag)))
|| name.equals(ATTRIBUTE_TARGET_ACTIVITY)
|| name.equals(ATTRIBUTE_MANAGE_SPACE_ACTIVITY)
|| name.equals(ATTRIBUTE_BACKUP_AGENT)
|| name.equals(ATTRIBUTE_PARENT_ACTIVITY_NAME)) {
return ANDROID_URI.equals(uri);
}
return false;
}
}
|
