/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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:  Class implementation for the FileSelectionBox skin, the skin being

*   the displayed element within the rendered XHTML page.

*

*/

// INCLUDE FILES

#include <AknBidiTextUtils.h>

#include <AknUtils.h>

#include <webkit.rsg>

#include "BrCtl.h"

#include "BrsrStatusCodes.h"

#include "GDIDevicecontext.h"

#include "GDIFont.h"

#include "MVCShell.h"

#include "MVCView.h"

#include "nw_fbox_fileselectionbox.h"

#include "nw_fbox_fileselectionboxskin.h"

#include "nw_fbox_fileselectionboxskini.h"

#include "nw_fbox_formboxutils.h"

#include "nw_fbox_skini.h"

#include "nw_gdi_types.h"

#include "nw_image_epoc32cannedimage.h"

#include "nw_lmgr_imgcontainerboxi.h"

#include "nw_lmgr_rootbox.h"

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES

// CONSTANTS

// Arbitrary limit, specified in bytes, on amount of tolerated wasted space

// within file-name buffer. If the wasted space exceeds this amount, the buffer

// is reallocated. Must not be less than 2 (size of a 2-byte NULL terminator).

const TInt KFileNameWasteThreshold = 50;

// Amount of padding in between text and icon.

const TUint KImageHorizontalPadding = 2;

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

const

NW_FBox_FileSelectionBoxSkin_Class_t NW_FBox_FileSelectionBoxSkin_Class =

    {

        { /* NW_Object_Core           */

            /* super                    */ &NW_FBox_Skin_Class,

            /* queryInterface           */ _NW_Object_Base_QueryInterface

        },

        { /* NW_Object_Base           */

            /* interfaceList            */ NULL

        },

        { /* NW_Object_Dynamic        */

            /* instanceSize             */ sizeof ( NW_FBox_FileSelectionBoxSkin_t ),

            /* construct                */ _NW_FBox_FileSelectionBoxSkin_Construct,

            /* destruct                 */ _NW_FBox_FileSelectionBoxSkin_Destruct

        },

        { /* NW_FBox_Skin             */

            /* draw                     */ _NW_FBox_FileSelectionBoxSkin_Draw,

            /* getSize                  */ _NW_FBox_FileSelectionBoxSkin_GetSize

        },

        { /* NW_FBox_FileSelectionBoxSkin */

            /* getBaseline              */ _NW_FBox_FileSelectionBoxSkin_GetBaseline,

            /* reset                    */ _NW_FBox_FileSelectionBoxSkin_Reset,

            /* setActive                */ _NW_FBox_FileSelectionBoxSkin_SetActive,

            /* split                    */ _NW_FBox_FileSelectionBoxSkin_Split

        }

    };

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

// ============================= LOCAL FUNCTIONS ===============================

// ============================ MEMBER FUNCTIONS ===============================

/* ------------------------------------------------------------------------- *

   private methods

 * ------------------------------------------------------------------------- */

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

// NW_FBox_FileSelectionBoxSkin::GetDirection

// Gets the layout direction, LTR or RTL.

// @param aLmgrBox Ptr to the parent LMgr OOC box class for this skin's box object.

// @param aDir Ptr to desitination into which direction is returned.

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

//

static

void

NW_FBox_FileSelectionBoxSkin_GetDirection(

    NW_LMgr_Box_t* aLmgrBox,

    NW_GDI_FlowDirection_t* aDir )

    {

    NW_LMgr_Property_t dirProp;

    // Parameter assertion block.

    NW_ASSERT( aLmgrBox );

    NW_ASSERT( aDir );

    dirProp.type = NW_CSS_ValueType_Token;

    dirProp.value.token = NW_CSS_PropValue_ltr;

    NW_LMgr_Box_GetProperty( aLmgrBox, NW_CSS_Prop_textDirection, &dirProp );

    *aDir = ( dirProp.value.token == NW_CSS_PropValue_ltr )

        ? NW_GDI_FlowDirection_LeftRight : NW_GDI_FlowDirection_RightLeft;

    }

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

// NW_FBox_FileSelectionBoxSkin::GetDisplayText

// Extract the name and extension, no path, from the filename and truncate that

// to fit within the displayable area.

// @param aThisObj Ptr to the OOC class structure for this class.

// @param aDir Text direction.

// @param aImageSize Ptr to image size.

// @param aFont Font being used to display the text.

// @param aInnerRectangle Ptr to rectangle of the box available for text & icon.

// @param aDisplayText Ptr to destination into which the allocated text buffer

//      for the display text is returned, which if not NULL, the caller is

//      responsible for taking ownership and deallocating when appropriate.

// @return Browser status code:

//      KBrsrSuccess if no errors

//      KBrsrOutOfMemory if not enough memory

//      KBrsrFailure for all other failure conditions

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

//

static

TBrowserStatusCode

NW_FBox_FileSelectionBoxSkin_GetDisplayText(

    NW_FBox_FileSelectionBoxSkin_t* aThisObj,

    NW_GDI_FlowDirection_t aDir,

    NW_GDI_Dimension3D_t* aImageSize,

    const CFont& aFont,

    NW_GDI_Rectangle_t* aInnerRectangle,

    HBufC** aDisplayText )

    {

    // Parameter assertion block.

    NW_ASSERT( aThisObj );

    NW_ASSERT( aImageSize );

    NW_ASSERT( aInnerRectangle );

    NW_ASSERT( aDisplayText );

    *aDisplayText = NULL;

    // If no name yet, then nothing left to do.

    if ( aThisObj->iFileNameAndExt.Length() == 0 )

        {

        return KBrsrSuccess;

        }

    // Determine the maxiumum width available for the text.

    TInt maxWidthInPixels = aInnerRectangle->dimension.width - aImageSize->width

        - KImageHorizontalPadding;

    // Must be at least 2 pixels wide to display any text.

    if ( maxWidthInPixels < 2 )

        {

        return KBrsrSuccess;

        }

    // Get text direction.

    AknBidiTextUtils::TParagraphDirectionality directionality =

        (aDir == NW_GDI_FlowDirection_LeftRight)

            ? AknBidiTextUtils::ELeftToRight : AknBidiTextUtils::ERightToLeft;

    // Allocate buffer for the truncated text.

    HBufC* truncatedText = HBufC::New( aThisObj->iFileNameAndExt.Length()

        + KAknBidiExtraSpacePerLine + 1 ); // +1 for NULL terminator

    if ( !truncatedText )

        {

        return KBrsrOutOfMemory;

        }

    // The buffer is an HBufC, which is a 'constant' class. However, it is

    // on the heap and is modifiable if accessed through its pointer.

    TPtr ptrTruncatedText( truncatedText->Des() );

    // Truncate.

    AknBidiTextUtils::ConvertToVisualAndClip( aThisObj->iFileNameAndExt, 

        ptrTruncatedText, aFont, maxWidthInPixels, maxWidthInPixels, 

        directionality );

    // Make sure it is NULL terminated for legacy text handling.

    ptrTruncatedText.ZeroTerminate();

    // Return the pointer to the truncated text.

    *aDisplayText = truncatedText;

    return KBrsrSuccess;

    }

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

// NW_FBox_FileSelectionBoxSkin::GetImageSize

// Gets the size of the icon used for indicating file-browse.

// @param aFileSelectionBox Ptr to OOC box to which this skin belongs.

// @param aImageSize Ptr to destination for returned image size.

// @return Browser status code, indicating status of operation.

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

//

static

TBrowserStatusCode

NW_FBox_FileSelectionBoxSkin_GetImageSize(

    NW_FBox_FileSelectionBox_t* aFileSelectionBox,

    NW_GDI_Dimension3D_t* aImageSize )

    {

    NW_LMgr_RootBox_t* rootBox;

    const NW_Image_AbstractImage_t* image;

    // Parameter assertion block.

    NW_ASSERT( aFileSelectionBox );

    NW_ASSERT( aImageSize );

    NW_TRY( status )

        {

        // Get root box.

        rootBox = NW_LMgr_Box_GetRootBox( NW_LMgr_BoxOf( aFileSelectionBox ) );

        NW_ASSERT( rootBox );

        // Get image from set of canned images.

        NW_ASSERT( rootBox->cannedImages );

        image = CONST_CAST( NW_Image_AbstractImage_t*,

            NW_Image_CannedImages_GetImage(

                rootBox->cannedImages, NW_Image_SelectFile ) );

        NW_THROW_ON_NULL( image, status, KBrsrFailure );

        // Get image size.

        status = NW_Image_AbstractImage_GetSize( image, aImageSize );

        _NW_THROW_ON_ERROR( status );

        }

    // status = KBrsrSuccess; // set by NW_CATCH

    NW_CATCH( status )

        {

        }

    NW_FINALLY

        {

        return status;

        }

    NW_END_TRY

    }

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

// NW_FBox_FileSelectionBoxSkin::GetMaxCharExtent

// Gets the max extents (width & height) of a character for the current font.

// @param aFileSelectionBox Ptr to OOC box to which this skin belongs.

// @param aDeviceContext Ptr to GDI device context from which the current font

//      and its extents are obtained.

// @param aExtent Ptr to destination into which the extents are returned.

// @return Browser status code, indicating status of operation.

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

//

static

TBrowserStatusCode

NW_FBox_FileSelectionBoxSkin_GetMaxCharExtent(

    NW_FBox_FileSelectionBox_t* aFileSelectionBox,

    CGDIDeviceContext* aDeviceContext,

    NW_GDI_Dimension2D_t* aExtent )

    {

    CFont* font;

    CGDIFont* gdiFont;

    // Parameter assertion block.

    NW_ASSERT( aFileSelectionBox );

    NW_ASSERT( aDeviceContext );

    NW_ASSERT( aExtent );

    // Get the box font.

    gdiFont = NW_LMgr_Box_GetFont( NW_LMgr_BoxOf( aFileSelectionBox ) );

    NW_ASSERT( gdiFont );

    font = ( CFont* )aDeviceContext->GetScaledCFont( gdiFont );

    NW_ASSERT( font );

    // Get character extents.

    aExtent->width = (NW_GDI_Metric_t)font->MaxNormalCharWidthInPixels();

    aExtent->height = (NW_GDI_Metric_t)font->HeightInPixels();

    return KBrsrSuccess;

    }

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

// NW_FBox_FileSelectionBoxSkin::DrawText

// Draws the text in the box, the text being the file name selected, if any.

// @param aThisObj Ptr to the OOC class structure for this class.

// @param aFileSelectionBox Ptr to OOC box to which this skin belongs.

// @param aDeviceContect Ptr to GDI device context to use for drawing.

// @param aImageSize Ptr to image size.

// @param aDir Direction of drawing, LTR or RTL.

// @return Browser status code, indicating status of operation.

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

//

static

TBrowserStatusCode

NW_FBox_FileSelectionBoxSkin_DrawText(

    NW_FBox_FileSelectionBoxSkin_t* aThisObj,

    NW_FBox_FileSelectionBox_t* aFileSelectionBox,

    CGDIDeviceContext* aDeviceContext,

    NW_GDI_Dimension3D_t* aImageSize,

    NW_GDI_FlowDirection_t aDir )

    {

    NW_GDI_Point2D_t start;

    const CFont* font;

    CGDIFont* gdiFont;

    NW_GDI_Rectangle_t innerRect;

    NW_LMgr_PropertyValue_t colorVal;

    NW_GDI_Color_t oldFgColor;

    NW_GDI_Dimension2D_t extent;

    HBufC* displayText = NULL;

    NW_Text_t* legacyText = NULL;

    // Parameter assertion block.

    NW_ASSERT( aThisObj );

    NW_ASSERT( aFileSelectionBox );

    NW_ASSERT( aDeviceContext );

    NW_ASSERT( aImageSize );

    // Get ALL items that will need to be restored in the "FINALLY" clause:

    oldFgColor = aDeviceContext->ForegroundColor();

    NW_TRY( status )

        {

        NW_LMgr_Box_t* lmgrBox = NW_LMgr_BoxOf( aFileSelectionBox );

        // Get box's font.

        gdiFont = NW_LMgr_Box_GetFont( lmgrBox );

        NW_ASSERT( gdiFont );

        font = (CFont*)aDeviceContext->GetScaledCFont( gdiFont );

        NW_ASSERT( font );

        // Get and set the box foreground color.

        colorVal.integer = 0;

        NW_LMgr_Box_GetPropertyValue( lmgrBox, NW_CSS_Prop_color,

            NW_CSS_ValueType_Color, &colorVal );

        aDeviceContext->SetForegroundColor( ( NW_GDI_Color_t ) colorVal.integer );

        // Get start coordinates.

        NW_LMgr_Box_GetInnerRectangle( lmgrBox, &innerRect );

        start = innerRect.point;

        // Text set every time in order to truncate according to current

        // settings. Note, GetDisplayText() may need to allocate a new

        // buffer for the truncated text.  If that happens, the returned

        // descriptor will point to the new buffer, which will need to be

        // deallocated below when it is no longer needed.

        status = NW_FBox_FileSelectionBoxSkin_GetDisplayText( aThisObj,

            aDir, aImageSize, *font, &innerRect, &displayText );

        _NW_THROW_ON_ERROR( status );

        if ( displayText )

            {

            if ( displayText->Length() )

                {

                // Convert from Symbian data structure to legacy data

                // structure. For efficiency, this was delayed as long as

                // possible but now it's needed.  Unfortunately, this will

                // allocate another buffer for the text.

                legacyText = (NW_Text_t*)NW_Text_UCS2_New(

                    (NW_Ucs2*)(displayText->Ptr()),

                    displayText->Length(),

                    NW_Text_Flags_NullTerminated );

                NW_THROW_OOM_ON_NULL( legacyText, status );

                // Get extents.

                status = aDeviceContext->GetTextExtent( legacyText, gdiFont, 0, aDir, &extent );

                _NW_THROW_ON_ERROR( status );

                // If RTL, change drawing coordinates.

                if ( aDir == NW_GDI_FlowDirection_RightLeft )

                    {

                    start.x = innerRect.point.x + innerRect.dimension.width - extent.width;

                    }

                status = aDeviceContext->DrawText( &start, legacyText, gdiFont, 0, 

                    NW_GDI_TextDecoration_None, aDir, extent.width );

                _NW_THROW_ON_ERROR( status );

                }

            }

        }

    // status = KBrsrSuccess; // set by NW_CATCH

    NW_CATCH( status )

        {

        }

    NW_FINALLY

        {

        // Free any allocated resources.

        delete displayText;

        NW_Object_Delete( legacyText );

        // Restore fg color.

        aDeviceContext->SetForegroundColor( oldFgColor );

        return status;

        }

    NW_END_TRY

    }

/* ------------------------------------------------------------------------- *

   virtual methods

 * ------------------------------------------------------------------------- */

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

// NW_FBox_FileSelectionBoxSkin::NW_FBox_FileSelectionBoxSkin

// OOC constructor.

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

//

TBrowserStatusCode

_NW_FBox_FileSelectionBoxSkin_Construct(

    NW_Object_Dynamic_t* aDynamicObject,

    va_list* aArgp )

    {

    TBrowserStatusCode status;

    NW_FBox_FileSelectionBoxSkin_t* thisObj;

    // For convenience.

    thisObj = NW_FBox_FileSelectionBoxSkinOf( aDynamicObject );

    // Invoke superclass constructor.

    status = _NW_FBox_Skin_Construct( aDynamicObject, aArgp );

    if ( status != KBrsrSuccess )

        {

        return status;

        }

    // Init member variables.

    thisObj->iFullFileName = NULL;

    thisObj->iFileNameAndExt.Set( NULL, 0 );

    return KBrsrSuccess;

    }

// Destructor

void

_NW_FBox_FileSelectionBoxSkin_Destruct( NW_Object_Dynamic_t* aDynamicObject )

    {

    NW_FBox_FileSelectionBoxSkin_t* thisObj;

    // For convenience.

    thisObj = NW_FBox_FileSelectionBoxSkinOf( aDynamicObject );

    delete thisObj->iFullFileName;

    thisObj->iFullFileName = NULL;

    thisObj->iFileNameAndExt.Set( NULL, 0 );

    }

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

// NW_FBox_FileSelectionBoxSkin::Draw

// Draws the box, including border, icon, and text of file name.

// (Other items are commented in header.)

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

//

TBrowserStatusCode

_NW_FBox_FileSelectionBoxSkin_Draw(

    NW_FBox_Skin_t* aSkin,

    NW_LMgr_Box_t* aLmgrBox,

    CGDIDeviceContext* aDeviceContext,

    NW_Uint8 aHasFocus )

    {

    NW_FBox_FileSelectionBox_t* fileSelectionBox;

    NW_FBox_FileSelectionBoxSkin_t* thisObj;

    NW_GDI_Rectangle_t innerRectangle;

    NW_GDI_Point2D_t imagePoint;

    NW_GDI_Dimension3D_t imageSize;

    NW_LMgr_RootBox_t* rootBox;

    NW_Image_AbstractImage_t* image;

    NW_GDI_FlowDirection_t dir;

    // Parameter assertion block.

    NW_ASSERT( NW_Object_IsInstanceOf( aSkin, &NW_FBox_FileSelectionBoxSkin_Class ) );

    NW_ASSERT( NW_Object_IsInstanceOf( aLmgrBox, &NW_FBox_FileSelectionBox_Class ) );

    NW_ASSERT( aDeviceContext );

    // For convenience.

    fileSelectionBox = NW_FBox_FileSelectionBoxOf( aLmgrBox );

    NW_ASSERT( fileSelectionBox );

    thisObj = NW_FBox_FileSelectionBoxSkinOf( aSkin );

    NW_ASSERT( thisObj );

    NW_TRY( status )

        {

        // Standard paint mode.

        aDeviceContext->SetPaintMode( NW_GDI_PaintMode_Copy );

        // Let base class draw the box -- borders, padding, background color, etc.

        status = _NW_LMgr_Box_Draw( aLmgrBox, aDeviceContext, aHasFocus );

        _NW_THROW_ON_ERROR( status );

        // Get root box.

        rootBox = NW_LMgr_Box_GetRootBox( NW_LMgr_BoxOf( fileSelectionBox ) );

        NW_ASSERT( rootBox );

        // Get image from set of canned images.

        NW_ASSERT( rootBox->cannedImages );

        image = CONST_CAST( NW_Image_AbstractImage_t*,

            NW_Image_CannedImages_GetImage(

                rootBox->cannedImages, NW_Image_SelectFile ) );

        NW_THROW_ON_NULL( image, status, KBrsrFailure );

        // Get image size.

        status = NW_Image_AbstractImage_GetSize( image, &imageSize );

        _NW_THROW_ON_ERROR( status );

        // Get current direction.

        NW_FBox_FileSelectionBoxSkin_GetDirection( aLmgrBox, &dir );

        // Draw text first.

        status = NW_FBox_FileSelectionBoxSkin_DrawText( thisObj, fileSelectionBox,

            aDeviceContext, &imageSize, dir );

        _NW_THROW_ON_ERROR( status );

        // ==========================================

        // Position image within the inner rectangle.

        // ==========================================