/*
[The "BSD licence"]
Copyright (c) 2005 Jean Bovet
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.antlr.works.dialog;
import com.jgoodies.forms.factories.Borders;
import com.jgoodies.forms.factories.FormFactory;
import com.jgoodies.forms.layout.*;
import org.antlr.xjlib.appkit.frame.XJDialog;
import org.antlr.xjlib.appkit.utils.XJAlert;
import org.antlr.xjlib.appkit.utils.XJDialogProgress;
import org.antlr.xjlib.appkit.utils.XJDialogProgressDelegate;
import org.antlr.xjlib.foundation.XJSystem;
import org.antlr.works.stats.StatisticsManager;
import org.antlr.works.stats.StatisticsReporter;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
public class DialogReports extends XJDialog {
public static final int TYPE_GUI = 0;
public static final int TYPE_GRAMMAR = 1;
public static final int TYPE_RUNTIME = 2;
protected StatisticsManager guiManager;
protected StatisticsManager grammarManager;
protected StatisticsManager runtimeManager;
protected DialogReportsDelegate delegate;
protected XJDialogProgress progress;
protected DefaultComboBoxModel typeModel = new DefaultComboBoxModel();
protected boolean usesAWStats = true;
public DialogReports(Container parent, boolean usesAWStats) {
super(parent, true);
this.usesAWStats = usesAWStats;
initComponents();
setSize(550, 500);
if(XJSystem.isMacOS()) {
CellConstraints cc = new CellConstraints();
buttonBar.remove(cancelButton);
buttonBar.remove(submitButton);
buttonBar.add(cancelButton, cc.xy(3, 1));
buttonBar.add(submitButton, cc.xy(5, 1));
}
setDefaultButton(submitButton);
setOKButton(submitButton);
setCancelButton(cancelButton);
buildTypeCombo();
humanFormatCheck.setSelected(true);
statsTextArea.setTabSize(2);
typeCombo.addActionListener(new MyActionListener());
humanFormatCheck.addActionListener(new MyActionListener());
currentSpinner.addChangeListener(new ChangeListener() {
public void stateChanged(ChangeEvent event) {
updateInfo(true);
}
});
}
public void setDelegate(DialogReportsDelegate delegate) {
this.delegate = delegate;
}
public void buildTypeCombo() {
if(usesAWStats)
typeModel.addElement("ANTLRWorks");
typeModel.addElement("ANTLR - grammar");
typeModel.addElement("ANTLR - runtime");
typeCombo.setModel(typeModel);
}
public void dialogWillDisplay() {
guiManager = new StatisticsManager(StatisticsReporter.TYPE_GUI);
grammarManager = new StatisticsManager(StatisticsReporter.TYPE_GRAMMAR);
runtimeManager = new StatisticsManager(StatisticsReporter.TYPE_RUNTIME);
updateInfo(false);
}
public void dialogWillCloseCancel() {
SwingUtilities.invokeLater(new Runnable() {
public void run() {
if(delegate != null)
delegate.reportsCancelled();
}
});
}
public void dialogWillCloseOK() {
new SendReport().send();
}
protected int getTypeIndex() {
if(usesAWStats)
return typeCombo.getSelectedIndex();
else
return typeCombo.getSelectedIndex()+1;
}
protected void updateInfo(boolean textOnly) {
StatisticsManager sm = null;
boolean rangeEnabled = true;
switch(getTypeIndex()) {
case TYPE_GUI:
rangeEnabled = false;
sm = guiManager;
break;
case TYPE_GRAMMAR:
rangeEnabled = true;
sm = grammarManager;
break;
case TYPE_RUNTIME:
rangeEnabled = true;
sm = runtimeManager;
break;
}
if(!textOnly)
setRangeEnabled(rangeEnabled, sm);
if(sm != null)
setText(sm);
}
protected void setRangeEnabled(boolean flag, StatisticsManager sm) {
currentSpinner.setEnabled(flag);
infoLabel.setEnabled(flag);
currentSpinner.setValue(new Integer(1));
SpinnerNumberModel spm = (SpinnerNumberModel)currentSpinner.getModel();
spm.setMaximum(new Integer(sm.getStatsCount()));
if(flag)
infoLabel.setText("of "+sm.getStatsCount());
else
infoLabel.setText("");
}
protected void setText(StatisticsManager sm) {
int index = ((Integer)currentSpinner.getValue()).intValue()-1;
String text = isHumanReadable() ? sm.getReadableString(index) : sm.getRawString(index);
if(text == null)
text = "* no statistics available *";
statsTextArea.setText(text);
statsTextArea.setCaretPosition(0);
}
protected boolean isHumanReadable() {
return humanFormatCheck.isSelected();
}
protected class SendReport implements Runnable, XJDialogProgressDelegate {
public boolean error = false;
public boolean cancel = false;
public StatisticsReporter reporter;
public StatisticsManager managers[] = { guiManager, grammarManager, runtimeManager };
public void send() {
progress = new XJDialogProgress(parent);
progress.setDelegate(this);
progress.setCancellable(true);
progress.setProgressMax(managers.length);
progress.setIndeterminate(false);
progress.setInfo("Sending statistics...");
progress.display();
error = false;
cancel = false;
reporter = new StatisticsReporter();
new Thread(this).start();
}
public boolean submit() {
for (int i = 0; i < managers.length; i++) {
StatisticsManager manager = managers[i];
if(manager == guiManager && !usesAWStats)
continue;
progress.setProgress(i+1);
if(!reporter.submitStats(manager))
return true;
if(cancel)
return false;
}
return false;
}
public void run() {
try {
error = submit();
} finally {
SwingUtilities.invokeLater(new Runnable() {
public void run() {
finished();
}
});
}
}
public void finished() {
if(!cancel) {
guiManager.reset();
grammarManager.reset();
runtimeManager.reset();
}
progress.close();
String title;
String info;
if(cancel) {
title = "Submission cancelled";
info = "The submission has been cancelled.";
} else {
if(error) {
title = "Submission failed";
info = "An error has occurred when sending the statistics:\n"+reporter.getError();
} else {
title = "Thank you";
info = "The statistics have been successfully transmitted.";
}
}
XJAlert.display(getJavaComponent(), title, info);
if(delegate != null) {
if(cancel)
delegate.reportsCancelled();
else
delegate.reportsSend(!error);
}
}
public void dialogDidCancel() {
cancel = true;
reporter.cancel();
}
}
protected class MyActionListener implements ActionListener {
public void actionPerformed(ActionEvent event) {
updateInfo(false);
}
}
private void initComponents() {
// JFormDesigner - Component initialization - DO NOT MODIFY //GEN-BEGIN:initComponents
// Generated using JFormDesigner Open Source Project license - ANTLR (www.antlr.org)
dialogPane = new JPanel();
contentPane = new JPanel();
label1 = new JLabel();
typeCombo = new JComboBox();
label22 = new JLabel();
humanFormatCheck = new JCheckBox();
currentSpinner = new JSpinner();
label2 = new JLabel();
infoLabel = new JLabel();
scrollPane1 = new JScrollPane();
statsTextArea = new JTextArea();
buttonBar = new JPanel();
submitButton = new JButton();
cancelButton = new JButton();
CellConstraints cc = new CellConstraints();
//======== this ========
setTitle("Review reports before submission");
Container contentPane2 = getContentPane();
contentPane2.setLayout(new BorderLayout());
//======== dialogPane ========
{
dialogPane.setBorder(Borders.DIALOG_BORDER);
dialogPane.setPreferredSize(new Dimension(500, 500));
dialogPane.setLayout(new BorderLayout());
//======== contentPane ========
{
contentPane.setLayout(new FormLayout(
new ColumnSpec[] {
FormFactory.DEFAULT_COLSPEC,
FormFactory.LABEL_COMPONENT_GAP_COLSPEC,
new ColumnSpec("max(min;30dlu)"),
FormFactory.LABEL_COMPONENT_GAP_COLSPEC,
FormFactory.RELATED_GAP_COLSPEC,
FormFactory.LABEL_COMPONENT_GAP_COLSPEC,
new ColumnSpec("max(min;30dlu):grow"),
FormFactory.LABEL_COMPONENT_GAP_COLSPEC,
new ColumnSpec(ColumnSpec.FILL, Sizes.DEFAULT, FormSpec.DEFAULT_GROW)
},
new RowSpec[] {
FormFactory.DEFAULT_ROWSPEC,
FormFactory.LINE_GAP_ROWSPEC,
FormFactory.DEFAULT_ROWSPEC,
FormFactory.LINE_GAP_ROWSPEC,
FormFactory.DEFAULT_ROWSPEC,
FormFactory.LINE_GAP_ROWSPEC,
FormFactory.DEFAULT_ROWSPEC,
FormFactory.LINE_GAP_ROWSPEC,
new RowSpec(RowSpec.CENTER, Sizes.DEFAULT, FormSpec.DEFAULT_GROW)
}));
//---- label1 ----
label1.setText("View report for:");
label1.setHorizontalAlignment(SwingConstants.RIGHT);
contentPane.add(label1, cc.xy(1, 1));
//---- typeCombo ----
typeCombo.setModel(new DefaultComboBoxModel(new String[] {
"ANTLRWorks",
"ANTLR - grammar",
"ANTLR - runtime"
}));
contentPane.add(typeCombo, cc.xywh(3, 1, 5, 1));
//---- label22 ----
label22.setText("Format:");
label22.setHorizontalAlignment(SwingConstants.RIGHT);
contentPane.add(label22, cc.xy(1, 3));
//---- humanFormatCheck ----
humanFormatCheck.setText("Human readable");
humanFormatCheck.setSelected(true);
contentPane.add(humanFormatCheck, cc.xywh(3, 3, 7, 1));
//---- currentSpinner ----
currentSpinner.setModel(new SpinnerNumberModel(new Integer(1), new Integer(1), null, new Integer(1)));
contentPane.add(currentSpinner, cc.xywh(3, 5, 2, 1));
//---- label2 ----
label2.setText("Report:");
label2.setHorizontalAlignment(SwingConstants.RIGHT);
contentPane.add(label2, cc.xy(1, 5));
//---- infoLabel ----
infoLabel.setText("of 999");
contentPane.add(infoLabel, cc.xywh(7, 5, 3, 1));
//======== scrollPane1 ========
{
//---- statsTextArea ----
statsTextArea.setEditable(false);
statsTextArea.setLineWrap(false);
statsTextArea.setWrapStyleWord(false);
statsTextArea.setTabSize(2);
scrollPane1.setViewportView(statsTextArea);
}
contentPane.add(scrollPane1, cc.xywh(1, 7, 9, 3));
}
dialogPane.add(contentPane, BorderLayout.CENTER);
//======== buttonBar ========
{
buttonBar.setBorder(Borders.BUTTON_BAR_GAP_BORDER);
buttonBar.setLayout(new FormLayout(
new ColumnSpec[] {
new ColumnSpec(ColumnSpec.FILL, Sizes.DEFAULT, FormSpec.DEFAULT_GROW),
FormFactory.LABEL_COMPONENT_GAP_COLSPEC,
FormFactory.BUTTON_COLSPEC,
FormFactory.RELATED_GAP_COLSPEC,
FormFactory.BUTTON_COLSPEC
},
RowSpec.decodeSpecs("pref")));
//---- submitButton ----
submitButton.setText("Submit");
buttonBar.add(submitButton, cc.xy(3, 1));
//---- cancelButton ----
cancelButton.setText("Cancel");
buttonBar.add(cancelButton, cc.xy(5, 1));
}
dialogPane.add(buttonBar, BorderLayout.SOUTH);
}
contentPane2.add(dialogPane, BorderLayout.CENTER);
pack();
// JFormDesigner - End of component initialization //GEN-END:initComponents
}
// JFormDesigner - Variables declaration - DO NOT MODIFY //GEN-BEGIN:variables
// Generated using JFormDesigner Open Source Project license - ANTLR (www.antlr.org)
private JPanel dialogPane;
private JPanel contentPane;
private JLabel label1;
private JComboBox typeCombo;
private JLabel label22;
private JCheckBox humanFormatCheck;
private JSpinner currentSpinner;
private JLabel label2;
private JLabel infoLabel;
private JScrollPane scrollPane1;
private JTextArea statsTextArea;
private JPanel buttonBar;
private JButton submitButton;
private JButton cancelButton;
// JFormDesigner - End of variables declaration //GEN-END:variables
}