// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.core.util;

import org.litesoft.commonfoundation.typeutils.*;
import org.litesoft.core.simpletypes.*;

public abstract class RectangleContainmentStrategy
{
    private String mStrategyName;

    protected RectangleContainmentStrategy( String pStrategyName )
    {
        mStrategyName = pStrategyName;
    }

    /**
     * Adjust pRect so that it fits within pContainer.
     *
     * @param pRect      !null
     * @param pContainer !null
     */
    public Rect adjustToFitIn( Rect pRect, Rect pContainer )
    {
        Objects.assertNotNull( "Rect", pRect );
        Objects.assertNotNull( "Container", pContainer );

        return pContainer.obscures( pRect ) ? //
               pRect : //
               pRect.moveTo( moveToFitIn( pRect, pContainer ) ).adjustToBeObscuredBy( pContainer );
    }

    /**
     * @return !null means to move to
     */
    public abstract PointXY moveToFitIn( Rect pRect, Rect pContainer );

    protected Integer adjust( int pLineOffset, int pLineLength, int pContainerOffset, int pContainerLength )
    {
        int zLineOffset = pLineOffset;

        // Check to far Right/Bottom
        int zLineEnd = zLineOffset + pLineLength;
        int zContainerEnd = pContainerOffset + pContainerLength;
        if ( zLineEnd > zContainerEnd )
        {
            zLineOffset -= zLineEnd - zContainerEnd;
        }

        // Check to far Left/Top
        if ( zLineOffset < pContainerOffset )
        {
            zLineOffset = pContainerOffset;
        }

        return (zLineOffset != pLineOffset) ? zLineOffset : null;
    }

    public String toString()
    {
        return mStrategyName + "AdjustStrategy";
    }
}