1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
|
/******************************************************************************
*
* Project: CPL - Common Portability Library
* Author: Frank Warmerdam, warmerdam@pobox.com
* Purpose: Progress function implementations.
*
******************************************************************************
* Copyright (c) 2013, Frank Warmerdam
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include "cpl_progress.h"
#include <cmath>
#include <cstdio>
#include <algorithm>
#include "cpl_conv.h"
/************************************************************************/
/* GDALDummyProgress() */
/************************************************************************/
/**
* \brief Stub progress function.
*
* This is a stub (does nothing) implementation of the GDALProgressFunc()
* semantics. It is primarily useful for passing to functions that take
* a GDALProgressFunc() argument but for which the application does not want
* to use one of the other progress functions that actually do something.
*/
int CPL_STDCALL GDALDummyProgress(double /* dfComplete */,
const char * /* pszMessage */,
void * /* pData */)
{
return TRUE;
}
/************************************************************************/
/* GDALScaledProgress() */
/************************************************************************/
typedef struct
{
GDALProgressFunc pfnProgress;
void *pData;
double dfMin;
double dfMax;
} GDALScaledProgressInfo;
/**
* \brief Scaled progress transformer.
*
* This is the progress function that should be passed along with the
* callback data returned by GDALCreateScaledProgress().
*/
int CPL_STDCALL GDALScaledProgress(double dfComplete, const char *pszMessage,
void *pData)
{
GDALScaledProgressInfo *psInfo =
reinterpret_cast<GDALScaledProgressInfo *>(pData);
// Optimization if GDALCreateScaledProgress() provided with
// GDALDummyProgress.
if (psInfo == nullptr)
return TRUE;
return psInfo->pfnProgress(dfComplete * (psInfo->dfMax - psInfo->dfMin) +
psInfo->dfMin,
pszMessage, psInfo->pData);
}
/************************************************************************/
/* GDALCreateScaledProgress() */
/************************************************************************/
/**
* \brief Create scaled progress transformer.
*
* Sometimes when an operations wants to report progress it actually
* invokes several subprocesses which also take GDALProgressFunc()s,
* and it is desirable to map the progress of each sub operation into
* a portion of 0.0 to 1.0 progress of the overall process. The scaled
* progress function can be used for this.
*
* For each subsection a scaled progress function is created and
* instead of passing the overall progress func down to the sub functions,
* the GDALScaledProgress() function is passed instead.
*
* @param dfMin the value to which 0.0 in the sub operation is mapped.
* @param dfMax the value to which 1.0 is the sub operation is mapped.
* @param pfnProgress the overall progress function.
* @param pData the overall progress function callback data.
*
* @return pointer to pass as pProgressArg to sub functions. Should be freed
* with GDALDestroyScaledProgress().
*
* Example:
*
* \code
* int MyOperation( ..., GDALProgressFunc pfnProgress, void *pProgressData );
*
* {
* void *pScaledProgress;
*
* pScaledProgress = GDALCreateScaledProgress( 0.0, 0.5, pfnProgress,
* pProgressData );
* GDALDoLongSlowOperation( ..., GDALScaledProgress, pScaledProgress );
* GDALDestroyScaledProgress( pScaledProgress );
*
* pScaledProgress = GDALCreateScaledProgress( 0.5, 1.0, pfnProgress,
* pProgressData );
* GDALDoAnotherOperation( ..., GDALScaledProgress, pScaledProgress );
* GDALDestroyScaledProgress( pScaledProgress );
*
* return ...;
* }
* \endcode
*/
void *CPL_STDCALL GDALCreateScaledProgress(double dfMin, double dfMax,
GDALProgressFunc pfnProgress,
void *pData)
{
if (pfnProgress == nullptr || pfnProgress == GDALDummyProgress)
return nullptr;
GDALScaledProgressInfo *psInfo = static_cast<GDALScaledProgressInfo *>(
CPLCalloc(sizeof(GDALScaledProgressInfo), 1));
if (std::abs(dfMin - dfMax) < 0.0000001)
dfMax = dfMin + 0.01;
psInfo->pData = pData;
psInfo->pfnProgress = pfnProgress;
psInfo->dfMin = dfMin;
psInfo->dfMax = dfMax;
return static_cast<void *>(psInfo);
}
/************************************************************************/
/* GDALDestroyScaledProgress() */
/************************************************************************/
/**
* \brief Cleanup scaled progress handle.
*
* This function cleans up the data associated with a scaled progress function
* as returned by GADLCreateScaledProgress().
*
* @param pData scaled progress handle returned by GDALCreateScaledProgress().
*/
void CPL_STDCALL GDALDestroyScaledProgress(void *pData)
{
CPLFree(pData);
}
/************************************************************************/
/* GDALTermProgress() */
/************************************************************************/
/**
* \fn GDALTermProgress(double, const char*, void*)
* \brief Simple progress report to terminal.
*
* This progress reporter prints simple progress report to the
* terminal window. The progress report generally looks something like
* this:
\verbatim
0...10...20...30...40...50...60...70...80...90...100 - done.
\endverbatim
* Every 2.5% of progress another number or period is emitted. Note that
* GDALTermProgress() uses internal static data to keep track of the last
* percentage reported and will get confused if two terminal based progress
* reportings are active at the same time.
*
* The GDALTermProgress() function maintains an internal memory of the
* last percentage complete reported in a static variable, and this makes
* it unsuitable to have multiple GDALTermProgress()'s active either in a
* single thread or across multiple threads.
*
* @param dfComplete completion ratio from 0.0 to 1.0.
* @param pszMessage optional message.
* @param pProgressArg ignored callback data argument.
*
* @return Always returns TRUE indicating the process should continue.
*/
int CPL_STDCALL GDALTermProgress(double dfComplete,
CPL_UNUSED const char *pszMessage,
CPL_UNUSED void *pProgressArg)
{
const int nThisTick =
std::min(40, std::max(0, static_cast<int>(dfComplete * 40.0)));
// Have we started a new progress run?
static int nLastTick = -1;
if (nThisTick < nLastTick && nLastTick >= 39)
nLastTick = -1;
if (nThisTick <= nLastTick)
return TRUE;
while (nThisTick > nLastTick)
{
++nLastTick;
if (nLastTick % 4 == 0)
fprintf(stdout, "%d", (nLastTick / 4) * 10);
else
fprintf(stdout, ".");
}
if (nThisTick == 40)
fprintf(stdout, " - done.\n");
else
fflush(stdout);
return TRUE;
}
|