3#if !defined(ORG_FOSSIL_SCM_FSL_CHECKOUT_H_INCLUDED)
4#define ORG_FOSSIL_SCM_FSL_CHECKOUT_H_INCLUDED
25#if defined(__cplusplus)
71 bool checkParentDirs );
115 bool checkParentDirs,
180 char const * zOrigName,
fsl_buffer *
const pOut );
345#define fsl_ckout_manage_opt_empty_m {\
516#define fsl_ckout_unmanage_opt_empty_m {\
692 char const * filename,
693 char const * origName);
785 unsigned cksigFlags);
895#define fsl_checkin_queue_opt_empty_m { \
1257#define fsl_checkin_opt_empty_m { \
1259 .messageMimeType = NULL, \
1263 .isPrivate = false, \
1264 .calcRCard = true, \
1265 .integrate = false, \
1266 .allowMergeConflict = false,\
1267 .scanForChanges = true,\
1268 .rmRemovedFiles = false,\
1271 .julianTime = 0.0, \
1272 .closeBranch = NULL, \
1273 .dumpManifestFile = NULL \
1388 char const * value);
1521#define fsl_repo_open_ckout_opt_m { \
1523 FSL_OVERWRITE_ERROR, \
1856#define fsl_ckup_opt_m {\
1858 fsl_confirmer_empty_m,\
2090 int *
const wroteWhat );
2214#define fsl_ckout_revert_opt_empty_m { \
2215 NULL,NULL,true,true, \
2415 bool clearOtherVersions,
2416 uint32_t * missingCount);
2585FSL_MERGE_FCHANGE_CONFLICT_ADDED,
2603FSL_MERGE_FCHANGE_CONFLICT_RM,
2847#define fsl_merge_opt_empty_m \
2849 FSL_MERGE_TYPE_NORMAL, \
2956 char const * zSrcName,
char const *zDestName);
3004#define fsl_ckout_rename_opt_empty_m {NULL,NULL,true,false,false,NULL,NULL}
3121 char const * zNewName,
3122 bool relativeToCwd,
bool doFsMv,
3123 bool *didSomething);
3140 bool absolute,
char **zOut);
3143#if defined(__cplusplus)
FSL_EXPORT int fsl_ckout_fingerprint_check(fsl_cx *const f)
Performs a "fingerprint check" between f's current checkout and repository databases.
FSL_EXPORT int fsl_filename_to_vfile_id(fsl_cx *const f, fsl_id_t vid, char const *zName, fsl_id_t *const vfid)
Expects f to have an opened checkout and zName to be the name of an entry in the vfile table where vf...
int(* fsl_ckout_changes_f)(void *state, fsl_ckout_change_e change, char const *filename, char const *origName)
A typedef for visitors of checkout status information via fsl_ckout_changes_visit().
FSL_EXPORT int fsl_ckout_rename_revert(fsl_cx *const f, char const *zNewName, bool relativeToCwd, bool doFsMv, bool *didSomething)
Undoes a rename scheduled by fsl_ckout_rename().
FSL_EXPORT bool fsl_checkin_is_enqueued(fsl_cx *const f, char const *zName, bool relativeToCwd)
Returns true if the file named by zName is in f's current file checkin queue.
fsl_ckup_fchange_e
This enum lists the various types of individual file change states which can happen during a checkout...
@ FSL_CKUP_FCHANGE_INVALID
Sentinel value.
@ FSL_CKUP_FCHANGE_CONFLICT_MERGED
Special case of FSL_CKUP_FCHANGE_MERGED.
@ FSL_CKUP_FCHANGE_RENAMED
File was renamed in the updated-to version.
@ FSL_CKUP_FCHANGE_CONFLICT_RM
Edited locally but removed from updated-to version.
@ FSL_CKUP_FCHANGE_RM
Removed from SCM in the updated-to to version OR in the checked-out version but not yet committed.
@ FSL_CKUP_FCHANGE_MERGED
Updated with a merge by the update process.
@ FSL_CKUP_FCHANGE_CONFLICT_BINARY
Indicates that a merge of binary content was requested.
@ FSL_CKUP_FCHANGE_CONFLICT_ADDED
Added in the current checkout but also contained in the updated-to version.
@ FSL_CKUP_FCHANGE_RM_PROPAGATED
Removed from the checked-out version but not yet commited, so was carried over to the updated-to vers...
@ FSL_CKUP_FCHANGE_ADD_PROPAGATED
Added to SCM in the current checkout version and carried over into the updated-to version.
@ FSL_CKUP_FCHANGE_UPDATED
Updated or replaced without a merge by the checkout/update process.
@ FSL_CKUP_FCHANGE_ADDED
Added to SCM in the updated-to version.
@ FSL_CKUP_FCHANGE_EDITED
Locally modified.
@ FSL_CKUP_FCHANGE_CONFLICT_ADDED_UNMANAGED
Added by the updated-to version but a local unmanaged copy exists.
@ FSL_CKUP_FCHANGE_CONFLICT_SYMLINK
Cannot merge if one or both of the update/updating verions of a file is a symlink.
@ FSL_CKUP_FCHANGE_UPDATED_BINARY
Merge was not performed because at least one of the inputs appears to be binary.
@ FSL_CKUP_FCHANGE_NONE
Was unchanged between the previous and updated-to version, so no change was made to the on-disk file.
FSL_EXPORT int fsl_ckout_changes_scan(fsl_cx *f)
This is equivalent to calling fsl_vfile_changes_scan() with the arguments (f, -1, 0).
FSL_EXPORT int fsl_ckout_manifest_write(fsl_cx *const f, int manifest, int manifestUuid, int manifestTags, int *const wroteWhat)
Might write out the files manifest, manifest.uuid, and/or manifest.tags for the current checkout to t...
const fsl_merge_opt fsl_merge_opt_empty
Initialized-with-defaults fsl_merge_opt structure, intended for non-const copy initialization.
FSL_EXPORT int fsl_checkin_T_add2(fsl_cx *f, fsl_card_T *t)
Works identically to fsl_checkin_T_add() except that it takes its argument in the form of a T-card ob...
FSL_EXPORT char const * fsl_is_top_of_ckout(char const *zDirName)
If zDirName is a directory name which contains what appears to be a fossil checkout database (noting ...
FSL_EXPORT void fsl_ckout_manifest_setting(fsl_cx *f, int *m)
Returns a bitmask representing which manifest files, if any, will be written when opening or updating...
fsl_ckup_rm_state_e
State values for use with fsl_ckup_state::fileRmInfo.
@ FSL_CKUP_RM_KEPT
Indicates that a file was removed from a checkout but kept in the filesystem because it was locally m...
@ FSL_CKUP_RM_NOT
Indicates that the file was not removed in a given checkout.
@ FSL_CKUP_RM
Indicates that a file was removed from a checkout and the filesystem, with the caveat that failed att...
FSL_EXPORT bool fsl_is_rooted_in_ckout(fsl_cx *const f, char const *const zAbsPath)
Returns true if f has an opened checkout and the given absolute path is rooted in that checkout,...
FSL_EXPORT int fsl_ckout_vfile_ids(fsl_cx *const f, fsl_id_t vid, fsl_id_bag *const dest, char const *zName, bool relativeToCwd, bool changedOnly)
This is a variant of fsl_filename_to_vfile_ids() which accepts filenames in a more flexible form than...
FSL_EXPORT int fsl_card_F_ckout_mtime(fsl_cx *const f, fsl_id_t vid, fsl_card_F const *const fc, fsl_time_t *const repoMtime, fsl_time_t *const localMtime)
Fetches the timestamp of the given F-card's name against the filesystem and/or the most recent checki...
FSL_EXPORT int fsl_ckout_unmanage(fsl_cx *f, fsl_ckout_unmanage_opt const *opt)
The converse of fsl_ckout_manage(), this queues a file for removal from the current checkout.
FSL_EXPORT int fsl_ckout_changes_visit(fsl_cx *f, fsl_id_t vid, bool doChangeScan, fsl_ckout_changes_f visitor, void *state)
Compares the changes of f's local checkout against repository version vid (checkout version if vid is...
int(* fsl_ckout_revert_f)(char const *zFilename, fsl_ckout_revert_e changeType, void *callbackState)
Callback type for use with fsl_ckout_revert().
FSL_EXPORT int fsl_ckout_manage(fsl_cx *const f, fsl_ckout_manage_opt *const opt)
Adds the given filename or directory (recursively) to the current checkout vfile list of files as a t...
FSL_EXPORT int fsl_ckout_merge(fsl_cx *const f, fsl_merge_opt const *const opt)
UNDER CONSTRUCTION and not yet well-tested.
FSL_EXPORT int fsl_is_rooted_in_ckout2(fsl_cx *const f, char const *const zAbsPath)
Works like fsl_is_rooted_in_ckout() except that it returns 0 on success, and on error updates f with ...
FSL_EXPORT int fsl_ckout_calc_update_version(fsl_cx *f, fsl_id_t *outRid)
Tries to calculate a version to update the current checkout version to, preferring the tip of the cur...
FSL_EXPORT const fsl_ckout_manage_opt fsl_ckout_manage_opt_empty
Initialized-with-defaults fsl_ckout_manage_opt instance, intended for use in non-const copy initializ...
fsl_ckout_revert_e
Change-type values for use with fsl_ckout_revert_f() callbacks.
@ FSL_REVERT_NONE
Sentinel value.
@ FSL_REVERT_REMOVE
File was previously queued for removal but unqueued by the revert process.
@ FSL_REVERT_PERMISSIONS
File's permissions (only) were reverted.
@ FSL_REVERT_CONTENTS
File's contents reverted.
@ FSL_REVERT_RENAME
File was previously scheduled to be renamed, but the rename was reverted.
@ FSL_REVERT_UNMANAGE
File was previously queued for addition but unqueued by the revert process.
fsl_file_overwrite_policy_e
File-overwrite policy values for use with fsl_ckup_opt and friends.
@ FSL_OVERWRITE_NEVER
Indicates that files should never be overwritten, and silently skipped over.
@ FSL_OVERWRITE_ERROR
Indicates that an error should be triggered if a file would be overwritten.
@ FSL_OVERWRITE_ALWAYS
Indicates that files should always be overwritten.
fsl_ckout_change_e
Change-type flags for use with fsl_ckout_changes_visit() and friends.
@ FSL_CKOUT_CHANGE_REMOVED
Indicates that a file was removed from SCM management.
@ FSL_CKOUT_CHANGE_BECAME_SYMLINK
Indicates that the file has changed to a symlink.
@ FSL_CKOUT_CHANGE_INTEGRATE_ADD
Indicates that a file was added as the result of an integrate-merge.
@ FSL_CKOUT_CHANGE_MOD
Indicates that a file was modified in some unspecified way.
@ FSL_CKOUT_CHANGE_MERGE_ADD
Indicates that a file was added as the result of a merge.
@ FSL_CKOUT_CHANGE_NONE
Sentinel placeholder value.
@ FSL_CKOUT_CHANGE_ADDED
Indicates that a file was added.
@ FSL_CKOUT_CHANGE_INTEGRATE_MOD
Indicates that a file was modified as the result of an integrate-merge.
@ FSL_CKOUT_CHANGE_MISSING
Indicates that a file is missing from the local checkout.
@ FSL_CKOUT_CHANGE_NOT_EXEC
Indicates that the file lost the is-executable trait but is otherwise unmodified.
@ FSL_CKOUT_CHANGE_NOT_SYMLINK
Indicates that the file was previously a symlink but is now a plain file.
@ FSL_CKOUT_CHANGE_RENAMED
Indicates that a file was renamed.
@ FSL_CKOUT_CHANGE_IS_EXEC
Indicates that the file gained the is-executable trait but is otherwise unmodified.
@ FSL_CKOUT_CHANGE_MERGE_MOD
Indicates that a file was modified as the result of a merge.
int(* fsl_merge_f)(fsl_merge_state const *const)
Callback type for use with fsl_merge_opt and fsl_ckout_merge().
fsl_ckout_sig_e
A bitmask of flags for fsl_vfile_changes_scan().
@ FSL_VFILE_CKSIG_KEEP_OTHERS
Indicates that when populating the vfile table, it should be not be cleared of entries for other chec...
@ FSL_VFILE_CKSIG_SETMTIME
For unchanged or changed-by-merge files, set the mtime to last check-out time, as determined by fsl_m...
@ FSL_VFILE_CKSIG_ENOTFILE
Non-file/non-link FS objects trigger an error.
@ FSL_VFILE_CKSIG_WRITE_CKOUT_VERSION
If set and fsl_vfile_changes_scan() is passed a version other than the pre-call checkout version,...
@ FSL_VFILE_CKSIG_NONE
The empty flags set.
@ FSL_VFILE_CKSIG_HASH
Verify file content using hashing, regardless of whether or not file timestamps differ.
FSL_EXPORT int fsl_checkin_commit(fsl_cx *f, fsl_checkin_opt const *opt, fsl_id_t *newRid, fsl_uuid_str *newUuid)
This creates and saves a "checkin manifest" for the current checkout.
fsl_vfile_change_e
Hard-coded range of values of the vfile.chnged db field.
@ FSL_VFILE_CHANGE_IS_EXEC
File became executable but has unmodified contents.
@ FSL_VFILE_CHANGE_MERGE_MOD
File changed due to a merge.
@ FSL_VFILE_CHANGE_NOT_SYMLINK
File lost symlink status and has contents equal to its old target.
@ FSL_VFILE_CHANGE_BECAME_SYMLINK
File became a symlink whose target equals its old contents.
@ FSL_VFILE_CHANGE_NOT_EXEC
File lost executable status but has unmodified contents.
@ FSL_VFILE_CHANGE_MOD
File edit.
@ FSL_VFILE_CHANGE_INTEGRATE_MOD
File changed due to an integrate merge.
@ FSL_VFILE_CHANGE_MERGE_ADD
File added by a merge.
@ FSL_VFILE_CHANGE_NONE
File is unchanged.
@ FSL_VFILE_CHANGE_INTEGRATE_ADD
File added by an integrate merge.
FSL_EXPORT int fsl_vfile_unload(fsl_cx *const f, fsl_id_t vid)
Clears out all entries in the current checkout's vfile table with the given vfile....
FSL_EXPORT int fsl_ckout_file_content(fsl_cx *const f, bool relativeToCwd, char const *zName, fsl_buffer *const dest)
Looks for the given file in f's current checkout.
FSL_EXPORT const fsl_ckout_revert_opt fsl_ckout_revert_opt_empty
Initialized-with-defaults fsl_ckout_revert_opt instance, intended for use in non-const copy initializ...
FSL_EXPORT int fsl_vfile_load(fsl_cx *const f, fsl_id_t manifestRid, bool clearOtherVersions, uint32_t *missingCount)
This "mostly internal" routine (re)populates f's checkout vfile table with all files from the given c...
FSL_EXPORT const fsl_repo_open_ckout_opt fsl_repo_open_ckout_opt_empty
Empty-initialised fsl_repo_open_ckout_opt instance.
FSL_EXPORT int fsl_repo_open_ckout(fsl_cx *const f, fsl_repo_open_ckout_opt const *opt)
Opens a checkout db for use with the currently-connected repository or creates a new checkout db.
int(* fsl_ckout_unmanage_f)(fsl_ckout_unmanage_state const *ums)
Callback type for use with fsl_ckout_unmanage().
FSL_EXPORT char const * fsl_preferred_ckout_db_name(void)
Returns the base name of the current platform's checkout database file.
int(* fsl_checkin_queue_f)(const char *filename, void *state)
Callback type for use with fsl_checkin_queue_opt for alerting a client about exactly which files get ...
FSL_EXPORT int fsl_ckout_rename(fsl_cx *const f, fsl_ckout_rename_opt const *opt)
This routine renames one or more SCM-managed files matching all entries in opt->src to opt->dest with...
FSL_EXPORT int fsl_checkin_dequeue(fsl_cx *const f, fsl_checkin_queue_opt const *opt)
The opposite of fsl_checkin_enqueue(), this opt->filename, which may resolve to a single name or a di...
const fsl_ckout_rename_opt fsl_ckout_rename_opt_empty
Initialized-with-defaults fsl_ckout_rename_opt structure, intended for non-const copy initialization.
fsl_merge_type_e
Merge type enum for use with fsl_merge_opt::mergeType.
@ FSL_MERGE_TYPE_INTEGRATE
Indicates an "integrate" merge, which tells the next checkin operation to apply a "closed" tag to the...
@ FSL_MERGE_TYPE_BACKOUT
Indicates a backout merge, a reverse cherrypick, backing out any changes which were added by the corr...
@ FSL_MERGE_TYPE_CHERRYPICK
Indicates a cherrypick merge, pulling in only the changes made to a specific checkin without otherwis...
@ FSL_MERGE_TYPE_NORMAL
Indicates a normal merge.
FSL_EXPORT int fsl_ckout_db_search(char const *dirName, bool checkParentDirs, fsl_buffer *const pOut)
Searches the given directory (or the current directory if dirName is 0) for a fossil checkout databas...
FSL_EXPORT int fsl_checkin_enqueue(fsl_cx *f, fsl_checkin_queue_opt const *opt)
Adds one or more files to f's list of "selected" files - those which should be included in the next c...
FSL_EXPORT bool fsl_ckout_has_changes(fsl_cx *const f)
If f has an opened checkout which has local changes noted in its checkout db state (the vfile table),...
FSL_EXPORT int fsl_filename_to_vfile_ids(fsl_cx *const f, fsl_id_t vid, fsl_id_bag *const dest, char const *zName, bool changedOnly)
Searches the vfile table where vfile.vid=vid for a name which matches zName or all vfile entries foun...
int(* fsl_ckout_rename_f)(fsl_cx *, fsl_ckout_rename_opt const *, char const *zSrcName, char const *zDestName)
Callback type for use with fsl_ckout_rename().
fsl_cx_manifest_mask_e
Bitmask used by fsl_ckout_manifest_setting() and fsl_ckout_manifest_write().
@ FSL_MANIFEST_UUID
Coresponds to the file "manifest.uuid".
@ FSL_MANIFEST_MAIN
Coresponds to the file "manifest".
@ FSL_MANIFEST_TAGS
Coresponds to the file "manifest.tags".
const fsl_checkin_queue_opt fsl_checkin_queue_opt_empty
Initialized-with-defaults fsl_checkin_queue_opt structure, intended for non-const copy initialization...
int(* fsl_ckout_manage_f)(fsl_ckout_manage_state const *mst, bool *include)
Callback type for use with fsl_ckout_manage_opt().
fsl_merge_fchange_e
File change types for use with fsl_merge_state::fileChangeType.
@ FSL_MERGE_FCHANGE_COPIED
File content was copied as-is from (M) to (V).
@ FSL_MERGE_FCHANGE_CONFLICT_ADDED_UNMANAGED
Added to (V) by (M) but a local unmanaged copy exists.
@ FSL_MERGE_FCHANGE_CONFLICT_SYMLINK
Cannot merge if one or both of the update/updating versions of a file is a symlink.
@ FSL_MERGE_FCHANGE_RENAMED
File was renamed in the updated-to version.
@ FSL_MERGE_FCHANGE_RM
File was removed from (V) via (M).
@ FSL_MERGE_FCHANGE_ADDED
File was added to (V) from (M).
@ FSL_MERGE_FCHANGE_NONE
Not currently used.
@ FSL_MERGE_FCHANGE_CONFLICT_MERGED
Special case of FSL_MERGE_FCHANGE_MERGED.
@ FSL_MERGE_FCHANGE_CONFLICT_BINARY
Indicates that a merge of binary content was requested.
@ FSL_MERGE_FCHANGE_MERGED
Content from (M) was merged into (V).
@ FSL_MERGE_FCHANGE_count
This is the number of entries in this enum, for purposes of creating, e.g.
FSL_EXPORT int fsl_vfile_changes_scan(fsl_cx *const f, fsl_id_t vid, unsigned cksigFlags)
This function populates (if needed) the vfile table of f's checkout db for the given checkin version ...
FSL_EXPORT int fsl_ckout_filename_check(fsl_cx *const f, bool relativeToCwd, char const *zOrigName, fsl_buffer *const pOut)
Given a fsl_cx with an opened checkout, and a file/directory name, this function canonicalizes zOrigN...
FSL_EXPORT const fsl_checkin_opt fsl_checkin_opt_empty
Empty-initialized fsl_checkin_opt instance, intended for use in copy-constructing.
FSL_EXPORT int fsl_repo_ckout(fsl_cx *f, fsl_ckup_opt const *cOpt)
A fsl_repo_extract() proxy which extracts the contents of the repository version specified by opt->ch...
FSL_EXPORT const fsl_ckout_unmanage_opt fsl_ckout_unmanage_opt_empty
Initialized-with-defaults fsl_ckout_unmanage_opt instance, intended for use in non-const copy initial...
FSL_EXPORT int fsl_ckout_revert(fsl_cx *const f, fsl_ckout_revert_opt const *opt)
Reverts changes to checked-out files, replacing their on-disk versions with the current checkout's ve...
FSL_EXPORT int fsl_vfile_unload_except(fsl_cx *const f, fsl_id_t vid)
A counterpart of fsl_vfile_unload() which removes all vfile entries where vfile.vid is not the given ...
FSL_EXPORT int fsl_checkin_T_add(fsl_cx *f, fsl_tagtype_e tagType, fsl_uuid_cstr uuid, char const *name, char const *value)
Works like fsl_deck_T_add(), adding the given tag information to the pending checkin state.
FSL_EXPORT int fsl_ckout_clear_db(fsl_cx *f)
Clears all contents from f's checkout database, including the vfile table, vmerge table,...
FSL_EXPORT void fsl_checkin_discard(fsl_cx *const f)
Discards any state accumulated for a pending checking, including any files queued via fsl_checkin_enq...
FSL_EXPORT char const ** fsl_ckout_dbnames(void)
Returns an array of strings with the base names of valid fossil checkout databases.
int(* fsl_ckup_f)(fsl_ckup_state const *cState)
A callback type for use with fsl_ckup_state.
FSL_EXPORT void fsl_ckout_version_info(fsl_cx *const f, fsl_id_t *const rid, fsl_uuid_cstr *const uuid)
Returns version information for the current checkout.
FSL_EXPORT int fsl_vfile_pathname(fsl_cx *const f, fsl_id_t vfid, bool absolute, char **zOut)
Fetches the vfile.pathname value for the given vfile.id entry.
FSL_EXPORT int fsl_ckout_open_dir(fsl_cx *const f, char const *dirName, bool checkParentDirs)
Tries to open a checked-out fossil repository db in the given directory (or "." if dirName is NULL).
FSL_EXPORT int fsl_ckout_update(fsl_cx *f, fsl_ckup_opt const *opt)
UNDER CONSTRUCTION.
FSL_EXPORT const fsl_ckup_opt fsl_ckup_opt_empty
Empty-initialised fsl_ckup_opt instance.
int32_t fsl_id_t
fsl_id_t is a signed integer type used to store database record IDs.
int64_t fsl_time_t
The type used to represent type values.
int64_t fsl_int_t
fsl_int_t is a signed integer type used to denote "relative" ranges and lengths, or to tell a routine...
repo.h declares APIs specifically dealing with repository-db-side state, as opposed to specifically c...
fsl_tagtype_e
Artifact tag types used by the Fossil framework.
A general-purpose buffer class, analog to Fossil's Blob class, but it is not called fsl_blob to avoid...
F-cards each represent one file entry in a Manifest Artifact (i.e., a checkin version).
Represents a tag in a Manifest or Control Artifact.
Parameters for fsl_checkin_commit().
bool dryRun
If true, the checkin's db savepoint is rolled back after it's complete, effectively meaning that the ...
char const * closeBranch
If this is not NULL then the committed manifest will include a tag which closes the branch.
bool allowMergeConflict
If true, allow a file to be checked in if it contains fossil-style merge conflict markers,...
bool isPrivate
If true, the checkin will be marked as private, otherwise it will be marked as private or public,...
bool scanForChanges
A hint to fsl_checkin_commit() about whether it needs to scan the checkout for changes.
char const * bgColor
If this->branch is not NULL, this is applied as its "bgcolor" propagating property.
char const * messageMimeType
The optional mime type for the message.
double julianTime
Time of the checkin.
bool integrate
Tells the checkin to close merged-in branches (merge type of 0).
char const * message
The commit message.
bool calcRCard
Whether or not to calculate an R-card.
char const * branch
If not NULL, makes the checkin the start of a new branch with this name.
char const * user
The user name for the checkin.
char const * dumpManifestFile
Tells fsl_checkin_commit() to dump the generated manifest to this file.
int deltaPolicy
Whether to allow (or try to force) a delta manifest or not.
bool rmRemovedFiles
NOT YET IMPLEMENTED!
Options object type used by fsl_checkin_enqueue() and fsl_checkin_dequeue().
void * callbackState
Opaque client-side state for use as the 2nd argument to this->callback.
fsl_checkin_queue_f callback
It not NULL, is pass passed the checkout-relative filename of each enqueued/dequeued file and this->c...
bool relativeToCwd
If true, filename (if not absolute) is interpreted as relative to the current working directory,...
char const * filename
File or directory name to enqueue/dequeue to/from a pending checkin.
bool onlyModifiedFiles
If true, only flagged-as-modified files will be enqueued by fsl_checkin_enqueue().
fsl_id_bag const * vfileIds
If not NULL then this->filename and this->relativeToCwd are IGNORED and any to-queue filename(s) is/a...
bool scanForChanges
If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.
Options for use with fsl_ckout_manage().
void * callbackState
State to be passed to this->callback.
fsl_ckout_manage_f callback
Optional predicate function which may be called for each to-be-added filename.
bool checkIgnoreGlobs
Whether or not to check the name(s) against the 'ignore-globs' config setting (if set).
uint32_t updated
Number of files which were requested to be added but were only updated because they had previously be...
struct fsl_ckout_manage_opt::@165150144055323066204210121204355317235107070054 counts
These counts are updated by fsl_ckout_manage() to report what it did.
bool relativeToCwd
Whether to evaluate the given name as relative to the current working directory or to the current che...
char const * filename
The file or directory name to add.
uint32_t skipped
The number of files skipped over for addition.
uint32_t added
Number of files actually added by fsl_ckout_manage().
State passed to fsl_ckout_manage_f() callback.
fsl_ckout_manage_opt const * opt
The options object passed to the corresponding call to fsl_ckout_manage().
fsl_cx * f
The fsl_cx instance for the correspnding fsl_ckout_manage() call.
Options object for use with fsl_ckout_rename().
bool doFsMv
If true fsl_ckout_rename() will attempt to move files within the filesystem.
bool dryRun
If true, fsl_ckout_rename() will not perform any lasting operations but will "go through the motions"...
bool relativeToCwd
If true, src and dest are resolved/normalized based on the current working directory,...
char const * dest
The target filename or directory name to rename to.
fsl_ckout_rename_f callback
Optional callback.
void * callbackState
Optional state for the callback.
fsl_list const * src
The source filename(s) or directory name(s) to rename.
Options for passing to fsl_ckout_revert().
bool scanForChanges
If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.
char const * filename
File or directory name to revert.
void * callbackState
State for this->callback.
fsl_id_bag const * vfileIds
An alternative to assigning this->filename is to point this->vfileIds to a bag of vfile....
bool relativeToCwd
Interpret filename as relative to cwd if true, else relative to the current checkout root.
fsl_ckout_revert_f callback
Optional callback to notify the client of what gets reverted.
Options for use with fsl_ckout_unmanage().
void * callbackState
State to be passed to this->callback.
bool relativeToCwd
Whether to evaluate this->filename as relative to the current working directory (true) or to the curr...
fsl_ckout_unmanage_f callback
Optional predicate function which will be called after each file is made unmanaged.
fsl_id_bag const * vfileIds
An alternative to assigning this->filename is to point this->vfileIds to a bag of vfile....
char const * filename
The file or directory name to add.
bool scanForChanges
If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.
State passed to fsl_ckout_unmanage_f() callback.
fsl_cx * f
The fsl_cx instance for the correspnding fsl_ckout_unmanage() call.
fsl_ckout_unmanage_opt const * opt
The options object passed to the corresponding call to fsl_ckout_unmanage().
Options for use with fsl_repo_ckout() and fsl_ckout_update().
bool scanForChanges
A hint to fsl_repo_ckout() and fsl_ckout_update() about whether it needs to scan the checkout for cha...
fsl_ckup_f callback
Gets called once per checked-out or updated file, passed a fsl_ckup_state instance with information a...
bool setMtime
If true, the checkout/update processes will calculate the (synthetic) mtime of each extracted file an...
bool dryRun
If true, the extraction process will "go through the motions" but will not write any files to disk.
fsl_id_t checkinRid
The version of the repostitory to check out or update.
fsl_confirmer confirmer
An optional "confirmer" for answering questions about file overwrites and deletions posed by the chec...
void * callbackState
State to be passed to this->callback via the fsl_ckup_state::callbackState member.
State to be passed to fsl_ckup_f() implementations via calls to fsl_repo_ckout() and fsl_ckout_update...
bool dryRun
True if the current checkout/update is running in dry-run mode, else false.
fsl_ckup_fchange_e fileChangeType
Vaguely describes the type of change the current call into the fsl_ckup_f() represents.
fsl_int_t size
The size of the extracted file, in bytes.
fsl_repo_extract_state const * extractState
The core SCM state for the just-extracted file.
void * callbackState
Optional client-dependent state for use in the fsl_ckup_f() callback.
fsl_time_t mtime
If fsl_repo_ckout()'s or fsl_ckout_update()'s options specified that the mtime should be set on each ...
fsl_ckup_rm_state_e fileRmInfo
Indicates whether the file was removed by the process:
A fsl_confirm_callback_f and its callback state, packaged into a neat little struct for easy copy/rep...
The main Fossil "context" type.
A container type for lists of db record IDs.
Generic list container type.
fsl_merge_type_e mergeType
Specifies the merge type to perform.
fsl_merge_f callback
Gets called once per merge-updated file, passed a fsl_ckup_state instance with information about the ...
bool scanForChanges
A hint to fsl_ckout_merge() about whether it needs to scan the checkout for changes.
void * callbackState
Client-defined state for use with this->callback.
bool dryRun
If true, the extraction process will "go through the motions" but will not write any files to disk.
unsigned short debug
This flag is not part of the public API and will be removed once the merge operation's development ha...
fsl_id_t baselineRid
The version of the most recent common ancestor.
fsl_id_t mergeRid
The version of the repostitory to merge into the current checkout.
char const * priorName
If this->fileChangeType is FSL_MERGE_FCHANGE_RENAMED then this is the previous name of the file,...
char const * filename
The checkout-relative name of the file affected by the merge.
fsl_merge_opt const * opt
The options object which drives the current fsl_ckout_merge() run.
fsl_merge_fchange_e fileChangeType
Indicates the state of the file currently being merged.
fsl_ckup_rm_state_e fileRmInfo
Indicates whether the current file was removed.
fsl_cx * f
The fsl_cx object for which the current merge is running.
char const * targetDir
Name of the target directory, which must already exist.
bool checkForOpenedCkout
If true, the checkout-open process will look for an opened checkout in the target directory and its p...
fsl_file_overwrite_policy_e fileOverwritePolicy
Policy for how to handle overwrites of files extracted from a newly-opened checkout.
char const * ckoutDbFile
The filename, with no directory components, of the desired checkout db name.
bool dbOverwritePolicy
fsl_repo_open_ckout() installs the fossil checkout schema.
char * fsl_uuid_str
fsl_uuid_str and fsl_uuid_cstr are "for documentation andreadability purposes" typedefs used to denot...
char const * fsl_uuid_cstr
The const counterpart of fsl_uuid_str.