PatternList.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2025 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * This program 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.
 *
 * This program 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 https://www.gnu.org/licenses
 *
 */
 
#ifndef H2C_PATTERN_LIST_H
#define H2C_PATTERN_LIST_H
 
#include <vector>
#include <core/Object.h>
#include <core/AudioEngine/AudioEngine.h>
 
namespace H2Core
{
 
class Pattern;
class AudioEngineLocking;
class InstrumentList;
class XMLNode;

  class PatternList : public H2Core::Object<PatternList>, public H2Core::AudioEngineLocking
{
                H2_OBJECT(PatternList)
        public:
                PatternList();
                ~PatternList();
                PatternList( PatternList* other );
        
        static PatternList* load_from( XMLNode* pNode, std::shared_ptr<InstrumentList> pInstrumentList, bool bSilent = false );
        void save_to( XMLNode* pNode, const std::shared_ptr<Instrument> pInstrumentOnly = nullptr ) const;

                int size() const;

                void operator<<( Pattern* new_pattern );
                Pattern* operator[]( int idx );
        void add( Pattern* pattern, bool bAddVirtuals = false );
                void insert( int idx, Pattern* pattern );
                Pattern* get( int idx );
                Pattern* get( int idx ) const;
                Pattern* del( int idx );
                Pattern* del( Pattern* pattern );
                int index( const Pattern* pattern ) const;
                Pattern* replace( int idx, Pattern* pattern );
                void clear();
                void set_to_old();
                Pattern* find( const QString& name );
                void swap( int idx_a, int idx_b );
                void move( int idx_a, int idx_b );
                void flattened_virtual_patterns_compute();
                void virtual_pattern_del( Pattern* pattern );
                bool check_name( QString patternName, Pattern* ignore = NULL );
                QString find_unused_pattern_name( QString sourceName, Pattern* ignore = NULL );

                int longest_pattern_length( bool bIncludeVirtuals = true ) const;
 
                friend bool operator==( const PatternList& lhs, const PatternList& rhs );
                friend bool operator!=( const PatternList& lhs, const PatternList& rhs );
 

                QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;

                std::vector<Pattern*>::iterator begin();
                std::vector<Pattern*>::iterator end();
                std::vector<Pattern*>::const_iterator cbegin() const;
                std::vector<Pattern*>::const_iterator cend() const;
 
        private:
                std::vector<Pattern*> __patterns;            
 
};
 
// DEFINITIONS
 
inline int PatternList::size() const
{
        return __patterns.size();
}
 
inline void PatternList::clear()
{
        __patterns.clear();
}
 
inline void PatternList::operator<<( Pattern* pattern )
{
        add( pattern );
}
 
inline Pattern *PatternList::operator[]( int idx ) {
        return get( idx );
}
 
};
 
#endif // H2C_PATTERN_LIST_H
 
/* vim: set softtabstop=4 noexpandtab: */