GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-07-07 20:06:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #347 from djmitche/take-from-lists

Browse source 
Allow taking from pointer lists
This commit is contained in:
Dustin J. Mitchell 2022-03-15 17:57:48 -04:00 • committed by GitHub
commit 8e5ab78440
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 278 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

32
lib/taskchampion.h
View file

@ -304,7 +304,7 @@ typedef struct TCAnnotationList {
* array of annotations. these remain owned by the TCAnnotationList instance and will be freed by
* tc_annotation_list_free. This pointer is never NULL for a valid TCAnnotationList.
*/
const struct TCAnnotation *items;
struct TCAnnotation *items;
} TCAnnotationList;
/**
@ -336,13 +336,16 @@ typedef struct TCKVList {
* array of TCKV's. these remain owned by the TCKVList instance and will be freed by
* tc_kv_list_free. This pointer is never NULL for a valid TCKVList.
*/
const struct TCKV *items;
struct TCKV *items;
} TCKVList;
/**
* TCTaskList represents a list of tasks.
*
* The content of this struct must be treated as read-only.
* The content of this struct must be treated as read-only: no fields or anything they reference
* should be modified directly by C code.
*
* When an item is taken from this list, its pointer in `items` is set to NULL.
*/
typedef struct TCTaskList {
/**
@ -358,7 +361,7 @@ typedef struct TCTaskList {
* will be freed by tc_task_list_free. This pointer is never NULL for a valid TCTaskList,
* and the *TCTaskList at indexes 0..len-1 are not NULL.
*/
struct TCTask *const *items;
struct TCTask **items;
} TCTaskList;
/**
@ -388,7 +391,7 @@ typedef struct TCUuidList {
* array of uuids. these remain owned by the TCUuidList instance and will be freed by
* tc_uuid_list_free. This pointer is never NULL for a valid TCUuidList.
*/
const struct TCUuid *items;
struct TCUuid *items;
} TCUuidList;
/**
@ -410,7 +413,7 @@ typedef struct TCStringList {
* be freed by tc_string_list_free. This pointer is never NULL for a valid TCStringList, and the
* *TCStringList at indexes 0..len-1 are not NULL.
*/
const struct TCString *items;
struct TCString *items;
} TCStringList;
/**
@ -449,7 +452,7 @@ typedef struct TCUdaList {
* array of UDAs. These remain owned by the TCUdaList instance and will be freed by
* tc_uda_list_free. This pointer is never NULL for a valid TCUdaList.
*/
const struct TCUda *items;
struct TCUda *items;
} TCUdaList;
#ifdef __cplusplus
@ -923,13 +926,26 @@ struct TCString tc_task_error(struct TCTask *task);
*/
void tc_task_free(struct TCTask *task);
/**
* Take an item from a TCTaskList. After this call, the indexed item is no longer associated
* with the list and becomes the caller's responsibility, just as if it had been returned from
* `tc_replica_get_task`.
*
* The corresponding element in the `items` array will be set to NULL. If that field is already
* NULL (that is, if the item has already been taken), this function will return NULL. If the
* index is out of bounds, this function will also return NULL.
*
* The passed TCTaskList remains owned by the caller.
*/
struct TCTask *tc_task_list_take(struct TCTaskList *tasks, size_t index);
/**
* Free a TCTaskList instance. The instance, and all TCTaskList it contains, must not be used after
* this call.
*
* When this call returns, the `items` pointer will be NULL, signalling an invalid TCTaskList.
*/
void tc_task_list_free(struct TCTaskList *tctasks);
void tc_task_list_free(struct TCTaskList *tasks);
/**
* Free a TCUda instance. The instance, and the TCStrings it contains, must not be used