/*

* Copyright (c) 2003-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:  Handles the display of the box tree

*

*/

// INCLUDE FILES

//lint -save -e578 -e1707 static assumed for operator new, Declaration of symbol hides symbol

#include <e32def.h>  // To avoid NULL redefine warning (no #ifndef NULL)

#include <aknappui.h>

#include <aknmessagequerydialog.h>

#include <apgcli.h>

#include <badesca.h>

#include <eiksbfrm.h>

#include <eikspane.h>

#include <FeatMgr.h>

#include <f32file.h>

#include <flogger.h>

#include <stddef.h>

#include <CenRepNotifyHandler.h>

#include <centralrepository.h>

#include <httpcachemanagerinternalcrkeys.h>

#include <stringloader.h>

#include <webkit.rsg>

#include <brctlinterface.h>

#include "BoxFormatHandler.h"

#include "BoxRender.h"

#include "BrCtl.h"

#include "BrsrStatusCodes.h"

#include "CBrowserSettings.h"

#include "GDIDeviceContext.h"

#include "LMgrMarkerText.h"

#include "LMgrMarkerImage.h"

#include "LMgrAnonBlock.h"

#include "LMgrObjectBoxOOC.h"

#include "LMgrObjectBox.h"

#include "MVCScroll.h"

#include "MVCShell.h"

#include "MVCView.h"

#include "MVCViewAsyncInit.h"

#include "MVCViewListener.h"

#include "nw_adt_resizablevector.h"

#include "nwx_cleanup_epoc32.h"

#include "nwx_ctx.h"

#include "nwx_defs_symbian.h"

#include "nw_evt_accesskeyevent.h"

#include "nw_evt_activateevent.h"

#include "nw_evt_clearfieldevent.h"

#include "nw_evt_controlkeyevent.h"

#include "nw_evt_fontsizechangeevent.h"

#include "nw_evt_focusevent.h"

#include "nw_evt_keyevent.h"

#include "nw_evt_openviewerevent.h"

#include "nw_evt_scrollevent.h"

#include "nw_evt_tabevent.h"

#include "nw_evt_unicodekeyevent.h"

#include "nw_fbox_buttonbox.h"

#include "nw_fbox_inputbox.h"

#include "nw_fbox_formbox.h"

#include "nw_fbox_formboxutils.h"

#include "nw_fbox_checkbox.h"

#include "nw_fbox_WmlFormattedEditor.h"

#include "nw_fbox_radiobox.h"

#include "nw_fbox_epoc32inputskin.h"

#include "nw_fbox_selectbox.h"

#include "nw_fbox_textareabox.h"

#include "nw_fbox_imagebuttonbox.h"

#include "nw_fbox_fileselectionbox.h"

#include "nw_hed_documentroot.h"

#include "nw_hed_iimageviewer.h"

#include "nw_image_epoc32simpleimage.h"

#include "nw_image_virtualimage.h"

#include "nw_lmgr_imagebox.h"

#include "nw_lmgr_animatedimagebox.h"

#include "nw_lmgr_box.h"

#include "nw_lmgr_boxvisitor.h"

#include "nw_lmgr_cssproperties.h"

#include "nw_lmgr_activecontainerbox.h"

#include "nw_lmgr_statictablecellbox.h"

#include "nw_lmgr_verticaltablecellbox.h"

#include "nw_lmgr_rootbox.h"

#include "nw_lmgr_areabox.h"

#include "nw_lmgr_accesskey.h"

#include "nw_lmgr_eventhandler.h"

#include "nw_lmgr_textbox.h"

#include "nw_lmgr_slavepropertylist.h"

#include "nw_lmgr_simplepropertylist.h"

#include "nw_lmgr_verticaltablebox.h"

#include "nw_lmgr_statictablebox.h"

#include "nw_lmgr_imagemapbox.h"

#include "nw_lmgr_animatedimagebox.h"

#include "nw_lmgr_areabox.h"

#include "nw_object_object.h"

#include "nw_system_optionlist.h"

#include "nw_xhtml_savetophonebkevent.h"

#include "nw_xhtml_xhtmlcontenthandler.h"

#include "nw_xhtml_attributepropertytable.h"

#include "nwx_http_defs.h"

#include "nwx_logger.h"

#include "nwx_math.h"

#include "nwx_settings.h"

#include "TEncodingMapping.h"

#include "urlloader_urlloaderint.h"

#include "HistoryController.h"

#include "WmlInterface.h"

//lint -restore

#include "pagescaler.h"

#include "nw_lmgr_posflowbox.h"

#ifdef __WINS__

#ifdef _DEBUG

//#define _DEBUG_LOG

#ifdef _DEBUG_LOG

NW_LMGR_EXPORT

TBrowserStatusCode

NW_LMgr_Box_DumpBoxTree(NW_LMgr_Box_t* box);

#endif /* DEBUG_LOG */

#endif /* DEBUG */

#endif /* WINS */

// ============================= PRIVATE FUNCTIONS ===============================

NW_Bool

CView::ProcessFontSizeChangeEvent ()

{

  iDeviceContext->SetFontSizeLevel();

  return NW_TRUE;

}

NW_GDI_Rectangle_t

CView::GetBoxDisplayBounds(NW_LMgr_Box_t* aBox )

  {

  NW_GDI_Rectangle_t boxBounds;

  if (NW_Object_IsClass( aBox, &NW_LMgr_AreaBox_Class))

    {

    boxBounds = NW_LMgr_AreaBox_GetBounds( aBox );

    }

  else

    {

    boxBounds = NW_LMgr_Box_GetDisplayBounds( aBox );

    }

  return boxBounds;

  }

void

CView::SetBoxFormatBounds( NW_LMgr_Box_t* aBox, NW_GDI_Rectangle_t aBoxBounds )

  {

  if (NW_Object_IsClass( aBox, &NW_LMgr_AreaBox_Class))

    {

    // set area box is not supported

    NW_ASSERT( 0 );

    }

  else

    {

    NW_LMgr_Box_SetFormatBounds( aBox, aBoxBounds );

    }

  }

/*

This is a fix for version 2.8. For 3.0, we have to do more check for the position absolute, otherwise, it will break the 

absolute position.

*/

void CView::GetParentBox(NW_LMgr_Box_t* parentBox, NW_LMgr_Box_t** pReturnedParentBox)

{

	if(parentBox == NULL) {

		return;

	}

	if (NW_Object_IsInstanceOf(parentBox, &NW_LMgr_FlowBox_Class))

	{

		if(*pReturnedParentBox == NULL) {

			*pReturnedParentBox = parentBox;

		}

	}

	if (NW_Object_IsClass(parentBox, &NW_LMgr_StaticTableCellBox_Class) ||

		NW_Object_IsClass(parentBox, &NW_LMgr_VerticalTableCellBox_Class)) 

	{

		*pReturnedParentBox = parentBox;

		return;

	} else {

		//continue to find parent

		parentBox = (NW_LMgr_Box_t*)NW_LMgr_Box_GetParent(parentBox);

		if(parentBox != NULL) {

			GetParentBox(parentBox, pReturnedParentBox);

		}

	}

}

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

TBrowserStatusCode

CView::HandleFormattingComplete ()

    {

    TBrowserStatusCode status = KBrsrSuccess;

    iRootBox->calculateExtents = NW_TRUE;

    iCreateTabList = NW_FALSE;

    NW_LMgr_RootBox_InvalidateCache (iRootBox );

    // if the user has not tabbed to any tab item

    if (GetActiveBoxId() == 0)

        {

        if (((iInitialDocPosition.x != 0) && (iInitialDocPosition.x != RIGHT_ORIGIN))

            || (iInitialDocPosition.y !=0))

            {

            SetOrigin (&iInitialDocPosition);

            }

        // initialActiveBoxId is either the activeBoxId from history or is the first tab index

        status = GotoActiveBox (iInitialActiveBoxId);

        if ( iAnchorName != NULL && iInitialActiveBoxId == 0 )

            {

			  NW_LMgr_Box_t* targetBox = NULL;

			  NW_LMgr_Box_t* box = NULL;

			  NW_LMgr_BoxVisitor_t boxVisitor;

			  NW_LMgr_Property_t  prop;

			  /* find the named box */

			  NW_LMgr_BoxVisitor_Initialize (&boxVisitor, (NW_LMgr_Box_t *)iRootBox);

			  (void) NW_LMgr_BoxVisitor_SetCurrentBox (&boxVisitor, (NW_LMgr_Box_t *)iRootBox);

            while ((box = NW_LMgr_BoxVisitor_NextBox (&boxVisitor, NULL)) != NULL)

                {

				status = NW_LMgr_Box_GetProperty(box, NW_CSS_Prop_boxName, &prop);

                if ((status == KBrsrSuccess) && (prop.type == NW_CSS_ValueType_Text))

                    {

                    if (!NW_Text_Compare (iAnchorName, prop.value.object))

                        {

					targetBox = box;

					break;

				  }

				}

			  }

            if (targetBox != NULL)

                {

				(void) JumpToLink (box, NW_FALSE);

			  }

			  (void) Draw(NW_TRUE);

			  NW_Object_Delete(iAnchorName);

			  iAnchorName = NULL;

		  }

        }

    else

        {

        status = Draw (NW_TRUE);

        }

    for( TInt n=0; n<iListeners.Count(); n++ )

        {

        iListeners[n]->FormattingComplete();

        }

    return status;

    }

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

//lint --e{578} (Warning -- Declaration of symbol 'index' hides symbol 'index(const char *, int)' (line 75, file Q:\EPOC32\INCLUDE\LIBC\string.h))

TBrowserStatusCode CView::GetBoxTabIndex (NW_LMgr_Box_t* box, NW_ADT_Vector_Metric_t* index)

  {

  NW_Int32 i;

  NW_ADT_Vector_Metric_t size;

  NW_LMgr_Box_t* tempBox;

  NW_LMgr_RootBox_t* rootBox = iRootBox;

  NW_GDI_Rectangle_t tempBoxBounds;

  NW_GDI_Rectangle_t boxBounds;

  NW_Bool isPageRTL = NW_LMgr_RootBox_IsPageRTL(rootBox);

  NW_Bool smallScreenOn = NW_LMgr_RootBox_GetSmallScreenOn( iRootBox );

  NW_ASSERT(box != NULL);

  *index = NW_ADT_Vector_AtEnd;

  size = NW_ADT_Vector_GetSize( iTabList );

  // if a box is about to be added to the tab list the second time -so it's already in the list

  // we need to delete it from the list as this time, then box might have different x y which

  // requires different index to return with.

  i = 0;

  while( i < size )

    {

    tempBox = (NW_LMgr_Box_t*)*NW_ADT_Vector_ElementAt( iTabList,

      (NW_ADT_Vector_Metric_t)i);

    // check if the box is duplicated

    if( tempBox == box )

      {

      NW_ADT_DynamicVector_RemoveAt( iTabList, (NW_ADT_Vector_Metric_t)i );

      break;

      }

    // check if this is a image map box 'cause it appends the area boxes into the list

    // instead of the image map box - only in normal mode

    else if( NW_Object_IsClass(box, &NW_LMgr_ImageMapBox_Class) == NW_TRUE &&

      smallScreenOn == NW_FALSE )

      {

      //

      NW_ADT_Vector_Metric_t arrayIndex;

      NW_ADT_Vector_Metric_t elementSize;

      NW_LMgr_Box_t* areaBox = NULL;

      NW_ADT_DynamicVector_t* areaBoxArray =

        NW_LMgr_ImageMapBox_GetAreaBoxList( NW_LMgr_ImageMapBoxOf( box ) );

      if( areaBoxArray )

        {

        // find the index of the node vector

        elementSize = NW_ADT_Vector_GetSize(areaBoxArray);

        // loop through all the area boxes in the array and check if the box has already

        // been added

        for( arrayIndex = 0; arrayIndex < elementSize; arrayIndex++ )

          {

          areaBox = *(NW_LMgr_Box_t**)NW_ADT_Vector_ElementAt( areaBoxArray, arrayIndex );

          if( tempBox == areaBox )

            {

            NW_ADT_DynamicVector_RemoveAt( iTabList, (NW_ADT_Vector_Metric_t)i );

            // set size variable

            size = NW_ADT_Vector_GetSize( iTabList );

            // get the next box with the same index ( the result of the delete )

            i--;

            break;

            }

          }

        }

      }

    i++;

    }

  size = NW_ADT_Vector_GetSize( iTabList );

  CMVCScroll* scrollView = static_cast<CMVCScroll*>(GetScroll());

  NW_LMgr_Box_t* siblingBox = scrollView->GetFirstSiblingBox(box);

  boxBounds = NW_LMgr_Box_GetDisplayBounds(siblingBox);

  for( i = size - 1; i >= 0; i-- )

    {

    tempBox = (NW_LMgr_Box_t*)*NW_ADT_Vector_ElementAt(iTabList,

                                                        (NW_ADT_Vector_Metric_t)i);

    siblingBox = scrollView->GetFirstSiblingBox( NW_LMgr_BoxOf(tempBox) );

    tempBoxBounds = GetBoxDisplayBounds( siblingBox );

    // rule of inserting: first check y so that links on the same line go right after each other

    // and then check x to keep the order within the line

    // crossing rectangles tells us if those two boxes are in the same line

    NW_GDI_Rectangle_t boxRect;

    NW_GDI_Rectangle_t tempBoxRect;

    // x does not matter as we are only interested in y.

    // set fake x and width. we must set the same x, width values on those two boxes though.

    boxRect.point.x = tempBoxRect.point.x = 0;

    boxRect.dimension.width = tempBoxRect.dimension.width = 10;

    // set real y, height values

    boxRect.point.y = boxBounds.point.y;

    boxRect.dimension.height = boxBounds.dimension.height;

    tempBoxRect.point.y = tempBoxBounds.point.y;

    tempBoxRect.dimension.height = tempBoxBounds.dimension.height;

    if( NW_GDI_Rectangle_Cross( &boxRect, &tempBoxRect, NULL ) )

      {

      // same line

      // on right to left pages the x has to be decreasing as you jump

      // from link to link within the line.

      if( !isPageRTL )

        {

        if( boxBounds.point.x > tempBoxBounds.point.x ||

            (boxBounds.point.x == tempBoxBounds.point.x &&

             boxBounds.point.y > tempBoxBounds.point.y) )

          {

          *index = (NW_ADT_Vector_Metric_t)( i + 1 );

          break;

          }

        else if( i == 0 )

          {

          // the candiate is above even the first box

          *index = 0;

          break;

          }

        }

      // rtl

      else

        {

        if( boxBounds.point.x < tempBoxBounds.point.x ||

            (boxBounds.point.x == tempBoxBounds.point.x &&

             boxBounds.point.y > tempBoxBounds.point.y) )

          {

          *index = (NW_ADT_Vector_Metric_t)( i + 1 );

          break;

          }

        else if( i == 0 )

          {

          // the candiate is above even the first box

          *index = 0;

          break;

          }

        }

      }

    else if( boxBounds.point.y > tempBoxBounds.point.y )

      {

      // the box is right below the tempbox.

      *index = (NW_ADT_Vector_Metric_t)( i + 1 );

      break;

      }

    else if( i == 0 )

      {

      // the candiate is above even the first box

      *index = 0;

      break;

      }

    else

      {

      // not on the same line but above, keep going

      }

    }

  return KBrsrSuccess;

  }

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

TBool CView::ValidateAddedIndex(NW_LMgr_Box_t* aBox, NW_LMgr_Box_t* aMasterBox)

    {

    NW_GDI_Rectangle_t boxBounds = GetBoxDisplayBounds(aMasterBox);

    // If master box is not visible, do not add to tab index

    // Break box now has a width of 1. Don't add to tab index if there are only break boxes

    if ( boxBounds.dimension.width == 0 || boxBounds.dimension.height == 0)

        {

        return EFalse;

        }

    // If all the boxes associated with this box are not visible, don't add to tab index

    NW_LMgr_BoxVisitor_t boxVisitor;

    NW_LMgr_Box_t* visitedBox;

    NW_LMgr_BoxVisitor_Initialize (&boxVisitor, aBox);

    while((visitedBox = NW_LMgr_BoxVisitor_NextBox (&boxVisitor, NULL)) != NULL)

        {

        boxBounds = GetBoxDisplayBounds(visitedBox);

        if (NW_Object_IsInstanceOf(visitedBox, &NW_LMgr_ContainerBox_Class))

            {

            continue;

            }

        if (( boxBounds.dimension.width != 0 || boxBounds.dimension.height != 0) &&

            !NW_Object_IsInstanceOf(visitedBox, &NW_LMgr_BreakBox_Class))

            {

            // Found a visible box

            return ETrue;;

            }

        }

    NW_LMgr_BoxVisitor_Initialize (&boxVisitor, aMasterBox);

    while((visitedBox = NW_LMgr_BoxVisitor_NextBox (&boxVisitor, NULL)) != NULL)

        {

        boxBounds = GetBoxDisplayBounds(visitedBox);

        if (NW_Object_IsInstanceOf(visitedBox, &NW_LMgr_ContainerBox_Class))

            {

            continue;

            }

        if ((boxBounds.dimension.width != 0 && boxBounds.dimension.height != 0) &&

            !NW_Object_IsInstanceOf(visitedBox, &NW_LMgr_BreakBox_Class))

            {

            // Found a visible box

            return ETrue;;

            }

        }

    return EFalse;

    }

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

TBrowserStatusCode

CView::AppendTabItem (NW_LMgr_Box_t* aBox)

  {

  TBrowserStatusCode status = KBrsrSuccess;

  //lint --e{578} (Warning -- Declaration of symbol 'index' hides symbol 'index(const char *, int)' (line 75, file Q:\EPOC32\INCLUDE\LIBC\string.h))

  NW_ADT_Vector_Metric_t index = 0;

  NW_LMgr_Property_t prop;

  NW_LMgr_Box_t* box = aBox;

  if (box->propList && NW_Object_IsInstanceOf(box->propList, &NW_LMgr_SlavePropertyList_Class))

    {

    // this is a slave, get the master box as we MUST NOT add slave box to the tablist

    // Slave boxes are destroyed when box tree is collaped. Collapse can happen multiple times while

    // the page is being loaded and if we added slave boxes to the tablist, then we would end up having

    // invalid pointers in the tablist after each collapse.

    NW_LMgr_Box_t* masterBox = NW_LMgr_SlavePropertyList_GetMasterBox( box->propList );

    if( !masterBox )

      {

      return KBrsrUnexpectedError;

      }

    box = masterBox;

    }

    // Add the new box only if there is something visible for this active box

    if (!ValidateAddedIndex(aBox, box))

        {

        return KBrsrSuccess;

        }

  // set available accesskey

  status = NW_LMgr_Box_GetPropertyFromList(box, NW_CSS_Prop_accesskey, &prop);

  if (status == KBrsrSuccess)

    {

    (void) NW_LMgr_AccessKey_SetAvailableKey (NW_LMgr_AccessKeyOf (prop.value.object),

      iTabList);

    }

  // ignore duplicated boxes

  if( GetBoxTabIndex (box, &index) == KBrsrSuccess )

    {

    // if the box is an image map box, and we are in normal layout mode, then we want to

    // add the image map's area boxes to the tab list instead of the image map box itself

    // if we are in small screen mode, we will add the image map box to the tab list