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