Deprecator.h

Go to the documentation of this file.

#ifndef _utl_deprecator_h_
#define _utl_deprecator_h_

#include <string>
#include <map>
#include <utl/AugerException.h>
#include <utl/Singleton.h>


namespace utl {

  class Deprecator : public Singleton<Deprecator> {
  public:

    Deprecator() { }


    void Deprecated(const std::string& theInterface,
                    const std::string& theVersion,
                    const std::string& theNewUsageHint);

    bool IsEmpty() const { return fData.empty(); }

    std::size_t GetSize() const { return fData.size(); }

    std::string GetReport() const;

  private:
    class DeprecationInfo {
    public:
      DeprecationInfo(const std::string& theHint,
                      const std::string& theVersion)
        : fHint(theHint), fVersion(theVersion), fCount(1) { }

      void IncrementUsage() { ++fCount; }

      const std::string& GetHint() const { return fHint; }

      const std::string& GetVersion() const { return fVersion; }

      std::size_t GetCount() const { return fCount; }
    private:
      std::string fHint;
      std::string fVersion;
      std::size_t fCount;
    };

    typedef std::map<std::string, DeprecationInfo> DataMap;
    DataMap fData;
  };

}


#endif