/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

// System includes

#include <QGraphicsLinearLayout>

#include <QGraphicsSceneResizeEvent>

#include <QTimer>

#include <HbPanGesture>

#include <HbSwipeGesture>

#include <HbFontSpec>

#include <HbMenu>

#include <QPainter>

// User includes

#include "radiostationcarousel.h"

#include "radiocarouselanimator.h"

#include "radiouiloader.h"

#include "radiocarouselitem.h"

#include "radiostation.h"

#include "radiouiengine.h"

#include "radiostationmodel.h"

#include "radiofadinglabel.h"

#include "radiologger.h"

#include "radioutil.h"

#include "radio_global.h"

// Constants

const int RTPLUS_CHECK_TIMEOUT = 700;

const int INFOTEXT_NOFAVORITES_TIMEOUT = 5000;

const int SET_FREQUENCY_TIMEOUT = 500;

const int FAVORITE_HINT_SHOW_DELAY = 1000;

const int FAVORITE_HINT_HIDE_DELAY = 2000;

// Matti testing constants

const QLatin1String LEFT_ITEM_NAME      ( "carousel_left" );

const QLatin1String CENTER_ITEM_NAME    ( "carousel_center" );

const QLatin1String RIGHT_ITEM_NAME     ( "carousel_right" );

#ifdef BUILD_WIN32

#   define SCROLLBAR_POLICY ScrollBarAlwaysOn

#else

#   define SCROLLBAR_POLICY ScrollBarAlwaysOff

#endif // BUILD_WIN32

#define CALL_TO_ALL_ITEMS( expr ) \

    mItems[LeftItem]->expr; \

    mItems[CenterItem]->expr; \

    mItems[RightItem]->expr;

/*!

 *

 */

RadioStationCarousel::RadioStationCarousel( QGraphicsItem* parent ) :

    HbScrollArea( parent ),

    mUiEngine( NULL ),

    mAutoScrollTime( 300 ),

    mGenericTimer( new QTimer( this ) ),

    mTimerMode( NoTimer ),

    mInfoText( NULL ),

    mRadiotextPopup( NULL ),

    mContainer( new HbWidget( this ) ),

    mMidScrollPos( 0 ),

    mMaxScrollPos( 0 ),

    mCurrentIndex( 0 ),

    mTargetIndex( -1 ),

    mIsCustomFreq( false ),

    mInfoTextType( CarouselInfoText::None ),

    mModel( NULL ),

    mPosAdjustmentDisabled( false ),

    mScrollDirection( Scroll::Shortest ),

    mManualSeekMode( false ),

    mAlternateSkipping( false )

#ifdef USE_DEBUGGING_CONTROLS

    ,mRdsLabel( new RadioFadingLabel( this ) )

#endif // USE_DEBUGGING_CONTROLS

{

}

/*!

 * Property

 *

 */

void RadioStationCarousel::setFavoriteIcon( const HbIcon& favoriteIcon )

{

    mFavoriteIcon = favoriteIcon;

}

/*!

 * Property

 *

 */

HbIcon RadioStationCarousel::favoriteIcon() const

{

    return mFavoriteIcon;

}

/*!

 * Property

 *

 */

void RadioStationCarousel::setNonFavoriteIcon( const HbIcon& nonFavoriteIcon )

{

    mNonFavoriteIcon = nonFavoriteIcon;

}

/*!

 * Property

 *

 */

HbIcon RadioStationCarousel::nonFavoriteIcon() const

{

    return mNonFavoriteIcon;

}

/*!

 *

 */

void RadioStationCarousel::setAutoScrollTime( const int time )

{

    mAutoScrollTime = time;

}

/*!

 *

 */

int RadioStationCarousel::autoScrollTime() const

{

    return mAutoScrollTime;

}

/*!

 *

 */

void RadioStationCarousel::init( RadioUiLoader& uiLoader, RadioUiEngine* uiEngine )

{

    mUiEngine = uiEngine;

    RadioUtil::setCarousel( this );

    mItems[CenterItem] = new RadioCarouselItem( *this, this, true );

    mItems[LeftItem] = new RadioCarouselItem( *this, this );

    mItems[RightItem] = new RadioCarouselItem( *this, this );

    // Matti testing needs the objects to have names

    mItems[LeftItem]->setObjectName( LEFT_ITEM_NAME );

    mItems[CenterItem]->setObjectName( CENTER_ITEM_NAME );

    mItems[RightItem]->setObjectName( RIGHT_ITEM_NAME );

    QGraphicsLinearLayout* layout = new QGraphicsLinearLayout( Qt::Horizontal );

    layout->setContentsMargins( 0, 0, 0, 0 );

    layout->setSpacing( 0 );

    layout->addItem( mItems[LeftItem] );

    layout->addItem( mItems[CenterItem] );

    layout->addItem( mItems[RightItem] );

    mContainer->setLayout( layout );

    setContentWidget( mContainer );

    setClampingStyle( HbScrollArea::NoClamping );

    setScrollDirections( Qt::Horizontal );

    setFrictionEnabled( true );

    setHorizontalScrollBarPolicy( HbScrollArea::SCROLLBAR_POLICY );

    setVerticalScrollBarPolicy( HbScrollArea::ScrollBarAlwaysOff );

    mInfoText = uiLoader.findWidget<HbLabel>( DOCML::MV_NAME_INFO_TEXT );

    mInfoText->setTextWrapping( Hb::TextWordWrap );

    mRadiotextPopup = uiLoader.findObject<HbMenu>( DOCML::MV_NAME_CAROUSEL_RT_MENU );

#ifdef BUILD_WIN32

    HbFontSpec spec = mInfoText->fontSpec();

    spec.setRole( HbFontSpec::Secondary );

    mInfoText->setFontSpec( spec );

#endif

    setScrollDirections( Qt::Horizontal );

    Radio::connect( this,           SIGNAL(scrollingEnded()),

                    this,           SLOT(adjustAfterScroll()) );

    mModel = &mUiEngine->stationModel();

    Radio::connect( mModel,         SIGNAL(favoriteChanged(RadioStation)),

                    this,           SLOT(update(RadioStation)) );

    Radio::connect( mModel,         SIGNAL(stationDataChanged(RadioStation)),

                    this,           SLOT(update(RadioStation)));

    Radio::connect( mModel,         SIGNAL(radioTextReceived(RadioStation)),

                    this,           SLOT(updateRadioText(RadioStation)));

    Radio::connect( mModel,         SIGNAL(dynamicPsChanged(RadioStation)),

                    this,           SLOT(update(RadioStation)));

    mGenericTimer->setSingleShot( true );

    Radio::connect( mGenericTimer,  SIGNAL(timeout()),

                    this,           SLOT(timerFired()));

    Radio::connect( mModel,         SIGNAL(rowsInserted(QModelIndex,int,int)),

                    this,           SLOT(updateStations()) );

    Radio::connect( mModel,         SIGNAL(modelReset()),

                    this,           SLOT(updateStations()) );

    Radio::connect( mModel,         SIGNAL(rowsRemoved(QModelIndex,int,int)),

                    this,           SLOT(updateStations()) );

    setFrequency( mUiEngine->currentFrequency(), TuneReason::Unspecified );

#ifdef USE_DEBUGGING_CONTROLS

    mRdsLabel->setPos( QPoint( 300, 10 ) );

    mRdsLabel->setText( "RDS" );

    mRdsLabel->setElideMode( Qt::ElideNone );

    HbFontSpec spec = mRdsLabel->fontSpec();

    spec.setTextPaneHeight( 10 );

    spec.setRole( HbFontSpec::Secondary );

    mRdsLabel->setFontSpec( spec );

    mRdsLabel->setTextColor( Qt::gray );

    if ( mUiEngine ) {

        Radio::connect( mUiEngine,      SIGNAL(rdsAvailabilityChanged(bool)),

                        this,           SLOT(setRdsAvailable(bool)) );

    }

#endif // USE_DEBUGGING_CONTROLS

}

/*!

 *

 */

void RadioStationCarousel::setFrequency( uint frequency, int reason, Scroll::Direction direction )

{

    if ( mModel ) {

        if ( !mManualSeekMode ) {

            if ( mModel->rowCount() <= 1 ) {

                mItems[LeftItem]->setStation( RadioStation() );

                mItems[RightItem]->setStation( RadioStation() );

            }

            mIsCustomFreq = false;

            if ( reason == TuneReason::Skip || reason == TuneReason::StationScanFinalize ) {

                const int newIndex = mModel->indexFromFrequency( frequency );

                scrollToIndex( newIndex, direction, NoSignal );

                mCurrentIndex = newIndex;

            } else {

                if ( mModel->contains( frequency ) ) {

                    mCurrentIndex = mModel->indexFromFrequency( frequency );

                } else {

                    const RadioStation prevStation = mModel->findClosest( frequency, StationSkip::Previous );

                    if ( prevStation.isValid() ) {

                        mCurrentIndex = mModel->indexFromFrequency( prevStation.frequency() );

                    } else {

                        mCurrentIndex = -1;

                    }

                    mIsCustomFreq = true;

                }

                mItems[CenterItem]->setFrequency( frequency );

                mTimerMode = SetFrequency;

                mGenericTimer->stop();

                mGenericTimer->start( SET_FREQUENCY_TIMEOUT );

            }

        } else {

            mItems[CenterItem]->setFrequency( frequency );

        }

    }

}

/*!

 *

 */

RadioUiEngine* RadioStationCarousel::uiEngine()

{

    return mUiEngine;

}

/*!

 *

 */

bool RadioStationCarousel::isAntennaAttached() const

{

    return mUiEngine->isAntennaAttached();

}

/*!

 *

 */

void RadioStationCarousel::setScanningMode( bool scanning )

{

    CALL_TO_ALL_ITEMS( setSeekLayout( scanning ) );

    if ( scanning ) {

        setInfoText( CarouselInfoText::Scanning );

        if ( !mAnimator ) {

            mAnimator = new RadioCarouselAnimator( *this );

        }

        mAnimator.data()->startFlashingText();

    } else {

        if ( mAnimator ) {

            mAnimator.data()->stopFlashingText();

        }

        clearInfoText();

        setCenterIndex( 0 );

        mTimerMode = FavoriteHintShow;

        mGenericTimer->start( FAVORITE_HINT_SHOW_DELAY );

    }

    setEnabled( !scanning );

}

/*!

 *

 */

bool RadioStationCarousel::isInScanningMode() const

{

    return RadioUtil::scanStatus() == Scan::ScanningInMainView;

}

/*!

 *

 */

void RadioStationCarousel::cleanRdsData()

{

    mItems[CenterItem]->cleanRdsData();

}

/*!

 *

 */

void RadioStationCarousel::animateNewStation( const RadioStation& station )

{

    if ( mAnimator && mUiEngine ) {

        const uint previousFrequency = mItems[CenterItem]->frequency();

        mItems[RightItem]->setFrequency( previousFrequency );

        mCurrentIndex = mModel->indexFromFrequency( station.frequency() );

        mAnimator.data()->startNumberScroll( previousFrequency, station.frequency() );

    }

}

/*!

 *

 */

void RadioStationCarousel::cancelAnimation()

{

    if ( mAnimator ) {

        mAnimator.data()->stopAll();

    }

}

/*!

 *

 */

void RadioStationCarousel::setInfoText( CarouselInfoText::Type type )

{

    mInfoTextType = type;

    if ( type == CarouselInfoText::NoFavorites || type == CarouselInfoText::FavoriteIconHint ) {

//        mInfoText->setPlainText( hbTrId( "txt_rad_dialog_long_press_arrow_keys_to_search_str" ) );

    //TODO: Remove hardcoding. Temporarily hardcoded for usability testing

        mInfoText->setPlainText( "Tap star to mark favourites" );

        mInfoText->setAlignment( Qt::AlignCenter );

        mItems[CenterItem]->setItemVisibility( RadioCarouselItem::IconVisible );

        mTimerMode = InfoText;

        mGenericTimer->setInterval( INFOTEXT_NOFAVORITES_TIMEOUT );

        mGenericTimer->start();

        if ( !mAnimator ) {

            mAnimator = new RadioCarouselAnimator( *this );

        }

        mAnimator.data()->startFlashingIcon();

    } else if ( type == CarouselInfoText::ConnectAntenna ) {

        cleanRdsData();

        mInfoText->setPlainText( hbTrId( "txt_rad_info_connect_wired_headset1" ) );

        mInfoText->setAlignment( Qt::AlignBottom | Qt::AlignHCenter );

    } else if ( type == CarouselInfoText::Seeking ) {

        cleanRdsData();

        mInfoText->setAlignment( Qt::AlignBottom | Qt::AlignHCenter );

        mInfoText->setPlainText( hbTrId( "txt_rad_list_seeking" ) );

    } else if ( type == CarouselInfoText::Scanning ) {

        cleanRdsData();

        mInfoText->setAlignment( Qt::AlignBottom | Qt::AlignHCenter );

        mInfoText->setPlainText( hbTrId( "txt_rad_list_searching_all_available_stations_ple" ) );

    } else if ( type == CarouselInfoText::ManualSeek ) {

        mInfoText->setAlignment( Qt::AlignBottom | Qt::AlignHCenter );

        mInfoText->setPlainText( "Manual Seek Mode" );

    }

    mInfoText->setVisible( true );

}

/*!

 *

 */

void RadioStationCarousel::clearInfoText()

{

    if ( mInfoTextType != CarouselInfoText::None ) {

        if ( mAnimator ) {

            mAnimator.data()->stopFlashingIcon();

        }

        mGenericTimer->stop();

        mInfoTextType = CarouselInfoText::None;

        mInfoText->setVisible( false );

        mInfoText->clear();

        mItems[CenterItem]->setItemVisibility( RadioCarouselItem::AllVisible );

    }

}

/*!

 *

 */

void RadioStationCarousel::setManualSeekMode( bool manualSeekActive )

{

    mManualSeekMode = manualSeekActive;

    setEnabled( !manualSeekActive );

    mItems[CenterItem]->setSeekLayout( manualSeekActive );

    if ( manualSeekActive ) {

        setInfoText( CarouselInfoText::ManualSeek );

    } else {

        clearInfoText();

        setFrequency( mUiEngine->currentFrequency(), TuneReason::Unspecified );

    }

}

/*!

 *

 */

void RadioStationCarousel::drawOffScreen( QPainter& painter )

{

    mItems[CenterItem]->drawOffScreen( painter );

}

/*!

 * TODO: Remove this! This is test code

 */

void RadioStationCarousel::setAlternateSkippingMode( bool alternateSkipping )

{

    mAlternateSkipping = alternateSkipping;

}

/*!

 * Private slot

 *

 */

void RadioStationCarousel::scrollPosChanged( const QPointF& newPosition )

{

    Q_UNUSED( newPosition );

//    const int xPos = static_cast<int>( newPosition.x() );

//    mItems[CenterItem]->setPos( xPos - mMidScrollPos, 0 );

}

/*!

 * Private slot

 ''

 */

void RadioStationCarousel::adjustAfterScroll()

{

    if ( isInScanningMode() ) {

        return;

    }

    if ( mTargetIndex != -1 ) {

        setCenterIndex( mTargetIndex );

    }

}

/*!

 * Private slot

 *

 */

void RadioStationCarousel::update( const RadioStation& station )

{

    if ( !mManualSeekMode && !isInScanningMode() ) {

        for ( int i = LeftItem; i <= RightItem; ++i ) {

            if ( mItems[i]->frequency() == station.frequency() ) {

                mItems[i]->update( &station );

            }

        }

    }

}

/*!

 * Private slot

 */

void RadioStationCarousel::updateRadioText( const RadioStation& station )

{