ProgressLogger.h

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <string>
 
#include <vrs/VrsExport.h>
 
namespace vrs {
 
using std::string;
 
class VRS_API ProgressLogger {
 public:
  static constexpr double kDefaultUpdateDelay = 2;
  explicit ProgressLogger(bool detailedProgress = false, double updateDelay = kDefaultUpdateDelay);
  virtual ~ProgressLogger();
 
  virtual void setStepCount(int stepCount);
  virtual void setDetailedProgress(bool detailedProgress);
  bool getDetailedProgress() const {
    return detailedProgress_;
  }
 
  virtual bool logNewStep(const string& stepName, size_t progress = 0, size_t maxProgress = 100);
 
  bool logProgress(const string& stepName, size_t progress = 0, size_t maxProgress = 100) {
    return logProgress(stepName, progress, maxProgress, false);
  }
  bool logProgress(const string& stepName, int64_t progress, int64_t maxProgress) {
    return logProgress(
        stepName, static_cast<size_t>(progress), static_cast<size_t>(maxProgress), false);
  }
 
  virtual bool logStatus(const string& stepName, int status = 0);
 
  virtual bool logDuration(const string& operationName, double duration, int precision = 1);
 
 protected:
  virtual bool
  logProgress(const string& stepName, size_t progress, size_t maxProgress, bool newStep);
  virtual void logMessage(const string& message);
  virtual void logErrorMessage(const string& message);
  virtual void updateStep(size_t progress = 0, size_t maxProgress = 100);
  virtual void updateNextProgressTime();
  virtual bool shouldKeepGoing();
 
 protected:
  bool detailedProgress_;
  double updateDelay_;
  int stepNumber_;
  int stepCount_;
  double nextProgressTime_;
};
 
class VRS_API SilentLogger : public ProgressLogger {
 public:
  ~SilentLogger() override;
  bool logProgress(const string&, size_t = 0, size_t = 100, bool = false) override {
    return true;
  }
  bool logStatus(const string&, int = 0) override {
    return true;
  }
  bool logDuration(const string& /*operationName*/, double /*duration*/, int /*precision*/ = 1)
      override {
    return true;
  }
};
 
} // namespace vrs