From 9d67ce484d256e26430b6e6c56be36a77a5f0a40 Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Tue, 22 May 2018 16:56:14 +0200 Subject: [PATCH] lib: Make inline functions real functions Otherwise they will not be parsed by gtk-doc and documented. --- doc/libfprint-sections.txt | 1 + libfprint/core.c | 11 ++++++ libfprint/fprint.h | 80 ++++---------------------------------- libfprint/sync.c | 62 +++++++++++++++++++++++++++++ 4 files changed, 81 insertions(+), 73 deletions(-) diff --git a/doc/libfprint-sections.txt b/doc/libfprint-sections.txt index fbf13e58..6be10c8c 100644 --- a/doc/libfprint-sections.txt +++ b/doc/libfprint-sections.txt @@ -22,6 +22,7 @@ fp_discover_devs fp_dscv_devs_free fp_dscv_dev_get_driver fp_dscv_dev_get_devtype +fp_dscv_dev_get_driver_id fp_dscv_dev_supports_print_data fp_dscv_dev_supports_dscv_print fp_dscv_dev_for_print_data diff --git a/libfprint/core.c b/libfprint/core.c index c2867a09..7adc86cb 100644 --- a/libfprint/core.c +++ b/libfprint/core.c @@ -455,6 +455,17 @@ API_EXPORTED struct fp_driver *fp_dscv_dev_get_driver(struct fp_dscv_dev *dev) return dev->drv; } +/** + * fp_dscv_dev_get_driver_id: + * @dev: a discovered fingerprint device + * + * Returns: the ID for the underlying driver for that device + */ +API_EXPORTED uint16_t fp_dscv_dev_get_driver_id(struct fp_dscv_dev *dev) +{ + return fp_driver_get_driver_id(fp_dscv_dev_get_driver(dev)); +} + /** * fp_dscv_dev_get_devtype: * @dev: the discovered device diff --git a/libfprint/fprint.h b/libfprint/fprint.h index 51cb79c4..d9ca3dca 100644 --- a/libfprint/fprint.h +++ b/libfprint/fprint.h @@ -131,6 +131,7 @@ enum fp_scan_type fp_driver_get_scan_type(struct fp_driver *drv); struct fp_dscv_dev **fp_discover_devs(void); void fp_dscv_devs_free(struct fp_dscv_dev **devs); struct fp_driver *fp_dscv_dev_get_driver(struct fp_dscv_dev *dev); +uint16_t fp_dscv_dev_get_driver_id(struct fp_dscv_dev *dev); uint32_t fp_dscv_dev_get_devtype(struct fp_dscv_dev *dev); int fp_dscv_dev_supports_print_data(struct fp_dscv_dev *dev, struct fp_print_data *print); @@ -141,17 +142,6 @@ struct fp_dscv_dev *fp_dscv_dev_for_print_data(struct fp_dscv_dev **devs, struct fp_dscv_dev *fp_dscv_dev_for_dscv_print(struct fp_dscv_dev **devs, struct fp_dscv_print *print); -/** - * fp_dscv_dev_get_driver_id: - * @dev: a discovered fingerprint device - * - * Returns: the ID for the underlying driver for that device - */ -static inline uint16_t fp_dscv_dev_get_driver_id(struct fp_dscv_dev *dev) -{ - return fp_driver_get_driver_id(fp_dscv_dev_get_driver(dev)); -} - /* Print discovery */ struct fp_dscv_print **fp_discover_prints(void); void fp_dscv_prints_free(struct fp_dscv_print **prints); @@ -225,25 +215,8 @@ enum fp_enroll_result { int fp_enroll_finger_img(struct fp_dev *dev, struct fp_print_data **print_data, struct fp_img **img); - -/** - * fp_enroll_finger: - * @dev: the device - * @print_data: a location to return the resultant enrollment data from - * the final stage. Must be freed with fp_print_data_free() after use. - * - * Performs an enroll stage. See [Enrolling](libfprint-Devices-operations.html#enrolling) - * for an explanation of enroll stages. This function is just a shortcut to - * calling fp_enroll_finger_img() with a %NULL image parameter. Be sure to read - * the description of fp_enroll_finger_img() in order to understand its behaviour. - * - * Returns: negative code on error, otherwise a code from #fp_enroll_result - */ -static inline int fp_enroll_finger(struct fp_dev *dev, - struct fp_print_data **print_data) -{ - return fp_enroll_finger_img(dev, print_data, NULL); -} +int fp_enroll_finger(struct fp_dev *dev, + struct fp_print_data **print_data); /** * fp_verify_result: @@ -279,54 +252,15 @@ enum fp_verify_result { int fp_verify_finger_img(struct fp_dev *dev, struct fp_print_data *enrolled_print, struct fp_img **img); - -/** - * fp_verify_finger: - * @dev: the device to perform the scan. - * @enrolled_print: the print to verify against. Must have been previously - * enrolled with a device compatible to the device selected to perform the scan. - * - * Performs a new scan and verify it against a previously enrolled print. This - * function is just a shortcut to calling fp_verify_finger_img() with a NULL - * image output parameter. - * - * Returns: negative code on error, otherwise a code from #fp_verify_result - * \sa fp_verify_finger_img() - */ -static inline int fp_verify_finger(struct fp_dev *dev, - struct fp_print_data *enrolled_print) -{ - return fp_verify_finger_img(dev, enrolled_print, NULL); -} +int fp_verify_finger(struct fp_dev *dev, + struct fp_print_data *enrolled_print); int fp_dev_supports_identification(struct fp_dev *dev); int fp_identify_finger_img(struct fp_dev *dev, struct fp_print_data **print_gallery, size_t *match_offset, struct fp_img **img); - -/** - * fp_identify_finger: - * @dev: the device to perform the scan. - * @print_gallery: %NULL-terminated array of pointers to the prints to - * identify against. Each one must have been previously enrolled with a device - * compatible to the device selected to perform the scan. - * @match_offset: output location to store the array index of the matched - * gallery print (if any was found). Only valid if FP_VERIFY_MATCH was - * returned. - - * Performs a new scan and attempts to identify the scanned finger against a - * collection of previously enrolled fingerprints. This function is just a - * shortcut to calling fp_identify_finger_img() with a %NULL image output - * parameter. - * - * Returns: negative code on error, otherwise a code from #fp_verify_result - * \sa fp_identify_finger_img() - */ -static inline int fp_identify_finger(struct fp_dev *dev, - struct fp_print_data **print_gallery, size_t *match_offset) -{ - return fp_identify_finger_img(dev, print_gallery, match_offset, NULL); -} +int fp_identify_finger(struct fp_dev *dev, + struct fp_print_data **print_gallery, size_t *match_offset); /* Data handling */ int fp_print_data_load(struct fp_dev *dev, enum fp_finger finger, diff --git a/libfprint/sync.c b/libfprint/sync.c index 87c8cb9e..af26272a 100644 --- a/libfprint/sync.c +++ b/libfprint/sync.c @@ -287,6 +287,25 @@ err: return r; } +/** + * fp_enroll_finger: + * @dev: the device + * @print_data: a location to return the resultant enrollment data from + * the final stage. Must be freed with fp_print_data_free() after use. + * + * Performs an enroll stage. See [Enrolling](libfprint-Devices-operations.html#enrolling) + * for an explanation of enroll stages. This function is just a shortcut to + * calling fp_enroll_finger_img() with a %NULL image parameter. Be sure to read + * the description of fp_enroll_finger_img() in order to understand its behaviour. + * + * Returns: negative code on error, otherwise a code from #fp_enroll_result + */ +API_EXPORTED int fp_enroll_finger(struct fp_dev *dev, + struct fp_print_data **print_data) +{ + return fp_enroll_finger_img(dev, print_data, NULL); +} + struct sync_verify_data { gboolean populated; int result; @@ -401,6 +420,25 @@ err: return r; } +/** + * fp_verify_finger: + * @dev: the device to perform the scan. + * @enrolled_print: the print to verify against. Must have been previously + * enrolled with a device compatible to the device selected to perform the scan. + * + * Performs a new scan and verify it against a previously enrolled print. This + * function is just a shortcut to calling fp_verify_finger_img() with a NULL + * image output parameter. + * + * Returns: negative code on error, otherwise a code from #fp_verify_result + * \sa fp_verify_finger_img() + */ +API_EXPORTED int fp_verify_finger(struct fp_dev *dev, + struct fp_print_data *enrolled_print) +{ + return fp_verify_finger_img(dev, enrolled_print, NULL); +} + struct sync_identify_data { gboolean populated; int result; @@ -523,6 +561,30 @@ err: return r; } +/** + * fp_identify_finger: + * @dev: the device to perform the scan. + * @print_gallery: %NULL-terminated array of pointers to the prints to + * identify against. Each one must have been previously enrolled with a device + * compatible to the device selected to perform the scan. + * @match_offset: output location to store the array index of the matched + * gallery print (if any was found). Only valid if FP_VERIFY_MATCH was + * returned. + + * Performs a new scan and attempts to identify the scanned finger against a + * collection of previously enrolled fingerprints. This function is just a + * shortcut to calling fp_identify_finger_img() with a %NULL image output + * parameter. + * + * Returns: negative code on error, otherwise a code from #fp_verify_result + * \sa fp_identify_finger_img() + */ +API_EXPORTED int fp_identify_finger(struct fp_dev *dev, + struct fp_print_data **print_gallery, size_t *match_offset) +{ + return fp_identify_finger_img(dev, print_gallery, match_offset, NULL); +} + struct sync_capture_data { gboolean populated; int result;