/*
 * Licensed under the GNU Lesser General Public License Version 3
 *
 * 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 3 of the license, or
 * (at your option) any later version.
 *
 * This software 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, see <http://www.gnu.org/licenses/>.
 */

// generated automatically - do not change


module appstream.Metadata;

private import appstream.Component;
private import appstream.c.functions;
public  import appstream.c.types;
private import gio.FileIF;
private import glib.ConstructionException;
private import glib.ErrorG;
private import glib.GException;
private import glib.PtrArray;
private import glib.Str;
private import gobject.ObjectG;


/** */
public class Metadata : ObjectG
{
	/** the main Gtk struct */
	protected AsMetadata* asMetadata;

	/** Get the main Gtk struct */
	public AsMetadata* getMetadataStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return asMetadata;
	}

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

	protected override void setStruct(GObject* obj)
	{
		asMetadata = cast(AsMetadata*)obj;
		super.setStruct(obj);
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (AsMetadata* asMetadata, bool ownedRef = false)
	{
		this.asMetadata = asMetadata;
		super(cast(GObject*)asMetadata, ownedRef);
	}


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

	/**
	 * Creates a new #AsMetadata.
	 *
	 * Returns: a #AsMetadata
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto p = as_metadata_new();

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(AsMetadata*) p, true);
	}

	/**
	 * Returns: An error quark.
	 */
	public static GQuark errorQuark()
	{
		return as_metadata_error_quark();
	}

	/**
	 * Add an #AsComponent to the list of components.
	 * This can be used to add multiple components in order to
	 * produce a distro-XML AppStream metadata file.
	 */
	public void addComponent(Component cpt)
	{
		as_metadata_add_component(asMetadata, (cpt is null) ? null : cpt.getComponentStruct());
	}

	/** */
	public void clearComponents()
	{
		as_metadata_clear_components(asMetadata);
	}

	/**
	 * Convert an #AsComponent to metainfo data.
	 * This will always be XML, YAML is no valid format for metainfo files.
	 *
	 * The amount of localization included in the metadata depends on how the #AsComponent
	 * was initially loaded and whether it contains data for all locale.
	 *
	 * The first #AsComponent added to the internal list will be transformed.
	 * In case no component is present, %NULL is returned.
	 *
	 * Params:
	 *     format = The format to use (XML or YAML)
	 *
	 * Returns: A string containing the XML metadata. Free with g_free()
	 *
	 * Throws: GException on failure.
	 */
	public string componentToMetainfo(AsFormatKind format)
	{
		GError* err = null;

		auto retStr = as_metadata_component_to_metainfo(asMetadata, format, &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}

		scope(exit) Str.freeString(retStr);
		return Str.toString(retStr);
	}

	/**
	 * Serialize all #AsComponent instances into AppStream
	 * collection metadata.
	 * %NULL is returned if there is nothing to serialize.
	 *
	 * Params:
	 *     format = The format to serialize the data to (XML or YAML).
	 *
	 * Returns: A string containing the YAML or XML data. Free with g_free()
	 *
	 * Throws: GException on failure.
	 */
	public string componentsToCollection(AsFormatKind format)
	{
		GError* err = null;

		auto retStr = as_metadata_components_to_collection(asMetadata, format, &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}

		scope(exit) Str.freeString(retStr);
		return Str.toString(retStr);
	}

	/**
	 * Returns: The architecture of AppStream distro metadata
	 */
	public string getArchitecture()
	{
		return Str.toString(as_metadata_get_architecture(asMetadata));
	}

	/**
	 * Gets the #AsComponent which has been parsed from the XML.
	 * If the AppStream XML contained multiple components, return the first
	 * component that has been parsed.
	 *
	 * Returns: An #AsComponent or %NULL
	 */
	public Component getComponent()
	{
		auto p = as_metadata_get_component(asMetadata);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Component)(cast(AsComponent*) p);
	}

	/**
	 * Returns: A #GPtrArray of all parsed components
	 */
	public PtrArray getComponents()
	{
		auto p = as_metadata_get_components(asMetadata);

		if(p is null)
		{
			return null;
		}

		return new PtrArray(cast(GPtrArray*) p);
	}

	/**
	 * Get the metadata parsing mode.
	 */
	public AsFormatStyle getFormatStyle()
	{
		return as_metadata_get_format_style(asMetadata);
	}

	/**
	 * Returns: The AppStream metadata format version.
	 */
	public AsFormatVersion getFormatVersion()
	{
		return as_metadata_get_format_version(asMetadata);
	}

	/**
	 * Gets the current active locale for parsing metadata,
	 * or "ALL" if all locales are read.
	 *
	 * Returns: Locale used for metadata parsing.
	 */
	public string getLocale()
	{
		return Str.toString(as_metadata_get_locale(asMetadata));
	}

	/**
	 * Returns: The origin of AppStream distro metadata
	 */
	public string getOrigin()
	{
		return Str.toString(as_metadata_get_origin(asMetadata));
	}

	/**
	 * Returns: Whether existing components should be updates with the parsed data,
	 *     instead of creating new ones.
	 */
	public bool getUpdateExisting()
	{
		return as_metadata_get_update_existing(asMetadata) != 0;
	}

	/**
	 * Returns: Whether we will write a header/root node in collection metadata.
	 */
	public bool getWriteHeader()
	{
		return as_metadata_get_write_header(asMetadata) != 0;
	}

	/**
	 * Parses AppStream metadata.
	 *
	 * Params:
	 *     data = Metadata describing one or more software components.
	 *     format = The format of the data (XML or YAML).
	 *
	 * Throws: GException on failure.
	 */
	public void parse(string data, AsFormatKind format)
	{
		GError* err = null;

		as_metadata_parse(asMetadata, Str.toStringz(data), format, &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
	}

	/**
	 * Parses XDG Desktop Entry metadata and adds it to the pool.
	 *
	 * Params:
	 *     data = Metadata describing one or more software components.
	 *     cid = The component-id the new #AsComponent should have.
	 *
	 * Throws: GException on failure.
	 */
	public void parseDesktopData(string data, string cid)
	{
		GError* err = null;

		as_metadata_parse_desktop_data(asMetadata, Str.toStringz(data), Str.toStringz(cid), &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
	}

	/**
	 * Parses an AppStream upstream metadata file.
	 *
	 * Params:
	 *     file = #GFile for the upstream metadata
	 *     format = The format the data is in, or %AS_FORMAT_KIND_UNKNOWN if not known.
	 *
	 * Throws: GException on failure.
	 */
	public void parseFile(FileIF file, AsFormatKind format)
	{
		GError* err = null;

		as_metadata_parse_file(asMetadata, (file is null) ? null : file.getFileStruct(), format, &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
	}

	/** */
	public void saveCollection(string fname, AsFormatKind format)
	{
		GError* err = null;

		as_metadata_save_collection(asMetadata, Str.toStringz(fname), format, &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
	}

	/**
	 * Serialize #AsComponent instance to XML and save it to file.
	 * An existing file at the same location will be overridden.
	 *
	 * Params:
	 *     fname = The filename for the new metadata file.
	 *     format = The format to save this file in. Only XML is supported at time.
	 *
	 * Throws: GException on failure.
	 */
	public void saveMetainfo(string fname, AsFormatKind format)
	{
		GError* err = null;

		as_metadata_save_metainfo(asMetadata, Str.toStringz(fname), format, &err);

		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
	}

	/**
	 * Set the architecture the components in this metadata belong to.
	 *
	 * Params:
	 *     arch = an architecture string.
	 */
	public void setArchitecture(string arch)
	{
		as_metadata_set_architecture(asMetadata, Str.toStringz(arch));
	}

	/**
	 * Sets the current metadata parsing mode.
	 *
	 * Params:
	 *     mode = the #AsFormatStyle.
	 */
	public void setFormatStyle(AsFormatStyle mode)
	{
		as_metadata_set_format_style(asMetadata, mode);
	}

	/**
	 * Set the current AppStream format version that we should generate data for
	 * or be able to read.
	 *
	 * Params:
	 *     versio = the AppStream metadata format version as #AsFormatVersion.
	 */
	public void setFormatVersion(AsFormatVersion versio)
	{
		as_metadata_set_format_version(asMetadata, versio);
	}

	/**
	 * Sets the locale which should be read when processing metadata.
	 * All other locales are ignored, which increases parsing speed and
	 * reduces memory usage.
	 * If you set the locale to "ALL", all locales will be read.
	 *
	 * Params:
	 *     locale = the locale.
	 */
	public void setLocale(string locale)
	{
		as_metadata_set_locale(asMetadata, Str.toStringz(locale));
	}

	/**
	 * Set the origin of AppStream distro metadata
	 *
	 * Params:
	 *     origin = the origin of AppStream distro metadata.
	 */
	public void setOrigin(string origin)
	{
		as_metadata_set_origin(asMetadata, Str.toStringz(origin));
	}

	/**
	 * If set to %TRUE, the parser will not create new components but
	 * instead update existing components in the pool with new metadata.
	 *
	 * NOTE: Right now, this feature is only implemented for metainfo XML parsing!
	 *
	 * Params:
	 *     update = A boolean value.
	 */
	public void setUpdateExisting(bool update)
	{
		as_metadata_set_update_existing(asMetadata, update);
	}

	/**
	 * If set to %TRUE, tehe metadata writer will omit writing a DEP-11
	 * header document when in YAML mode, and will not write a root components node
	 * when writing XML data.
	 * Please keep in mind that this will create an invalid DEP-11 YAML AppStream
	 * collection metadata file, and an invalid XML file.
	 * This parameter should only be changed e.g. by the appstream-generator tool.
	 *
	 * NOTE: Right now, this feature is only implemented for YAML!
	 *
	 * Params:
	 *     wheader = A boolean value.
	 */
	public void setWriteHeader(bool wheader)
	{
		as_metadata_set_write_header(asMetadata, wheader);
	}
}