--- /dev/null
+/*\r
+ * (c) Copyright IBM Corp. 2000, 2001.\r
+ * All Rights Reserved.\r
+ */\r
+package net.sourceforge.phpdt.internal.ui.preferences;\r
+\r
+import java.io.BufferedReader;\r
+import java.io.IOException;\r
+import java.io.InputStreamReader;\r
+import java.util.ArrayList;\r
+import java.util.Hashtable;\r
+\r
+import net.sourceforge.phpdt.core.ICodeFormatter;\r
+import net.sourceforge.phpdt.core.JavaCore;\r
+import net.sourceforge.phpdt.core.ToolFactory;\r
+import net.sourceforge.phpdt.internal.ui.PHPUIMessages;\r
+import net.sourceforge.phpdt.internal.ui.dialogs.StatusInfo;\r
+import net.sourceforge.phpdt.internal.ui.dialogs.StatusUtil;\r
+import net.sourceforge.phpdt.internal.ui.util.TabFolderLayout;\r
+import net.sourceforge.phpeclipse.PHPeclipsePlugin;\r
+\r
+import org.eclipse.core.runtime.IStatus;\r
+import org.eclipse.jface.preference.PreferencePage;\r
+import org.eclipse.jface.text.Document;\r
+import org.eclipse.jface.text.IDocument;\r
+import org.eclipse.swt.SWT;\r
+import org.eclipse.swt.events.ModifyEvent;\r
+import org.eclipse.swt.events.ModifyListener;\r
+import org.eclipse.swt.events.SelectionEvent;\r
+import org.eclipse.swt.events.SelectionListener;\r
+import org.eclipse.swt.layout.GridData;\r
+import org.eclipse.swt.layout.GridLayout;\r
+import org.eclipse.swt.widgets.Button;\r
+import org.eclipse.swt.widgets.Composite;\r
+import org.eclipse.swt.widgets.Control;\r
+import org.eclipse.swt.widgets.Label;\r
+import org.eclipse.swt.widgets.TabFolder;\r
+import org.eclipse.swt.widgets.TabItem;\r
+import org.eclipse.swt.widgets.Text;\r
+import org.eclipse.ui.IWorkbench;\r
+import org.eclipse.ui.IWorkbenchPreferencePage;\r
+\r
+/*\r
+ * The page for setting code formatter options\r
+ */\r
+public class CodeFormatterPreferencePage extends PreferencePage implements\r
+ IWorkbenchPreferencePage {\r
+\r
+ // Preference store keys, see PHPCore.getOptions\r
+ private static final String PREF_NEWLINE_OPENING_BRACES = JavaCore.FORMATTER_NEWLINE_OPENING_BRACE;\r
+\r
+ private static final String PREF_NEWLINE_CONTROL_STATEMENT = JavaCore.FORMATTER_NEWLINE_CONTROL;\r
+\r
+ private static final String PREF_NEWLINE_CLEAR_ALL = JavaCore.FORMATTER_CLEAR_BLANK_LINES;\r
+\r
+ // private static final String PREF_NEWLINE_ELSE_IF=\r
+ // PHPCore.FORMATTER_NEWLINE_ELSE_IF;\r
+ private static final String PREF_NEWLINE_EMPTY_BLOCK = JavaCore.FORMATTER_NEWLINE_EMPTY_BLOCK;\r
+\r
+ private static final String PREF_LINE_SPLIT = JavaCore.FORMATTER_LINE_SPLIT;\r
+\r
+ private static final String PREF_STYLE_COMPACT_ASSIGNEMENT = JavaCore.FORMATTER_COMPACT_ASSIGNMENT;\r
+\r
+ private static final String PREF_STYLE_COMPACT_STRING_CONCATENATION = JavaCore.FORMATTER_COMPACT_STRING_CONCATENATION;\r
+\r
+ private static final String PREF_STYLE_COMPACT_ARRAYS = JavaCore.FORMATTER_COMPACT_ARRAYS;\r
+ \r
+ private static final String PREF_TAB_CHAR = JavaCore.FORMATTER_TAB_CHAR;\r
+\r
+ private static final String PREF_TAB_SIZE = JavaCore.FORMATTER_TAB_SIZE;\r
+\r
+ // values\r
+ private static final String INSERT = JavaCore.INSERT;\r
+\r
+ private static final String DO_NOT_INSERT = JavaCore.DO_NOT_INSERT;\r
+\r
+ private static final String COMPACT = JavaCore.COMPACT;\r
+\r
+ private static final String NORMAL = JavaCore.NORMAL;\r
+\r
+ private static final String TAB = JavaCore.TAB;\r
+\r
+ private static final String SPACE = JavaCore.SPACE;\r
+\r
+ private static final String CLEAR_ALL = JavaCore.CLEAR_ALL;\r
+\r
+ private static final String PRESERVE_ONE = JavaCore.PRESERVE_ONE;\r
+\r
+ private static String[] getAllKeys() {\r
+ return new String[] { PREF_NEWLINE_OPENING_BRACES,\r
+ PREF_NEWLINE_CONTROL_STATEMENT, PREF_NEWLINE_CLEAR_ALL,\r
+ // PREF_NEWLINE_ELSE_IF,\r
+ PREF_NEWLINE_EMPTY_BLOCK, PREF_LINE_SPLIT,\r
+ PREF_STYLE_COMPACT_ASSIGNEMENT, PREF_STYLE_COMPACT_STRING_CONCATENATION,\r
+ PREF_STYLE_COMPACT_ARRAYS,\r
+ PREF_TAB_CHAR, PREF_TAB_SIZE };\r
+ }\r
+\r
+ /**\r
+ * Gets the currently configured tab size\r
+ * \r
+ * @deprecated Inline to avoid reference to preference page\r
+ */\r
+ public static int getTabSize() {\r
+ String string = (String) JavaCore.getOptions().get(PREF_TAB_SIZE);\r
+ return getPositiveIntValue(string, 4);\r
+ }\r
+\r
+ /**\r
+ * Gets the current compating assignement configuration\r
+ * \r
+ * @deprecated Inline to avoid reference to preference page\r
+ */\r
+ public static boolean isCompactingAssignment() {\r
+ return COMPACT.equals(JavaCore.getOptions().get(\r
+ PREF_STYLE_COMPACT_ASSIGNEMENT));\r
+ }\r
+\r
+ /**\r
+ * Gets the current compating assignement configuration\r
+ * \r
+ * @deprecated Inline to avoid reference to preference page\r
+ */\r
+ public static boolean useSpaces() {\r
+ return SPACE.equals(JavaCore.getOptions().get(PREF_TAB_CHAR));\r
+ }\r
+\r
+ private static int getPositiveIntValue(String string, int dflt) {\r
+ try {\r
+ int i = Integer.parseInt(string);\r
+ if (i >= 0) {\r
+ return i;\r
+ }\r
+ } catch (NumberFormatException e) {\r
+ }\r
+ return dflt;\r
+ }\r
+\r
+ private static class ControlData {\r
+ private String fKey;\r
+\r
+ private String[] fValues;\r
+\r
+ public ControlData(String key, String[] values) {\r
+ fKey = key;\r
+ fValues = values;\r
+ }\r
+\r
+ public String getKey() {\r
+ return fKey;\r
+ }\r
+\r
+ public String getValue(boolean selection) {\r
+ int index = selection ? 0 : 1;\r
+ return fValues[index];\r
+ }\r
+\r
+ public String getValue(int index) {\r
+ return fValues[index];\r
+ }\r
+\r
+ public int getSelection(String value) {\r
+ for (int i = 0; i < fValues.length; i++) {\r
+ if (value.equals(fValues[i])) {\r
+ return i;\r
+ }\r
+ }\r
+ throw new IllegalArgumentException();\r
+ }\r
+ }\r
+\r
+ private Hashtable fWorkingValues;\r
+\r
+ private ArrayList fCheckBoxes;\r
+\r
+ private ArrayList fTextBoxes;\r
+\r
+ private SelectionListener fButtonSelectionListener;\r
+\r
+ private ModifyListener fTextModifyListener;\r
+\r
+ private String fPreviewText;\r
+\r
+ private IDocument fPreviewDocument;\r
+\r
+ private Text fTabSizeTextBox;\r
+\r
+ // private SourceViewer fSourceViewer;\r
+\r
+ public CodeFormatterPreferencePage() {\r
+ setPreferenceStore(PHPeclipsePlugin.getDefault().getPreferenceStore());\r
+ setDescription(PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.description")); //$NON-NLS-1$\r
+\r
+ fWorkingValues = JavaCore.getOptions();\r
+ fCheckBoxes = new ArrayList();\r
+ fTextBoxes = new ArrayList();\r
+\r
+ fButtonSelectionListener = new SelectionListener() {\r
+ public void widgetDefaultSelected(SelectionEvent e) {\r
+ }\r
+\r
+ public void widgetSelected(SelectionEvent e) {\r
+ if (!e.widget.isDisposed()) {\r
+ controlChanged((Button) e.widget);\r
+ }\r
+ }\r
+ };\r
+\r
+ fTextModifyListener = new ModifyListener() {\r
+ public void modifyText(ModifyEvent e) {\r
+ if (!e.widget.isDisposed()) {\r
+ textChanged((Text) e.widget);\r
+ }\r
+ }\r
+ };\r
+\r
+ fPreviewDocument = new Document();\r
+ fPreviewText = loadPreviewFile("CodeFormatterPreviewCode.txt"); //$NON-NLS-1$ \r
+ }\r
+\r
+ /*\r
+ * @see IWorkbenchPreferencePage#init()\r
+ */\r
+ public void init(IWorkbench workbench) {\r
+ }\r
+\r
+ /*\r
+ * @see PreferencePage#createControl(Composite)\r
+ */\r
+ public void createControl(Composite parent) {\r
+ super.createControl(parent);\r
+ // WorkbenchHelp.setHelp(getControl(),\r
+ // IJavaHelpContextIds.CODEFORMATTER_PREFERENCE_PAGE);\r
+ }\r
+\r
+ /*\r
+ * @see PreferencePage#createContents(Composite)\r
+ */\r
+ protected Control createContents(Composite parent) {\r
+\r
+ GridLayout layout = new GridLayout();\r
+ layout.marginHeight = 0;\r
+ layout.marginWidth = 0;\r
+\r
+ Composite composite = new Composite(parent, SWT.NONE);\r
+ composite.setLayout(layout);\r
+\r
+ TabFolder folder = new TabFolder(composite, SWT.NONE);\r
+ folder.setLayout(new TabFolderLayout());\r
+ folder.setLayoutData(new GridData(GridData.FILL_BOTH));\r
+\r
+ String[] insertNotInsert = new String[] { INSERT, DO_NOT_INSERT };\r
+\r
+ layout = new GridLayout();\r
+ layout.numColumns = 2;\r
+\r
+ Composite newlineComposite = new Composite(folder, SWT.NULL);\r
+ newlineComposite.setLayout(layout);\r
+\r
+ String label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.newline_opening_braces.label"); //$NON-NLS-1$\r
+ addCheckBox(newlineComposite, label, PREF_NEWLINE_OPENING_BRACES,\r
+ insertNotInsert);\r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.newline_control_statement.label"); //$NON-NLS-1$\r
+ addCheckBox(newlineComposite, label, PREF_NEWLINE_CONTROL_STATEMENT,\r
+ insertNotInsert);\r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.newline_clear_lines"); //$NON-NLS-1$\r
+ addCheckBox(newlineComposite, label, PREF_NEWLINE_CLEAR_ALL,\r
+ new String[] { CLEAR_ALL, PRESERVE_ONE });\r
+\r
+ // label=\r
+ // PHPUIMessages.getString("CodeFormatterPreferencePage.newline_else_if.label");\r
+ // //$NON-NLS-1$\r
+ // addCheckBox(newlineComposite, label, PREF_NEWLINE_ELSE_IF,\r
+ // insertNotInsert);\r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.newline_empty_block.label"); //$NON-NLS-1$\r
+ addCheckBox(newlineComposite, label, PREF_NEWLINE_EMPTY_BLOCK,\r
+ insertNotInsert);\r
+\r
+ layout = new GridLayout();\r
+ layout.numColumns = 2;\r
+\r
+ Composite lineSplittingComposite = new Composite(folder, SWT.NULL);\r
+ lineSplittingComposite.setLayout(layout);\r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.split_line.label"); //$NON-NLS-1$\r
+ addTextField(lineSplittingComposite, label, PREF_LINE_SPLIT);\r
+\r
+ layout = new GridLayout();\r
+ layout.numColumns = 2;\r
+\r
+ Composite styleComposite = new Composite(folder, SWT.NULL);\r
+ styleComposite.setLayout(layout);\r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.style_compact_assignement.label"); //$NON-NLS-1$\r
+ addCheckBox(styleComposite, label, PREF_STYLE_COMPACT_ASSIGNEMENT,\r
+ new String[] { COMPACT, NORMAL });\r
+ \r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.style_compact_string_concatenation.label"); //$NON-NLS-1$\r
+ addCheckBox(styleComposite, label, PREF_STYLE_COMPACT_STRING_CONCATENATION,\r
+ new String[] { COMPACT, NORMAL });\r
+ \r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.style_compact_arrays.label"); //$NON-NLS-1$\r
+ addCheckBox(styleComposite, label, PREF_STYLE_COMPACT_ARRAYS,\r
+ new String[] { COMPACT, NORMAL }); \r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.tab_char.label"); //$NON-NLS-1$\r
+ addCheckBox(styleComposite, label, PREF_TAB_CHAR, new String[] { TAB,\r
+ SPACE });\r
+\r
+ label = PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.tab_size.label"); //$NON-NLS-1$\r
+ fTabSizeTextBox = addTextField(styleComposite, label, PREF_TAB_SIZE);\r
+\r
+ TabItem item = new TabItem(folder, SWT.NONE);\r
+ item.setText(PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.tab.newline.tabtitle")); //$NON-NLS-1$\r
+ item.setControl(newlineComposite);\r
+\r
+ item = new TabItem(folder, SWT.NONE);\r
+ item\r
+ .setText(PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.tab.linesplit.tabtitle")); //$NON-NLS-1$\r
+ item.setControl(lineSplittingComposite);\r
+\r
+ item = new TabItem(folder, SWT.NONE);\r
+ item.setText(PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.tab.style.tabtitle")); //$NON-NLS-1$\r
+ item.setControl(styleComposite);\r
+\r
+ // fSourceViewer= createPreview(parent);\r
+\r
+ updatePreview();\r
+\r
+ return composite;\r
+ }\r
+\r
+ // private SourceViewer createPreview(Composite parent) {\r
+ // SourceViewer previewViewer= new SourceViewer(parent, null, SWT.V_SCROLL |\r
+ // SWT.H_SCROLL | SWT.BORDER);\r
+ // JavaTextTools tools= JavaPlugin.getDefault().getJavaTextTools();\r
+ // previewViewer.configure(new PHPSourceViewerConfiguration(tools, null));\r
+ // previewViewer.getTextWidget().setFont(JFaceResources.getFontRegistry().get(JFaceResources.TEXT_FONT));\r
+ // previewViewer.getTextWidget().setTabs(getPositiveIntValue((String)\r
+ // fWorkingValues.get(PREF_TAB_SIZE), 0));\r
+ // previewViewer.setEditable(false);\r
+ // previewViewer.setDocument(fPreviewDocument);\r
+ // Control control= previewViewer.getControl();\r
+ // GridData gdata= new GridData(GridData.FILL_BOTH);\r
+ // gdata.widthHint= convertWidthInCharsToPixels(30);\r
+ // gdata.heightHint= convertHeightInCharsToPixels(5);\r
+ // control.setLayoutData(gdata);\r
+ // return previewViewer;\r
+ // }\r
+\r
+ private Button addCheckBox(Composite parent, String label, String key,\r
+ String[] values) {\r
+ ControlData data = new ControlData(key, values);\r
+\r
+ GridData gd = new GridData(GridData.FILL_HORIZONTAL);\r
+ gd.horizontalSpan = 2;\r
+\r
+ Button checkBox = new Button(parent, SWT.CHECK);\r
+ checkBox.setText(label);\r
+ checkBox.setData(data);\r
+ checkBox.setLayoutData(gd);\r
+\r
+ String currValue = (String) fWorkingValues.get(key);\r
+ checkBox.setSelection(data.getSelection(currValue) == 0);\r
+ checkBox.addSelectionListener(fButtonSelectionListener);\r
+\r
+ fCheckBoxes.add(checkBox);\r
+ return checkBox;\r
+ }\r
+\r
+ private Text addTextField(Composite parent, String label, String key) {\r
+ Label labelControl = new Label(parent, SWT.NONE);\r
+ labelControl.setText(label);\r
+ labelControl.setLayoutData(new GridData());\r
+\r
+ Text textBox = new Text(parent, SWT.BORDER | SWT.SINGLE);\r
+ textBox.setData(key);\r
+ textBox.setLayoutData(new GridData());\r
+\r
+ String currValue = (String) fWorkingValues.get(key);\r
+ textBox.setText(String.valueOf(getPositiveIntValue(currValue, 1)));\r
+ textBox.setTextLimit(3);\r
+ textBox.addModifyListener(fTextModifyListener);\r
+\r
+ GridData gd = new GridData();\r
+ gd.widthHint = convertWidthInCharsToPixels(5);\r
+ textBox.setLayoutData(gd);\r
+\r
+ fTextBoxes.add(textBox);\r
+ return textBox;\r
+ }\r
+\r
+ private void controlChanged(Button button) {\r
+ ControlData data = (ControlData) button.getData();\r
+ boolean selection = button.getSelection();\r
+ String newValue = data.getValue(selection);\r
+ fWorkingValues.put(data.getKey(), newValue);\r
+ updatePreview();\r
+\r
+ if (PREF_TAB_CHAR.equals(data.getKey())) {\r
+ updateStatus(new StatusInfo());\r
+ if (selection) {\r
+ fTabSizeTextBox.setText((String) fWorkingValues\r
+ .get(PREF_TAB_SIZE));\r
+ }\r
+ }\r
+ }\r
+\r
+ private void textChanged(Text textControl) {\r
+ String key = (String) textControl.getData();\r
+ String number = textControl.getText();\r
+ IStatus status = validatePositiveNumber(number);\r
+ if (!status.matches(IStatus.ERROR)) {\r
+ fWorkingValues.put(key, number);\r
+ }\r
+ // if (PREF_TAB_SIZE.equals(key)) {\r
+ // fSourceViewer.getTextWidget().setTabs(getPositiveIntValue(number,\r
+ // 0));\r
+ // }\r
+ updateStatus(status);\r
+ updatePreview();\r
+ }\r
+\r
+ /*\r
+ * @see IPreferencePage#performOk()\r
+ */\r
+ public boolean performOk() {\r
+ String[] allKeys = getAllKeys();\r
+ // preserve other options\r
+ // store in JCore\r
+ Hashtable actualOptions = JavaCore.getOptions();\r
+ for (int i = 0; i < allKeys.length; i++) {\r
+ String key = allKeys[i];\r
+ String val = (String) fWorkingValues.get(key);\r
+ actualOptions.put(key, val);\r
+ }\r
+ JavaCore.setOptions(actualOptions);\r
+ PHPeclipsePlugin.getDefault().savePluginPreferences();\r
+ return super.performOk();\r
+ }\r
+\r
+ /*\r
+ * @see PreferencePage#performDefaults()\r
+ */\r
+ protected void performDefaults() {\r
+ fWorkingValues = JavaCore.getDefaultOptions();\r
+ updateControls();\r
+ super.performDefaults();\r
+ }\r
+\r
+ private String loadPreviewFile(String filename) {\r
+ String separator = System.getProperty("line.separator"); //$NON-NLS-1$\r
+ StringBuffer btxt = new StringBuffer(512);\r
+ BufferedReader rin = null;\r
+ try {\r
+ rin = new BufferedReader(new InputStreamReader(getClass()\r
+ .getResourceAsStream(filename)));\r
+ String line;\r
+ while ((line = rin.readLine()) != null) {\r
+ btxt.append(line);\r
+ btxt.append(separator);\r
+ }\r
+ } catch (IOException io) {\r
+ PHPeclipsePlugin.log(io);\r
+ } finally {\r
+ if (rin != null) {\r
+ try {\r
+ rin.close();\r
+ } catch (IOException e) {\r
+ }\r
+ }\r
+ }\r
+ return btxt.toString();\r
+ }\r
+\r
+ private void updatePreview() {\r
+ ICodeFormatter formatter = ToolFactory\r
+ .createDefaultCodeFormatter(fWorkingValues);\r
+ fPreviewDocument.set(formatter.format(fPreviewText, 0, null, "\n")); //$NON-NLS-1$\r
+ }\r
+\r
+ private void updateControls() {\r
+ // update the UI\r
+ for (int i = fCheckBoxes.size() - 1; i >= 0; i--) {\r
+ Button curr = (Button) fCheckBoxes.get(i);\r
+ ControlData data = (ControlData) curr.getData();\r
+\r
+ String currValue = (String) fWorkingValues.get(data.getKey());\r
+ curr.setSelection(data.getSelection(currValue) == 0);\r
+ }\r
+ for (int i = fTextBoxes.size() - 1; i >= 0; i--) {\r
+ Text curr = (Text) fTextBoxes.get(i);\r
+ String key = (String) curr.getData();\r
+ String currValue = (String) fWorkingValues.get(key);\r
+ curr.setText(currValue);\r
+ }\r
+ }\r
+\r
+ private IStatus validatePositiveNumber(String number) {\r
+ StatusInfo status = new StatusInfo();\r
+ if (number.length() == 0) {\r
+ status.setError(PHPUIMessages\r
+ .getString("CodeFormatterPreferencePage.empty_input")); //$NON-NLS-1$\r
+ } else {\r
+ try {\r
+ int value = Integer.parseInt(number);\r
+ if (value < 0) {\r
+ status\r
+ .setError(PHPUIMessages\r
+ .getFormattedString(\r
+ "CodeFormatterPreferencePage.invalid_input", number)); //$NON-NLS-1$\r
+ }\r
+ } catch (NumberFormatException e) {\r
+ status.setError(PHPUIMessages.getFormattedString(\r
+ "CodeFormatterPreferencePage.invalid_input", number)); //$NON-NLS-1$\r
+ }\r
+ }\r
+ return status;\r
+ }\r
+\r
+ private void updateStatus(IStatus status) {\r
+ if (!status.matches(IStatus.ERROR)) {\r
+ // look if there are more severe errors\r
+ for (int i = 0; i < fTextBoxes.size(); i++) {\r
+ Text curr = (Text) fTextBoxes.get(i);\r
+ if (!(curr == fTabSizeTextBox && usesTabs())) {\r
+ IStatus currStatus = validatePositiveNumber(curr.getText());\r
+ status = StatusUtil.getMoreSevere(currStatus, status);\r
+ }\r
+ }\r
+ }\r
+ setValid(!status.matches(IStatus.ERROR));\r
+ StatusUtil.applyToStatusLine(this, status);\r
+ }\r
+\r
+ private boolean usesTabs() {\r
+ return TAB.equals(fWorkingValues.get(PREF_TAB_CHAR));\r
+ }\r
+\r
+}\r