/*
 * This file is part of gtkD.
 *
 * gtkD 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 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD 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 gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module pango.PgLanguage;

private import glib.Str;
private import glib.c.functions;
private import gobject.ObjectG;
private import pango.c.functions;
public  import pango.c.types;


/**
 * The `PangoLanguage` structure is used to
 * represent a language.
 * 
 * `PangoLanguage` pointers can be efficiently
 * copied and compared with each other.
 */
public class PgLanguage
{
	/** the main Gtk struct */
	protected PangoLanguage* pangoLanguage;
	protected bool ownedRef;

	/** Get the main Gtk struct */
	public PangoLanguage* getPgLanguageStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return pangoLanguage;
	}

	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)pangoLanguage;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (PangoLanguage* pangoLanguage, bool ownedRef = false)
	{
		this.pangoLanguage = pangoLanguage;
		this.ownedRef = ownedRef;
	}


	/** */
	public static GType getType()
	{
		return pango_language_get_type();
	}

	/**
	 * Get a string that is representative of the characters needed to
	 * render a particular language.
	 *
	 * The sample text may be a pangram, but is not necessarily. It is chosen
	 * to be demonstrative of normal text in the language, as well as exposing
	 * font feature requirements unique to the language. It is suitable for use
	 * as sample text in a font selection dialog.
	 *
	 * If @language is %NULL, the default language as found by
	 * [type_func@Pango.Language.get_default] is used.
	 *
	 * If Pango does not have a sample string for @language, the classic
	 * "The quick brown fox..." is returned.  This can be detected by
	 * comparing the returned pointer value to that returned for (non-existent)
	 * language code "xx".  That is, compare to:
	 *
	 * ```
	 * pango_language_get_sample_string (pango_language_from_string ("xx"))
	 * ```
	 *
	 * Returns: the sample string. This value is owned by Pango
	 *     and should not be freed.
	 */
	public string getSampleString()
	{
		return Str.toString(pango_language_get_sample_string(pangoLanguage));
	}

	/**
	 * Determines the scripts used to to write @language.
	 *
	 * If nothing is known about the language tag @language,
	 * or if @language is %NULL, then %NULL is returned.
	 * The list of scripts returned starts with the script that the
	 * language uses most and continues to the one it uses least.
	 *
	 * The value @num_script points at will be set to the number
	 * of scripts in the returned array (or zero if %NULL is returned).
	 *
	 * Most languages use only one script for writing, but there are
	 * some that use two (Latin and Cyrillic for example), and a few
	 * use three (Japanese for example). Applications should not make
	 * any assumptions on the maximum number of scripts returned
	 * though, except that it is positive if the return value is not
	 * %NULL, and it is a small number.
	 *
	 * The [method@Pango.Language.includes_script] function uses this function
	 * internally.
	 *
	 * Note: while the return value is declared as `PangoScript`, the
	 * returned values are from the `GUnicodeScript` enumeration, which
	 * may have more values. Callers need to handle unknown values.
	 *
	 * Returns: An array of
	 *     `PangoScript` values, with the number of entries in the array
	 *     stored in @num_scripts, or %NULL if Pango does not have any
	 *     information about this particular language tag (also the case
	 *     if @language is %NULL). The returned array is owned by Pango
	 *     and should not be modified or freed.
	 *
	 * Since: 1.22
	 */
	public PangoScript[] getScripts()
	{
		int numScripts;

		auto __p = pango_language_get_scripts(pangoLanguage, &numScripts);

		return __p[0 .. numScripts];
	}

	/**
	 * Determines if @script is one of the scripts used to
	 * write @language. The returned value is conservative;
	 * if nothing is known about the language tag @language,
	 * %TRUE will be returned, since, as far as Pango knows,
	 * @script might be used to write @language.
	 *
	 * This routine is used in Pango's itemization process when
	 * determining if a supplied language tag is relevant to
	 * a particular section of text. It probably is not useful
	 * for applications in most circumstances.
	 *
	 * This function uses [method@Pango.Language.get_scripts] internally.
	 *
	 * Params:
	 *     script = a `PangoScript`
	 *
	 * Returns: %TRUE if @script is one of the scripts used
	 *     to write @language or if nothing is known about @language
	 *     (including the case that @language is %NULL), %FALSE otherwise.
	 *
	 * Since: 1.4
	 */
	public bool includesScript(PangoScript script)
	{
		return pango_language_includes_script(pangoLanguage, script) != 0;
	}

	/**
	 * Checks if a language tag matches one of the elements in a list of
	 * language ranges.
	 *
	 * A language tag is considered to match a range
	 * in the list if the range is '*', the range is exactly the tag,
	 * or the range is a prefix of the tag, and the character after it
	 * in the tag is '-'.
	 *
	 * Params:
	 *     rangeList = a list of language ranges, separated by ';', ':',
	 *         ',', or space characters.
	 *         Each element must either be '*', or a RFC 3066 language range
	 *         canonicalized as by [type_func@Pango.Language.from_string]
	 *
	 * Returns: %TRUE if a match was found.
	 */
	public bool matches(string rangeList)
	{
		return pango_language_matches(pangoLanguage, Str.toStringz(rangeList)) != 0;
	}

	/**
	 * Gets the RFC-3066 format string representing the given language tag.
	 *
	 * Returns: a string representing the language tag. This is owned by
	 *     Pango and should not be freed.
	 */
	public override string toString()
	{
		return Str.toString(pango_language_to_string(pangoLanguage));
	}

	/**
	 * Convert a language tag to a `PangoLanguage`.
	 *
	 * The language tag must be in a RFC-3066 format. `PangoLanguage` pointers
	 * can be efficiently copied (copy the pointer) and compared with other
	 * language tags (compare the pointer.)
	 *
	 * This function first canonicalizes the string by converting it to
	 * lowercase, mapping '_' to '-', and stripping all characters other
	 * than letters and '-'.
	 *
	 * Use [type_func@Pango.Language.get_default] if you want to get the `PangoLanguage`
	 * for the current locale of the process.
	 *
	 * Params:
	 *     language = a string representing a language tag, or %NULL
	 *
	 * Returns: an opaque pointer to a
	 *     `PangoLanguage` structure, or %NULL if @language was %NULL. The
	 *     returned pointer will be valid forever after, and should not be freed.
	 */
	public static PgLanguage fromString(string language)
	{
		auto __p = pango_language_from_string(Str.toStringz(language));

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(PgLanguage)(cast(PangoLanguage*) __p);
	}

	/**
	 * Returns the `PangoLanguage` for the current locale of the process.
	 *
	 * On Unix systems, this is the return value is derived from
	 * `setlocale (LC_CTYPE, NULL)`, and the user can
	 * affect this through the environment variables LC_ALL, LC_CTYPE or
	 * LANG (checked in that order). The locale string typically is in
	 * the form lang_COUNTRY, where lang is an ISO-639 language code, and
	 * COUNTRY is an ISO-3166 country code. For instance, sv_FI for
	 * Swedish as written in Finland or pt_BR for Portuguese as written in
	 * Brazil.
	 *
	 * On Windows, the C library does not use any such environment
	 * variables, and setting them won't affect the behavior of functions
	 * like ctime(). The user sets the locale through the Regional Options
	 * in the Control Panel. The C library (in the setlocale() function)
	 * does not use country and language codes, but country and language
	 * names spelled out in English.
	 * However, this function does check the above environment
	 * variables, and does return a Unix-style locale string based on
	 * either said environment variables or the thread's current locale.
	 *
	 * Your application should call `setlocale(LC_ALL, "")` for the user
	 * settings to take effect. GTK does this in its initialization
	 * functions automatically (by calling gtk_set_locale()).
	 * See the setlocale() manpage for more details.
	 *
	 * Note that the default language can change over the life of an application.
	 *
	 * Returns: the default language as a
	 *     `PangoLanguage`, must not be freed.
	 *
	 * Since: 1.16
	 */
	public static PgLanguage getDefault()
	{
		auto __p = pango_language_get_default();

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(PgLanguage)(cast(PangoLanguage*) __p);
	}

	/**
	 * Returns the list of languages that the user prefers.
	 *
	 * The list is specified by the `PANGO_LANGUAGE` or `LANGUAGE` environment
	 * variables, in order of preference. Note that this list does not necessarily
	 * include the language returned by [type_func@Pango.Language.get_default].
	 *
	 * When choosing language-specific resources, such as the sample
	 * text returned by [method@Pango.Language.get_sample_string], you should
	 * first try the default language, followed by the languages returned
	 * by this function.
	 *
	 * Returns: a %NULL-terminated array of
	 *     `PangoLanguage`*
	 *
	 * Since: 1.48
	 */
	public static PgLanguage getPreferred()
	{
		auto __p = pango_language_get_preferred();

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(PgLanguage)(cast(PangoLanguage*) __p);
	}
}