libfossil
fsl_cidiff_state Struct Reference

Holds the state for a single iteration step of fsl_cidiff. More...

#include "repo.h"

Collaboration diagram for fsl_cidiff_state:

Data Fields

int changes
 Describes the change(s) being reported by the current iteration step, as a bitmask of fsl_cidiff_e values.
fsl_deck const * d1
 The deck corresponding to this->opt->v1.
fsl_deck const * d2
 The deck corresponding to this->opt->v2.
fsl_cx * f
 The associated fsl_cx instance.
fsl_card_F const * fc1
 The file, if any, corresponding to this->v1.
fsl_card_F const * fc2
 The file, if any, corresponding to this->v2.
fsl_cidiff_opt const * opt
 The options object passed to fsl_cidiff().
int stepType
 Denotes the type of this step in the iteration.

Detailed Description

Holds the state for a single iteration step of fsl_cidiff.

Definition at line 4041 of file repo.h.

Field Documentation

◆ changes

int fsl_cidiff_state::changes

Describes the change(s) being reported by the current iteration step, as a bitmask of fsl_cidiff_e values.

Definition at line 4074 of file repo.h.

◆ d1

fsl_deck const* fsl_cidiff_state::d1

The deck corresponding to this->opt->v1.

It is strictly forbidden for this->callback to manipulate this object. Specifically, any traversal of its F-card list will invalidate the iteration being done by fsl_cidiff(). Read-only operations on other state of the deck are legal.

Definition at line 4092 of file repo.h.

◆ d2

fsl_deck const* fsl_cidiff_state::d2

The deck corresponding to this->opt->v2.

See the docs for this->d1 for important details.

Definition at line 4097 of file repo.h.

◆ f

fsl_cx* fsl_cidiff_state::f

The associated fsl_cx instance.

Definition at line 4045 of file repo.h.

◆ fc1

fsl_card_F const* fsl_cidiff_state::fc1

The file, if any, corresponding to this->v1.

This will be NULL this->changeType is FSL_CIDIFF_FILE_ADDED.

Definition at line 4079 of file repo.h.

◆ fc2

fsl_card_F const* fsl_cidiff_state::fc2

The file, if any, corresponding to this->v2.

This will be NULL this->changeType is FSL_CIDIFF_FILE_REMOVED.

Definition at line 4084 of file repo.h.

◆ opt

fsl_cidiff_opt const* fsl_cidiff_state::opt

The options object passed to fsl_cidiff().

Definition at line 4049 of file repo.h.

◆ stepType

int fsl_cidiff_state::stepType

Denotes the type of this step in the iteration.

Before fsl_cidiff() starts its loop over F-card changes, it calls the callback once with this value set to 0. The intent is to give the caller an opporuntity to do any required setup, e.g. outputing a report header. The fc1 and fc2 members will both be NULL, but the d1 and d2 members will be set.

For each step of the F-card iteration, stepType will be set to FSL_RC_STEP_ROW.

After successful difference iteration, fsl_cidiff() calls its callback with stepType set to FSL_RC_STEP_DONE. The intent is to give the caller an opporuntity to do any required cleanup, e.g. outputing a report footer. The fc1 and fc2 members will both be NULL, but the d1 and d2 members will be set.

Definition at line 4069 of file repo.h.


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