Merge refined doxygen comments of Base header files
[platform/framework/native/appfw.git] / inc / FBaseDataType.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17
18 /**
19  * @file                FBaseDataType.h
20  * @brief               This is the header file for the data types.
21  *
22  * This header file defines the data types.
23  */
24 #ifndef _FBASE_DATA_TYPE_H_
25 #define _FBASE_DATA_TYPE_H_
26
27
28 /**
29  * @c byte is an @c unsigned @c char datatype.
30  * @since 2.0
31  */
32 typedef unsigned char byte;
33
34 /**
35  * @c result is an @c unsigned @c long type and indicates the result of the method execution.
36  * @since 2.0
37  */
38 typedef unsigned long result;
39
40
41 namespace Tizen { namespace Base
42 {
43 class String;
44 }}
45
46 typedef Tizen::Base::String UserId;
47 typedef Tizen::Base::String LoginId;
48
49
50 /**
51 * The invocation ID is returned when a request is sent.
52 * @since 2.0
53 */
54 typedef long RequestId;
55 #define INVALID_REQUEST_ID  -1
56
57
58 // Macro to get the value in byte
59 #define GET_MASK(val, pos, msk) (((val) & ((msk) << (pos))) >> (pos))
60 // Macro to put the value in byte
61 #define PUT_MASK(var, val, pos) ((var) | ((val) << (pos)))
62
63
64 #ifndef Handle
65 typedef int Handle;
66 #define INVALID_HANDLE  -1
67 #endif // Handle
68
69 #ifndef null
70 #define null    0
71 #endif // null
72
73 #ifndef INFINITE
74 #define INFINITE    0xFFFFFFFF
75 #endif // INFINITE
76
77
78 #ifndef UUID
79 #ifndef UUID__DEFINED
80 typedef struct UUID_
81 {
82         unsigned long x;
83         unsigned short s1;
84         unsigned short s2;
85         unsigned char c[8];
86 } UUID_;
87
88 #define UUID__DEFINED
89 #define UUID_DEFINED
90 #endif
91
92 #define UUID UUID_
93 #endif // UUID
94
95 #endif // _FBASE_DATA_TYPE_H_