/* gbookmarkfile.h: parsing and building desktop bookmarks

 *

 * Copyright (C) 2005-2006 Emmanuele Bassi

 *

 * 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, see <http://www.gnu.org/licenses/>.

 */

#ifndef __G_BOOKMARK_FILE_H__

#define __G_BOOKMARK_FILE_H__

#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)

#error "Only <glib.h> can be included directly."

#endif

#include <glib/gerror.h>

#include <time.h>

G_BEGIN_DECLS

/**

 * G_BOOKMARK_FILE_ERROR:

 *

 * Error domain for bookmark file parsing.

 * Errors in this domain will be from the #GBookmarkFileError

 * enumeration. See #GError for information on error domains.

 */

#define G_BOOKMARK_FILE_ERROR	(g_bookmark_file_error_quark ())

/**

 * GBookmarkFileError:

 * @G_BOOKMARK_FILE_ERROR_INVALID_URI: URI was ill-formed

 * @G_BOOKMARK_FILE_ERROR_INVALID_VALUE: a requested field was not found

 * @G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED: a requested application did

 *     not register a bookmark

 * @G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND: a requested URI was not found

 * @G_BOOKMARK_FILE_ERROR_READ: document was ill formed

 * @G_BOOKMARK_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was

 *     in an unknown encoding

 * @G_BOOKMARK_FILE_ERROR_WRITE: an error occurred while writing

 * @G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND: requested file was not found

 *

 * Error codes returned by bookmark file parsing.

 */

typedef enum

{

  G_BOOKMARK_FILE_ERROR_INVALID_URI,

  G_BOOKMARK_FILE_ERROR_INVALID_VALUE,

  G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,

  G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,

  G_BOOKMARK_FILE_ERROR_READ,

  G_BOOKMARK_FILE_ERROR_UNKNOWN_ENCODING,

  G_BOOKMARK_FILE_ERROR_WRITE,

  G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND

} GBookmarkFileError;

GLIB_AVAILABLE_IN_ALL

GQuark g_bookmark_file_error_quark (void);

/**

 * GBookmarkFile:

 *

 * The `GBookmarkFile` structure contains only

 * private data and should not be directly accessed.

 */

typedef struct _GBookmarkFile GBookmarkFile;

GLIB_AVAILABLE_IN_ALL

GBookmarkFile *g_bookmark_file_new                 (void);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_free                (GBookmarkFile  *bookmark);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_load_from_file      (GBookmarkFile  *bookmark,

						    const gchar    *filename,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_load_from_data      (GBookmarkFile  *bookmark,

						    const gchar    *data,

						    gsize           length,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_load_from_data_dirs (GBookmarkFile  *bookmark,

						    const gchar    *file,

						    gchar         **full_path,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gchar *        g_bookmark_file_to_data             (GBookmarkFile  *bookmark,

						    gsize          *length,

						    GError        **error) G_GNUC_MALLOC;

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_to_file             (GBookmarkFile  *bookmark,

						    const gchar    *filename,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_title           (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *title);

GLIB_AVAILABLE_IN_ALL

gchar *        g_bookmark_file_get_title           (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error) G_GNUC_MALLOC;

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_description     (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *description);

GLIB_AVAILABLE_IN_ALL

gchar *        g_bookmark_file_get_description     (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error) G_GNUC_MALLOC;

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_mime_type       (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *mime_type);

GLIB_AVAILABLE_IN_ALL

gchar *        g_bookmark_file_get_mime_type       (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error) G_GNUC_MALLOC;

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_groups          (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar   **groups,

						    gsize           length);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_add_group           (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *group);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_has_group           (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *group,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gchar **       g_bookmark_file_get_groups          (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    gsize          *length,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_add_application     (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *name,

						    const gchar    *exec);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_has_application     (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *name,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gchar **       g_bookmark_file_get_applications    (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    gsize          *length,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_set_app_info        (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *name,

						    const gchar    *exec,

						    gint            count,

						    time_t          stamp,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_get_app_info        (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *name,

						    gchar         **exec,

						    guint          *count,

						    time_t         *stamp,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_is_private      (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    gboolean        is_private);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_get_is_private      (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_icon            (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *href,

						    const gchar    *mime_type);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_get_icon            (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    gchar         **href,

						    gchar         **mime_type,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_added           (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    time_t          added);

GLIB_AVAILABLE_IN_ALL

time_t         g_bookmark_file_get_added           (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_modified        (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    time_t          modified);

GLIB_AVAILABLE_IN_ALL

time_t         g_bookmark_file_get_modified        (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

void           g_bookmark_file_set_visited         (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    time_t          visited);

GLIB_AVAILABLE_IN_ALL

time_t         g_bookmark_file_get_visited         (GBookmarkFile  *bookmark,

						    const gchar    *uri, 

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_has_item            (GBookmarkFile  *bookmark,

						    const gchar    *uri);

GLIB_AVAILABLE_IN_ALL

gint           g_bookmark_file_get_size            (GBookmarkFile  *bookmark);

GLIB_AVAILABLE_IN_ALL

gchar **       g_bookmark_file_get_uris            (GBookmarkFile  *bookmark,

						    gsize          *length);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_remove_group        (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *group,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_remove_application  (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    const gchar    *name,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_remove_item         (GBookmarkFile  *bookmark,

						    const gchar    *uri,

						    GError        **error);

GLIB_AVAILABLE_IN_ALL

gboolean       g_bookmark_file_move_item           (GBookmarkFile  *bookmark,

						    const gchar    *old_uri,

						    const gchar    *new_uri,

						    GError        **error);

G_END_DECLS

#endif /* __G_BOOKMARK_FILE_H__ */