version_id.h

Go to the documentation of this file.

#ifndef DATATOOLS_VERSION_ID_H
#define DATATOOLS_VERSION_ID_H

// Standard Library:
#include <iostream>
#include <string>

// Third Party:
// - Boost:
#include <boost/cstdlib.hpp>

// Datatools:
#include <datatools/i_serializable.h>

namespace datatools {

  class version_id
    : public datatools::i_serializable
  {
  public:
    // TODO: could probably all be private or in an PImpl...
    static const int32_t INVALID_NUMBER;    // = -1;
    static const char    INVALID_SYMBOL;    // = '?';
    static const char    NUMERIC_SEPARATOR; // = '.';
    static const char    TAG_SEPARATOR;     // = '-';
    static const int32_t MAX_RC_NUM; //   = 9999;
    static const int32_t ALPHA_NUM; //    = -10003;
    static const int32_t BETA_NUM; //    = -10002;
    static const int32_t RC_BASE_NUM; //  = -10001;

    struct tags {
      static const std::string & alpha();
      static const std::string & beta();
      static const std::string & release_candidate_prefix();
    };

  public:

    // Constructors/Destructors
    version_id();

    explicit version_id(const std::string & tag_);

    version_id(int major_, int minor_ = -1, int revision_ = -1,
               const std::string & tag_ = "");

    // Global operations
    bool is_valid() const;

    bool has_numbers_only() const;

    void reset();

    // Major number operations
    bool has_major() const;

    bool has_major_only() const;

    int get_major() const;

    void set_major(int);

    // Minor number operations
    bool has_minor() const;

    int get_minor() const;

    void set_minor(int);

    // Revision number operations
    bool has_revision() const;

    int get_revision() const;

    void set_revision(int);

    // Tag number operations
    bool has_tag() const;

    bool has_tag_number() const;

    bool has_tag_only() const;

    bool has_numeric_tag() const;

    bool has_special_tag() const;

    const std::string & get_tag() const;

    int get_tag_number() const;

    void set_tag(const std::string &);

    // Comparisons
    bool equals(const version_id &, bool ignore_tag_ = false) const;

    bool operator==(const version_id &) const;

    int compare(const version_id &, bool major_only_ = false) const;

    bool matches(const std::string & version_rules_, bool major_only_ = false) const;

    // I/O and Conversions
    friend std::ostream & operator<<(std::ostream &, const version_id &);

    friend std::istream & operator>>(std::istream &, version_id &);

    void to_string(std::string& format_) const;

    std::string to_string() const;

    bool from_string(const std::string &);

    void dump(std::ostream & out_ = std::clog,
              const std::string & title_ = "",
              const std::string & indent_ = "") const;


    // These could/should be free functions
    static int compare(const version_id & vid0_,
                       const version_id & vid1_,
                       bool major_only = false);

    static bool are_orderable(const version_id & vid0_,
                              const version_id & vid1_,
                              bool major_only_ = false);

    static const version_id & invalid();

  private:
    int32_t     _major_;      
    int32_t     _minor_;      
    int32_t     _revision_;   
    std::string _tag_;        
    int32_t     _tag_number_; 

    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(version_id)

  };

} // namespace datatools

#endif // DATATOOLS_VERSION_ID_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --