ExperimentalFeatures.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include <atomic>
#include <iostream>
#include <map>
#include <mutex>
#include <string>
 
namespace ChimeraTK {
 
  class ExperimentalFeatures {
   public:
    static void enable() {
      if(isEnabled) return;
      std::cerr << "*******************************************************************************" << std::endl;
      std::cerr << " Experimental features are now enabled in ChimeraTK DeviceAccess" << std::endl;
      std::cerr << "*******************************************************************************" << std::endl;
      isEnabled = true;
    }
 
    static void check(const std::string& featureName) {
      if(!isEnabled) {
        std::cerr << "You are using the experimental feature '" << featureName
                  << "' but do not have experimental features enabled!" << std::endl;
        std::terminate();
      }
      std::lock_guard<std::mutex> guard(reminder.lock_useCount);
      reminder.useCount[featureName]++;
    }
 
   private:
    static std::atomic<bool> isEnabled;
 
    class Reminder {
      friend class ExperimentalFeatures;
      Reminder() = default;
      ~Reminder() {
        if(ExperimentalFeatures::isEnabled) {
          std::cerr << "*******************************************************************************" << std::endl;
          std::cerr << " Experimental features were enabled in ChimeraTK DeviceAccess" << std::endl;
          std::cerr << " The following features were used (use count):" << std::endl;
          for(auto& uc : useCount) {
            std::cerr << "  - " << uc.first << " (" << uc.second << ")" << std::endl;
          }
          std::cerr << "*******************************************************************************" << std::endl;
        }
      }
      std::map<std::string, uint64_t> useCount;
      std::mutex lock_useCount;
    };
    static Reminder reminder;
  };
} // namespace ChimeraTK