|
libfossil
|
Callback state for use by fsl_annotate_step_f(). More...
#include "repo.h"
Data Fields | |
| fsl_uuid_cstr | fileHash |
| The hash of the file version from which this->line was pulled. | |
| char const * | line |
| NUL-terminated current line of the input file, minus any newline and/or carriage return. | |
| uint32_t | lineLength |
| The number of bytes in this->line. | |
| uint32_t | lineNumber |
| Line number for the current file. | |
| double | mtime |
| The mtime field from the [event] table (timeline) entry associated with this version. | |
| int | stepNumber |
| Step number in this annotation run. | |
| fsl_annotate_step_e | stepType |
| Tells the caller the "type" of annotation step this call represents. | |
| char const * | username |
| The user name this change was attributed to, noting that merges are attributed to the one who did the merge. | |
| fsl_uuid_cstr | versionHash |
| The hash of the checkin version from which this->line was pulled. | |
Callback state for use by fsl_annotate_step_f().
ACHTUNG: this state gets repopulated for each call to the fsl_annote_step_f() callback and any pointers it holds must be treated as if they are invalidated as soon as the callback returns (whether or not that is the case is undefined, though).
Not all state is set on each call involving this object. See the stepType member for details.
| fsl_uuid_cstr fsl_annotate_step::fileHash |
| char const* fsl_annotate_step::line |
| uint32_t fsl_annotate_step::lineLength |
| uint32_t fsl_annotate_step::lineNumber |
| double fsl_annotate_step::mtime |
The mtime field from the [event] table (timeline) entry associated with this version.
This is a Julian Date and, because it is updated by annotations which modify timestamps in the [event] table, it reflects any "edited" time (if any).
| int fsl_annotate_step::stepNumber |
Step number in this annotation run.
When this->stepType is FSL_ANNOTATE_STEP_VERSION, this value is the relative number of the version, starting at 0 and incremented by 1 on each call. In the other modes it is 0-based relative version from which the current line is from, or negative if that information is incomplete due to a limited annotation run. e.g. a value of 3 indicates that this line is from 3 version away from the starting version.
| fsl_annotate_step_e fsl_annotate_step::stepType |
Tells the caller the "type" of annotation step this call represents.
The type of step will determine which fields of this object are populated when it is passed to a fsl_annotate_step_f() callback:
Always set:
stepType, stepNumber (but interpretation varies - see that member's docs for details).
FSL_ANNOTATE_STEP_VERSION: fileHash, versionHash, mtime
FSL_ANNOTATE_STEP_LIMITED: stepNumber (always 0 for the limited case), lineNumber, line, lineNength.
FSL_ANNOTATE_STEP_FULL: as for FSL_ANNOTATE_STEP_LIMITED plus: fileHash, versionHash, mtime, username.
| char const* fsl_annotate_step::username |
| fsl_uuid_cstr fsl_annotate_step::versionHash |