|
libfossil
|
A struct for passing on interactive questions to fsl_confirmer_callback_f implementations. More...
#include "util.h"
Data Fields | |
| fsl_confirm_event_e | eventId |
| The message ID of this confirmation request. | |
| const char * | filename |
| Depending on the eventId, this might be NULL or might refer to a filename. | |
| const fsl_list * | multi |
| Depending on the eventId, this might be NULL or might refer to a list of details of a type specified in the documentation for that eventId. | |
A struct for passing on interactive questions to fsl_confirmer_callback_f implementations.
| fsl_confirm_event_e fsl_confirm_detail::eventId |
| const char* fsl_confirm_detail::filename |
Depending on the eventId, this might be NULL or might refer to a filename.
This will be a filename for following confirmations events:
For all others it will be NULL.
Whether this name refers to an absolute or relative path is context-dependent, and not specified by this API. In general, relative paths should be used if/when what they are relative to (e.g. a checkout root) is/should be clear to the user. The intent is that applications can display that name to the user in a UI control, so absolute paths "should" "generally" be avoided because they can be arbitrarily long.
| const fsl_list* fsl_confirm_detail::multi |
Depending on the eventId, this might be NULL or might refer to a list of details of a type specified in the documentation for that eventId.
Implementation of such an event is still TODO, but we have at least one use case lined up (asking a user which of several versions is intended when the checkout-update operation is given an ambiguous hash prefix).
Events for which this list will be populated:
In all cases, a response of FSL_CRESPONSE_CANCEL will trigger a cancellation.
In all cases, the memory for the items in this list is owned by (or temporarily operated on the behalf of) the routine which has launched this query. fsl_confirm_callback_f implements must never manipulate the list's or its content's state.