/*******************************************************************************
* Copyright (c) 2000, 2009 IBM Corporation and others.
* 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:
* IBM Corporation - initial API and implementation
* John Kaplan, johnkaplantech@gmail.com - 108071 [code templates] template for body of newly created class
*******************************************************************************/
package org.eclipse.wst.jsdt.internal.ui.preferences;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.eclipse.core.resources.IProject;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.jface.text.templates.persistence.TemplatePersistenceData;
import org.eclipse.jface.text.templates.persistence.TemplateReaderWriter;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.FileDialog;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.wst.jsdt.internal.corext.template.java.CodeTemplateContextType;
import org.eclipse.wst.jsdt.internal.corext.util.Messages;
import org.eclipse.wst.jsdt.internal.ui.JavaScriptPlugin;
import org.eclipse.wst.jsdt.internal.ui.javaeditor.JavaSourceViewer;
import org.eclipse.wst.jsdt.internal.ui.text.template.preferences.TemplateVariableProcessor;
import org.eclipse.wst.jsdt.internal.ui.util.PixelConverter;
import org.eclipse.wst.jsdt.internal.ui.viewsupport.ProjectTemplateStore;
import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.DialogField;
import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.IDialogFieldListener;
import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.ITreeListAdapter;
import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.LayoutUtil;
import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.TreeListDialogField;
import org.eclipse.wst.jsdt.ui.PreferenceConstants;
import org.eclipse.wst.jsdt.ui.text.IJavaScriptPartitions;
import org.eclipse.wst.jsdt.ui.text.JavaScriptTextTools;
/**
*/
public class CodeTemplateBlock {
private class CodeTemplateAdapter extends ViewerComparator implements ITreeListAdapter, IDialogFieldListener {
private final Object[] NO_CHILDREN= new Object[0];
public void customButtonPressed(TreeListDialogField field, int index) {
doButtonPressed(index, field.getSelectedElements());
}
public void selectionChanged(TreeListDialogField field) {
List selected= field.getSelectedElements();
field.enableButton(IDX_EDIT, canEdit(selected));
field.enableButton(IDX_EXPORT, !selected.isEmpty());
updateSourceViewerInput(selected);
}
public void doubleClicked(TreeListDialogField field) {
List selected= field.getSelectedElements();
if (canEdit(selected)) {
doButtonPressed(IDX_EDIT, selected);
}
}
public Object[] getChildren(TreeListDialogField field, Object element) {
if (element == COMMENT_NODE || element == CODE_NODE) {
return getTemplateOfCategory(element == COMMENT_NODE);
}
return NO_CHILDREN;
}
public Object getParent(TreeListDialogField field, Object element) {
if (element instanceof TemplatePersistenceData) {
TemplatePersistenceData data= (TemplatePersistenceData) element;
if (data.getTemplate().getName().endsWith(CodeTemplateContextType.COMMENT_SUFFIX)) {
return COMMENT_NODE;
}
return CODE_NODE;
}
return null;
}
public boolean hasChildren(TreeListDialogField field, Object element) {
return (element == COMMENT_NODE || element == CODE_NODE);
}
public void dialogFieldChanged(DialogField field) {
}
public void keyPressed(TreeListDialogField field, KeyEvent event) {
}
/* (non-Javadoc)
* @see org.eclipse.jface.viewers.ViewerSorter#category(java.lang.Object)
*/
public int category(Object element) {
if (element == COMMENT_NODE) {
return 1;
} else if (element == CODE_NODE) {
return 2;
}
TemplatePersistenceData data= (TemplatePersistenceData) element;
String id= data.getId();
if (CodeTemplateContextType.NEWTYPE_ID.equals(id)) {
return 101;
} else if (CodeTemplateContextType.CLASSBODY_ID.equals(id)) {
return 102;
} else if (CodeTemplateContextType.METHODSTUB_ID.equals(id)) {
return 106;
} else if (CodeTemplateContextType.CONSTRUCTORSTUB_ID.equals(id)) {
return 107;
} else if (CodeTemplateContextType.GETTERSTUB_ID.equals(id)) {
return 108;
} else if (CodeTemplateContextType.SETTERSTUB_ID.equals(id)) {
return 109;
} else if (CodeTemplateContextType.CATCHBLOCK_ID.equals(id)) {
return 110;
} else if (CodeTemplateContextType.FILECOMMENT_ID.equals(id)) {
return 1;
} else if (CodeTemplateContextType.TYPECOMMENT_ID.equals(id)) {
return 2;
} else if (CodeTemplateContextType.FIELDCOMMENT_ID.equals(id)) {
return 3;
} else if (CodeTemplateContextType.CONSTRUCTORCOMMENT_ID.equals(id)) {
return 4;
} else if (CodeTemplateContextType.METHODCOMMENT_ID.equals(id)) {
return 5;
} else if (CodeTemplateContextType.OVERRIDECOMMENT_ID.equals(id)) {
return 6;
} else if (CodeTemplateContextType.DELEGATECOMMENT_ID.equals(id)) {
return 7;
} else if (CodeTemplateContextType.GETTERCOMMENT_ID.equals(id)) {
return 8;
} else if (CodeTemplateContextType.SETTERCOMMENT_ID.equals(id)) {
return 9;
}
return 1000;
}
}
private static class CodeTemplateLabelProvider extends LabelProvider {
/* (non-Javadoc)
* @see org.eclipse.jface.viewers.ILabelProvider#getImage(java.lang.Object)
*/
public Image getImage(Object element) {
return null;
}
/* (non-Javadoc)
* @see org.eclipse.jface.viewers.ILabelProvider#getText(java.lang.Object)
*/
public String getText(Object element) {
if (element == COMMENT_NODE || element == CODE_NODE) {
return (String) element;
}
TemplatePersistenceData data= (TemplatePersistenceData) element;
String id=data.getId();
if (CodeTemplateContextType.CATCHBLOCK_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_catchblock_label;
} else if (CodeTemplateContextType.METHODSTUB_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_methodstub_label;
} else if (CodeTemplateContextType.CONSTRUCTORSTUB_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_constructorstub_label;
} else if (CodeTemplateContextType.GETTERSTUB_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_getterstub_label;
} else if (CodeTemplateContextType.SETTERSTUB_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_setterstub_label;
} else if (CodeTemplateContextType.NEWTYPE_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_newtype_label;
} else if (CodeTemplateContextType.CLASSBODY_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_classbody_label;
} else if (CodeTemplateContextType.FILECOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_filecomment_label;
} else if (CodeTemplateContextType.TYPECOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_typecomment_label;
} else if (CodeTemplateContextType.FIELDCOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_fieldcomment_label;
} else if (CodeTemplateContextType.METHODCOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_methodcomment_label;
} else if (CodeTemplateContextType.OVERRIDECOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_overridecomment_label;
} else if (CodeTemplateContextType.DELEGATECOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_delegatecomment_label;
} else if (CodeTemplateContextType.CONSTRUCTORCOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_constructorcomment_label;
} else if (CodeTemplateContextType.GETTERCOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_gettercomment_label;
} else if (CodeTemplateContextType.SETTERCOMMENT_ID.equals(id)) {
return PreferencesMessages.CodeTemplateBlock_settercomment_label;
}
return data.getTemplate().getDescription();
}
}
private final static int IDX_EDIT= 0;
private final static int IDX_IMPORT= 2;
private final static int IDX_EXPORT= 3;
private final static int IDX_EXPORTALL= 4;
protected final static Object COMMENT_NODE= PreferencesMessages.CodeTemplateBlock_templates_comment_node;
protected final static Object CODE_NODE= PreferencesMessages.CodeTemplateBlock_templates_code_node;
private TreeListDialogField fCodeTemplateTree;
protected ProjectTemplateStore fTemplateStore;
private PixelConverter fPixelConverter;
private SourceViewer fPatternViewer;
private Control fSWTWidget;
private TemplateVariableProcessor fTemplateProcessor;
private final IProject fProject;
public CodeTemplateBlock(IProject project) {
fProject= project;
fTemplateStore= new ProjectTemplateStore(project);
try {
fTemplateStore.load();
} catch (IOException e) {
JavaScriptPlugin.log(e);
}
fTemplateProcessor= new TemplateVariableProcessor();
CodeTemplateAdapter adapter= new CodeTemplateAdapter();
String[] buttonLabels= new String[] {
PreferencesMessages.CodeTemplateBlock_templates_edit_button,
/* */ null,
PreferencesMessages.CodeTemplateBlock_templates_import_button,
PreferencesMessages.CodeTemplateBlock_templates_export_button,
PreferencesMessages.CodeTemplateBlock_templates_exportall_button
};
fCodeTemplateTree= new TreeListDialogField(adapter, buttonLabels, new CodeTemplateLabelProvider());
fCodeTemplateTree.setDialogFieldListener(adapter);
fCodeTemplateTree.setLabelText(PreferencesMessages.CodeTemplateBlock_templates_label);
fCodeTemplateTree.setViewerComparator(adapter);
fCodeTemplateTree.enableButton(IDX_EXPORT, false);
fCodeTemplateTree.enableButton(IDX_EDIT, false);
fCodeTemplateTree.addElement(COMMENT_NODE);
fCodeTemplateTree.addElement(CODE_NODE);
fCodeTemplateTree.selectFirstElement();
}
public void postSetSelection(Object element) {
fCodeTemplateTree.postSetSelection(new StructuredSelection(element));
}
public boolean hasProjectSpecificOptions(IProject project) {
if (project != null) {
return ProjectTemplateStore.hasProjectSpecificTempates(project);
}
return false;
}
protected Control createContents(Composite parent) {
fPixelConverter= new PixelConverter(parent);
fSWTWidget= parent;
Composite composite= new Composite(parent, SWT.NONE);
composite.setFont(parent.getFont());
GridLayout layout= new GridLayout();
layout.marginHeight= 0;
layout.marginWidth= 0;
layout.numColumns= 2;
composite.setLayout(layout);
fCodeTemplateTree.doFillIntoGrid(composite, 3);
LayoutUtil.setHorizontalSpan(fCodeTemplateTree.getLabelControl(null), 2);
LayoutUtil.setHorizontalGrabbing(fCodeTemplateTree.getTreeControl(null));
fPatternViewer= createViewer(composite, 2);
return composite;
}
private Shell getShell() {
if (fSWTWidget != null) {
return fSWTWidget.getShell();
}
return JavaScriptPlugin.getActiveWorkbenchShell();
}
private SourceViewer createViewer(Composite parent, int nColumns) {
Label label= new Label(parent, SWT.NONE);
label.setText(PreferencesMessages.CodeTemplateBlock_preview);
GridData data= new GridData();
data.horizontalSpan= nColumns;
label.setLayoutData(data);
IDocument document= new Document();
JavaScriptTextTools tools= JavaScriptPlugin.getDefault().getJavaTextTools();
tools.setupJavaDocumentPartitioner(document, IJavaScriptPartitions.JAVA_PARTITIONING);
IPreferenceStore store= JavaScriptPlugin.getDefault().getCombinedPreferenceStore();
SourceViewer viewer= new JavaSourceViewer(parent, null, null, false, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL, store);
CodeTemplateSourceViewerConfiguration configuration= new CodeTemplateSourceViewerConfiguration(tools.getColorManager(), store, null, fTemplateProcessor);
viewer.configure(configuration);
viewer.setEditable(false);
viewer.setDocument(document);
Font font= JFaceResources.getFont(PreferenceConstants.EDITOR_TEXT_FONT);
viewer.getTextWidget().setFont(font);
new JavaSourcePreviewerUpdater(viewer, configuration, store);
Control control= viewer.getControl();
data= new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.FILL_VERTICAL);
data.horizontalSpan= nColumns;
data.heightHint= fPixelConverter.convertHeightInCharsToPixels(5);
control.setLayoutData(data);
return viewer;
}
protected TemplatePersistenceData[] getTemplateOfCategory(boolean isComment) {
ArrayList res= new ArrayList();
TemplatePersistenceData[] templates= fTemplateStore.getTemplateData();
for (int i= 0; i < templates.length; i++) {
TemplatePersistenceData curr= templates[i];
if (isComment == curr.getTemplate().getName().endsWith(CodeTemplateContextType.COMMENT_SUFFIX)) {
res.add(curr);
}
}
return (TemplatePersistenceData[]) res.toArray(new TemplatePersistenceData[res.size()]);
}
protected static boolean canEdit(List selected) {
return selected.size() == 1 && (selected.get(0) instanceof TemplatePersistenceData);
}
protected void updateSourceViewerInput(List selection) {
if (fPatternViewer == null || fPatternViewer.getTextWidget().isDisposed()) {
return;
}
if (selection.size() == 1 && selection.get(0) instanceof TemplatePersistenceData) {
TemplatePersistenceData data= (TemplatePersistenceData) selection.get(0);
Template template= data.getTemplate();
TemplateContextType type= JavaScriptPlugin.getDefault().getCodeTemplateContextRegistry().getContextType(template.getContextTypeId());
fTemplateProcessor.setContextType(type);
fPatternViewer.getDocument().set(template.getPattern());
} else {
fPatternViewer.getDocument().set(""); //$NON-NLS-1$
}
}
protected void doButtonPressed(int buttonIndex, List selected) {
if (buttonIndex == IDX_EDIT) {
edit((TemplatePersistenceData) selected.get(0));
} else if (buttonIndex == IDX_EXPORT) {
export(selected);
} else if (buttonIndex == IDX_EXPORTALL) {
exportAll();
} else if (buttonIndex == IDX_IMPORT) {
import_();
}
}
private void edit(TemplatePersistenceData data) {
Template newTemplate= new Template(data.getTemplate());
EditTemplateDialog dialog= new EditTemplateDialog(getShell(), newTemplate, true, false, JavaScriptPlugin.getDefault().getCodeTemplateContextRegistry());
if (dialog.open() == Window.OK) {
// changed
data.setTemplate(dialog.getTemplate());
fCodeTemplateTree.refresh(data);
fCodeTemplateTree.selectElements(new StructuredSelection(data));
}
}
private void import_() {
FileDialog dialog= new FileDialog(getShell());
dialog.setText(PreferencesMessages.CodeTemplateBlock_import_title);
dialog.setFilterExtensions(new String[] {PreferencesMessages.CodeTemplateBlock_import_extension});
String path= dialog.open();
if (path == null)
return;
try {
TemplateReaderWriter reader= new TemplateReaderWriter();
File file= new File(path);
if (file.exists()) {
InputStream input= new BufferedInputStream(new FileInputStream(file));
try {
TemplatePersistenceData[] datas= reader.read(input, null);
for (int i= 0; i < datas.length; i++) {
updateTemplate(datas[i]);
}
} finally {
try {
input.close();
} catch (IOException x) {
}
}
}
fCodeTemplateTree.refresh();
updateSourceViewerInput(fCodeTemplateTree.getSelectedElements());
} catch (FileNotFoundException e) {
openReadErrorDialog(e);
} catch (IOException e) {
openReadErrorDialog(e);
}
}
private void updateTemplate(TemplatePersistenceData data) {
TemplatePersistenceData[] datas= fTemplateStore.getTemplateData();
for (int i= 0; i < datas.length; i++) {
String id= datas[i].getId();
if (id != null && id.equals(data.getId())) {
datas[i].setTemplate(data.getTemplate());
break;
}
}
}
private void exportAll() {
export(fTemplateStore.getTemplateData());
}
private void export(List selected) {
Set datas= new HashSet();
for (int i= 0; i < selected.size(); i++) {
Object curr= selected.get(i);
if (curr instanceof TemplatePersistenceData) {
datas.add(curr);
} else {
TemplatePersistenceData[] cat= getTemplateOfCategory(curr == COMMENT_NODE);
datas.addAll(Arrays.asList(cat));
}
}
export((TemplatePersistenceData[]) datas.toArray(new TemplatePersistenceData[datas.size()]));
}
private void export(TemplatePersistenceData[] templates) {
FileDialog dialog= new FileDialog(getShell(), SWT.SAVE);
dialog.setText(Messages.format(PreferencesMessages.CodeTemplateBlock_export_title, String.valueOf(templates.length)));
dialog.setFilterExtensions(new String[] {PreferencesMessages.CodeTemplateBlock_export_extension});
dialog.setFileName(PreferencesMessages.CodeTemplateBlock_export_filename);
String path= dialog.open();
if (path == null)
return;
File file= new File(path);
if (file.isHidden()) {
String title= PreferencesMessages.CodeTemplateBlock_export_error_title;
String message= Messages.format(PreferencesMessages.CodeTemplateBlock_export_error_hidden, file.getAbsolutePath());
MessageDialog.openError(getShell(), title, message);
return;
}
if (file.exists() && !file.canWrite()) {
String title= PreferencesMessages.CodeTemplateBlock_export_error_title;
String message= Messages.format(PreferencesMessages.CodeTemplateBlock_export_error_canNotWrite, file.getAbsolutePath());
MessageDialog.openError(getShell(), title, message);
return;
}
if (!file.exists() || confirmOverwrite(file)) {
OutputStream output= null;
try {
output= new BufferedOutputStream(new FileOutputStream(file));
TemplateReaderWriter writer= new TemplateReaderWriter();
writer.save(templates, output);
output.close();
} catch (IOException e) {
if (output != null) {
try {
output.close();
} catch (IOException e2) {
// ignore
}
}
openWriteErrorDialog(e);
}
}
}
private boolean confirmOverwrite(File file) {
return MessageDialog.openQuestion(getShell(),
PreferencesMessages.CodeTemplateBlock_export_exists_title,
Messages.format(PreferencesMessages.CodeTemplateBlock_export_exists_message, file.getAbsolutePath()));
}
public void performDefaults() {
fTemplateStore.restoreDefaults();
// refresh
fCodeTemplateTree.refresh();
updateSourceViewerInput(fCodeTemplateTree.getSelectedElements());
}
public boolean performOk(boolean enabled) {
if (fProject != null) {
TemplatePersistenceData[] templateData= fTemplateStore.getTemplateData();
for (int i= 0; i < templateData.length; i++) {
fTemplateStore.setProjectSpecific(templateData[i].getId(), enabled);
}
}
try {
fTemplateStore.save();
} catch (IOException e) {
JavaScriptPlugin.log(e);
openWriteErrorDialog(e);
}
return true;
}
public void performCancel() {
try {
fTemplateStore.revertChanges();
} catch (IOException e) {
openReadErrorDialog(e);
}
}
private void openReadErrorDialog(Exception e) {
String title= PreferencesMessages.CodeTemplateBlock_error_read_title;
String message= e.getLocalizedMessage();
if (message != null)
message= Messages.format(PreferencesMessages.CodeTemplateBlock_error_parse_message, message);
else
message= PreferencesMessages.CodeTemplateBlock_error_read_message;
MessageDialog.openError(getShell(), title, message);
}
private void openWriteErrorDialog(Exception e) {
String title= PreferencesMessages.CodeTemplateBlock_error_write_title;
String message= PreferencesMessages.CodeTemplateBlock_error_write_message;
MessageDialog.openError(getShell(), title, message);
}
}