neuromanager/neuromanager/DataViewProperties.cpp

/* --------------------------------------------------------------------- */
/* NeuroManager - A spike train analysis tool                            */
/* Copyright (c) 2005-2006 RIKEN, Japan. All rights reserved.            */
/* http://satellite.sourceforge.jp/                                      */
/* --------------------------------------------------------------------- */
/* 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; see the file COPYING.txt. If not, write      */
/* to the Free Software Foundation, Inc., 51 Franklin Street, Fifth      */
/* Floor, Boston, MA 02110-1301, USA.                                    */
/* --------------------------------------------------------------------- */

/* $Id: DataViewProperties.cpp,v 1.18 2006/01/24 01:59:57 orrisroot Exp $ */

// DataViewProperties.cpp : implementation of the CDataViewProperties class
//

#include "stdafx.h"
#include <atlrx.h>

#include "NeuroManager.h"
#include "NeuroManagerDoc.h"

#include "DataViewSplitter.h"
#include "DataViewContext.h"
#include "DataView.h"
#include "DataViewProperties.h"
#include ".\dataviewproperties.h"

#include <math.h>

// CDataViewProperties

IMPLEMENT_DYNCREATE( CDataViewProperties, CFormView )

CDataViewProperties::CDataViewProperties()
                : CFormView( CDataViewProperties::IDD )
{
        EnableActiveAccessibility();
        m_bInitCtrlList = FALSE;
}

CDataViewProperties::~CDataViewProperties()
{}

void CDataViewProperties::DoDataExchange( CDataExchange *pDX )
{
        CFormView::DoDataExchange( pDX );
        DDX_Control( pDX, IDC_LIST_CHANNEL, m_ctrlList );
}

BEGIN_MESSAGE_MAP( CDataViewProperties, CFormView )
ON_NOTIFY( LVN_ITEMCHANGED, IDC_LIST_CHANNEL, OnLvnItemchangedListChannel )
ON_NOTIFY( LVN_BEGINLABELEDIT, IDC_LIST_CHANNEL, OnLvnBeginlabeleditListChannel )
ON_NOTIFY( LVN_ENDLABELEDIT, IDC_LIST_CHANNEL, OnLvnEndlabeleditListChannel )
ON_UPDATE_COMMAND_UI( ID_EDIT_COPY, OnUpdateNeedSel )
ON_UPDATE_COMMAND_UI( ID_EDIT_CUT, OnUpdateNeedSel )
ON_UPDATE_COMMAND_UI( ID_EDIT_PASTE, OnUpdateNeedClip )
ON_COMMAND( ID_EDIT_COPY, OnEditCopy )
ON_COMMAND( ID_EDIT_CUT, OnEditCut )
ON_COMMAND( ID_EDIT_PASTE, OnEditPaste )
END_MESSAGE_MAP()


// CDataViewProperties diagnostics

#ifdef _DEBUG
void CDataViewProperties::AssertValid() const
{
        CFormView::AssertValid();
}

void CDataViewProperties::Dump( CDumpContext &dc ) const
{
        CFormView::Dump( dc );
}
#endif //_DEBUG

BOOL CDataViewProperties::String2Double( CString &str, double &result )
{
        CAtlRegExp<> reDouble;
        str.Trim();
        // accept pattern
        // "0.0001",     ".00001",    "0.0001e10",  ".0001e10",
        // "0.0001e+10", ".0001e+10", "0.0001e-10", ".0001e-10"
        REParseError status = reDouble.Parse( _T( "^{(\\-?)((\\z\\.\\z?)|(\\z?\\.\\z))([eE][\\+\\-]?\\z)?}$" ) );
        if ( REPARSE_ERROR_OK != status )
        {
                // Unexpected error
                return FALSE;
        }
        CAtlREMatchContext<> mcDouble;
        if ( !reDouble.Match( str, &mcDouble ) )
        {
                // Unexpected error
                return FALSE;
        }
        // reform of floating point numbered string
        result = strtod( str, NULL );
        str.Format( "%f", result );
        return TRUE;
}

BOOL CDataViewProperties::IsEdit( CWnd* pWnd )
{
        ASSERT( pWnd != NULL );
        HWND hWnd = pWnd->GetSafeHwnd();
        if ( hWnd == NULL )
                return FALSE;

        TCHAR szClassName[ 6 ];
        return ::GetClassName( hWnd, szClassName, 6 ) && _tcsicmp( szClassName, _T( "Edit" ) ) == 0;
}

CScrollView *CDataViewProperties::GetDataView() const
{
        CDataViewSplitter * wndSplit = ( CDataViewSplitter* ) GetParent();
        if ( wndSplit == NULL )
                return NULL;
        return wndSplit->GetDataViewWindow();
}

void CDataViewProperties::FormatTime( CString &str, double dTime ) const
{
        CString unit( _T( "[sec]" ) );
        if ( dTime != 0.0 )
        {
                double order = floor( log10( dTime ) );
                if ( order < -6.0 )
                { // nano sec
                        dTime *= pow( 10.0, -9 );
                        unit = _T( "[nanosec]" );
                }
                else if ( order < -3.0 )
                { // micro sec
                        dTime /= pow( 10.0, -6 );
                        unit = _T( "[microsec]" );
                }
                else if ( order < -0.0 )
                { // mili sec
                        dTime /= pow( 10.0, -3 );
                        unit = _T( "[msec]" );
                }
        }
        str.Format( _T( "%.4f %s" ), dTime, unit );
}

void CDataViewProperties::InitializeDataChannelList()
{
        CNeuroManagerDoc * pDoc = ( CNeuroManagerDoc* ) GetDocument();
        ASSERT_VALID( pDoc );

        // check for already initialized
        if ( m_bInitCtrlList == FALSE )
        {
                // set control list style
                DWORD cStyle = m_ctrlList.GetExtendedStyle();
                m_ctrlList.SetExtendedStyle( cStyle | LVS_EX_HEADERDRAGDROP | LVS_EX_FULLROWSELECT |
                                             LVS_EX_GRIDLINES | LVS_EX_CHECKBOXES );
                // read header width
                int nCl0 = AfxGetApp() ->GetProfileInt( "LISTCTRL", "Head0", 60 );
                int nCl1 = AfxGetApp() ->GetProfileInt( "LISTCTRL", "Head1", 150 );
                int nCl2 = AfxGetApp() ->GetProfileInt( "LISTCTRL", "Head2", 150 );
                // set header title and width
                m_ctrlList.InsertColumn( 0, _T( "Channel" ), LVCFMT_RIGHT, nCl0 );
                m_ctrlList.InsertColumn( 1, _T( "Y Min" ), LVCFMT_LEFT, nCl1 );
                m_ctrlList.InsertColumn( 2, _T( "Y Max" ), LVCFMT_LEFT, nCl2 );

                // set initilized flag
                m_bInitCtrlList = TRUE;
        }

        // set items
        m_ctrlList.DeleteAllItems();
        if ( pDoc->IsMapped() )
        {
                UINT maxch = pDoc->GetChannelNumber();
                CString str;
                for ( UINT ch = 0; ch < maxch; ch++ )
                {
                        str.Format( "%-3d", ch + 1 );
                        m_ctrlList.InsertItem( ch, str );
                        double d = pDoc->GetYAxisRange( ch );
                        SetDataYAxisRange( ch, -d, d );
                }
                SetVisibleDataChannelState( 0, TRUE );
        }
}

BOOL CDataViewProperties::InitializeDataLength( QWORD len, double dTime )
{
        CEdit * pEdit = ( CEdit* ) GetDlgItem( IDC_STATIC_DATALENGTH );
        ASSERT_VALID( pEdit );
        CString lenstr;
        if ( len != 0 )
        {
                CString totalTime;
                FormatTime( totalTime, dTime );
                lenstr.Format( _T( "%s (%I64d pt)" ), totalTime, len );
        }
        else
        {
                lenstr.Format( _T( "0" ) );
        }
        pEdit->SetWindowText( lenstr );
        return TRUE;
}

BOOL CDataViewProperties::OnChangedVisibleDataChannelState( LPNMLISTVIEW pNMLV )
{
        if ( pNMLV->uOldState == 0 && pNMLV->uNewState == 0 )
                return FALSE; // No change

        // get old check box state
        BOOL bPrevState = ( BOOL ) ( ( ( pNMLV->uOldState & LVIS_STATEIMAGEMASK ) >> 12 ) - 1 );
        // On startup there's no previous state
        if ( bPrevState < 0 )
                bPrevState = FALSE;  // assing as false (unchecked)

        // get new check box state
        BOOL bNewState = ( BOOL ) ( ( ( pNMLV->uNewState & LVIS_STATEIMAGEMASK ) >> 12 ) - 1 );
        // non-check box notification
        if ( bNewState < 0 )
                bNewState = FALSE;

        if ( bPrevState == bNewState )
                return FALSE;

        UINT ch = pNMLV->iItem;
        CDataViewContext::SetVisibleDataChannelState( ch, bNewState );
        return TRUE;
}

BOOL CDataViewProperties::SetVisibleDataChannelState( UINT ch, BOOL bState )
{
        BOOL bOldState = CDataViewContext::SetVisibleDataChannelState( ch, bState );
        ListView_SetItemState( m_ctrlList.m_hWnd, ch, UINT( ( int( bState ) + 1 ) << 12 ), LVIS_STATEIMAGEMASK );
        return bOldState;
}

void CDataViewProperties::SetDataYAxisRange( UINT ch, double ymin, double ymax )
{
        CDataViewContext::SetDataYAxisRange( ch, ymin, ymax );
        CString str;
        str.Format( "%f", ymin );
        m_ctrlList.SetItemText( ch, 1, str );
        str.Format( "%f", ymax );
        m_ctrlList.SetItemText( ch, 2, str );
}

void CDataViewProperties::SetDataTime( double dTime )
{
        CNeuroManagerDoc * pDoc = ( CNeuroManagerDoc* ) GetDocument();
        ASSERT_VALID( pDoc );
        // data time
        CEdit *pTime = ( CEdit* ) GetDlgItem( IDC_STATIC_TIME );
        ASSERT_VALID( pTime );
        CString str = _T( "0" );
        if ( pDoc->IsMapped() )
        {
                FormatTime( str, dTime );
        }
        pTime->SetWindowText( str );
}

// CDataViewProperties message handlers
void CDataViewProperties::OnUpdate( CView* /*pSender*/, LPARAM /*lHint*/, CObject* /*pHint*/ )
{
        CNeuroManagerDoc * pDoc = ( CNeuroManagerDoc* ) GetDocument();
        ASSERT_VALID( pDoc );

        UINT ch = 0;
        QWORD len = 0;
        double dMaxTime = 0.0;
        if ( pDoc->IsMapped() )
        {
                ch = ( int ) pDoc->GetChannelNumber();
                len = pDoc->GetDataLength();
                dMaxTime = pDoc->GetPosTime( len );
        }
        InitializeContext( ch );
        InitializeDataLength( len, dMaxTime );
        InitializeDataChannelList();
        SetDataTime( 0.0 );
}

void CDataViewProperties::OnLvnItemchangedListChannel( NMHDR *pNMHDR, LRESULT *pResult )
{
        LPNMLISTVIEW pNMLV = reinterpret_cast<LPNMLISTVIEW>( pNMHDR );

        BOOL bVisibleStateChanged = OnChangedVisibleDataChannelState( pNMLV );
        if ( bVisibleStateChanged )
        {
                CDataView * wndDataView = ( CDataView* ) GetDataView();
                wndDataView->RedrawRequest();
        }
        *pResult = 0;
}

void CDataViewProperties::OnLvnBeginlabeleditListChannel( NMHDR *pNMHDR, LRESULT *pResult )
{
        NMLVDISPINFO * pDispInfo = reinterpret_cast<NMLVDISPINFO*>( pNMHDR );

        // pResult - 0: show EditControl, 1: doen't show EditControl

        // stop to show EditControl
        *pResult = 1;
        // set current column number to 'pDispInfo->item.iSubItem' from cursor position.
        if ( ! m_ctrlList.PrepareLabelEdit( pDispInfo ) )
                return ; // invalid cursor position

        // don't edit label of first column 'Channel'
        if ( pDispInfo->item.iSubItem == 0 )
        {
                return ;
        }
        m_ctrlList.BeginLabelEdit( pDispInfo, pResult );
}

void CDataViewProperties::OnLvnEndlabeleditListChannel( NMHDR *pNMHDR, LRESULT *pResult )
{
        NMLVDISPINFO * pDispInfo = reinterpret_cast<NMLVDISPINFO*>( pNMHDR );

        // pResult - 0: changed text does not applies to label.
        //           1: changed text applies to label.

        CString str = pDispInfo->item.pszText;

        // changed text will apply to label text by myself.
        *pResult = 0;
        double result;
        if ( String2Double( str, result ) == FALSE )
        {
                // invalid text string
                ::MessageBeep( MB_OK );
                return ;
        }

        BOOL bChange = FALSE;
        double ymin, ymax;
        GetDataYAxisRange( pDispInfo->item.iItem, ymin, ymax );
        switch ( pDispInfo->item.iSubItem )
        {
        case 0:
                // channel
                // invalid column number
                break;
        case 1:
                // y axis range min
                // check value. it has to be less than colums 2.
                if ( ymax > result )
                {
                        ymin = result;
                        bChange = TRUE;
                }
                break;
        case 2:
                // y axis range max
                // check value. it has to be more than colums 1.
                if ( ymin < result )
                {
                        ymax = result;
                        bChange = TRUE;
                }
                break;
        default:
                break;
        }
        if ( bChange == TRUE )
        {
                SetDataYAxisRange( pDispInfo->item.iItem, ymin, ymax );
                BOOL bVisible = GetVisibleDataChannelState( pDispInfo->item.iItem );
                if ( bVisible == TRUE )
                {
                        CDataView * wndDataView = ( CDataView* ) GetDataView();
                        wndDataView->RedrawRequest();
                }
        }
        else
                ::MessageBeep( MB_OK );
}

// UPDATE_COMMAND_UI handler for Edit Copy and Edit Cut which both
// require that the current focus is on an edit control that has
// text selected.
void CDataViewProperties::OnUpdateNeedSel( CCmdUI *pCmdUI )
{
        // get the current focus & determine if its on a CEdit control
        CWnd * pWnd = GetFocus();
        if ( NULL == pWnd || !IsEdit( pWnd ) )
        {
                pCmdUI->Enable( FALSE );
        }
        else
        {
                CEdit* pEdit = ( CEdit* ) pWnd;
                int nBeg, nEnd;

                pEdit->GetSel( nBeg, nEnd );
                pCmdUI->Enable( nBeg != nEnd );
        }
}

// UPDATE_COMMAND_UI handlers for Edit Paste requires that focus be
// on an edit control and that the clipboard contains text to be
// pasted into the control.
void CDataViewProperties::OnUpdateNeedClip( CCmdUI* pCmdUI )
{
        // get the current focus & determine if its on a CEdit control
        // also check to see if the control is read-only.
        CWnd * pWnd = GetFocus();
        if ( NULL == pWnd || !IsEdit( pWnd ) || ( pWnd->GetStyle() & ES_READONLY ) != 0 )
        {
                pCmdUI->Enable( FALSE );
        }
        else
                pCmdUI->Enable( ::IsClipboardFormatAvailable( CF_TEXT ) );
}

void CDataViewProperties::OnEditCopy()
{
        CEdit * pEdit = ( CEdit* ) GetFocus();
        ASSERT( IsEdit( pEdit ) );
        pEdit->Copy();
}

void CDataViewProperties::OnEditCut()
{
        CEdit * pEdit = ( CEdit* ) GetFocus();
        ASSERT( IsEdit( pEdit ) );
        pEdit->Cut();
}

void CDataViewProperties::OnEditPaste()
{
        CEdit * pEdit = ( CEdit* ) GetFocus();
        ASSERT( IsEdit( pEdit ) );
        ASSERT( ::IsClipboardFormatAvailable( CF_TEXT ) );
        pEdit->Paste();
}
