/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- * * Copyright (C) 2014-2015 Richard Hughes * * Licensed under the GNU Lesser General Public License Version 2.1 * * 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.1 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef ASB_CONTEXT_H #define ASB_CONTEXT_H #include #include "asb-app.h" #include "asb-package.h" G_BEGIN_DECLS #define ASB_TYPE_CONTEXT (asb_context_get_type ()) G_DECLARE_DERIVABLE_TYPE (AsbContext, asb_context, ASB, CONTEXT, GObject) struct _AsbContextClass { GObjectClass parent_class; /*< private >*/ void (*_asb_reserved1) (void); void (*_asb_reserved2) (void); void (*_asb_reserved3) (void); void (*_asb_reserved4) (void); void (*_asb_reserved5) (void); void (*_asb_reserved6) (void); void (*_asb_reserved7) (void); void (*_asb_reserved8) (void); }; /** * AsbContextFlags: * @ASB_CONTEXT_FLAG_NONE: No special actions to use * @ASB_CONTEXT_FLAG_IGNORE_MISSING_INFO: Ignore missing information * @ASB_CONTEXT_FLAG_IGNORE_MISSING_PARENTS: Ignore missing parents * @ASB_CONTEXT_FLAG_ADD_CACHE_ID: Unused * @ASB_CONTEXT_FLAG_HIDPI_ICONS: Include HiDPI icons * @ASB_CONTEXT_FLAG_EMBEDDED_ICONS: Embed the icons in the XML * @ASB_CONTEXT_FLAG_NO_NETWORK: Do not download files * @ASB_CONTEXT_FLAG_INCLUDE_FAILED: Write the origin-ignore.xml file * @ASB_CONTEXT_FLAG_UNCOMPRESSED_ICONS: Do not pack icons into a tarball * @ASB_CONTEXT_FLAG_IGNORE_DEAD_UPSTREAM: Include apps that are dead upstream * @ASB_CONTEXT_FLAG_IGNORE_OBSOLETE_DEPS: Include apps that use obsolete toolkits * @ASB_CONTEXT_FLAG_IGNORE_LEGACY_ICONS: Include apps that use legacy icon formats * @ASB_CONTEXT_FLAG_IGNORE_SETTINGS: Include apps that are marked as settings * @ASB_CONTEXT_FLAG_USE_FALLBACKS: Fall back to suboptimal data where required * @ASB_CONTEXT_FLAG_ADD_DEFAULT_ICONS: Add artificial icons and categories where required * * The flags to use when processing the context. **/ typedef enum { ASB_CONTEXT_FLAG_NONE, ASB_CONTEXT_FLAG_IGNORE_MISSING_INFO = 0, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_IGNORE_MISSING_PARENTS = 1 << 0, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_ADD_CACHE_ID = 1 << 1, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_HIDPI_ICONS = 1 << 2, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_EMBEDDED_ICONS = 1 << 3, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_NO_NETWORK = 1 << 4, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_INCLUDE_FAILED = 1 << 5, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_UNCOMPRESSED_ICONS = 1 << 6, /* Since: 0.3.5 */ ASB_CONTEXT_FLAG_IGNORE_DEAD_UPSTREAM = 1 << 7, /* Since: 0.4.1 */ ASB_CONTEXT_FLAG_IGNORE_OBSOLETE_DEPS = 1 << 8, /* Since: 0.4.1 */ ASB_CONTEXT_FLAG_IGNORE_LEGACY_ICONS = 1 << 9, /* Since: 0.4.1 */ ASB_CONTEXT_FLAG_IGNORE_SETTINGS = 1 << 10, /* Since: 0.4.1 */ ASB_CONTEXT_FLAG_USE_FALLBACKS = 1 << 11, /* Since: 0.4.1 */ ASB_CONTEXT_FLAG_ADD_DEFAULT_ICONS = 1 << 12, /* Since: 0.4.1 */ /*< private >*/ ASB_CONTEXT_FLAG_LAST, } AsbContextFlags; AsbContext *asb_context_new (void); AsbPackage *asb_context_find_by_pkgname (AsbContext *ctx, const gchar *pkgname); void asb_context_add_app (AsbContext *ctx, AsbApp *app); void asb_context_add_app_ignore (AsbContext *ctx, AsbPackage *pkg); void asb_context_set_api_version (AsbContext *ctx, gdouble api_version); void asb_context_set_flags (AsbContext *ctx, AsbContextFlags flags); void asb_context_set_max_threads (AsbContext *ctx, guint max_threads); void asb_context_set_min_icon_size (AsbContext *ctx, guint min_icon_size); void asb_context_set_old_metadata (AsbContext *ctx, const gchar *old_metadata); void asb_context_set_log_dir (AsbContext *ctx, const gchar *log_dir); void asb_context_set_screenshot_dir (AsbContext *ctx, const gchar *screenshot_dir); void asb_context_set_cache_dir (AsbContext *ctx, const gchar *cache_dir); void asb_context_set_temp_dir (AsbContext *ctx, const gchar *temp_dir); void asb_context_set_output_dir (AsbContext *ctx, const gchar *output_dir); void asb_context_set_icons_dir (AsbContext *ctx, const gchar *icons_dir); void asb_context_set_basename (AsbContext *ctx, const gchar *basename); void asb_context_set_origin (AsbContext *ctx, const gchar *origin); const gchar *asb_context_get_temp_dir (AsbContext *ctx); const gchar *asb_context_get_cache_dir (AsbContext *ctx); AsbContextFlags asb_context_get_flags (AsbContext *ctx); gboolean asb_context_get_flag (AsbContext *ctx, AsbContextFlags flag); gdouble asb_context_get_api_version (AsbContext *ctx); guint asb_context_get_min_icon_size (AsbContext *ctx); gboolean asb_context_setup (AsbContext *ctx, GError **error); gboolean asb_context_process (AsbContext *ctx, GError **error); void asb_context_add_package (AsbContext *ctx, AsbPackage *pkg); gboolean asb_context_add_filename (AsbContext *ctx, const gchar *filename, GError **error); gboolean asb_context_find_in_cache (AsbContext *ctx, const gchar *filename); G_END_DECLS #endif /* ASB_CONTEXT_H */