chordtext.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:            chordtext.cpp
// Purpose:         Stores and renders chord text
// Author:          Brad Larsen
// Modified by:     
// Created:         Jan 3, 2005
// RCS-ID:          
// Copyright:       (c) Brad Larsen
// License:         wxWindows license
/////////////////////////////////////////////////////////////////////////////

#include "stdwx.h"
#include "chordtext.h"

#ifdef _DEBUG
#define new DEBUG_NEW
#endif

// Default Constants
const wxByte ChordText::DEFAULT_POSITION = 0;

// Constructor/Destructor
/// Default Constructor
ChordText::ChordText() : 
    m_position(DEFAULT_POSITION)
{
    //------Last Checked------//
    // - Jan 3, 2005
}

/// Primary Constructor
/// @param position Zero-based index of the position within the system where the
/// chord text is anchored
/// @param chordName Chord name represented in the chord text
ChordText::ChordText(wxUint32 position, const ChordName& chordName) :
    m_position((wxByte)position), m_chordName(chordName)
{
    //------Last Checked------//
    // - Jan 3, 2005
    wxASSERT(IsValidPosition(position));
}

/// Copy Constructor
ChordText::ChordText(const ChordText& chordText) :
    m_position(DEFAULT_POSITION)
{
    //------Last Checked------//
    // - Jan 3, 2005
	*this = chordText;
}

/// Destructor
ChordText::~ChordText()
{
    //------Last Checked------//
    // - Jan 3, 2005
}

// Operators
/// Assignment Operator
const ChordText& ChordText::operator=(const ChordText& chordText)
{
    //------Last Checked------//
    // - Jan 3, 2005
    
    // Check for assignment to self
    if (this != &chordText)
    {
	    m_position = chordText.m_position;
	    m_chordName = chordText.m_chordName;
    }
	return (*this);
}

/// Equality Operator
bool ChordText::operator==(const ChordText& chordText) const
{
    //------Last Checked------//
    // - Jan 3, 2005
    return (
        (m_position == chordText.m_position) &&
        (m_chordName == chordText.m_chordName)
    );
}

/// Inequality Operator
bool ChordText::operator!=(const ChordText& chordText) const
{
    //------Last Checked------//
    // - Jan 3, 2005
    return (!operator==(chordText));
}

// Serialization Functions
/// Performs serialization for the class
/// @param stream Power Tab output stream to serialize to
/// @return True if the object was serialized, false if not
bool ChordText::DoSerialize(PowerTabOutputStream& stream)
{
    //------Last Checked------//
    // - Jan 3, 2005
    stream << m_position;
    wxCHECK(stream.CheckState(), false);
    
    m_chordName.Serialize(stream);
    wxCHECK(stream.CheckState(), false);
    
    return (stream.CheckState());
}

/// Performs deserialization for the class
/// @param stream Power Tab input stream to load from
/// @param version File version
/// @return True if the object was deserialized, false if not
bool ChordText::DoDeserialize(PowerTabInputStream& stream, wxWord version)
{
    //------Last Checked------//
    // - Jan 3, 2005
    stream >> m_position;
    wxCHECK(stream.CheckState(), false);
    
    m_chordName.Deserialize(stream, version);
    wxCHECK(stream.CheckState(), false);
    
    return (stream.CheckState());
}