Source/WebKit2/UIProcess/API/efl/ewk_resource.h

   1 /*
   2  * Copyright (C) 2012 Intel Corporation. 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 APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * 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 APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 /**
  27  * @file    ewk_resource.h
  28  * @brief   Describes the Web Resource API.
  29  */
  30
  31 #ifndef ewk_resource_h
  32 #define ewk_resource_h
  33
  34 #include <Eina.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /** Creates a type name for @a Ewk_Resource. */
  41 typedef struct Ewk_Resource Ewk_Resource;
  42
  43 /**
  44  * Increases the reference count of the given object.
  45  *
  46  * @param resource the resource object to increase the reference count
  47  *
  48  * @return a pointer to the object on success, @c NULL otherwise.
  49  */
  50 EAPI Ewk_Resource *ewk_resource_ref(Ewk_Resource *resource);
  51
  52 /**
  53  * Decreases the reference count of the given object, possibly freeing it.
  54  *
  55  * When the reference count reaches 0, the resource is freed.
  56  *
  57  * @param resource the resource object to decrease the reference count
  58  */
  59 EAPI void ewk_resource_unref(Ewk_Resource *resource);
  60
  61 /**
  62  * Query URL for this resource.
  63  *
  64  * @param resource resource object to query.
  65  *
  66  * @return the URL pointer, that may be @c NULL. This pointer is
  67  *         guaranteed to be eina_stringshare, so whenever possible
  68  *         save yourself some cpu cycles and use
  69  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  70  *         strdup().
  71  */
  72 EAPI const char *ewk_resource_url_get(const Ewk_Resource *resource);
  73
  74 /**
  75  * Query if this is the main resource.
  76  *
  77  * @param resource resource object to query.
  78  *
  79  * @return @c EINA_TRUE if this is the main resource, @c EINA_FALSE otherwise
  80  */
  81 EAPI Eina_Bool ewk_resource_main_resource_get(const Ewk_Resource *resource);
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif
  86
  87 #endif // ewk_resource_h