1/*
2 * Copyright (C) 2012 Samsung Electronics. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
14 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26/**
27 * @file   ewk_database_manager.h
28 * @brief  Describes the Ewk Database Manager API.
29 *
30 * Ewk Database Manager manages web database.
31 */
32
33#ifndef ewk_database_manager_h
34#define ewk_database_manager_h
35
36#include <Eina.h>
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42/** Creates a type name for Ewk_Database_Manager. */
43typedef struct EwkDatabaseManager Ewk_Database_Manager;
44
45/**
46 * @typedef Ewk_Database_Origins_Async_Get_Cb Ewk_Database_Origins_Async_Get_Cb
47 * @brief Callback type for use with ewk_database_manager_origins_async_get()
48 *
49 * @param origins @c Eina_List containing @c Ewk_Security_Origin elements.
50 *
51 * @note The @a origins should be freed like below code after use.
52 *
53 * @code
54 *
55 * static void
56 * _origins_get_cb(Eina_List* origins, data)
57 * {
58 *    // ...
59 *
60 *    void *origin;
61 *    EINA_LIST_FREE(origins, origin)
62 *      ewk_object_unref((Ewk_Object*)origin);
63 * }
64 *
65 * @endcode
66 */
67typedef void (*Ewk_Database_Origins_Async_Get_Cb)(Eina_List *origins, void *user_data);
68
69/**
70 * Gets list of origins using web database asynchronously.
71 *
72 * This function allocates memory for context structure made from callback and user_data.
73 *
74 * @param manager Ewk_Database_Manager object
75 * @param callback callback to get database origins
76 * @param user_data user_data will be passed when result_callback is called,
77 *    -i.e., user data will be kept until callback is called
78 *
79 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
80 */
81EAPI Eina_Bool ewk_database_manager_origins_async_get(const Ewk_Database_Manager *manager, Ewk_Database_Origins_Async_Get_Cb callback, void *user_data);
82
83#ifdef __cplusplus
84}
85#endif
86#endif // ewk_database_manager_h
87