depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
libfprint/libfprint/fpi-ssm.h

96 lines
3.4 KiB
C
Raw Normal View History

lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
/*
* Copyright (C) 2007-2008 Daniel Drake <dsd@gentoo.org>
* Copyright (C) 2018 Bastien Nocera <hadess@hadess.net>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
* Copyright (C) 2019 Benjamin Berg <bberg@redhat.com>
fpi-ssm, fp-device: Add missing copyright
2019-11-21 19:25:36 +00:00
* Copyright (C) 2019 Marco Trevisan <marco.trevisan@canonical.com>
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
#pragma once
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
#include "fp-device.h"
#include "fpi-usb-transfer.h"
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
/* async drv <--> lib comms */
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
/**
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
* FpiSsm:
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
*
* Sequential state machine that iterates sequentially over
lib: Rename fpi_ssm_mark_aborted to fpi_ssm_mark_failed
2018-09-05 14:29:26 +00:00
* a predefined series of states. Can be terminated by either completion or
* failure error conditions.
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
*/
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
typedef struct _FpiSsm FpiSsm;
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
/**
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
* FpiSsmCompletedCallback:
* @ssm: a #FpiSsm state machine
lib: Add more args to fpi_ssm callbacks Pass the struct fp_dev and user_data to fpi_ssm callbacks, so that we might be able to get rid of the fpi_ssm_get_user_data(), and fpi_ssm_get_dev() as most drivers just get those from the ssm anyway in their callbacks.
2018-09-18 11:46:39 +00:00
* @dev: the #fp_dev fingerprint device
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
* @error: The #GError or %NULL on successful completion
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
*
* The callback called when a state machine completes successfully,
* as set when calling fpi_ssm_start().
*/
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
typedef void (*FpiSsmCompletedCallback)(FpiSsm *ssm,
FpDevice *dev,
GError *error);
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
/**
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
* FpiSsmHandlerCallback:
* @ssm: a #FpiSsm state machine
lib: Add more args to fpi_ssm callbacks Pass the struct fp_dev and user_data to fpi_ssm callbacks, so that we might be able to get rid of the fpi_ssm_get_user_data(), and fpi_ssm_get_dev() as most drivers just get those from the ssm anyway in their callbacks.
2018-09-18 11:46:39 +00:00
* @dev: the #fp_dev fingerprint device
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
*
* The callback called when a state machine transitions from one
ssm: Make possible to set data via function Use the same approach of GTask, making possible to set the data from a function. Givent the fact that a SSM has now a device parameter, it's generally not needed to pass an extra data value. In such case make it possible to set it and to define a destroy-notify function to handle its destruction when freeing the SSM.
2019-11-20 17:05:46 +00:00
* state to the next, as set when calling fpi_ssm_new ().
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
*/
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
typedef void (*FpiSsmHandlerCallback)(FpiSsm *ssm,
ssm: Make possible to set data via function Use the same approach of GTask, making possible to set the data from a function. Givent the fact that a SSM has now a device parameter, it's generally not needed to pass an extra data value. In such case make it possible to set it and to define a destroy-notify function to handle its destruction when freeing the SSM.
2019-11-20 17:05:46 +00:00
FpDevice *dev);
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
/* for library and drivers */
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
FpiSsm *fpi_ssm_new (FpDevice *dev,
FpiSsmHandlerCallback handler,
ssm: Make possible to set data via function Use the same approach of GTask, making possible to set the data from a function. Givent the fact that a SSM has now a device parameter, it's generally not needed to pass an extra data value. In such case make it possible to set it and to define a destroy-notify function to handle its destruction when freeing the SSM.
2019-11-20 17:05:46 +00:00
int nr_states);
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
void fpi_ssm_free (FpiSsm *machine);
void fpi_ssm_start (FpiSsm *ssm,
FpiSsmCompletedCallback callback);
void fpi_ssm_start_subsm (FpiSsm *parent,
FpiSsm *child);
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
/* for drivers */
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
void fpi_ssm_next_state (FpiSsm *machine);
void fpi_ssm_jump_to_state (FpiSsm *machine,
int state);
void fpi_ssm_mark_completed (FpiSsm *machine);
void fpi_ssm_mark_failed (FpiSsm *machine,
GError *error);
ssm: Make possible to set data via function Use the same approach of GTask, making possible to set the data from a function. Givent the fact that a SSM has now a device parameter, it's generally not needed to pass an extra data value. In such case make it possible to set it and to define a destroy-notify function to handle its destruction when freeing the SSM.
2019-11-20 17:05:46 +00:00
void fpi_ssm_set_data (FpiSsm *machine,
gpointer ssm_data,
GDestroyNotify ssm_data_destroy);
gpointer fpi_ssm_get_data (FpiSsm *machine);
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
GError * fpi_ssm_get_error (FpiSsm *machine);
GError * fpi_ssm_dup_error (FpiSsm *machine);
int fpi_ssm_get_cur_state (FpiSsm *machine);
lib: Split off fpi_ssm functions Rename drv.c to something more fitting to its contents, and move state machine code to its own header.
2018-09-05 10:39:16 +00:00
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
/* Callbacks to be used by the driver instead of implementing their own
* logic.
*/
void fpi_ssm_next_state_timeout_cb (FpDevice *dev,
void *data);
void fpi_ssm_usb_transfer_cb (FpiUsbTransfer *transfer,
FpDevice *device,
gpointer user_data,
GError *error);
Reference in a new issue Copy permalink