forked from scala-ide/scala-ide
-
Notifications
You must be signed in to change notification settings - Fork 2
/
AbstractNewElementWizardPage.scala
456 lines (371 loc) · 14.6 KB
/
AbstractNewElementWizardPage.scala
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
/*
* Copyright 2010 LAMP/EPFL
*
* @author Tim Clendenen
*
*/
package scala.tools.eclipse.wizards
import org.eclipse.core.resources.IResource
import org.eclipse.core.runtime.{
CoreException,
FileLocator,
IPath,
IProgressMonitor,
IStatus,
NullProgressMonitor,
Path,
SubProgressMonitor
}
import org.eclipse.jdt.core.{
Flags,
ICompilationUnit,
IJavaElement,
IPackageFragment,
IPackageFragmentRoot,
IType,
ITypeHierarchy,
JavaModelException,
Signature,
WorkingCopyOwner
}
import org.eclipse.jdt.core.dom.{ AST, ASTParser, CompilationUnit }
import org.eclipse.jdt.internal.corext.codemanipulation.StubUtility
import org.eclipse.jdt.internal.corext.util.JavaModelUtil
import org.eclipse.jdt.internal.ui.dialogs.StatusInfo
import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages
import org.eclipse.jdt.internal.ui.wizards.dialogfields.{
DialogField,
IDialogFieldListener,
LayoutUtil,
SelectionButtonDialogFieldGroup
}
import org.eclipse.jdt.ui.wizards.NewTypeWizardPage
import org.eclipse.jface.dialogs.{ Dialog, IDialogSettings }
import org.eclipse.jface.resource.ImageDescriptor
import org.eclipse.jface.viewers.IStructuredSelection
import org.eclipse.swt.SWT
import org.eclipse.swt.layout.{ GridData, GridLayout }
import org.eclipse.swt.widgets.Composite
import collection.Seq
import collection.mutable.Buffer
import scala.tools.eclipse.ScalaPlugin._
import scala.tools.eclipse.formatter.ScalaFormatterCleanUpProvider
import scala.tools.eclipse.logging.HasLogger
abstract class AbstractNewElementWizardPage extends NewTypeWizardPage(1, "") with HasLogger {
val declarationType: String
val imageName = "new" + declarationType.replace(' ', '_').toLowerCase + "_wiz.gif"
val iPath = new Path("icons/full/wizban").append(imageName)
val url = FileLocator.find(plugin.getBundle, iPath, null)
setImageDescriptor(ImageDescriptor.createFromURL(url))
setTitle("Scala " + declarationType)
setDescription("Create a new Scala " + declarationType)
val PAGE_NAME = "New" + declarationType + "WizardPage"
val DEFAULT_SUPER_TYPE = "scala.AnyRef"
val SETTINGS_CREATEMAIN = "create_main"
val SETTINGS_CREATECONSTR = "create_constructor"
val SETTINGS_CREATEUNIMPLEMENTED = "create_unimplemented"
protected object dialogFieldListener extends IDialogFieldListener {
def dialogFieldChanged(field: DialogField) {
doStatusUpdate()
}
}
val accessModifierNames = Array(
NewWizardMessages.NewTypeWizardPage_modifiers_default,
NewWizardMessages.NewTypeWizardPage_modifiers_protected,
NewWizardMessages.NewTypeWizardPage_modifiers_private)
val accessModifierButtons =
new SelectionButtonDialogFieldGroup(SWT.RADIO, accessModifierNames, 3)
accessModifierButtons.setDialogFieldListener(dialogFieldListener)
accessModifierButtons.setLabelText(getModifiersLabel)
accessModifierButtons.setSelection(0, true)
def defaultSelected = accessModifierButtons.isSelected(0)
def protectedSelected = accessModifierButtons.isSelected(1)
def privateSelected = accessModifierButtons.isSelected(2)
val otherModifierNames = Array(
NewWizardMessages.NewTypeWizardPage_modifiers_abstract,
NewWizardMessages.NewTypeWizardPage_modifiers_final)
val otherModifierButtons =
new SelectionButtonDialogFieldGroup(SWT.CHECK, otherModifierNames, 4)
otherModifierButtons.setDialogFieldListener(dialogFieldListener)
def abstractSelected = otherModifierButtons.isSelected(0)
def finalSelected = otherModifierButtons.isSelected(1)
val methodStubNames = Array(
NewWizardMessages.NewClassWizardPage_methods_main,
NewWizardMessages.NewClassWizardPage_methods_constructors,
NewWizardMessages.NewClassWizardPage_methods_inherited)
val methodStubButtons =
new SelectionButtonDialogFieldGroup(SWT.CHECK, methodStubNames, 1)
methodStubButtons.setDialogFieldListener(dialogFieldListener)
methodStubButtons.setLabelText(
NewWizardMessages.NewClassWizardPage_methods_label)
def createMainSelected = methodStubButtons.isSelected(0)
def createConstructorsSelected = methodStubButtons.isSelected(1)
def createInheritedSelected = methodStubButtons.isSelected(2)
protected var createdType: IType = _
def init(selection: IStructuredSelection): Unit = {
val jelem = getInitialJavaElement(selection)
initContainerPage(jelem)
initTypePage(jelem)
val dialogSettings = getDialogSettings()
initializeOptions(dialogSettings)
}
def initializeOptions(dialogSettings: IDialogSettings): Unit
override def getModifiers = {
var modifiers = 0
if (privateSelected) modifiers += F_PRIVATE
else if (protectedSelected) modifiers += F_PROTECTED
if (abstractSelected) modifiers += F_ABSTRACT
if (finalSelected) modifiers += F_FINAL
modifiers
}
override def setModifiers(modifiers: Int, canBeModified: Boolean) = {
if (Flags.isPrivate(modifiers))
accessModifierButtons.setSelection(2, true)
else if (Flags.isProtected(modifiers))
accessModifierButtons.setSelection(1, true)
else
accessModifierButtons.setSelection(0, true)
if (Flags.isAbstract(modifiers))
otherModifierButtons.setSelection(0, true)
if (Flags.isFinal(modifiers))
otherModifierButtons.setSelection(1, true)
accessModifierButtons.setEnabled(canBeModified)
otherModifierButtons.setEnabled(canBeModified)
}
override def setVisible(visible: Boolean) {
super.setVisible(visible)
if (visible) {
setFocus()
} else {
val dialogSettings = getDialogSettings()
if (dialogSettings != null) {
var section = dialogSettings.getSection(PAGE_NAME)
if (section == null) {
section = dialogSettings.addNewSection(PAGE_NAME)
}
section.put(SETTINGS_CREATEMAIN, createMainSelected)
section.put(SETTINGS_CREATECONSTR, createConstructorsSelected)
section.put(SETTINGS_CREATEUNIMPLEMENTED, createInheritedSelected)
}
}
}
private def doStatusUpdate() {
val parentStatus = if (isEnclosingTypeSelected) fEnclosingTypeStatus
else fPackageStatus
val status = Array(fContainerStatus, parentStatus, fTypeNameStatus,
fModifierStatus, fSuperClassStatus,
fSuperInterfacesStatus)
// the mode severe status will be displayed and the OK button
// enabled/disabled.
updateStatus(status);
}
/*
* @see NewContainerWizardPage#handleFieldChanged
*/
override protected def handleFieldChanged(fieldName: String) {
super.handleFieldChanged(fieldName)
doStatusUpdate()
}
override protected def getSuperInterfacesLabel(): String =
"Traits and \nInterfaces:"
override protected def createModifierControls(composite: Composite, columns: Int) = {
LayoutUtil.setHorizontalSpan(accessModifierButtons.getLabelControl(composite), 1)
val control1 = accessModifierButtons.getSelectionButtonsGroup(composite)
val gd1 = new GridData(GridData.HORIZONTAL_ALIGN_FILL)
gd1.horizontalSpan = columns - 2
control1.setLayoutData(gd1)
DialogField.createEmptySpace(composite)
specifyModifierControls(composite, columns)
}
def specifyModifierControls(composite: Composite, columns: Int): Unit
protected def createMethodStubSelectionControls(composite: Composite, columns: Int) {
val labelControl = methodStubButtons.getLabelControl(composite)
LayoutUtil.setHorizontalSpan(labelControl, columns)
DialogField.createEmptySpace(composite)
val buttonGroup = methodStubButtons.getSelectionButtonsGroup(composite)
LayoutUtil.setHorizontalSpan(buttonGroup, columns - 1)
}
/*
* Override to pick the UI components relevant for a Scala elements
*/
override def createControl(parent: Composite) = {
initializeDialogUnits(parent)
val composite = new Composite(parent, SWT.NONE)
composite.setFont(parent.getFont)
val columns = 4
val layout = new GridLayout()
layout.numColumns = columns
composite.setLayout(layout)
createContainerControls(composite, columns)
createPackageControls(composite, columns)
//createEnclosingTypeControls(composite, nColumns)
createSeparator(composite, columns)
createTypeNameControls(composite, columns)
createModifierControls(composite, columns)
createSuperClassControls(composite, columns)
setSuperClass(DEFAULT_SUPER_TYPE, true)
createSuperInterfacesControls(composite, columns)
createMethodStubSelectionControls(composite, columns)
createCommentControls(composite, columns)
enableCommentControl(true)
setControl(composite)
Dialog.applyDialogFont(composite)
}
protected def makeCreatedType(implicit parentCU: ICompilationUnit) = {
createdType = parentCU.getType(getGeneratedTypeName)
}
/* (non-Javadoc)
* @see org.eclipse.jdt.ui.wizards.NewTypeWizardPage#createType(org.eclipse.core.runtime.IProgressMonitor)
*/
override def createType(progressMonitor: IProgressMonitor): Unit = {
def reconcile(cu: ICompilationUnit,
astLevel: Int = ICompilationUnit.NO_AST,
forceProblemDetection: Boolean = false,
enableStatementsRecovery: Boolean = false,
workingCopyOwner: WorkingCopyOwner = null,
monitor: IProgressMonitor = null): Unit = {
cu.reconcile(astLevel, forceProblemDetection,
enableStatementsRecovery, workingCopyOwner, monitor)
}
def superTypes: List[String] = {
import scala.collection.JavaConversions._
val javaArrayList = getSuperInterfaces
val jual = javaArrayList.toArray(new Array[String](javaArrayList.size))
(getSuperClass +: jual).toList
}
val monitor = if (progressMonitor == null) new NullProgressMonitor()
else progressMonitor
monitor.beginTask(NewWizardMessages.NewTypeWizardPage_operationdesc, 8)
implicit val packageFragment = {
val rt = getPackageFragmentRoot
val pf = getPackageFragment
var p = pf match {
case ipf: IPackageFragment => ipf
case _ => rt.getPackageFragment("")
}
p.exists match {
case true => monitor.worked(1)
case _ => p = rt.createPackageFragment(pf.getElementName, true,
new SubProgressMonitor(monitor, 1))
}
p
}
implicit val ld = StubUtility.getLineDelimiterUsed(
packageFragment.getJavaProject)
val typeName = getTypeNameWithoutParameters
val cuName = getCompilationUnitName(typeName)
try {
val parentCU = packageFragment.createCompilationUnit(
cuName, "", false, new SubProgressMonitor(monitor, 2))
parentCU.becomeWorkingCopy(new SubProgressMonitor(monitor, 1))
import CodeBuilder._
type CommentGetter = (ICompilationUnit, String) => String
def comment(cg: CommentGetter): Option[String] = {
val s = cg(parentCU, ld)
toOption(in = s)(guard = s != null && s.nonEmpty)
}
def elementModifiers = {
val mods = getModifiers
mods match {
case 0 => ""
case _ => Flags.toString(mods) + " "
}
}
import templates._
// generate basic element skeleton
val buffer = parentCU.getBuffer
//start control of buffer
val cb = CodeBuilder(getPackageNameToInject.getOrElse(""), superTypes, buffer)
cb.append(commentTemplate(comment(getFileComment _)))
cb.append(packageTemplate(getPackageNameToInject))
cb.writeImports // to buffer
cb.append(commentTemplate(comment(getTypeComment _)))
cb.append(elementModifiers)
cb.append(declarationType.toLowerCase)
cb.createElementDeclaration(getTypeName, superTypes, buffer)
cb.append(bodyStub)
reconcile(cu = parentCU)
makeCreatedType(parentCU)
// refine the created type
val typeHierarchy = createdType.newSupertypeHierarchy(Array(parentCU),
new SubProgressMonitor(monitor, 1))
cb.finishReWrites(typeHierarchy, createdType)(
createConstructorsSelected)(createInheritedSelected)(
createMainSelected)
//end control of buffer
val cu = createdType.getCompilationUnit
reconcile(cu = cu)
if (monitor.isCanceled) throw new InterruptedException()
val formatter= new ScalaFormatterCleanUpProvider()
val textChange= formatter.createCleanUp(cu).createChange(monitor)
textChange.perform(monitor)
cu.commitWorkingCopy(true, new SubProgressMonitor(monitor, 1))
parentCU.discardWorkingCopy
} catch {
case ex: JavaModelException => eclipseLog.error(ex)
} finally {
monitor done
}
}
/** Return the package declaration used in the resources created by the wizard.
* This is needed because the package declaration may be different from the
* file's location (as in the case of a `package object`).*/
protected def getPackageNameToInject = !getPackageFragment.isDefaultPackage match {
case true => Some(getPackageFragment.getElementName)
case _ => None
}
protected def getTypeNameWithoutParameters() = getTypeName.split('[')(0)
override def getCompilationUnitName(typeName: String) = typeName + ".scala"
/*
* Override because getTypeNameWithoutParameters is a private method in
* superclass
*
* @see org.eclipse.jdt.ui.wizards.NewTypeWizardPage#getModifiedResource()
*/
override def getModifiedResource(): IResource = {
val enclosing = getEnclosingType()
if (enclosing != null) {
return enclosing.getResource()
}
val pack = getPackageFragment()
if (pack != null) {
val cuName = getCompilationUnitName(getTypeNameWithoutParameters())
return pack.getCompilationUnit(cuName).getResource()
}
null
}
override def getCreatedType() = createdType
override protected def typeNameChanged(): IStatus = {
var status = super.typeNameChanged.asInstanceOf[StatusInfo]
logger.info(">>>> Status = " + status)
val pack = getPackageFragment
if (pack != null) {
val project = pack.getJavaProject
try {
if (!plugin.isScalaProject(project.getProject)) {
val msg = project.getElementName + " is not a Scala project"
logger.info(msg)
status.setError(msg)
}
} catch {
case _: CoreException => status.setError(
"Exception when accessing project natures for " +
project.getElementName)
}
if (!isEnclosingTypeSelected && (status.getSeverity < IStatus.ERROR)) {
try {
val theType = project.findType(pack.getElementName, getGeneratedTypeName)
if (theType != null) {
status.setError(
NewWizardMessages.NewTypeWizardPage_error_TypeNameExists)
}
} catch {
case _: JavaModelException =>
}
}
}
status
}
/** The type's name that is generated by the wizard.*/
protected def getGeneratedTypeName = getTypeNameWithoutParameters
}