basemusicscore.h

Go to the documentation of this file.

/*
 * basemusicscore.h, Author: Andrea Rizzi <88whacko@gmail.com>
 *
 * Copyright (C) 2001-2013 Atomic Blue (info@planeshift.it, http://www.atomicblue.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 (version 2 of the License)
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef BASE_MUSIC_SCORE_H
#define BASE_MUSIC_SCORE_H


//====================================================================================
// Crystal Space Includes
//====================================================================================

//====================================================================================
// Project Includes
//====================================================================================

//====================================================================================
// Local Includes
//====================================================================================
#include "scoreelements.h"

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------

template<template<typename> class MeasureType = Measure, typename MeasureElementType = MeasureElement>
class BaseMusicalScore
{

public:
    class Cursor;

    BaseMusicalScore();

    ~BaseMusicalScore();

    bool AdvanceCursor(bool ignoreEndOfMeasure);

    Cursor* GetEditCursor();

    const MeasureType<MeasureElementType>* GetMeasure(size_t n) const;

    size_t GetNMeasures() const { return measures.GetSize(); }

    const Cursor* GetPlayCursor() const;

    Cursor* SetEditMode();

    const Cursor* SetPlayMode();

private:
    enum ScoreMode
    {
        EDIT,
        PLAY
    };

    Cursor* cursor; 
    ScoreMode mode; 

    csArray<MeasureType<MeasureElementType>> measures;
};

//------------------------------------------------------------------------------------

template<template<typename> class MeasureType, typename MeasureElementType>
class BaseMusicalScore<MeasureType, MeasureElementType>::Cursor
{
public:
    ~Cursor();

    bool Advance(bool ignoreEndOfMeasure);

    MeasureElementType* GetCurrentElement();

    const MeasureElementType* GetCurrentElement() const;

    MeasureType<MeasureElementType>* GetCurrentMeasure();

    const MeasureType<MeasureElementType>* GetCurrentMeasure() const;

    bool HasNext(bool ignoreEndOfMeasure) const;

    void InsertElementAfter(const MeasureElementType &element);

    void InsertElementBefore(const MeasureElementType &element);

    void InsertMeasureAfter(const MeasureType<MeasureElementType> &measure);

    void InsertMeasureBefore(const MeasureType<MeasureElementType> &measure);

    bool IsEndOfMeasure() const;

    bool IsEndOfScore() const;

    bool IsValid() const;

    bool RemoveCurrentElement();

    bool RemoveCurrentMeasure();

    void Validate();

private:
    // In this way only BaseMusicalScore can access the private constructor
    friend BaseMusicalScore<MeasureType, MeasureElementType>::BaseMusicalScore();
    friend Cursor* BaseMusicalScore<MeasureType, MeasureElementType>::SetEditMode();
    friend const Cursor* BaseMusicalScore<MeasureType, MeasureElementType>::SetPlayMode();

    size_t currElementIdx; 
    size_t currMeasureIdx; 

    ScoreContext* context;
    BaseMusicalScore<MeasureType, MeasureElementType>* score; 

    Cursor(BaseMusicalScore<MeasureType, MeasureElementType>* score,
           typename BaseMusicalScore<MeasureType, MeasureElementType>::ScoreMode mode);

    bool CheckRepeat() const;

    bool HasNextWritten(bool ignoreEndOfMeasure) const;

    void Reset();
};

#include "basemusicscore.hpp"

#endif // BASE_MUSIC_SCORE_H