summaryrefslogtreecommitdiffstats
path: root/libdimension/progress.c
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2011-10-19 12:37:32 -0400
committerTavian Barnes <tavianator@gmail.com>2011-10-19 14:19:43 -0400
commite9810a7b1aae15320e58371b657a2f963562834d (patch)
treec74c37b635d7c35773d9b9b57e579763ff946300 /libdimension/progress.c
parentb14a87691f42be83691861b97a2f410c25c9c4bb (diff)
downloaddimension-e9810a7b1aae15320e58371b657a2f963562834d.tar.xz
Rename progress objects to future objects.
Diffstat (limited to 'libdimension/progress.c')
-rw-r--r--libdimension/progress.c165
1 files changed, 0 insertions, 165 deletions
diff --git a/libdimension/progress.c b/libdimension/progress.c
deleted file mode 100644
index f2ff25f..0000000
--- a/libdimension/progress.c
+++ /dev/null
@@ -1,165 +0,0 @@
-/*************************************************************************
- * Copyright (C) 2009-2011 Tavian Barnes <tavianator@tavianator.com> *
- * *
- * 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 *
- * <http://www.gnu.org/licenses/>. *
- *************************************************************************/
-
-/**
- * @file
- * Progress objects.
- */
-
-#include "dimension-internal.h"
-#include <pthread.h>
-
-/* Allocate a new dmnsn_progress* */
-dmnsn_progress *
-dmnsn_new_progress(void)
-{
- dmnsn_progress *progress = dmnsn_malloc(sizeof(dmnsn_progress));
- progress->progress = 0;
- progress->total = 1;
-
- /* Initialize the rwlock, condition variable, and mutex */
-
- progress->rwlock = dmnsn_malloc(sizeof(pthread_rwlock_t));
- dmnsn_initialize_rwlock(progress->rwlock);
-
- progress->cond = dmnsn_malloc(sizeof(pthread_cond_t));
- dmnsn_initialize_cond(progress->cond);
-
- progress->mutex = dmnsn_malloc(sizeof(pthread_mutex_t));
- dmnsn_initialize_mutex(progress->mutex);
-
- progress->min_wait = dmnsn_malloc(sizeof(double));
- *progress->min_wait = 1.0;
-
- return progress;
-}
-
-/* Join the worker thread and delete `progress'. */
-int
-dmnsn_finish_progress(dmnsn_progress *progress)
-{
- void *ptr;
- int retval = -1;
-
- if (progress) {
- /* Get the thread's return value */
- dmnsn_join_thread(progress->thread, &ptr);
- if (ptr && ptr != PTHREAD_CANCELED) {
- retval = *(int *)ptr;
- dmnsn_free(ptr);
- }
-
- /* Free the progress object */
-
- dmnsn_free(progress->min_wait);
-
- dmnsn_destroy_mutex(progress->mutex);
- dmnsn_free(progress->mutex);
-
- dmnsn_destroy_cond(progress->cond);
- dmnsn_free(progress->cond);
-
- dmnsn_destroy_rwlock(progress->rwlock);
- dmnsn_free(progress->rwlock);
-
- dmnsn_free(progress);
- }
-
- return retval;
-}
-
-/* Cancel a background thread */
-void
-dmnsn_cancel_progress(dmnsn_progress *progress)
-{
- pthread_cancel(progress->thread);
-}
-
-/* Get the current progress of the worker thread, in [0.0, 1.0] */
-double
-dmnsn_get_progress(const dmnsn_progress *progress)
-{
- double prog;
-
- dmnsn_read_lock(progress->rwlock);
- prog = (double)progress->progress/progress->total;
- dmnsn_unlock_rwlock(progress->rwlock);
-
- return prog;
-}
-
-/* Wait until dmnsn_get_progress(progress) >= prog */
-void
-dmnsn_wait_progress(const dmnsn_progress *progress, double prog)
-{
- dmnsn_lock_mutex(progress->mutex);
- while (dmnsn_get_progress(progress) < prog) {
- /* Set the minimum waited-on value */
- if (prog < *progress->min_wait)
- *progress->min_wait = prog;
-
- dmnsn_cond_wait(progress->cond, progress->mutex);
- }
- dmnsn_unlock_mutex(progress->mutex);
-}
-
-/* Set the total number of loop iterations */
-void
-dmnsn_set_progress_total(dmnsn_progress *progress, size_t total)
-{
- dmnsn_write_lock(progress->rwlock);
- progress->total = total;
- dmnsn_unlock_rwlock(progress->rwlock);
-}
-
-/* Increment the number of completed loop iterations */
-void
-dmnsn_increment_progress(dmnsn_progress *progress)
-{
- /* Allow a thread to be canceled whenever it increments a progress object --
- this is close to PTHREAD_CANCEL_ASYNCHRONOUS but allows consistent state
- on cancellation */
- pthread_testcancel();
-
- dmnsn_write_lock(progress->rwlock);
- ++progress->progress;
- dmnsn_unlock_rwlock(progress->rwlock);
-
- dmnsn_lock_mutex(progress->mutex);
- if (dmnsn_get_progress(progress) >= *progress->min_wait) {
- *progress->min_wait = 1.0;
-
- dmnsn_cond_broadcast(progress->cond);
- }
- dmnsn_unlock_mutex(progress->mutex);
-}
-
-/* Immediately set to 100% completion */
-void
-dmnsn_done_progress(dmnsn_progress *progress)
-{
- dmnsn_write_lock(progress->rwlock);
- progress->progress = progress->total;
- dmnsn_unlock_rwlock(progress->rwlock);
-
- dmnsn_lock_mutex(progress->mutex);
- dmnsn_cond_broadcast(progress->cond);
- dmnsn_unlock_mutex(progress->mutex);
-}