ewk_context.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 Samsung Electronics
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this program; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef ewk_context_h
#define ewk_context_h

#include "ewk_application_cache_manager.h"
#include "ewk_cookie_manager.h"
#include "ewk_database_manager.h"
#include "ewk_download_job.h"
#include "ewk_error.h"
#include "ewk_favicon_database.h"
#include "ewk_navigation_data.h"
#include "ewk_storage_manager.h"
#include "ewk_url_scheme_request.h"
#include <Evas.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct Ewk_Download_Job_Error Ewk_Download_Job_Error;

struct Ewk_Download_Job_Error {
    Ewk_Download_Job *download_job; 
    Ewk_Error *error; 
};

#ifdef __cplusplus
typedef class EwkObject Ewk_Context;
#else
typedef struct EwkObject Ewk_Context;
#endif

enum Ewk_Cache_Model {
    EWK_CACHE_MODEL_DOCUMENT_VIEWER,
    EWK_CACHE_MODEL_DOCUMENT_BROWSER,
    EWK_CACHE_MODEL_PRIMARY_WEBBROWSER
};

typedef enum Ewk_Cache_Model Ewk_Cache_Model;

enum Ewk_TLS_Error_Policy {
    EWK_TLS_ERROR_POLICY_FAIL, // Fail on TLS errors.
    EWK_TLS_ERROR_POLICY_IGNORE // Ignore TLS errors.
};

// Creates a type name for the Ewk_TLS_Error_Policy.
typedef enum Ewk_TLS_Error_Policy Ewk_TLS_Error_Policy;

typedef void (*Ewk_Url_Scheme_Request_Cb) (Ewk_Url_Scheme_Request *request, void *user_data);

typedef void (*Ewk_History_Navigation_Cb)(const Evas_Object *view, Ewk_Navigation_Data *navigation_data, void *user_data);

typedef void (*Ewk_History_Client_Redirection_Cb)(const Evas_Object *view, const char *source_url, const char *destination_url, void *user_data);

typedef void (*Ewk_History_Server_Redirection_Cb)(const Evas_Object *view, const char *source_url, const char *destination_url, void *user_data);

typedef void (*Ewk_History_Title_Update_Cb)(const Evas_Object *view, const char *title, const char *url, void *user_data);

typedef void (*Ewk_Download_Requested_Cb)(Ewk_Download_Job *download, void *user_data);

typedef void (*Ewk_Download_Failed_Cb)(Ewk_Download_Job_Error *error, void *user_data);

typedef void (*Ewk_Download_Cancelled_Cb)(Ewk_Download_Job *download, void *user_data);

typedef void (*Ewk_Download_Finished_Cb)(Ewk_Download_Job *download, void *user_data);

typedef void (*Ewk_History_Populate_Visited_Links_Cb)(void *user_data);

typedef void (*Ewk_Context_Message_From_Extension_Cb)(const char *name, const Eina_Value *body, void *user_data);

EAPI Ewk_Context *ewk_context_default_get(void);

EAPI Ewk_Context *ewk_context_new(void);

EAPI Ewk_Context *ewk_context_new_with_extensions_path(const char *path);

EAPI Ewk_Application_Cache_Manager *ewk_context_application_cache_manager_get(const Ewk_Context *context);

EAPI Ewk_Cookie_Manager *ewk_context_cookie_manager_get(const Ewk_Context *context);

EAPI Ewk_Database_Manager *ewk_context_database_manager_get(const Ewk_Context *context);

EAPI Eina_Bool ewk_context_favicon_database_directory_set(Ewk_Context *context, const char *directory_path);

EAPI Ewk_Favicon_Database *ewk_context_favicon_database_get(const Ewk_Context *context);

EAPI Ewk_Storage_Manager *ewk_context_storage_manager_get(const Ewk_Context *context);

EAPI Eina_Bool ewk_context_url_scheme_register(Ewk_Context *context, const char *scheme, Ewk_Url_Scheme_Request_Cb callback, void *user_data);

EAPI void ewk_context_history_callbacks_set(Ewk_Context *context,
                                            Ewk_History_Navigation_Cb navigate_func,
                                            Ewk_History_Client_Redirection_Cb client_redirect_func,
                                            Ewk_History_Server_Redirection_Cb server_redirect_func,
                                            Ewk_History_Title_Update_Cb title_update_func,
                                            Ewk_History_Populate_Visited_Links_Cb populate_visited_links_func,
                                            void *data);

EAPI void ewk_context_download_callbacks_set(Ewk_Context *context,
                                             Ewk_Download_Requested_Cb download_requested_func,
                                             Ewk_Download_Failed_Cb download_failed_func,
                                             Ewk_Download_Cancelled_Cb download_cancelled_func,
                                             Ewk_Download_Finished_Cb download_finished_func,
                                             void* data);

EAPI void ewk_context_visited_link_add(Ewk_Context *context, const char *visited_url);

EAPI Eina_Bool ewk_context_cache_model_set(Ewk_Context *context, Ewk_Cache_Model cache_model);

EAPI Ewk_Cache_Model ewk_context_cache_model_get(const Ewk_Context *context);

EAPI Eina_Bool ewk_context_additional_plugin_path_set(Ewk_Context *context, const char *path);

EAPI void ewk_context_resource_cache_clear(Ewk_Context *context);

EAPI Eina_Bool ewk_context_message_post_to_extensions(Ewk_Context *context, const char *name, const Eina_Value *body);

EAPI void ewk_context_message_from_extensions_callback_set(Ewk_Context *context, Ewk_Context_Message_From_Extension_Cb callback, void *user_data);

EAPI Ewk_TLS_Error_Policy ewk_context_tls_error_policy_get(const Ewk_Context *context);

EAPI void ewk_context_tls_error_policy_set(Ewk_Context *context, Ewk_TLS_Error_Policy tls_error_policy);

EAPI void ewk_context_preferred_languages_set(Eina_List *languages);


EAPI void ewk_context_tls_certificate_for_host_allow(Ewk_Context *context, const char *pem, const char *host);

EAPI Eina_Bool ewk_context_web_process_count_limit_set(Ewk_Context *context, unsigned count);

EAPI unsigned ewk_context_web_process_count_limit_get(const Ewk_Context *context);

#ifdef __cplusplus
}
#endif

#endif // ewk_context_h