Clustal Omega: src/clustal/progress.h Source File

00001 /*********************************************************************
00002  * Clustal Omega - Multiple sequence alignment
00003  *
00004  * Copyright (C) 2010 University College Dublin
00005  *
00006  * Clustal-Omega is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU General Public License as
00008  * published by the Free Software Foundation; either version 2 of the
00009  * License, or (at your option) any later version.
00010  *
00011  * This file is part of Clustal-Omega.
00012  *
00013  ********************************************************************/
00014 
00015 /*
00016  *  RCS $Id: progress.h 193 2011-02-07 15:45:21Z andreas $
00017  */
00018 
00019 
00020 #ifndef CLUSTALO_PROGRESS_H
00021 #define CLUSTALO_PROGRESS_H
00022 
00023 #include "squid/stopwatch.h"
00024 
00025 typedef struct {
00026     /* where to write to */
00027     FILE *prFile;
00028     /* prefix printed before each step */
00029     char *pcPrefix;
00030     bool bPrintCR;
00031     char pcLastLogMsg[1024];
00032     Stopwatch_t *prStopwatch;
00033 } progress_t;
00034 
00035 
00036 extern void
00037 NewProgress(progress_t **pprProgress, FILE *prFile, char *pcPrefix, bool bPrintCR);
00038 
00039 extern void
00040 FreeProgress(progress_t **pprProgress);
00041 
00042 extern void
00043 ProgressLog(progress_t *prProgress, 
00044             unsigned long int iStep, unsigned long int iTotalSteps,
00045             bool bForceOutput);
00046 
00047 extern void
00048 ProgressDone(progress_t *pprProgress);
00049 
00050 #endif