/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* 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 Lesser General Public License for more details.
*
* Copyright (c) 2001 - 2013 Object Refinery Ltd, Pentaho Corporation and Contributors..  All rights reserved.
*/

package org.pentaho.reporting.libraries.pixie.wmf.records;

import org.pentaho.reporting.libraries.pixie.wmf.GDIColor;
import org.pentaho.reporting.libraries.pixie.wmf.MfRecord;
import org.pentaho.reporting.libraries.pixie.wmf.MfType;
import org.pentaho.reporting.libraries.pixie.wmf.WmfFile;

import java.awt.*;

/**
 * As with every palette-function: I'm not sure if this is correctly implemented.
 * <p/>
 * The SetPaletteEntries function sets RGB (red, green, blue) color values and flags in a range of entries in a logical
 * palette.
 */
public final class MfCmdSetPaletteEntries extends MfCmd {
  private static final int BASE_RECORD_SIZE = 3;
  private static final int POS_H_PALETTE = 0;
  private static final int POS_CSTART = 1;
  private static final int POS_CENTRIES = 2;

  private int hPalette;
  private Color[] colors;
  private int startPos;
  private static final Color[] COLOR = new Color[ 0 ];

  public MfCmdSetPaletteEntries() {
    colors = COLOR;
  }

  /**
   * Replays the command on the given WmfFile.
   *
   * @param file the meta file.
   */
  public void replay( final WmfFile file ) {
    // not yet
  }

  /**
   * Creates a empty unintialized copy of this command implementation.
   *
   * @return a new instance of the command.
   */
  public MfCmd getInstance() {
    return new MfCmdSetPaletteEntries();
  }

  public Color[] getEntries() {
    return (Color[]) colors.clone();
  }

  public void setEntries( final Color[] colors ) {
    this.colors = (Color[]) colors.clone();
  }

  /**
   * Reads the command data from the given record and adjusts the internal parameters according to the data parsed.
   * <p/>
   * After the raw record was read from the datasource, the record is parsed by the concrete implementation.
   *
   * @param record the raw data that makes up the record.
   */
  public void setRecord( final MfRecord record ) {
    final int hPalette = record.getParam( POS_H_PALETTE );
    final int cStart = record.getParam( POS_CSTART );
    final int cEntries = record.getParam( POS_CENTRIES );
    final Color[] colors = new Color[ cEntries ];

    for ( int i = 0; i < cEntries; i++ ) {
      final int colorRef = record.getLongParam( 2 * i + BASE_RECORD_SIZE );
      final GDIColor color = new GDIColor( colorRef );
      colors[ i ] = color;
    }
    setStartPos( cStart );
    setEntries( colors );
    setHPalette( hPalette );
  }

  /**
   * Creates a new record based on the data stored in the MfCommand.
   *
   * @return the created record.
   */
  public MfRecord getRecord()
    throws RecordCreationException {
    final Color[] cEntries = getEntries();
    if ( cEntries == null ) {
      throw new NullPointerException( "No CEntries set" );
    }

    final MfRecord record = new MfRecord( 2 * cEntries.length + BASE_RECORD_SIZE );
    record.setParam( POS_H_PALETTE, getHPalette() );
    record.setParam( POS_CSTART, getStartPos() );
    record.setParam( POS_CENTRIES, cEntries.length );

    for ( int i = 0; i < cEntries.length; i++ ) {
      record.setLongParam( 2 * i + BASE_RECORD_SIZE, GDIColor.translateColor( cEntries[ i ] ) );
    }
    return record;
  }

  public int getStartPos() {
    return startPos;
  }

  public void setStartPos( final int startPos ) {
    this.startPos = startPos;
  }

  /**
   * Reads the function identifier. Every record type is identified by a function number corresponding to one of the
   * Windows GDI functions used.
   *
   * @return the function identifier.
   */
  public int getFunction() {
    return MfType.SET_PALETTE_ENTRIES;
  }

  public int getHPalette() {
    return hPalette;
  }

  public void setHPalette( final int hPalette ) {
    this.hPalette = hPalette;
  }

  public String toString() {
    final StringBuffer b = new StringBuffer( 100 );
    b.append( "[SET_PALETTE_ENTRIES] entriesCount=" );
    if ( getEntries() == null ) {
      b.append( 0 );
    } else {
      b.append( getEntries().length );
    }
    b.append( " hpalette=" );
    b.append( hPalette );
    return b.toString();
  }

  /**
   * A callback function to inform the object, that the x scale has changed and the internal coordinate values have to
   * be adjusted.
   */
  protected void scaleXChanged() {
  }

  /**
   * A callback function to inform the object, that the y scale has changed and the internal coordinate values have to
   * be adjusted.
   */
  protected void scaleYChanged() {
  }
}