summaryrefslogtreecommitdiffstats
path: root/include/cutils/properties.h
diff options
context:
space:
mode:
authorIgor Murashkin <iam@google.com>2014-04-08 11:22:42 -0700
committerRiley Andrews <riandrews@google.com>2014-06-20 20:01:49 +0000
commitd8f2a8d34a5655d81fec2f56eb3ec36bd508886a (patch)
treee86242c509bcb44d84ac35c915a01a499bc5e029 /include/cutils/properties.h
parent4f5392cb6c09618b968a4c86bbde079bef57afd1 (diff)
downloadsystem_core-d8f2a8d34a5655d81fec2f56eb3ec36bd508886a.zip
system_core-d8f2a8d34a5655d81fec2f56eb3ec36bd508886a.tar.gz
system_core-d8f2a8d34a5655d81fec2f56eb3ec36bd508886a.tar.bz2
cutils: Add property_get_bool, _get_int32, _get_int64
* Read out system properties with same syntax as SystemProperties.java * Also adds unit test suite to validate correctness of properties * Also fixes buffer overrun in property_get (cherry picked from commit d4507e9246e4855c5431cac5c3d1a9155caebc87) Change-Id: Ifd42911f93e17da09e6ff1298e8875e02f3b6608
Diffstat (limited to 'include/cutils/properties.h')
-rw-r--r--include/cutils/properties.h59
1 files changed, 59 insertions, 0 deletions
diff --git a/include/cutils/properties.h b/include/cutils/properties.h
index 2c70165..798db8b 100644
--- a/include/cutils/properties.h
+++ b/include/cutils/properties.h
@@ -20,6 +20,7 @@
#include <sys/cdefs.h>
#include <stddef.h>
#include <sys/system_properties.h>
+#include <stdint.h>
#ifdef __cplusplus
extern "C" {
@@ -44,6 +45,64 @@ extern "C" {
*/
int property_get(const char *key, char *value, const char *default_value);
+/* property_get_bool: returns the value of key coerced into a
+** boolean. If the property is not set, then the default value is returned.
+**
+* The following is considered to be true (1):
+** "1", "true", "y", "yes", "on"
+**
+** The following is considered to be false (0):
+** "0", "false", "n", "no", "off"
+**
+** The conversion is whitespace-sensitive (e.g. " off" will not be false).
+**
+** If no property with this key is set (or the key is NULL) or the boolean
+** conversion fails, the default value is returned.
+**/
+int8_t property_get_bool(const char *key, int8_t default_value);
+
+/* property_get_int64: returns the value of key truncated and coerced into a
+** int64_t. If the property is not set, then the default value is used.
+**
+** The numeric conversion is identical to strtoimax with the base inferred:
+** - All digits up to the first non-digit characters are read
+** - The longest consecutive prefix of digits is converted to a long
+**
+** Valid strings of digits are:
+** - An optional sign character + or -
+** - An optional prefix indicating the base (otherwise base 10 is assumed)
+** -- 0 prefix is octal
+** -- 0x / 0X prefix is hex
+**
+** Leading/trailing whitespace is ignored. Overflow/underflow will cause
+** numeric conversion to fail.
+**
+** If no property with this key is set (or the key is NULL) or the numeric
+** conversion fails, the default value is returned.
+**/
+int64_t property_get_int64(const char *key, int64_t default_value);
+
+/* property_get_int32: returns the value of key truncated and coerced into an
+** int32_t. If the property is not set, then the default value is used.
+**
+** The numeric conversion is identical to strtoimax with the base inferred:
+** - All digits up to the first non-digit characters are read
+** - The longest consecutive prefix of digits is converted to a long
+**
+** Valid strings of digits are:
+** - An optional sign character + or -
+** - An optional prefix indicating the base (otherwise base 10 is assumed)
+** -- 0 prefix is octal
+** -- 0x / 0X prefix is hex
+**
+** Leading/trailing whitespace is ignored. Overflow/underflow will cause
+** numeric conversion to fail.
+**
+** If no property with this key is set (or the key is NULL) or the numeric
+** conversion fails, the default value is returned.
+**/
+int32_t property_get_int32(const char *key, int32_t default_value);
+
/* property_set: returns 0 on success, < 0 on failure
*/
int property_set(const char *key, const char *value);