gz/math/SemanticVersion.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * 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.
 *
*/
 
#ifndef GZ_MATH_SEMANTICVERSION_HH_
#define GZ_MATH_SEMANTICVERSION_HH_
 
#include <memory>
#include <string>
#include <gz/math/Helpers.hh>
#include <gz/math/config.hh>
 
namespace ignition
{
  namespace math
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    // Forward declare private data class
    class SemanticVersionPrivate;
 
    class IGNITION_MATH_VISIBLE SemanticVersion
    {
      public: SemanticVersion();
 
      public: explicit SemanticVersion(const std::string &_v);
 
      public: SemanticVersion(const SemanticVersion &_copy);
 
      public: SemanticVersion &operator=(const SemanticVersion &_other);
 
      public: SemanticVersion(const unsigned int _major,
                              const unsigned int _minor = 0,
                              const unsigned int _patch = 0,
                              const std::string &_prerelease = "",
                              const std::string &_build = "");
 
      public: ~SemanticVersion();
 
      public: bool Parse(const std::string &_versionStr);
 
      public: std::string Version() const;
 
      public: unsigned int Major() const;
 
      public: unsigned int Minor() const;
 
      public: unsigned int Patch() const;
 
      public: std::string Prerelease() const;
 
      public: std::string Build() const;
 
      public: bool operator<(const SemanticVersion &_other) const;
 
      public: bool operator<=(const SemanticVersion &_other) const;
 
      public: bool operator>(const SemanticVersion &_other) const;
 
      public: bool operator>=(const SemanticVersion &_other) const;
 
      public: bool operator==(const SemanticVersion &_other) const;
 
      public: bool operator!=(const SemanticVersion &_other) const;
 
      public: friend std::ostream &operator<<(std::ostream &_out,
                                              const SemanticVersion &_v)
      {
        _out << _v.Version();
        return _out;
      }
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<SemanticVersionPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };
    }
  }
}
#endif