Frame.java

/** {{{ Copyright (c) 2005-2013, Johan Kotlinski

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE. }}} */

package com.littlesounddj.lsdmanager;

import java.awt.*;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JList;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.File;

import javax.swing.event.ListSelectionListener;
import javax.swing.event.ListSelectionEvent;
import javax.swing.*;
import java.util.prefs.*;

public class Frame extends JFrame implements ActionListener {
    
    LSDSavFile m_file;
    String m_latest_sav_path = "\\";
    String m_latest_sng_path = "\\";
    
    JButton addLsdSngButton = new JButton();
    JButton clearSlotButton = new JButton();
    JButton exportLsdSngButton = new JButton();
    JButton openSavButton = new JButton();
    JButton saveSavAsButton = new JButton();
    JProgressBar jRamUsageIndicator = new JProgressBar();
    JList jSongSlotList = new JList();
    JScrollPane jScrollPane1 = new JScrollPane(jSongSlotList);
    JButton importV2SavButton = new JButton();
    JButton exportV2SavButton = new JButton();
    JLabel workMemLabel = new JLabel();
    
    Preferences prefs;
    private static final String LATEST_SAV_PATH = "latest_sav_path";
    private static final String LATEST_SNG_PATH = "latest_sng_path";
    private static final long serialVersionUID = 1279298060794170168L;

    public Frame() {
        m_file = new LSDSavFile();

        prefs = Preferences.userNodeForPackage(Frame.class);
        m_latest_sav_path = prefs.get(LATEST_SAV_PATH, m_latest_sav_path);
        m_latest_sng_path = prefs.get(LATEST_SNG_PATH, m_latest_sng_path);
        
        try {
            jbInit();
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }

    private void jbInit() throws Exception {
        
        addLsdSngButton.setBounds(new Rectangle(197, 108, 140, 31));
        addLsdSngButton.setEnabled(false);
        addLsdSngButton.setToolTipText(
                "Add compressed .lsdsng to file memory");
        addLsdSngButton.setText("Add .lsdsng...");
        addLsdSngButton.addActionListener(this);
        clearSlotButton.setBounds(new Rectangle(197, 267, 139, 30));
        clearSlotButton.setEnabled(false);
        clearSlotButton.setToolTipText("Clear file memory slot");
        clearSlotButton.setText("Clear Slot");
        clearSlotButton.addActionListener(this);
        exportLsdSngButton.setBounds(new Rectangle(197, 144, 140, 31));
        exportLsdSngButton.setEnabled(false);
        exportLsdSngButton.setToolTipText(
                "Export compressed .lsdsng from file memory");
        exportLsdSngButton.setText("Export .lsdsng...");
        exportLsdSngButton.addActionListener(this);
        jSongSlotList.addListSelectionListener(
                new Frame_jSongSlotList_listSelectionListener(this));

        openSavButton.setBounds(new Rectangle(198, 11, 139, 36));
        openSavButton.setPreferredSize(new Dimension(99, 20));
        openSavButton.setText("Open V3+ .SAV...");
        openSavButton.addActionListener(this);
        saveSavAsButton.setBounds(new Rectangle(198, 52, 139, 36));
        saveSavAsButton.setEnabled(false);
        saveSavAsButton.setText("Save V3+ .SAV as...");
        saveSavAsButton.addActionListener(this);
        jRamUsageIndicator.setString("");
        jRamUsageIndicator.setStringPainted(true);
        jRamUsageIndicator.setBounds(new Rectangle(11, 276, 178, 20));

        this.getContentPane().setLayout(null);
        this.setSize(new Dimension(352, 333));
        this.setDefaultCloseOperation(EXIT_ON_CLOSE);
        this.setResizable(false);
        this.setTitle("LSDManager v1.0");

        jScrollPane1.setBounds(new Rectangle(11, 35, 178, 236));
        importV2SavButton.setBounds(new Rectangle(197, 195, 139, 31));
        importV2SavButton.setEnabled(false);
        importV2SavButton.setToolTipText(
                "Import 32 kByte V2 .SAV file to work memory "
                        + "(will overwrite what\'s already there!!)");
        importV2SavButton.setActionCommand("Import V2 SAV...");
        importV2SavButton.setText("Import V2 .SAV...");
        importV2SavButton.addActionListener(this);
        exportV2SavButton.setBounds(new Rectangle(197, 231, 139, 31));
        exportV2SavButton.setEnabled(false);
        exportV2SavButton.setToolTipText(
                "Export work memory to 32 kByte V2 .SAV");
        exportV2SavButton.setActionCommand("Export to V2 SAV...");
        exportV2SavButton.setText("Export V2 .SAV...");
        exportV2SavButton.addActionListener(this);
        workMemLabel.setText("Work memory empty.");
        workMemLabel.setBounds(new Rectangle(11, 11, 178, 21));
        this.getContentPane().add(jScrollPane1);
        this.getContentPane().add(openSavButton);
        this.getContentPane().add(saveSavAsButton);
        this.getContentPane().add(addLsdSngButton);
        this.getContentPane().add(exportLsdSngButton);
        this.getContentPane().add(clearSlotButton);
        this.getContentPane().add(importV2SavButton);
        this.getContentPane().add(exportV2SavButton);
        this.getContentPane().add(jRamUsageIndicator);
        this.getContentPane().add(workMemLabel);
    }

    public void openSavButton_actionPerformed(ActionEvent e) {
        JFileChooser l_file_chooser = new JFileChooser(m_latest_sav_path);
        l_file_chooser.setFileFilter(new SAVFilter());
        l_file_chooser.setDialogTitle("Open 128kByte V3+ .sav");

        int l_ret_val = l_file_chooser.showOpenDialog(null);

        if (JFileChooser.APPROVE_OPTION == l_ret_val) {
            m_latest_sav_path = l_file_chooser.getSelectedFile().getAbsoluteFile()
                    .getParent().toString();
            if (m_latest_sng_path.equals("\\"))
                m_latest_sng_path = m_latest_sav_path;

            boolean l_fileLoadedOk = this.m_file.loadFromSav(l_file_chooser
                    .getSelectedFile().getAbsoluteFile().toString());

            if (true == l_fileLoadedOk) {
                m_file.populate_slot_list(jSongSlotList);
                workMemLabel.setText("Loaded work+file memory.");
                enable_all_buttons();
                SavePrefs();
            } else {
                workMemLabel.setText("File is not valid 128kB .SAV!");
            }
        }
    }

    private void enable_all_buttons() {
        exportV2SavButton.setEnabled(true);
        openSavButton.setEnabled(true);
        saveSavAsButton.setEnabled(true);
        addLsdSngButton.setEnabled(true);
        importV2SavButton.setEnabled(true);

        update_ram_usage_indicator();
    }

    public void clearSlotButton_actionPerformed(ActionEvent e) {

        if (jSongSlotList.isSelectionEmpty()) {
            JOptionPane.showMessageDialog(this, "Please select a song!",
                    "No song selected!", JOptionPane.ERROR_MESSAGE);
            return;
        }
        int[] l_slots = jSongSlotList.getSelectedIndices();
        
        for (int l_slot : l_slots)
            m_file.clear_slot(l_slot);
        m_file.populate_slot_list(jSongSlotList);
        update_ram_usage_indicator();
    }

    private void update_ram_usage_indicator() {
        jRamUsageIndicator.setMaximum(m_file.getTotalBlockCount());
        jRamUsageIndicator.setValue(m_file.get_used_blocks());
        jRamUsageIndicator.setString("File mem. used: "
                + m_file.get_used_blocks() + "/" + m_file.getTotalBlockCount());
    }

    public void exportLsdSngButton_actionPerformed(ActionEvent e) {
        if (jSongSlotList.isSelectionEmpty()) {
            JOptionPane.showMessageDialog(this, "Please select a song!",
                    "No song selected!", JOptionPane.ERROR_MESSAGE);
            return;
        }
        
        int[] l_slots = jSongSlotList.getSelectedIndices();

        JFileChooser l_file_chooser = new JFileChooser(m_latest_sng_path);
        if (l_slots.length == 1) {
            l_file_chooser.setFileFilter(new LsdSngFilter());
            l_file_chooser.setDialogTitle(
                    "Export selected slot to compressed .lsdsng file");
            int l_ret_val = l_file_chooser.showSaveDialog(null);

            if (JFileChooser.APPROVE_OPTION == l_ret_val) {
                m_latest_sng_path = l_file_chooser.getSelectedFile()
                        .getAbsoluteFile().getParent().toString();
                String l_file_name = l_file_chooser.getSelectedFile()
                        .getAbsoluteFile().toString();
                if (!l_file_name.toUpperCase().endsWith(".LSDSNG")) {
                    l_file_name += ".lsdsng";
                }

                m_file.export_song_to_file(l_slots[0], l_file_name);
                SavePrefs();
            }
        } else if (l_slots.length > 1) {
            l_file_chooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
            l_file_chooser.setDialogTitle(
                    "Batch export selected slots to compressed .lsdsng files");
            int ret_val = l_file_chooser.showDialog(null, "Choose Directory");
            
            if (JFileChooser.APPROVE_OPTION == ret_val) {
                m_latest_sng_path = l_file_chooser.getSelectedFile()
                        .getAbsolutePath().toString();
                SavePrefs();

                for (int slot : l_slots) {
                    String filename = m_file.get_file_name(slot).toLowerCase()
                            + "-" + m_file.get_version(slot) + ".lsdsng";
                    String path = m_latest_sng_path + File.separator + filename;
                    String[] options = { "Yes", "No", "Cancel" };
                    File f = new File(path);
                    if (f.exists()) {
                        int overWrite = JOptionPane.showOptionDialog(
                                this, "File \"" 
                                + filename
                                + "\" aready exists.\n"
                                + "Overwrite existing file?", "Warning",
                                JOptionPane.YES_NO_CANCEL_OPTION,
                                JOptionPane.WARNING_MESSAGE, null, options,
                                options[1]);

                        if (overWrite == JOptionPane.YES_OPTION) {
                            try {
                                f.delete();
                            } catch (Exception fileInUse) {
                                JOptionPane.showMessageDialog(this,
                                        "Error deleting file.\n"
                                        + "File is in use.");
                                continue;
                            }
                        } else if (overWrite == JOptionPane.NO_OPTION) {
                            continue;
                        } else if (overWrite == JOptionPane.CANCEL_OPTION)
                            return;
                    }
                    if (m_file.get_blocks_used(slot) > 0) {
                        m_file.export_song_to_file(slot, path);
                    }
                }
            }
        }
    }

    public void addLsdSngButton_actionPerformed(ActionEvent e) {
        JFileChooser l_file_chooser = new JFileChooser(m_latest_sng_path);
        l_file_chooser.setFileFilter(new LsdSngFilter());
        l_file_chooser.setMultiSelectionEnabled(true);
        l_file_chooser.setDialogTitle("Add compressed .lsdsng to file memory");
        int l_ret_val = l_file_chooser.showOpenDialog(null);

        if (JFileChooser.APPROVE_OPTION == l_ret_val) {
            boolean success = false;
            for (File f : l_file_chooser.getSelectedFiles()) {
                success = m_file.add_song_from_file(
                        f.getAbsoluteFile().toString());
                m_file.populate_slot_list(jSongSlotList);
            }
            m_latest_sng_path = l_file_chooser.getSelectedFiles()[0]
                    .getAbsoluteFile().getParent().toString();
            update_ram_usage_indicator();
            if (success)
                SavePrefs();
            else
                JOptionPane.showMessageDialog(this, 
                        "Not enough free blocks or song slots!", 
                        "Error adding song(s)!", 
                        JOptionPane.ERROR_MESSAGE);
        }
    }

    public void importV2SavButton_actionPerformed(ActionEvent e) {
        JFileChooser l_file_chooser = new JFileChooser(m_latest_sav_path);
        l_file_chooser.setFileFilter(new SAVFilter());
        l_file_chooser.setDialogTitle(
                "Import 32kByte .sav file to work memory");
        int l_ret_val = l_file_chooser.showOpenDialog(null);

        if (JFileChooser.APPROVE_OPTION == l_ret_val) {
            m_file.import_32kb_sav_to_work_ram(
                    l_file_chooser.getSelectedFile().getAbsoluteFile().toString());
            workMemLabel.setText("Work memory updated.");
        }
    }

    public void jSongSlotList_valueChanged(ListSelectionEvent e) {
        if (!jSongSlotList.isSelectionEmpty()) {
            clearSlotButton.setEnabled(true);
            exportLsdSngButton.setEnabled(true);
        } else {
            clearSlotButton.setEnabled(false);
            exportLsdSngButton.setEnabled(false);
        }
    }

    public void saveSavAsButton_actionPerformed(ActionEvent e) {
        JFileChooser l_file_chooser = new JFileChooser(m_latest_sav_path);
        l_file_chooser.setFileFilter(new SAVFilter());
        l_file_chooser.setDialogTitle("Save 128kByte V3+ .sav file");

        int l_ret_val = l_file_chooser.showSaveDialog(null);

        if (JFileChooser.APPROVE_OPTION == l_ret_val) {
            String l_file_name = l_file_chooser.getSelectedFile()
                    .getAbsoluteFile().toString();
            if (!l_file_name.toUpperCase().endsWith(".SAV")) {
                l_file_name += ".sav";
            }
            m_file.save_as(l_file_name);
        }
    }

    public void exportV2SavButton_actionPerformed(ActionEvent e) {
        JFileChooser l_file_chooser = new JFileChooser(m_latest_sav_path);
        l_file_chooser.setFileFilter(new SAVFilter());
        l_file_chooser
                .setDialogTitle("Export work memory to 32kByte v2 .sav file");

        int l_ret_val = l_file_chooser.showSaveDialog(null);

        if (JFileChooser.APPROVE_OPTION == l_ret_val) {
            String l_file_name = l_file_chooser.getSelectedFile()
                    .getAbsoluteFile().toString();
            if (!l_file_name.toUpperCase().endsWith(".SAV")) {
                l_file_name += ".sav";
            }
            m_file.save_work_memory_as(l_file_name);
        }
    }

    public void SavePrefs() {
        prefs.put(LATEST_SAV_PATH, m_latest_sav_path);
        prefs.put(LATEST_SNG_PATH, m_latest_sng_path);
    }

    public void actionPerformed(ActionEvent e) {
        if (e.getSource() == exportV2SavButton)
            exportV2SavButton_actionPerformed(e);
        else if (e.getSource() == saveSavAsButton)
            saveSavAsButton_actionPerformed(e);
        else if (e.getSource() == importV2SavButton)
            importV2SavButton_actionPerformed(e);
        else if (e.getSource() == addLsdSngButton)
            addLsdSngButton_actionPerformed(e);
        else if (e.getSource() == exportLsdSngButton)
            exportLsdSngButton_actionPerformed(e);
        else if (e.getSource() == clearSlotButton)
            clearSlotButton_actionPerformed(e);
        else if (e.getSource() == openSavButton)
            openSavButton_actionPerformed(e);
        else
            assert false : "unknown actionevent";
    }
}

class Frame_jSongSlotList_listSelectionListener implements
        ListSelectionListener {
    private Frame adaptee;

    Frame_jSongSlotList_listSelectionListener(Frame adaptee) {
        this.adaptee = adaptee;
    }

    public void valueChanged(ListSelectionEvent e) {
        adaptee.jSongSlotList_valueChanged(e);
    }
}