/* GTK - The GIMP Toolkit

 * gtkprintsettings.c: Print Settings

 * Copyright (C) 2006, Red Hat, Inc.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library 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.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

#include "config.h"

#include <string.h>

#include <stdlib.h>

#include <glib/gprintf.h>

#include <gtk/gtk.h>

#include "gtkprintsettings.h"

#include "gtkprintutils.h"

#include "gtkalias.h"

typedef struct _GtkPrintSettingsClass GtkPrintSettingsClass;

#define GTK_IS_PRINT_SETTINGS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_SETTINGS))

#define GTK_PRINT_SETTINGS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_SETTINGS, GtkPrintSettingsClass))

#define GTK_PRINT_SETTINGS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_SETTINGS, GtkPrintSettingsClass))

struct _GtkPrintSettings

{

  GObject parent_instance;

  GHashTable *hash;

};

struct _GtkPrintSettingsClass

{

  GObjectClass parent_class;

};

#define KEYFILE_GROUP_NAME "Print Settings"

G_DEFINE_TYPE (GtkPrintSettings, gtk_print_settings, G_TYPE_OBJECT)

static void

gtk_print_settings_finalize (GObject *object)

{

  GtkPrintSettings *settings = GTK_PRINT_SETTINGS (object);

  g_hash_table_destroy (settings->hash);

  G_OBJECT_CLASS (gtk_print_settings_parent_class)->finalize (object);

}

static void

gtk_print_settings_init (GtkPrintSettings *settings)

{

  settings->hash = g_hash_table_new_full (g_str_hash, g_str_equal,

					  g_free, g_free);

}

static void

gtk_print_settings_class_init (GtkPrintSettingsClass *class)

{

  GObjectClass *gobject_class = (GObjectClass *)class;

  gobject_class->finalize = gtk_print_settings_finalize;

}

/**

 * gtk_print_settings_new:

 * 

 * Creates a new #GtkPrintSettings object.

 *  

 * Return value: a new #GtkPrintSettings object

 *

 * Since: 2.10

 */

GtkPrintSettings *

gtk_print_settings_new (void)

{

  return g_object_new (GTK_TYPE_PRINT_SETTINGS, NULL);

}

static void

copy_hash_entry  (gpointer  key,

		  gpointer  value,

		  gpointer  user_data)

{

  GtkPrintSettings *settings = user_data;

  g_hash_table_insert (settings->hash, 

		       g_strdup (key), 

		       g_strdup (value));

}

/**

 * gtk_print_settings_copy:

 * @other: a #GtkPrintSettings

 *

 * Copies a #GtkPrintSettings object.

 *

 * Return value: (transfer full): a newly allocated copy of @other

 *

 * Since: 2.10

 */

GtkPrintSettings *

gtk_print_settings_copy (GtkPrintSettings *other)

{

  GtkPrintSettings *settings;

  if (other == NULL)

    return NULL;

  g_return_val_if_fail (GTK_IS_PRINT_SETTINGS (other), NULL);

  settings = gtk_print_settings_new ();

  g_hash_table_foreach (other->hash,

			copy_hash_entry,

			settings);

  return settings;

}

/**

 * gtk_print_settings_get:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * 

 * Looks up the string value associated with @key.

 * 

 * Return value: the string value for @key

 * 

 * Since: 2.10

 */

const gchar *

gtk_print_settings_get (GtkPrintSettings *settings,

			const gchar      *key)

{

  return g_hash_table_lookup (settings->hash, key);

}

/**

 * gtk_print_settings_set:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @value: (allow-none): a string value, or %NULL

 *

 * Associates @value with @key.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set (GtkPrintSettings *settings,

			const gchar      *key,

			const gchar      *value)

{

  if (value == NULL)

    gtk_print_settings_unset (settings, key);

  else

    g_hash_table_insert (settings->hash, 

			 g_strdup (key), 

			 g_strdup (value));

}

/**

 * gtk_print_settings_unset:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * 

 * Removes any value associated with @key. 

 * This has the same effect as setting the value to %NULL.

 *

 * Since: 2.10 

 */

void

gtk_print_settings_unset (GtkPrintSettings *settings,

			  const gchar      *key)

{

  g_hash_table_remove (settings->hash, key);

}

/**

 * gtk_print_settings_has_key:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * 

 * Returns %TRUE, if a value is associated with @key.

 * 

 * Return value: %TRUE, if @key has a value

 *

 * Since: 2.10

 */

gboolean        

gtk_print_settings_has_key (GtkPrintSettings *settings,

			    const gchar      *key)

{

  return gtk_print_settings_get (settings, key) != NULL;

}

/**

 * gtk_print_settings_get_bool:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * 

 * Returns the boolean represented by the value

 * that is associated with @key. 

 *

 * The string "true" represents %TRUE, any other 

 * string %FALSE.

 *

 * Return value: %TRUE, if @key maps to a true value.

 * 

 * Since: 2.10

 **/

gboolean

gtk_print_settings_get_bool (GtkPrintSettings *settings,

			     const gchar      *key)

{

  const gchar *val;

  val = gtk_print_settings_get (settings, key);

  if (g_strcmp0 (val, "true") == 0)

    return TRUE;

  return FALSE;

}

/**

 * gtk_print_settings_get_bool_with_default:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @default_val: the default value

 * 

 * Returns the boolean represented by the value

 * that is associated with @key, or @default_val

 * if the value does not represent a boolean.

 *

 * The string "true" represents %TRUE, the string

 * "false" represents %FALSE.

 *

 * Return value: the boolean value associated with @key

 * 

 * Since: 2.10

 */

static gboolean

gtk_print_settings_get_bool_with_default (GtkPrintSettings *settings,

					  const gchar      *key,

					  gboolean          default_val)

{

  const gchar *val;

  val = gtk_print_settings_get (settings, key);

  if (g_strcmp0 (val, "true") == 0)

    return TRUE;

  if (g_strcmp0 (val, "false") == 0)

    return FALSE;

  return default_val;

}

/**

 * gtk_print_settings_set_bool:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @value: a boolean

 * 

 * Sets @key to a boolean value.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set_bool (GtkPrintSettings *settings,

			     const gchar      *key,

			     gboolean          value)

{

  if (value)

    gtk_print_settings_set (settings, key, "true");

  else

    gtk_print_settings_set (settings, key, "false");

}

/**

 * gtk_print_settings_get_double_with_default:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @def: the default value

 * 

 * Returns the floating point number represented by 

 * the value that is associated with @key, or @default_val

 * if the value does not represent a floating point number.

 *

 * Floating point numbers are parsed with g_ascii_strtod().

 *

 * Return value: the floating point number associated with @key

 * 

 * Since: 2.10

 */

gdouble

gtk_print_settings_get_double_with_default (GtkPrintSettings *settings,

					    const gchar      *key,

					    gdouble           def)

{

  const gchar *val;

  val = gtk_print_settings_get (settings, key);

  if (val == NULL)

    return def;

  return g_ascii_strtod (val, NULL);

}

/**

 * gtk_print_settings_get_double:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * 

 * Returns the double value associated with @key, or 0.

 * 

 * Return value: the double value of @key

 *

 * Since: 2.10

 */

gdouble

gtk_print_settings_get_double (GtkPrintSettings *settings,

			       const gchar      *key)

{

  return gtk_print_settings_get_double_with_default (settings, key, 0.0);

}

/**

 * gtk_print_settings_set_double:

 * @settings: a #GtkPrintSettings

 * @key: a key 

 * @value: a double value

 * 

 * Sets @key to a double value.

 * 

 * Since: 2.10

 */

void

gtk_print_settings_set_double (GtkPrintSettings *settings,

			       const gchar      *key,

			       gdouble           value)

{

  gchar buf[G_ASCII_DTOSTR_BUF_SIZE];

  g_ascii_dtostr (buf, G_ASCII_DTOSTR_BUF_SIZE, value);

  gtk_print_settings_set (settings, key, buf);

}

/**

 * gtk_print_settings_get_length:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @unit: the unit of the return value

 * 

 * Returns the value associated with @key, interpreted

 * as a length. The returned value is converted to @units.

 * 

 * Return value: the length value of @key, converted to @unit

 *

 * Since: 2.10

 */

gdouble

gtk_print_settings_get_length (GtkPrintSettings *settings,

			       const gchar      *key,

			       GtkUnit           unit)

{

  gdouble length = gtk_print_settings_get_double (settings, key);

  return _gtk_print_convert_from_mm (length, unit);

}

/**

 * gtk_print_settings_set_length:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @value: a length

 * @unit: the unit of @length

 * 

 * Associates a length in units of @unit with @key.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set_length (GtkPrintSettings *settings,

			       const gchar      *key,

			       gdouble           value, 

			       GtkUnit           unit)

{

  gtk_print_settings_set_double (settings, key,

				 _gtk_print_convert_to_mm (value, unit));

}

/**

 * gtk_print_settings_get_int_with_default:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @def: the default value

 * 

 * Returns the value of @key, interpreted as

 * an integer, or the default value.

 * 

 * Return value: the integer value of @key

 *

 * Since: 2.10

 */

gint

gtk_print_settings_get_int_with_default (GtkPrintSettings *settings,

					 const gchar      *key,

					 gint              def)

{

  const gchar *val;

  val = gtk_print_settings_get (settings, key);

  if (val == NULL)

    return def;

  return atoi (val);

}

/**

 * gtk_print_settings_get_int:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * 

 * Returns the integer value of @key, or 0.

 * 

 * Return value: the integer value of @key 

 *

 * Since: 2.10

 */

gint

gtk_print_settings_get_int (GtkPrintSettings *settings,

			    const gchar      *key)

{

  return gtk_print_settings_get_int_with_default (settings, key, 0);

}

/**

 * gtk_print_settings_set_int:

 * @settings: a #GtkPrintSettings

 * @key: a key

 * @value: an integer 

 * 

 * Sets @key to an integer value.

 *

 * Since: 2.10 

 */

void

gtk_print_settings_set_int (GtkPrintSettings *settings,

			    const gchar      *key,

			    gint              value)

{

  gchar buf[128];

  g_sprintf (buf, "%d", value);

  gtk_print_settings_set (settings, key, buf);

}

/**

 * gtk_print_settings_foreach:

 * @settings: a #GtkPrintSettings

 * @func: (scope call): the function to call

 * @user_data: user data for @func

 *

 * Calls @func for each key-value pair of @settings.

 *

 * Since: 2.10

 */

void

gtk_print_settings_foreach (GtkPrintSettings    *settings,

			    GtkPrintSettingsFunc func,

			    gpointer             user_data)

{

  g_hash_table_foreach (settings->hash, (GHFunc)func, user_data);

}

/**

 * gtk_print_settings_get_printer:

 * @settings: a #GtkPrintSettings

 * 

 * Convenience function to obtain the value of 

 * %GTK_PRINT_SETTINGS_PRINTER.

 *

 * Return value: the printer name

 *

 * Since: 2.10

 */

const gchar *

gtk_print_settings_get_printer (GtkPrintSettings *settings)

{

  return gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_PRINTER);

}

/**

 * gtk_print_settings_set_printer:

 * @settings: a #GtkPrintSettings

 * @printer: the printer name

 * 

 * Convenience function to set %GTK_PRINT_SETTINGS_PRINTER

 * to @printer.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set_printer (GtkPrintSettings *settings,

				const gchar      *printer)

{

  gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_PRINTER, printer);

}

/**

 * gtk_print_settings_get_orientation:

 * @settings: a #GtkPrintSettings

 * 

 * Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, 

 * converted to a #GtkPageOrientation.

 * 

 * Return value: the orientation

 *

 * Since: 2.10

 */

GtkPageOrientation

gtk_print_settings_get_orientation (GtkPrintSettings *settings)

{

  const gchar *val;

  val = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_ORIENTATION);

  if (val == NULL || strcmp (val, "portrait") == 0)

    return GTK_PAGE_ORIENTATION_PORTRAIT;

  if (strcmp (val, "landscape") == 0)

    return GTK_PAGE_ORIENTATION_LANDSCAPE;

  if (strcmp (val, "reverse_portrait") == 0)

    return GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT;

  if (strcmp (val, "reverse_landscape") == 0)

    return GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE;

  return GTK_PAGE_ORIENTATION_PORTRAIT;

}

/**

 * gtk_print_settings_set_orientation:

 * @settings: a #GtkPrintSettings

 * @orientation: a page orientation

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION.

 * 

 * Since: 2.10

 */

void

gtk_print_settings_set_orientation (GtkPrintSettings   *settings,

				    GtkPageOrientation  orientation)

{

  const gchar *val;

  switch (orientation)

    {

    case GTK_PAGE_ORIENTATION_LANDSCAPE:

      val = "landscape";

      break;

    default:

    case GTK_PAGE_ORIENTATION_PORTRAIT:

      val = "portrait";

      break;

    case GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE:

      val = "reverse_landscape";

      break;

    case GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT:

      val = "reverse_portrait";

      break;

    }

  gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_ORIENTATION, val);

}

/**

 * gtk_print_settings_get_paper_size:

 * @settings: a #GtkPrintSettings

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, 

 * converted to a #GtkPaperSize.

 * 

 * Return value: the paper size

 *

 * Since: 2.10

 */

GtkPaperSize *     

gtk_print_settings_get_paper_size (GtkPrintSettings *settings)

{

  const gchar *val;

  const gchar *name;

  gdouble w, h;

  val = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_PAPER_FORMAT);

  if (val == NULL)

    return NULL;

  if (g_str_has_prefix (val, "custom-")) 

    {

      name = val + strlen ("custom-");

      w = gtk_print_settings_get_paper_width (settings, GTK_UNIT_MM);

      h = gtk_print_settings_get_paper_height (settings, GTK_UNIT_MM);

      return gtk_paper_size_new_custom (name, name, w, h, GTK_UNIT_MM);

    }

  return gtk_paper_size_new (val);

}

/**

 * gtk_print_settings_set_paper_size:

 * @settings: a #GtkPrintSettings

 * @paper_size: a paper size

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,

 * %GTK_PRINT_SETTINGS_PAPER_WIDTH and

 * %GTK_PRINT_SETTINGS_PAPER_HEIGHT.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set_paper_size (GtkPrintSettings *settings,

				   GtkPaperSize     *paper_size)

{

  gchar *custom_name;

  if (paper_size == NULL) 

    {

      gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_PAPER_FORMAT, NULL);

      gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_PAPER_WIDTH, NULL);

      gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_PAPER_HEIGHT, NULL);

    }

  else if (gtk_paper_size_is_custom (paper_size)) 

    {

      custom_name = g_strdup_printf ("custom-%s", 

				     gtk_paper_size_get_name (paper_size));

      gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_PAPER_FORMAT, custom_name);

      g_free (custom_name);

      gtk_print_settings_set_paper_width (settings, 

					  gtk_paper_size_get_width (paper_size, 

								    GTK_UNIT_MM),

					  GTK_UNIT_MM);

      gtk_print_settings_set_paper_height (settings, 

					   gtk_paper_size_get_height (paper_size, 

								      GTK_UNIT_MM),

					   GTK_UNIT_MM);

    } 

  else

    gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_PAPER_FORMAT, 

			    gtk_paper_size_get_name (paper_size));

}

/**

 * gtk_print_settings_get_paper_width:

 * @settings: a #GtkPrintSettings

 * @unit: the unit for the return value

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH,

 * converted to @unit. 

 * 

 * Return value: the paper width, in units of @unit

 *

 * Since: 2.10

 */

gdouble

gtk_print_settings_get_paper_width (GtkPrintSettings *settings,

				    GtkUnit           unit)

{

  return gtk_print_settings_get_length (settings, GTK_PRINT_SETTINGS_PAPER_WIDTH, unit);

}

/**

 * gtk_print_settings_set_paper_width:

 * @settings: a #GtkPrintSettings

 * @width: the paper width

 * @unit: the units of @width

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set_paper_width (GtkPrintSettings *settings,

				    gdouble           width, 

				    GtkUnit           unit)

{

  gtk_print_settings_set_length (settings, GTK_PRINT_SETTINGS_PAPER_WIDTH, width, unit);

}

/**

 * gtk_print_settings_get_paper_height:

 * @settings: a #GtkPrintSettings

 * @unit: the unit for the return value

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT,

 * converted to @unit. 

 * 

 * Return value: the paper height, in units of @unit

 *

 * Since: 2.10

 */

gdouble

gtk_print_settings_get_paper_height (GtkPrintSettings *settings,

				     GtkUnit           unit)

{

  return gtk_print_settings_get_length (settings, 

					GTK_PRINT_SETTINGS_PAPER_HEIGHT,

					unit);

}

/**

 * gtk_print_settings_set_paper_height:

 * @settings: a #GtkPrintSettings

 * @height: the paper height

 * @unit: the units of @height

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT.

 *

 * Since: 2.10

 */

void

gtk_print_settings_set_paper_height (GtkPrintSettings *settings,

				     gdouble           height, 

				     GtkUnit           unit)

{

  gtk_print_settings_set_length (settings, 

				 GTK_PRINT_SETTINGS_PAPER_HEIGHT, 

				 height, unit);

}

/**

 * gtk_print_settings_get_use_color:

 * @settings: a #GtkPrintSettings

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR.

 * 

 * Return value: whether to use color

 *

 * Since: 2.10

 */

gboolean

gtk_print_settings_get_use_color (GtkPrintSettings *settings)

{

  return gtk_print_settings_get_bool_with_default (settings, 

						   GTK_PRINT_SETTINGS_USE_COLOR,

						   TRUE);

}

/**

 * gtk_print_settings_set_use_color:

 * @settings: a #GtkPrintSettings

 * @use_color: whether to use color

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.

 * 

 * Since: 2.10

 */

void

gtk_print_settings_set_use_color (GtkPrintSettings *settings,

				  gboolean          use_color)

{

  gtk_print_settings_set_bool (settings,

			       GTK_PRINT_SETTINGS_USE_COLOR, 

			       use_color);

}

/**

 * gtk_print_settings_get_collate:

 * @settings: a #GtkPrintSettings

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_COLLATE.

 * 

 * Return value: whether to collate the printed pages

 *

 * Since: 2.10

 */

gboolean

gtk_print_settings_get_collate (GtkPrintSettings *settings)

{

  return gtk_print_settings_get_bool (settings, 

				      GTK_PRINT_SETTINGS_COLLATE);

}

/**

 * gtk_print_settings_set_collate:

 * @settings: a #GtkPrintSettings

 * @collate: whether to collate the output

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_COLLATE.

 * 

 * Since: 2.10

 */

void

gtk_print_settings_set_collate (GtkPrintSettings *settings,

				gboolean          collate)

{

  gtk_print_settings_set_bool (settings,

			       GTK_PRINT_SETTINGS_COLLATE, 

			       collate);

}

/**

 * gtk_print_settings_get_reverse:

 * @settings: a #GtkPrintSettings

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_REVERSE.

 * 

 * Return value: whether to reverse the order of the printed pages

 *

 * Since: 2.10

 */

gboolean

gtk_print_settings_get_reverse (GtkPrintSettings *settings)

{

  return gtk_print_settings_get_bool (settings, 

				      GTK_PRINT_SETTINGS_REVERSE);

}

/**

 * gtk_print_settings_set_reverse:

 * @settings: a #GtkPrintSettings

 * @reverse: whether to reverse the output

 * 

 * Sets the value of %GTK_PRINT_SETTINGS_REVERSE.

 * 

 * Since: 2.10

 */

void

gtk_print_settings_set_reverse (GtkPrintSettings *settings,

				  gboolean        reverse)

{

  gtk_print_settings_set_bool (settings,

			       GTK_PRINT_SETTINGS_REVERSE, 

			       reverse);

}

/**

 * gtk_print_settings_get_duplex:

 * @settings: a #GtkPrintSettings

 * 

 * Gets the value of %GTK_PRINT_SETTINGS_DUPLEX.

 * 

 * Return value: whether to print the output in duplex.

 *

 * Since: 2.10

 */

GtkPrintDuplex

gtk_print_settings_get_duplex (GtkPrintSettings *settings)

{

  const gchar *val;

  val = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_DUPLEX);

  if (val == NULL || (strcmp (val, "simplex") == 0))

    return GTK_PRINT_DUPLEX_SIMPLEX;

  if (strcmp (val, "horizontal") == 0)

    return GTK_PRINT_DUPLEX_HORIZONTAL;

  if (strcmp (val, "vertical") == 0)

    return GTK_PRINT_DUPLEX_VERTICAL;

  return GTK_PRINT_DUPLEX_SIMPLEX;

}