1 /******************************************************************************
2  *
3  *  Copyright 2014 Google, Inc.
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 #pragma once
20 
21 #include <bluetooth/uuid.h>
22 #include <hardware/bluetooth.h>
23 #include <stdint.h>
24 #include <stdlib.h>
25 
26 #include "btcore/include/device_class.h"
27 #include "types/raw_address.h"
28 
29 // Copies an array of consecutive properties of |count| to a newly
30 // allocated array. |properties| must not be NULL.
31 bt_property_t* property_copy_array(const bt_property_t* properties,
32                                    size_t count);
33 
34 // Copies |src| to |dest|. Returns the value of |dest|.
35 // |src| and |dest| must not be NULL.
36 bt_property_t* property_copy(bt_property_t* dest, const bt_property_t* src);
37 
38 // Returns true if the value of the two properties |p1| and |p2| are equal.
39 // |p1| and |p2| must not be NULL.
40 bool property_equals(const bt_property_t* p1, const bt_property_t* p2);
41 
42 // Property resource allocations. Caller is expected to free |property|
43 // using |property_free| or |property_free_array|.
44 // Parameter must not be NULL. A copy of the parameter is made and
45 // stored in the property.
46 bt_property_t* property_new_addr(const RawAddress* addr);
47 bt_property_t* property_new_device_class(const bt_device_class_t* dc);
48 bt_property_t* property_new_device_type(bt_device_type_t device_type);
49 bt_property_t* property_new_discoverable_timeout(const uint32_t timeout);
50 bt_property_t* property_new_name(const char* name);
51 bt_property_t* property_new_rssi(const int8_t rssi);
52 bt_property_t* property_new_scan_mode(bt_scan_mode_t scan_mode);
53 bt_property_t* property_new_uuids(const bluetooth::Uuid* uuid, size_t count);
54 
55 // Property resource frees both property and value.
56 void property_free(bt_property_t* property);
57 void property_free_array(bt_property_t* properties, size_t count);
58 
59 // Value check convenience methods. The contents of the property are
60 // checked for the respective validity and returns true, false otherwise.
61 // |property| must not be NULL.
62 bool property_is_addr(const bt_property_t* property);
63 bool property_is_device_class(const bt_property_t* property);
64 bool property_is_device_type(const bt_property_t* property);
65 bool property_is_discoverable_timeout(const bt_property_t* property);
66 bool property_is_name(const bt_property_t* property);
67 bool property_is_rssi(const bt_property_t* property);
68 bool property_is_scan_mode(const bt_property_t* property);
69 bool property_is_uuids(const bt_property_t* property);
70 
71 // Value conversion convenience methods. The contents of the property are
72 // properly typed and returned to the caller. |property| must not be NULL.
73 const RawAddress* property_as_addr(const bt_property_t* property);
74 const bt_device_class_t* property_as_device_class(
75     const bt_property_t* property);
76 bt_device_type_t property_as_device_type(const bt_property_t* property);
77 uint32_t property_as_discoverable_timeout(const bt_property_t* property);
78 const bt_bdname_t* property_as_name(const bt_property_t* property);
79 int8_t property_as_rssi(const bt_property_t* property);
80 bt_scan_mode_t property_as_scan_mode(const bt_property_t* property);
81 const bluetooth::Uuid* property_as_uuids(const bt_property_t* property,
82                                          size_t* count);
83