#include <UndoAddMetaDataAction.h>

Inheritance diagram for Kwave::UndoAddMetaDataAction:

Collaboration diagram for Kwave::UndoAddMetaDataAction:

Public Member Functions
	UndoAddMetaDataAction (const Kwave::MetaDataList &meta_data)

virtual	~UndoAddMetaDataAction () Q_DECL_OVERRIDE

QString	description () Q_DECL_OVERRIDE

virtual qint64	undoSize () Q_DECL_OVERRIDE

virtual qint64	redoSize () Q_DECL_OVERRIDE

virtual bool	store (SignalManager &manager) Q_DECL_OVERRIDE

virtual Kwave::UndoAction *	undo (Kwave::SignalManager &manager, bool with_redo) Q_DECL_OVERRIDE

Public Member Functions inherited from Kwave::UndoAction
virtual	~UndoAction ()

virtual bool	containsModification () const

virtual void	dump (const QString &indent)

Protected Attributes
QString	m_description

sample_index_t	m_offset

sample_index_t	m_length

QList< unsigned int >	m_tracks

Detailed Description

Undo action for inserting meta data.

Definition at line 40 of file UndoAddMetaDataAction.h.

Constructor & Destructor Documentation

◆ UndoAddMetaDataAction()

Kwave::UndoAddMetaDataAction::UndoAddMetaDataAction ( const Kwave::MetaDataList & meta_data )

explicit

Constructor

Parameters

meta_data reference to the meta data that has been inserted

Definition at line 34 of file UndoAddMetaDataAction.cpp.

References Kwave::MetaData::hasProperty(), m_description, m_length, m_offset, m_tracks, name, Kwave::MetaData::positionBoundPropertyNames(), SAMPLE_INDEX_MAX, Kwave::MetaData::STDPROP_TRACKS, and Kwave::MetaData::STDPROP_TYPE.

     :Kwave::UndoAction(),
      m_description(),
      m_offset(0),
      m_length(SAMPLE_INDEX_MAX),
      m_tracks()
 {
     sample_index_t first = SAMPLE_INDEX_MAX;
     sample_index_t last  = 0;
 
     // sanity check: list should not be empty
     Q_ASSERT(!meta_data.isEmpty());
     if (meta_data.isEmpty()) return;
 
     /*
      * loop over the list to find out the first/last sample offset
      * and the list of affected tracks
      */
     foreach (const Kwave::MetaData &m, meta_data)
     {
         // search over a list of known properties which contain range/position
         QStringList properties = Kwave::MetaData::positionBoundPropertyNames();
         foreach (const QString &tag, properties) {
             // check for a "start" property
             QVariant v = m[tag];
             bool ok = false;
             sample_index_t pos = static_cast<sample_index_t>(v.toULongLong(&ok));
             if (ok && (pos < first)) first = pos;
             if (ok && (pos > last))  last  = pos;
         }
 
         // convert the track list into a usable list of unsigned int
         const QList<QVariant> v_track_list =
             m[Kwave::MetaData::STDPROP_TRACKS].toList();
         QList<unsigned int> bound_tracks;
         foreach (const QVariant &v, v_track_list) {
             bool ok = false;
             unsigned int t = v.toUInt(&ok);
             if (ok) bound_tracks += t;
         }
 
         foreach (unsigned int t, bound_tracks)
             if (!m_tracks.contains(t)) m_tracks.append(t);;
     }
 
     // fix first/last in case that nothing was found, select everything
     if (first > last) {
         m_offset = SAMPLE_INDEX_MAX;
         m_length = 0;
     } else {
         m_offset = first;
         m_length = (last - first) + 1;
     }
     if (!m_tracks.isEmpty())
         std::sort(m_tracks.begin(),
                   m_tracks.end(), std::greater<unsigned int>());
 
     /*
      * determine the description of the action
      */
 
     for (;;) {
         QString name;
         QList<Kwave::MetaData> values = meta_data.values();
         Q_ASSERT(!values.isEmpty());
         if (!values.isEmpty()) {
             const Kwave::MetaData &m = values.first();
             if (m.hasProperty(Kwave::MetaData::STDPROP_TYPE))
                 name = m[Kwave::MetaData::STDPROP_TYPE].toString();
         }
 
         // if the meta data list contains only one object: try to find
         // out the object's name
         if ((meta_data.count() == 1) && name.length()) {
             m_description = i18nc(
                 "name of the undo action for inserting a meta data object",
                 "Insert %1",
                 name
             );
             break;
         }
 
         // check if the list contains only objects of the same type
         bool all_same_type = true;
         foreach (const Kwave::MetaData &m, meta_data) {
             QString n = m[Kwave::MetaData::STDPROP_TYPE].toString();
             if (!n.length() || (n != name)) {
                 all_same_type = false;
                 break;
             }
         }
         if (all_same_type) {
             m_description = i18nc(
                 "name of the undo action for inserting multiple "
                 "meta data objects of the same type: "
                 "%1=number of elements, %2=name of one element in singular",
                 "Insert %1 %2 objects", meta_data.count(), name
             );
             break;
         }
 
         m_description = i18n("Insert Meta Data");
         break;
     }
 }

Here is the call graph for this function:

◆ ~UndoAddMetaDataAction()

Kwave::UndoAddMetaDataAction::~UndoAddMetaDataAction ( )

virtual

Destructor

Definition at line 142 of file UndoAddMetaDataAction.cpp.

143 {

144 }

Member Function Documentation

◆ description()

QString Kwave::UndoAddMetaDataAction::description ( )

virtual

Returns a verbose short description of the action.

Implements Kwave::UndoAction.

Definition at line 147 of file UndoAddMetaDataAction.cpp.

References m_description.

 {
     return m_description;
 }

◆ redoSize()

qint64 Kwave::UndoAddMetaDataAction::redoSize ( )

virtual

See also: UndoAction::redoSize()

Implements Kwave::UndoAction.

Definition at line 159 of file UndoAddMetaDataAction.cpp.

 {
     return sizeof(UndoDeleteMetaDataAction);
 }

◆ store()

bool Kwave::UndoAddMetaDataAction::store ( Kwave::SignalManager & manager )

virtual

See also: UndoAction::store()

Implements Kwave::UndoAction.

Definition at line 165 of file UndoAddMetaDataAction.cpp.

 {
     // nothing to do, all data has already
     // been stored in the constructor
     return true;
 }

◆ undo()

Kwave::UndoAction * Kwave::UndoAddMetaDataAction::undo	(	Kwave::SignalManager &	manager,
		bool	with_redo
	)

virtual

See also: UndoAction::undo()

Implements Kwave::UndoAction.

Definition at line 173 of file UndoAddMetaDataAction.cpp.

References Kwave::MetaDataList::copy(), Kwave::MetaDataList::deleteRange(), m_length, m_offset, m_tracks, Kwave::SignalManager::metaData(), and Kwave::UndoAction::store().

 {
     Kwave::UndoAction *redo = Q_NULLPTR;
 
     Kwave::MetaDataList meta_data =
         manager.metaData().copy(m_offset, m_length, m_tracks);
 
     // store data for redo
     if (with_redo && !meta_data.isEmpty()) {
         redo = new(std::nothrow) Kwave::UndoDeleteMetaDataAction(meta_data);
         Q_ASSERT(redo);
         if (redo) redo->store(manager);
     }
 
     // remove the meta data from the signal manager
     manager.metaData().deleteRange(m_offset, m_length, m_tracks);
 
     return redo;
 }