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_object.h
28 * @brief   Describes the Ewk Ref Counted API.
29 */
30
31#ifndef ewk_object_h
32#define ewk_object_h
33
34#include <Eina.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/** Creates a type name for Ewk_Object */
41typedef struct EwkObject Ewk_Object;
42
43/**
44 * Increases the reference count of the given Ewk_Object.
45 *
46 * @param object the Ewk_Object instance to increase the reference count
47 *
48 * @return a pointer to the object on success, @c NULL otherwise.
49 */
50EAPI Ewk_Object *ewk_object_ref(Ewk_Object *object);
51
52/**
53 * Decreases the reference count of the given Ewk_Object, possibly freeing it.
54 *
55 * When the reference count reaches 0, the item is freed.
56 *
57 * @param object the Ewk_Object instance to decrease the reference count
58 */
59EAPI void ewk_object_unref(Ewk_Object *object);
60
61
62#ifdef __cplusplus
63}
64#endif
65#endif // ewk_object_h
66