summaryrefslogtreecommitdiff
path: root/core/pkg/tbox.pkg/inc/tbox/object/data.h
blob: 6449e8307716519e4cdfd24de4ba3a1353d6e009 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*!The Treasure Box Library
 * 
 * TBox 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.
 * 
 * TBox 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 TBox; 
 * If not, see <a href="http://www.gnu.org/licenses/"> http://www.gnu.org/licenses/</a>
 * 
 * Copyright (C) 2009 - 2015, ruki All rights reserved.
 *
 * @author      ruki
 * @file        data.h
 * @ingroup     object
 *
 */
#ifndef TB_OBJECT_DATA_H
#define TB_OBJECT_DATA_H

/* //////////////////////////////////////////////////////////////////////////////////////
 * includes
 */
#include "prefix.h"

/* //////////////////////////////////////////////////////////////////////////////////////
 * extern
 */
__tb_extern_c_enter__

/* //////////////////////////////////////////////////////////////////////////////////////
 * interfaces
 */

/*! init data from url
 *
 * @param data      the data
 * @param size      the size
 *
 * @return          the data object
 */
tb_object_ref_t     tb_object_data_init_from_url(tb_char_t const* url);

/*! init data from data
 *
 * @param data      the data
 * @param size      the size
 *
 * @return          the data object
 */
tb_object_ref_t     tb_object_data_init_from_data(tb_pointer_t data, tb_size_t size);

/*! init data from buffer
 *
 * @param buffer    the buffer
 *
 * @return          the data object
 */
tb_object_ref_t     tb_object_data_init_from_buffer(tb_buffer_ref_t buffer);

/*! get the data 
 *
 * @param data      the data object
 *
 * @return          the data address
 */
tb_pointer_t        tb_object_data_getp(tb_object_ref_t data);

/*! set the data 
 *
 * @param data      the data object
 * @param addr      the data address
 * @param size      the data size
 *
 * @return          tb_true or tb_false
 */
tb_bool_t           tb_object_data_setp(tb_object_ref_t data, tb_pointer_t addr, tb_size_t size);

/*! the data size
 *
 * @param data      the data object
 *
 * @return          the data size
 */
tb_size_t           tb_object_data_size(tb_object_ref_t data);

/*! the data buffer
 *
 * @param data      the data object
 *
 * @return          the data buffer
 */
tb_buffer_ref_t     tb_object_data_buffer(tb_object_ref_t data);

/*! writ data to url
 *
 * @param data      the data object
 *
 * @return          tb_true or tb_false
 */
tb_bool_t           tb_object_data_writ_to_url(tb_object_ref_t data, tb_char_t const* url);

/* //////////////////////////////////////////////////////////////////////////////////////
 * extern
 */
__tb_extern_c_leave__

#endif