File indexing completed on 2025-02-23 04:34:18

 /**
  * \file playlistdialog.cpp
  * Create playlist dialog.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 13 Sep 2009
  *
  * Copyright (C) 2009-2024  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * Kid3 is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "playlistdialog.h"
 #include <QLayout>
 #include <QPushButton>
 #include <QLabel>
 #include <QString>
 #include <QCheckBox>
 #include <QComboBox>
 #include <QLineEdit>
 #include <QRadioButton>
 #include <QButtonGroup>
 #include <QFrame>
 #include <QToolTip>
 #include <QVBoxLayout>
 #include <QHBoxLayout>
 #include <QGroupBox>
 #include "playlistconfig.h"
 #include "contexthelp.h"
 #include "trackdata.h"
 
 /**
  * Constructor.
  *
  * @param parent  parent widget
  */
 PlaylistDialog::PlaylistDialog(QWidget* parent)
   : QDialog(parent)
 {
   setObjectName(QLatin1String("PlaylistDialog"));
   setModal(true);
   setWindowTitle(tr("Create Playlist"));
   setSizeGripEnabled(true);
 
   auto vlayout = new QVBoxLayout(this);
   auto fnGroupBox = new QGroupBox(this);
   auto fnGroupBoxLayout = new QVBoxLayout(fnGroupBox);
   m_sameAsDirNameButton = new QRadioButton(this);
   fnGroupBoxLayout->addWidget(m_sameAsDirNameButton);
   auto fileNameFormatLayout = new QHBoxLayout;
   m_fileNameFormatButton = new QRadioButton(this);
   m_fileNameFormatComboBox = new QComboBox(this);
   m_fileNameFormatComboBox->setToolTip(TrackDataFormatReplacer::getToolTip());
   fileNameFormatLayout->addWidget(m_fileNameFormatButton);
   fileNameFormatLayout->addWidget(m_fileNameFormatComboBox);
   fnGroupBoxLayout->addLayout(fileNameFormatLayout);
 
   auto fileNameForEmptyLayout = new QHBoxLayout;
   m_fileNameForEmptyButton = new QRadioButton(this);
   m_fileNameForEmptyEdit = new QLineEdit(this);
   fileNameForEmptyLayout->addWidget(m_fileNameForEmptyButton);
   fileNameForEmptyLayout->addWidget(m_fileNameForEmptyEdit);
   fnGroupBoxLayout->addLayout(fileNameForEmptyLayout);
 
   auto locationLayout = new QHBoxLayout;
   auto locationLabel = new QLabel(this);
   m_locationComboBox = new QComboBox(this);
   locationLayout->addWidget(locationLabel);
   locationLayout->addWidget(m_locationComboBox);
   fnGroupBoxLayout->addLayout(locationLayout);
   vlayout->addWidget(fnGroupBox);
 
   auto pcGroupBox = new QGroupBox(this);
   auto pcGroupBoxLayout = new QVBoxLayout(pcGroupBox);
   auto formatLayout = new QHBoxLayout;
   auto formatLabel = new QLabel(this);
   m_formatComboBox = new QComboBox(this);
   formatLayout->addWidget(formatLabel);
   formatLayout->addWidget(m_formatComboBox);
   pcGroupBoxLayout->addLayout(formatLayout);
   m_onlySelectedFilesCheckBox = new QCheckBox(this);
   pcGroupBoxLayout->addWidget(m_onlySelectedFilesCheckBox);
 
   auto sortLine = new QFrame(pcGroupBox);
   sortLine->setFrameShape(QFrame::HLine);
   sortLine->setFrameShadow(QFrame::Sunken);
   pcGroupBoxLayout->addWidget(sortLine);
   auto sortButtonGroup = new QButtonGroup(pcGroupBox);
   m_sortFileNameButton = new QRadioButton(this);
   pcGroupBoxLayout->addWidget(m_sortFileNameButton);
   auto sortTagFieldLayout = new QHBoxLayout;
   m_sortTagFieldButton = new QRadioButton(this);
   m_sortTagFieldComboBox = new QComboBox(this);
   m_sortTagFieldComboBox->setToolTip(TrackDataFormatReplacer::getToolTip());
   sortTagFieldLayout->addWidget(m_sortTagFieldButton);
   sortTagFieldLayout->addWidget(m_sortTagFieldComboBox);
   pcGroupBoxLayout->addLayout(sortTagFieldLayout);
   sortButtonGroup->addButton(m_sortFileNameButton);
   sortButtonGroup->addButton(m_sortTagFieldButton);
 
   auto pathLine = new QFrame(pcGroupBox);
   pathLine->setFrameShape(QFrame::HLine);
   pathLine->setFrameShadow(QFrame::Sunken);
   pcGroupBoxLayout->addWidget(pathLine);
   auto pathButtonGroup = new QButtonGroup(pcGroupBox);
   m_relPathButton = new QRadioButton(this);
   pcGroupBoxLayout->addWidget(m_relPathButton);
   m_fullPathButton = new QRadioButton(this);
   pcGroupBoxLayout->addWidget(m_fullPathButton);
   pathButtonGroup->addButton(m_relPathButton);
   pathButtonGroup->addButton(m_fullPathButton);
 
   auto writeLine = new QFrame(pcGroupBox);
   writeLine->setFrameShape(QFrame::HLine);
   writeLine->setFrameShadow(QFrame::Sunken);
   pcGroupBoxLayout->addWidget(writeLine);
   auto writeButtonGroup = new QButtonGroup(pcGroupBox);
   m_writeListButton = new QRadioButton(this);
   pcGroupBoxLayout->addWidget(m_writeListButton);
   auto writeInfoLayout = new QHBoxLayout;
   m_writeInfoButton = new QRadioButton(this);
   m_writeInfoComboBox = new QComboBox(this);
   m_writeInfoComboBox->setToolTip(TrackDataFormatReplacer::getToolTip());
   writeInfoLayout->addWidget(m_writeInfoButton);
   writeInfoLayout->addWidget(m_writeInfoComboBox);
   pcGroupBoxLayout->addLayout(writeInfoLayout);
   writeButtonGroup->addButton(m_writeListButton);
   writeButtonGroup->addButton(m_writeInfoButton);
   vlayout->addWidget(pcGroupBox);
   fnGroupBox->setTitle(tr("Playlist File Name"));
   m_sameAsDirNameButton->setText(tr("Same as &folder name"));
   m_sameAsDirNameButton->setChecked(true);
   m_fileNameFormatButton->setText(tr("&Format:"));
   m_fileNameFormatComboBox->setEditable(true);
   m_fileNameFormatComboBox->setEnabled(false);
   connect(m_fileNameFormatButton, &QAbstractButton::toggled,
           m_fileNameFormatComboBox, &QWidget::setEnabled);
   m_fileNameForEmptyButton->setText(tr("Create ne&w empty playlist:"));
   m_fileNameForEmptyEdit->setText(tr("New"));
   m_fileNameForEmptyEdit->setEnabled(false);
   // Position line edit aligned with combo box.
   m_fileNameForEmptyEdit->setSizePolicy(m_fileNameFormatComboBox->sizePolicy());
   connect(m_fileNameForEmptyButton, &QAbstractButton::toggled,
           m_fileNameForEmptyEdit, &QWidget::setEnabled);
   locationLabel->setText(tr("Cr&eate in:"));
   locationLabel->setBuddy(m_locationComboBox);
   m_locationComboBox->addItems({
     tr("Current folder"),
     tr("Every folder"),
     tr("Top-level folder")
   });
   pcGroupBox->setTitle(tr("Playlist Content"));
   formatLabel->setText(tr("For&mat:"));
   formatLabel->setBuddy(m_formatComboBox);
   m_formatComboBox->addItems(
     {QLatin1String("M3U"), QLatin1String("PLS"), QLatin1String("XSPF")});
   m_onlySelectedFilesCheckBox->setText(tr("Incl&ude only the selected files"));
   m_sortFileNameButton->setText(tr("Sort by file &name"));
   m_sortFileNameButton->setChecked(true);
   m_sortTagFieldButton->setText(tr("Sort by &tag field"));
   m_sortTagFieldComboBox->setEditable(true);
   m_sortTagFieldComboBox->setEnabled(false);
   QStringList lst;
   lst.reserve(Frame::FT_LastFrame - Frame::FT_FirstFrame + 1);
   for (int type = Frame::FT_FirstFrame; type <= Frame::FT_LastFrame; ++type) {
     QString frameName =
         Frame::ExtendedType(static_cast<Frame::Type>(type), QLatin1String(""))
         .getName().toLower();
     if (frameName == QLatin1String("track number")) frameName = QLatin1String("track.3");
     if (!frameName.isEmpty()) {
       lst.append(QLatin1String("%{") + frameName + QLatin1String("}"));
     }
   }
   m_sortTagFieldComboBox->addItems(lst);
   connect(m_sortTagFieldButton, &QAbstractButton::toggled,
           m_sortTagFieldComboBox, &QWidget::setEnabled);
   m_relPathButton->setText(tr("Use &relative path for files in playlist"));
   m_relPathButton->setChecked(true);
   m_fullPathButton->setText(tr("Use full p&ath for files in playlist"));
   m_writeListButton->setText(tr("Write only &list of files"));
   m_writeListButton->setChecked(true);
   m_writeInfoButton->setText(tr("Write &info using"));
   m_writeInfoComboBox->setEditable(true);
   m_writeInfoComboBox->setEnabled(false);
   m_writeInfoComboBox->addItems({
     QLatin1String("%{artist} - %{title}"), QLatin1String("%{title}"),
     QLatin1String("%{track.1}/%{tracks} - %{artist} - %{album} - %{title}")
   });
   connect(m_writeInfoButton, &QAbstractButton::toggled,
           m_writeInfoComboBox, &QWidget::setEnabled);
 
   auto hlayout = new QHBoxLayout;
   auto helpButton = new QPushButton(tr("&Help"), this);
   helpButton->setAutoDefault(false);
   hlayout->addWidget(helpButton);
   connect(helpButton, &QAbstractButton::clicked, this, &PlaylistDialog::showHelp);
   auto saveButton = new QPushButton(tr("&Save Settings"), this);
   saveButton->setAutoDefault(false);
   hlayout->addWidget(saveButton);
   connect(saveButton, &QAbstractButton::clicked, this, &PlaylistDialog::saveConfig);
   auto hspacer = new QSpacerItem(16, 0, QSizePolicy::Expanding,
                                          QSizePolicy::Minimum);
   hlayout->addItem(hspacer);
 
   auto okButton = new QPushButton(tr("&OK"), this);
   hlayout->addWidget(okButton);
   connect(okButton, &QAbstractButton::clicked, this, &QDialog::accept);
   auto cancelButton = new QPushButton(tr("&Cancel"), this);
   hlayout->addWidget(cancelButton);
   connect(cancelButton, &QAbstractButton::clicked, this, &QDialog::reject);
   vlayout->addLayout(hlayout);
 }
 
 /**
  * Read the local settings from the configuration.
  */
 void PlaylistDialog::readConfig()
 {
   const PlaylistConfig& playlistCfg = PlaylistConfig::instance();
   m_fileNameFormatButton->setChecked(
     playlistCfg.useFileNameFormat());
   m_sameAsDirNameButton->setChecked(
     !playlistCfg.useFileNameFormat());
   m_onlySelectedFilesCheckBox->setChecked(
     playlistCfg.onlySelectedFiles());
   m_sortTagFieldButton->setChecked(playlistCfg.useSortTagField());
   m_sortFileNameButton->setChecked(!playlistCfg.useSortTagField());
   m_fullPathButton->setChecked(playlistCfg.useFullPath());
   m_relPathButton->setChecked(!playlistCfg.useFullPath());
   m_writeInfoButton->setChecked(playlistCfg.writeInfo());
   m_writeListButton->setChecked(!playlistCfg.writeInfo());
   m_locationComboBox->setCurrentIndex(playlistCfg.location());
   m_formatComboBox->setCurrentIndex(playlistCfg.format());
   m_fileNameFormatComboBox->clear();
   m_fileNameFormatComboBox->addItems(playlistCfg.fileNameFormats());
   m_fileNameFormatComboBox->setEditText(
     playlistCfg.fileNameFormat());
   m_sortTagFieldComboBox->setEditText(playlistCfg.sortTagField());
   m_writeInfoComboBox->setEditText(playlistCfg.infoFormat());
 
   if (QByteArray geometry = playlistCfg.windowGeometry(); !geometry.isEmpty()) {
     restoreGeometry(geometry);
   }
 }
 
 /**
  * Get the current dialog configuration.
  *
  * @param cfg the current configuration is returned here
  */
 void PlaylistDialog::getCurrentConfig(PlaylistConfig& cfg) const
 {
   cfg.setUseFileNameFormat(m_fileNameFormatButton->isChecked());
   cfg.setOnlySelectedFiles(m_onlySelectedFilesCheckBox->isChecked());
   cfg.setUseSortTagField(m_sortTagFieldButton->isChecked());
   cfg.setUseFullPath(m_fullPathButton->isChecked());
   cfg.setWriteInfo(m_writeInfoButton->isChecked());
   cfg.setLocation(static_cast<PlaylistConfig::PlaylistLocation>(
     m_locationComboBox->currentIndex()));
   cfg.setFormat(static_cast<PlaylistConfig::PlaylistFormat>(
     m_formatComboBox->currentIndex()));
   cfg.setFileNameFormat(m_fileNameFormatComboBox->currentText());
   cfg.setSortTagField(m_sortTagFieldComboBox->currentText());
   cfg.setInfoFormat(m_writeInfoComboBox->currentText());
   QByteArray geometry = saveGeometry();
   cfg.setWindowGeometry(geometry);
 }
 
 /**
  * Get the entered file name to create a new empty playlist.
  * @return file name if "Create new empty playlist" is selected, else empty.
  */
 QString PlaylistDialog::getFileNameForNewEmptyPlaylist() const
 {
   return m_fileNameForEmptyButton->isChecked()
       ? m_fileNameForEmptyEdit->text() : QString();
 }
 
 /**
  * Save the local settings to the configuration.
  */
 void PlaylistDialog::saveConfig() const
 {
   getCurrentConfig(PlaylistConfig::instance());
 }
 
 /**
  * Show help.
  */
 void PlaylistDialog::showHelp()
 {
   ContextHelp::displayHelp(QLatin1String("create-playlist"));
 }