libfossil
fsl_cx Struct Reference

The main Fossil "context" type. More...

#include "internal.h"

Collaboration diagram for fsl_cx:

Data Fields

void const * allocStamp
 Marker which tells us whether fsl_cx_finalize() needs to fsl_free() this instance or not.
struct { 
   short   allowSymlinks 
 Cached copy of the allow-symlinks config option, because it is (hypothetically) needed on many stat() call. More...
   fsl__bccache   blobContent 
 fsl_content_get() cache. More...
   short   caseInsensitive 
 Specifies whether SOME repository-level file-name comparisons/searches will work case-insensitively. More...
   fsl_buffer   deltaContent 
 Reusable buffer for creating and fetching deltas via fsl_content_get() and fsl__content_deltify(). More...
   fsl_buffer   fileContent 
 A place for temporarily holding file content. More...
   fsl_fstat   fstat 
 Internal optimization to avoid duplicate fsl_stat() calls across two functions in some cases. More...
   struct { 
      fsl_list   binary 
 Holds the "binary-glob" globs. More...
      fsl_list   crnl 
 Holds the "crnl-glob" globs. More...
      fsl_list   ignore 
 Holds the "ignore-glob" globs. More...
   }   globs
 Holds various glob lists. More...
   bool   ignoreDephantomizations 
 If true, skip "dephantomization" of phantom blobs. More...
   bool   inFinalVerify 
 Is used to tell the content-save internals that a "final verification" (a.k.a. More...
   bool   isCrosslinking 
 True if fsl__crosslink_begin() has been called but fsl__crosslink_end() is still pending. More...
   bool   isSyncing 
 True when a sync is active, to prevent recursive attempts to sync. More...
   short   manifestSetting 
 Cache for the manifest config setting, as used by fsl_ckout_manifest_setting(), with the caveat that if the setting changes after it is cached, we won't necessarily see that here! More...
   fsl_id_bag   markAvailableCache 
 An internal cache for fsl__content_mark_availble(). More...
   bool   markPrivate 
 Whether or not a running commit process should be marked as private. More...
   fsl__mcache   mcache 
 Parsed-deck cache. More...
   fsl_id_t   mtimeManifest 
 Infrastructure for fsl_mtime_of_manifest_file(). More...
   char *   projectCode 
 The "project-code" config option. More...
   fsl__ptl   ptl 
 Per-transaction-level cache. More...
   fsl_id_t   rcvId 
 Record ID of rcvfrom entry during commits. More...
   short   searchIndexExists 
 Records whether this repository has an FTS search index. More...
   short   seenDeltaManifest 
 Indicates whether or not this repo has ever seen a delta manifest. More...
   struct { 
   }   stmt
 Very-frequently-used SQL statements. More...
   char **   tempDirs 
 Holds a list of temp-dir names. More...
   bool   xlinkClustersOnly 
 Flag indicating that only cluster control artifacts should be processed by manifest crosslinking. More...
} cache
 A place for caching generic things.
struct { 
   fsl_deck   mf 
 The deck used for incrementally building certain parts of a checkin. More...
   fsl_id_bag   selectedIds 
 Holds a list of "selected files" in the form of vfile.id values. More...
} ckin
 State for incrementally preparing a checkin operation.
fsl_state clientState
 Can be used to tie client-specific data to the context.
fsl_confirmer confirmer
 Confirmation callback.
fsl_cx_config cxConfig
 A bitwise copy of the config object passed to fsl_cx_init() (or some default).
struct { 
   struct { 
      fsl_db   db 
 Holds the filename of the current checkout db and possibly related state. More...
      char *   dir 
 The directory part of an opened checkout db. More...
      fsl_size_t   dirLen 
 Optimization: fsl_strlen() of dir. More...
      double   mtime 
 Julian mtime of the checkout version, as reported by the [event] table. More...
      fsl_id_t   rid 
 The rid of the current checkout. More...
      fsl_uuid_str   uuid 
 The UUID of the current checkout. More...
   }   ckout
 Holds info directly related to a checkout database. More...
   struct { 
      fsl_db   db 
 Holds the filename of the current global config db and possibly related state. More...
   }   gconfig
 Holds info directly related to a global config database. More...
   fsl_size_t   nBegin 
   fsl_size_t   nCommit 
   fsl_size_t   nRollback 
   int   peakTxnLevel 
   struct { 
      fsl_db   db 
 Holds the filename of the current repo db and possibly related state. More...
      char *   mainBranch 
 The 'main-branch' repo config setting, defaulting to trunk. More...
      char *   user 
 The default user name, for operations which need one. More...
   }   repo
 Holds info directly related to a repo database. More...
} db
fsl_db * dbMain
 A pointer to the "main" db handle.
fsl_error error
 Holds error state.
fsl_flag32_t flags
 Flags, some (or one) of which is runtime-configurable by the client (see fsl_cx_flags_e).
volatile int interrupted
 Error flag which is intended to be set via signal handlers or a UI thread to tell this context to cancel any currently long-running operation.
struct { 
   struct { 
      fsl_size_t   nCached 
 Number of times the internal content cache was used. More...
      fsl_size_t   nCappedMaxSize 
 The number of times the content cache buffer was trimmed below the built-in maximum size. More...
      fsl_size_t   nPeakBufSize 
 The maximum buffer capacity the content buffer had at relenquish-time. More...
      fsl_size_t   nTotalUsed 
 Total of the number of "used" bytes of the content cache each time it was relinquished. More...
   }   content
} metrics
fsl_outputer output
 Output channel used by fsl_output() and friends.
struct { 
   fsl_buffer   buf [8] 
 Strictly-internal temporary buffers we intend to reuse many times, mostly for filename canonicalization, holding hash values, and small encoding/decoding tasks. More...
   fsl_buffer   emit 
 A scratchpad specific to fsl__cx_emit() and friends. More...
   fsl_buffer   format 
 A scratchpad specific to fsl_cx_format() and friends. More...
   short   next 
 A cursor hint to try to speed up fsl__cx_scratchpad() by about half a nanosecond, making it O(1) instead of O(small N) for the common case. More...
   bool   used [8] 
 Flags telling us which of this->buf is currenly in use. More...
} scratchpads
 Reuseable scratchpads for low-level file canonicalization buffering and whatnot.
struct { 
   fsl_list   customFields 
 Holds a list of (fsl_card_J*) records representing custom ticket table fields available in the db. More...
   bool   hasChng 
 Gets set to true (at some point) if the client has the ticketchng db table. More...
   bool   hasChngRid 
 Gets set to true (at some point) if the client has the ticketchng.rid db field. More...
   bool   hasCTime 
 Gets set to true (at some point) if the client has the ticket.tkt_ctime db field. More...
   bool   hasTicket 
 Gets set to true (at some point) if the client has the ticket db table. More...
   char *   statusColumn 
 The name of the ticket-table field which refers to a ticket's status. More...
   char *   titleColumn 
 The name of the ticket-table field which refers to a ticket's title. More...
} ticket
 Ticket-related information.
fsl_xlinker_list xlinkers
 List of callbacks for deck crosslinking purposes.

Detailed Description

The main Fossil "context" type.

This is the first argument to many Fossil library API routines, and holds all state related to a checkout and/or repository and/or global fossil configuration database(s).

An instance's lifetime looks something like this:

int rc;
fsl_cx * f = NULL; // ALWAYS initialize to NULL or results are undefined
rc = fsl_cx_init( &f, NULL );
assert(!rc);
rc = fsl_repo_open( f, "myrepo.fsl" );
...use the context, and clean up when done...
fsl_cx_finalize(f);
FSL_EXPORT int fsl_cx_init(fsl_cx **tgt, fsl_cx_config const *param)
Initializes a fsl_cx instance.
FSL_EXPORT int fsl_repo_open(fsl_cx *f, char const *repoDbFile)
Opens the given db file name as f's repository.
The main Fossil "context" type.
Definition internal.h:400

The contents of an fsl_cx instance are strictly private, for use only by APIs in this library. Any client-side dependencies on them will lead to undefined behaviour at some point.

Definition at line 400 of file internal.h.

Field Documentation

◆ allocStamp

void const* fsl_cx::allocStamp

Marker which tells us whether fsl_cx_finalize() needs to fsl_free() this instance or not.

Definition at line 453 of file internal.h.

◆ allowSymlinks

short fsl_cx::allowSymlinks

Cached copy of the allow-symlinks config option, because it is (hypothetically) needed on many stat() call.

Negative value=="not yet determined", 0==no, positive==yes. The negative value means we need to check the repo config resp. the global config to see if this is on.

As of late 2020, fossil(1) is much more restrictive with symlinks due to vulnerabilities which were discovered by a security researcher, and we definitely must not default any symlink-related features to enabled/on. As of Feb. 2021, my personal preference, and very likely plan of attack, is to only treat SCM'd symlinks as if symlinks support is disabled. It's very unlikely that i will implement "real" symlink support but would, solely for compatibility with fossil(1), be convinced to permit such changes if someone else wants to implement them. Patches are joyfully considered!

Definition at line 745 of file internal.h.

◆ binary

fsl_list fsl_cx::binary

Holds the "binary-glob" globs.

Definition at line 873 of file internal.h.

◆ blobContent

fsl__bccache fsl_cx::blobContent

fsl_content_get() cache.

Definition at line 816 of file internal.h.

◆ buf

fsl_buffer fsl_cx::buf[8]

Strictly-internal temporary buffers we intend to reuse many times, mostly for filename canonicalization, holding hash values, and small encoding/decoding tasks.

These must never be used for values which will be long-lived, nor are they intended to be used for large content, e.g. reading files, with the possible exception of holding versioned config settings, as those are typically rather small. They must also not be held while recursion back into a function holding one of these is possible.

If needed, the lengths of this->buf[] and this->used[] may be extended, but anything beyond 8, maybe 10, seems a bit extreme. They should only be increased if we find code paths which require it. As of this writing (2021-03-17), the peak concurrently used was 5. In any case fsl__cx_scratchpad() fails fatally if it needs more than it has, so we won't/can't fail to overlook such a case.

Definition at line 633 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::cache

A place for caching generic things.

◆ caseInsensitive

short fsl_cx::caseInsensitive

Specifies whether SOME repository-level file-name comparisons/searches will work case-insensitively.

<0 means not-yet-determined, 0 = no, >0 = yes.

Definition at line 725 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::ckin

State for incrementally preparing a checkin operation.

◆ [struct]

struct { ... } fsl_cx::ckout

Holds info directly related to a checkout database.

◆ clientState

fsl_state fsl_cx::clientState

Can be used to tie client-specific data to the context.

Its finalizer is called when fsl_cx_finalize() cleans up. The library does not use this state. It is intended primarily for tying, e.g., scripting-engine information to the context, e.g. mapping a scripting engine context to this one for later use in fossil-side callbacks.

Definition at line 591 of file internal.h.

◆ confirmer

fsl_confirmer fsl_cx::confirmer

Confirmation callback.

Used by routines which may have to interactively ask a user to confirm things.

Definition at line 565 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::content

◆ crnl

fsl_list fsl_cx::crnl

Holds the "crnl-glob" globs.

Definition at line 877 of file internal.h.

◆ customFields

fsl_list fsl_cx::customFields

Holds a list of (fsl_card_J*) records representing custom ticket table fields available in the db.

Each entry's flags member denotes (using fsl_card_J_flags) whether that field is used by the ticket or ticketchng tables.

TODO, eventually: add a separate type for these entries. We use fsl_card_J because the infrastructure is there and they provide what we need, but fsl_card_J::flags only exists for this list. A custom type would be smaller than fsl_card_J (only two members) but adding it requires adding some infrastructure which isn't worth the effort at the moment.

Definition at line 978 of file internal.h.

◆ cxConfig

fsl_cx_config fsl_cx::cxConfig

A bitwise copy of the config object passed to fsl_cx_init() (or some default).

Definition at line 459 of file internal.h.

◆ [struct] [1/2]

struct { ... } fsl_cx::db

◆ db [2/2]

fsl_db fsl_cx::db

Holds the filename of the current checkout db and possibly related state.

Holds the filename of the current global config db and possibly related state.

Holds the filename of the current repo db and possibly related state.

This handle is managed separately from the repo/ckout handles because this db is shared by all fossil instances are we have to ensure that we don't lock it for longer than necessary, thus this db may get opened and closed multiple times within even within a short-lived application.

Definition at line 470 of file internal.h.

◆ dbMain

fsl_db* fsl_cx::dbMain

A pointer to the "main" db handle.

Exactly which db IS the main db is, because we have three DBs, not generally knowble.

The internal management of fsl_cx's db handles has changed a couple of times. As of 2022-01-01 the following applies:

dbMain starts out NULL. When a repo or checkout is opened, dbMain is pointed at the first of those which is opened. When its partner is opened, it is ATTACHed to dbMain. dbMain->role holds a bitmask of fsl_dbrole_e values reflecting which roles are opened/attached to it.

The db-specific separate handles (this->{repo,ckout}.db) are used to store the name and file path to each db. ONE of those will have a db->dbh value of non-NULL, and that one is the instance which dbMain points to.

Whichever db is opened first gets its "main" schema aliased to the corresponding fsl_db_role_name() for is role so that SQL code need not care which db is "main" and which is "repo" or "ckout". (Sidebar: when this library was started, the ability to alias a db with another name did not exist, and thus we required a middle-man "main" db to which we ATTACHed the repo and checkout dbs.)

As of 20211230, f->config.db is its own handle, not ATTACHed with the others. Its db gets aliased to fsl_db_role_name(FSL_DBROLE_CONFIG).

Internal code should rely as little as possible on the actual arrangement of internal DB handles, and should use fsl_cx_db_repo(), fsl_cx_db_ckout(), and fsl_cx_db_config() to get a handle to the specific db they want. Whether or not they return the same handle or 3 different ones may change at some point, so the public API treats them as separate entities. That is especially important for the global config db, as that one is (for locking reason) almost certain to remain in its own db handle, independent of the repo/checkout dbs.

In any case, the internals very much rely on the repo and checkout dbs being accessible via a single db handle because the checkout-related SQL requires both dbs for most queries. The internals are less picky about the genuine layout of those handles (e.g. which one, if either, is the MAIN db).

Definition at line 447 of file internal.h.

◆ deltaContent

fsl_buffer fsl_cx::deltaContent

Reusable buffer for creating and fetching deltas via fsl_content_get() and fsl__content_deltify().

The number of allocations this actually saves is pretty small.

Definition at line 811 of file internal.h.

◆ dir

char* fsl_cx::dir

The directory part of an opened checkout db.

This is currently only set by fsl_ckout_open_dir(). It contains a trailing slash, largely because that simplifies porting fossil(1) code and appending filenames to this directory name to create absolute paths (a frequently-needed option).

Useful for doing absolute-to-relative path conversions for checking file lists.

Definition at line 481 of file internal.h.

◆ dirLen

fsl_size_t fsl_cx::dirLen

Optimization: fsl_strlen() of dir.

Guaranteed to be set to dir's length if dir is not NULL, else it will be 0.

Definition at line 486 of file internal.h.

◆ emit

fsl_buffer fsl_cx::emit

A scratchpad specific to fsl__cx_emit() and friends.

Definition at line 647 of file internal.h.

◆ error

fsl_error fsl_cx::error

Holds error state.

As a general rule, this information is updated only by routines which need to return more info than a simple integer error code. e.g. this is often used to hold db-driver-provided error state. It is not used by "simple" routines for which an integer code always suffices. APIs which set this should denote it with a comment like "updates the context's error state on error."

Definition at line 602 of file internal.h.

◆ fileContent

fsl_buffer fsl_cx::fileContent

A place for temporarily holding file content.

We use this in places where we have to loop over files and read their entire contents, so that we can reuse this buffer's memory if possible. The loop and the reading might be happening in different functions, though, and some care must be taken to avoid use in two functions concurrently.

All access to this must be acquired by fsl__cx_content_buffer() and released by fsl__cx_content_buffer_yield().

Definition at line 804 of file internal.h.

◆ flags

fsl_flag32_t fsl_cx::flags

Flags, some (or one) of which is runtime-configurable by the client (see fsl_cx_flags_e).

We can get rid of this and add the flags to the cache member along with the rest of them.

Definition at line 660 of file internal.h.

◆ format

fsl_buffer fsl_cx::format

A scratchpad specific to fsl_cx_format() and friends.

This one has to account for potential recursion.

Definition at line 652 of file internal.h.

◆ fstat

fsl_fstat fsl_cx::fstat

Internal optimization to avoid duplicate fsl_stat() calls across two functions in some cases.

Definition at line 847 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::gconfig

Holds info directly related to a global config database.

◆ [struct]

struct { ... } fsl_cx::globs

Holds various glob lists.

That said... these features are actually app-level stuff which the library itself does not resp. should not enforce. We can keep track of these for users but the library internals generally have no business using them.

THAT said... these have enough generic utility that we can justify storing them and optionally applying them. See fsl_checkin_opt for an example of where we do this.

◆ hasChng

bool fsl_cx::hasChng

Gets set to true (at some point) if the client has the ticketchng db table.

Definition at line 996 of file internal.h.

◆ hasChngRid

bool fsl_cx::hasChngRid

Gets set to true (at some point) if the client has the ticketchng.rid db field.

Definition at line 1002 of file internal.h.

◆ hasCTime

bool fsl_cx::hasCTime

Gets set to true (at some point) if the client has the ticket.tkt_ctime db field.

Definition at line 990 of file internal.h.

◆ hasTicket

bool fsl_cx::hasTicket

Gets set to true (at some point) if the client has the ticket db table.

Definition at line 984 of file internal.h.

◆ ignore

fsl_list fsl_cx::ignore

Holds the "ignore-glob" globs.

Definition at line 869 of file internal.h.

◆ ignoreDephantomizations

bool fsl_cx::ignoreDephantomizations

If true, skip "dephantomization" of phantom blobs.

This is a detail from fossil(1) with as-yet-undetermined utility. It's apparently only used during the remote-sync process, which this API does not (as of 2021-10) yet have.

Definition at line 686 of file internal.h.

◆ inFinalVerify

bool fsl_cx::inFinalVerify

Is used to tell the content-save internals that a "final verification" (a.k.a.

verify-before-commit) is underway.

Definition at line 712 of file internal.h.

◆ interrupted

volatile int fsl_cx::interrupted

Error flag which is intended to be set via signal handlers or a UI thread to tell this context to cancel any currently long-running operation.

Not all operations honor this check, but the ones which are prone to "exceedingly long" operation (at least a few seconds) do.

Definition at line 669 of file internal.h.

◆ isCrosslinking

bool fsl_cx::isCrosslinking

True if fsl__crosslink_begin() has been called but fsl__crosslink_end() is still pending.

Definition at line 699 of file internal.h.

◆ isSyncing

bool fsl_cx::isSyncing

True when a sync is active, to prevent recursive attempts to sync.

Definition at line 718 of file internal.h.

◆ mainBranch

char* fsl_cx::mainBranch

The 'main-branch' repo config setting, defaulting to trunk.

Definition at line 520 of file internal.h.

◆ manifestSetting

short fsl_cx::manifestSetting

Cache for the manifest config setting, as used by fsl_ckout_manifest_setting(), with the caveat that if the setting changes after it is cached, we won't necessarily see that here!

Definition at line 778 of file internal.h.

◆ markAvailableCache

fsl_id_bag fsl_cx::markAvailableCache

An internal cache for fsl__content_mark_availble().

This is only used in that routine but it's called frequently during checkins and sync.

Definition at line 828 of file internal.h.

◆ markPrivate

bool fsl_cx::markPrivate

Whether or not a running commit process should be marked as private.

This member is used for communicating this flag through multiple levels of API.

Definition at line 693 of file internal.h.

◆ mcache

fsl__mcache fsl_cx::mcache

Parsed-deck cache.

Definition at line 852 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::metrics

◆ mf

fsl_deck fsl_cx::mf

The deck used for incrementally building certain parts of a checkin.

Definition at line 558 of file internal.h.

◆ mtime

double fsl_cx::mtime

Julian mtime of the checkout version, as reported by the [event] table.

Definition at line 501 of file internal.h.

◆ mtimeManifest

fsl_id_t fsl_cx::mtimeManifest

Infrastructure for fsl_mtime_of_manifest_file().

It remembers the previous RID so that it knows when it has to invalidate/rebuild its ancestry cache.

Definition at line 835 of file internal.h.

◆ nBegin

fsl_size_t fsl_cx::nBegin

Definition at line 539 of file internal.h.

◆ nCached

fsl_size_t fsl_cx::nCached

Number of times the internal content cache was used.

Definition at line 1022 of file internal.h.

◆ nCappedMaxSize

fsl_size_t fsl_cx::nCappedMaxSize

The number of times the content cache buffer was trimmed below the built-in maximum size.

Definition at line 1039 of file internal.h.

◆ nCommit

fsl_size_t fsl_cx::nCommit

Definition at line 540 of file internal.h.

◆ next

short fsl_cx::next

A cursor hint to try to speed up fsl__cx_scratchpad() by about half a nanosecond, making it O(1) instead of O(small N) for the common case.

Definition at line 643 of file internal.h.

◆ nPeakBufSize

fsl_size_t fsl_cx::nPeakBufSize

The maximum buffer capacity the content buffer had at relenquish-time.

Definition at line 1033 of file internal.h.

◆ nRollback

fsl_size_t fsl_cx::nRollback

Definition at line 541 of file internal.h.

◆ nTotalUsed

fsl_size_t fsl_cx::nTotalUsed

Total of the number of "used" bytes of the content cache each time it was relinquished.

Definition at line 1027 of file internal.h.

◆ output

fsl_outputer fsl_cx::output

Output channel used by fsl_output() and friends.

This was added primarily so that fossil client apps can share a single output channel which the user can swap out, e.g. to direct all output to a UI widget or a file.

Though the library has adamantly avoided adding a "warning" output channel, features like:

https://fossil-scm.org/home/info/52a389d3dbd4b6cc

arguably call for one.

Definition at line 581 of file internal.h.

◆ peakTxnLevel

int fsl_cx::peakTxnLevel

Definition at line 538 of file internal.h.

◆ projectCode

char* fsl_cx::projectCode

The "project-code" config option.

This is primarily for use with the sync protocol. It is managed by fsl_repo_project_code().

Definition at line 841 of file internal.h.

◆ ptl

fsl__ptl fsl_cx::ptl

Per-transaction-level cache.

Definition at line 821 of file internal.h.

◆ rcvId

fsl_id_t fsl_cx::rcvId

Record ID of rcvfrom entry during commits.

This is likely to remain unused in libf until/unless the sync protocol is implemented.

2025-07-21: this will probably need to be manipulated by fsl__xfer. rcvId is used in fsl__content_put_ex() but it's historically (in this library, not fossil(1)) always been 0. Setting the rcvId requires high-level info that fossil(1) uses, and it's only really relevant for the sync layer.

Definition at line 791 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::repo

Holds info directly related to a repo database.

◆ rid

fsl_id_t fsl_cx::rid

The rid of the current checkout.

May be 0 for an empty repo/checkout. Must be negative if not yet known.

Definition at line 491 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::scratchpads

Reuseable scratchpads for low-level file canonicalization buffering and whatnot.

Not intended for huge content: use this->fileContent for that. This list should stay relatively short, as should the buffers (a few kb each, at most).

See also
fsl__cx_scratchpad()
fsl__cx_scratchpad_yield()

◆ searchIndexExists

short fsl_cx::searchIndexExists

Records whether this repository has an FTS search index.

<0=undetermined, 0=no, >0=yes.

Definition at line 770 of file internal.h.

◆ seenDeltaManifest

short fsl_cx::seenDeltaManifest

Indicates whether or not this repo has ever seen a delta manifest.

If none has ever been seen then the repository will prefer to use baseline (non-delta) manifests. Once a delta is seen in the repository, the checkin algorithm is free to choose deltas later on unless it's otherwise prohibited, e.g. by the forbid-delta-manifests config db setting.

This article provides an overview to the topic delta manifests and essentially debunks their ostensible benefits:

https://fossil-scm.org/home/doc/tip/www/delta-manifests.md

Values: negative==undetermined, 0==no, positive==yes. This is updated when a repository is first opened and when new content is written to it.

Definition at line 764 of file internal.h.

◆ selectedIds

fsl_id_bag fsl_cx::selectedIds

Holds a list of "selected files" in the form of vfile.id values.

Definition at line 552 of file internal.h.

◆ statusColumn

char* fsl_cx::statusColumn

The name of the ticket-table field which refers to a ticket's status.

Default = "status". The bytes are owned by this object.

Definition at line 1014 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::stmt

Very-frequently-used SQL statements.

◆ tempDirs

char** fsl_cx::tempDirs

Holds a list of temp-dir names.

Must be allocated using fsl_temp_dirs_get() and freed using fsl_temp_dirs_free().

Definition at line 956 of file internal.h.

◆ [struct]

struct { ... } fsl_cx::ticket

Ticket-related information.

◆ titleColumn

char* fsl_cx::titleColumn

The name of the ticket-table field which refers to a ticket's title.

Default = "title". The bytes are owned by this object.

Definition at line 1008 of file internal.h.

◆ used

bool fsl_cx::used[8]

Flags telling us which of this->buf is currenly in use.

Definition at line 637 of file internal.h.

◆ user

char* fsl_cx::user

The default user name, for operations which need one.

See fsl_cx_user_set().

Definition at line 517 of file internal.h.

◆ uuid

fsl_uuid_str fsl_cx::uuid

The UUID of the current checkout.

Only set if this->rid is positive. Owned by the containing fsl_cx object.

Definition at line 496 of file internal.h.

◆ xlinkClustersOnly

bool fsl_cx::xlinkClustersOnly

Flag indicating that only cluster control artifacts should be processed by manifest crosslinking.

This will only be relevant if/when the sync protocol is implemented.

Definition at line 706 of file internal.h.

◆ xlinkers

fsl_xlinker_list fsl_cx::xlinkers

List of callbacks for deck crosslinking purposes.

Definition at line 674 of file internal.h.


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