libfossil
fsl_confirm_detail Struct Reference

A struct for passing on interactive questions to fsl_confirmer_callback_f implementations. More...

#include "util.h"

Collaboration diagram for fsl_confirm_detail:

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.

Detailed Description

A struct for passing on interactive questions to fsl_confirmer_callback_f implementations.

Definition at line 6040 of file util.h.

Field Documentation

◆ eventId

fsl_confirm_event_e fsl_confirm_detail::eventId

The message ID of this confirmation request.

This value determines how the rest of this struct's values are to be interpreted.

Definition at line 6046 of file util.h.

◆ filename

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:

  • FSL_CEVENT_OVERWRITE_MOD_FILE
  • FSL_CEVENT_OVERWRITE_UNMGD_FILE
  • FSL_CEVENT_RM_MOD_UNMGD_FILE

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.

Definition at line 6066 of file util.h.

◆ multi

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:

  • FSL_CEVENT_MULTIPLE_VERSIONS: each list entry will be a (char const*) with a version number, branch name, or similar, perhaps with relevant metadata such as a checkin timestamp. The client is expected to pick one answer, set its list index to the fsl_confirm_response::multipleChoice member, and to set fsl_confirm_response::response to FSL_CRESPONSE_MULTI.

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.

Definition at line 6094 of file util.h.


The documentation for this struct was generated from the following file: