/*
 *
 * This file is part of the iText (R) project.
    Copyright (c) 1998-2020 iText Group NV
 * Authors: Kevin Day, Bruno Lowagie, Paulo Soares, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS
 *
 * 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 Affero General Public License for more details.
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * a covered work must retain the producer line in every PDF that is created
 * or manipulated using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: sales@itextpdf.com
 */
package com.itextpdf.text.pdf.parser;

import com.itextpdf.text.BaseColor;
import com.itextpdf.text.pdf.CMapAwareDocumentFont;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.PdfName;

/**
 * Keeps all the parameters of the graphics state.
 * @since	2.1.4
 */
public class GraphicsState {
    /** The current transformation matrix. */
    Matrix ctm;
    /** The current character spacing. */
    float characterSpacing;
    /** The current word spacing. */
    float wordSpacing;
    /** The current horizontal scaling */
    float horizontalScaling;
    /** The current leading. */
    float leading;
    /** The active font. */
    CMapAwareDocumentFont font;
    /** The current font size. */
    float fontSize;
    /** The current render mode. */
    int renderMode;
    /** The current text rise */
    float rise;
    /** The current knockout value. */
    boolean knockout;
    /** The current color space for stroke. */
    PdfName colorSpaceFill;
    /** The current color space for stroke. */
    PdfName colorSpaceStroke;
    /** The current fill color. */
    BaseColor fillColor = BaseColor.BLACK;
    /** The current stroke color. */
    BaseColor strokeColor = BaseColor.BLACK;

    /** The line width for stroking operations */
    private float lineWidth;

    /**
     * The line cap style. For possible values
     * see {@link PdfContentByte}
     */
    private int lineCapStyle;

    /**
     * The line join style. For possible values
     * see {@link PdfContentByte}
     */
    private int lineJoinStyle;

    /** The mitir limit value */
    private float miterLimit;

    /** The line dash pattern */
    private LineDashPattern lineDashPattern;
    
    /**
     * Constructs a new Graphics State object with the default values.
     */
    public GraphicsState(){
        ctm = new Matrix();
        characterSpacing = 0;
        wordSpacing = 0;
        horizontalScaling = 1.0f;
        leading = 0;
        font = null;
        fontSize = 0;
        renderMode = 0;
        rise = 0;
        knockout = true;
        colorSpaceFill = null;
        colorSpaceStroke = null;
        fillColor = null;
        strokeColor = null;
        lineWidth = 1.0f;
        lineCapStyle = PdfContentByte.LINE_CAP_BUTT;
        lineJoinStyle = PdfContentByte.LINE_JOIN_MITER;
        miterLimit = 10.0f;
    }
    
    /**
     * Copy constructor.
     * @param source	another GraphicsState object
     */
    public GraphicsState(GraphicsState source){
        // note: all of the following are immutable, with the possible exception of font
        // so it is safe to copy them as-is
        ctm = source.ctm;
        characterSpacing = source.characterSpacing;
        wordSpacing = source.wordSpacing;
        horizontalScaling = source.horizontalScaling;
        leading = source.leading;
        font = source.font;
        fontSize = source.fontSize;
        renderMode = source.renderMode;
        rise = source.rise;
        knockout = source.knockout;
        colorSpaceFill = source.colorSpaceFill;
        colorSpaceStroke = source.colorSpaceStroke;
        fillColor = source.fillColor;
        strokeColor = source.strokeColor;
        lineWidth = source.lineWidth;
        lineCapStyle = source.lineCapStyle;
        lineJoinStyle = source.lineJoinStyle;
        miterLimit = source.miterLimit;

        if (source.lineDashPattern != null) {
            lineDashPattern = new LineDashPattern(source.lineDashPattern.getDashArray(), source.lineDashPattern.getDashPhase());
        }
    }

	/**
	 * Getter for the current transformation matrix
	 * @return the ctm
	 * @since iText 5.0.1
	 */
	public Matrix getCtm() {
		return ctm;
	}

	/**
	 * Getter for the character spacing.
	 * @return the character spacing
	 * @since iText 5.0.1
	 */
	public float getCharacterSpacing() {
		return characterSpacing;
	}

	/**
	 * Getter for the word spacing
	 * @return the word spacing
	 * @since iText 5.0.1
	 */
	public float getWordSpacing() {
		return wordSpacing;
	}

	/**
	 * Getter for the horizontal scaling
	 * @return the horizontal scaling
	 * @since iText 5.0.1
	 */
	public float getHorizontalScaling() {
		return horizontalScaling;
	}

	/**
	 * Getter for the leading
	 * @return the leading
	 * @since iText 5.0.1
	 */
	public float getLeading() {
		return leading;
	}

	/**
	 * Getter for the font
	 * @return the font
	 * @since iText 5.0.1
	 */
	public CMapAwareDocumentFont getFont() {
		return font;
	}

	/**
	 * Getter for the font size
	 * @return the font size
	 * @since iText 5.0.1
	 */
	public float getFontSize() {
		return fontSize;
	}

	/**
	 * Getter for the render mode
	 * @return the renderMode
	 * @since iText 5.0.1
	 */
	public int getRenderMode() {
		return renderMode;
	}

	/**
	 * Getter for text rise
	 * @return the text rise
	 * @since iText 5.0.1
	 */
	public float getRise() {
		return rise;
	}

	/**
	 * Getter for knockout
	 * @return the knockout
	 * @since iText 5.0.1
	 */
	public boolean isKnockout() {
		return knockout;
	}
	
	/**
	 * Gets the current color space for fill operations
	 */
	public PdfName getColorSpaceFill() {
		return colorSpaceFill;
	}
	
	/**
	 * Gets the current color space for stroke operations
	 */
	public PdfName getColorSpaceStroke() {
		return colorSpaceStroke;
	}

	/**
	 * Gets the current fill color
	 * @return a BaseColor
	 */
	public BaseColor getFillColor() {
		return fillColor;
	}

	/**
	 * Gets the current stroke color
	 * @return a BaseColor
	 */
	public BaseColor getStrokeColor() {
		return strokeColor;
	}

    /**
     * Getter for the line width.
     * @return The line width
     * @since 5.5.6
     */
    public float getLineWidth() {
        return lineWidth;
    }

    /**
     * Setter for the line width.
     * @param lineWidth New line width.
     * @since 5.5.6
     */
    public void setLineWidth(float lineWidth) {
        this.lineWidth = lineWidth;
    }

    /**
     * Getter for the line cap style.
     * For possible values see {@link PdfContentByte}
     * @return The line cap style.
     * @since 5.5.6
     */
    public int getLineCapStyle() {
        return lineCapStyle;
    }

    /**
     * Setter for the line cap style.
     * For possible values see {@link PdfContentByte}
     * @param lineCapStyle New line cap style.
     * @since 5.5.6
     */
    public void setLineCapStyle(int lineCapStyle) {
        this.lineCapStyle = lineCapStyle;
    }

    /**
     * Getter for the line join style.
     * For possible values see {@link PdfContentByte}
     * @return The line join style.
     * @since 5.5.6
     */
    public int getLineJoinStyle() {
        return lineJoinStyle;
    }

    /**
     * Setter for the line join style.
     * For possible values see {@link PdfContentByte}
     * @param lineJoinStyle New line join style.
     * @since 5.5.6
     */
    public void setLineJoinStyle(int lineJoinStyle) {
        this.lineJoinStyle = lineJoinStyle;
    }

    /**
     * Getter for the miter limit value.
     * @return The miter limit.
     * @since 5.5.6
     */
    public float getMiterLimit() {
        return miterLimit;
    }

    /**
     * Setter for the miter limit value.
     * @param miterLimit New miter limit.
     * @since 5.5.6
     */
    public void setMiterLimit(float miterLimit) {
        this.miterLimit = miterLimit;
    }

    /**
     * Getter for the line dash pattern.
     * @return The line dash pattern.
     * @since 5.5.6
     */
    public LineDashPattern getLineDashPattern() {
        return lineDashPattern;
    }

    /**
     * Setter for the line dash pattern.
     * @param lineDashPattern New line dash pattern.
     * @since 5.5.6
     */
    public void setLineDashPattern(LineDashPattern lineDashPattern) {
        this.lineDashPattern = new LineDashPattern(lineDashPattern.getDashArray(), lineDashPattern.getDashPhase());
    }
}
