From d23bff8a2eee13eec0724aabe5d9a86b126c4b2c Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Mon, 22 Jun 2009 05:32:04 +0000 Subject: Add interface for performing long tasks in background, while giving a progress indication. --- libdimension/dimension/array.h | 5 ++-- libdimension/dimension/progress.h | 53 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 libdimension/dimension/progress.h (limited to 'libdimension/dimension') diff --git a/libdimension/dimension/array.h b/libdimension/dimension/array.h index 30a119d..5abdf48 100644 --- a/libdimension/dimension/array.h +++ b/libdimension/dimension/array.h @@ -48,10 +48,11 @@ void dmnsn_array_set(dmnsn_array *array, size_t i, const void *obj); void dmnsn_array_resize(dmnsn_array *array, size_t length); -/* Thread-unsafe! Don't give multiple threads the same raw pointer... */ +/* Manual locking */ + void *dmnsn_array_at(dmnsn_array *array, size_t i); +void dmnsn_array_resize_unlocked(dmnsn_array *array, size_t length); -/* Manual locking */ void dmnsn_array_rdlock(const dmnsn_array *array); void dmnsn_array_wrlock(dmnsn_array *array); void dmnsn_array_unlock(const dmnsn_array *array); diff --git a/libdimension/dimension/progress.h b/libdimension/dimension/progress.h new file mode 100644 index 0000000..d436b5d --- /dev/null +++ b/libdimension/dimension/progress.h @@ -0,0 +1,53 @@ +/************************************************************************* + * Copyright (C) 2008 Tavian Barnes * + * * + * This file is part of The Dimension Library. * + * * + * The Dimension Library is free software; you can redistribute it and/ * + * or modify it under the terms of the GNU Lesser General Public License * + * as published by the Free Software Foundation; either version 3 of the * + * License, or (at your option) any later version. * + * * + * The Dimension Library is distributed in the hope that it will be * + * useful, but WITHOUT ANY WARRANTY; without even the implied warranty * + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this program. If not, see * + * . * + *************************************************************************/ + +#ifndef DIMENSION_PROGRESS_H +#define DIMENSION_PROGRESS_H + +#include + +/* A single element in an array for dmnsn_progress. Progress of this item is + progress/total. */ +typedef struct { + unsigned int progress, total; +} dmnsn_progress_element; + +typedef struct { + /* Array of progress elements. Progress is given by P(0), where + P(i) = (elements[i].progress + P(i + 1))/elements[i].total. */ + dmnsn_array *elements; + + /* The worker thread */ + pthread_t thread; +} dmnsn_progress; + +dmnsn_progress *dmnsn_new_progress(); +void dmnsn_delete_progress(dmnsn_progress *progress); + +/* This joins the worker thread and returns it's integer return value in + addition to deleting `progress' */ +int dmnsn_finish_progress(dmnsn_progress *progress); + +double dmnsn_get_progress(const dmnsn_progress* progress); + +void dmnsn_new_progress_element(dmnsn_progress* progress, unsigned int total); +void dmnsn_increment_progress(dmnsn_progress* progress); + +#endif /* DIMENSION_PROGRESS_H */ -- cgit v1.2.3