fsfw/src/fsfw/version.h

#ifndef FSFW_SRC_FSFW_VERSION_H_
#define FSFW_SRC_FSFW_VERSION_H_

#include "fsfw/FSFW.h"

#if FSFW_CPP_OSTREAM_ENABLED == 1
#include <iostream>
#endif
#include <cstdint>

namespace fsfw {

class Version {
 public:
  Version(int major, int minor, int revision, const char* addInfo = nullptr);
  int major = -1;
  int minor = -1;
  int revision = -1;

  // Additional information, e.g. a git SHA hash
  const char* addInfo = nullptr;

  friend bool operator==(const Version& v1, const Version& v2) {
    return (v1.major == v2.major and v1.minor == v2.minor and v1.revision == v2.revision);
  }

  friend bool operator!=(const Version& v1, const Version& v2) { return not(v1 == v2); }

  friend bool operator<(const Version& v1, const Version& v2) {
    return ((v1.major < v2.major) or (v1.major == v2.major and v1.minor < v2.minor) or
            (v1.major == v2.major and v1.minor == v2.minor and v1.revision < v2.revision));
  }

  friend bool operator>(const Version& v1, const Version& v2) {
    return not(v1 < v2) and not(v1 == v2);
  }

  friend bool operator<=(const Version& v1, const Version& v2) { return ((v1 == v2) or (v1 < v2)); }

  friend bool operator>=(const Version& v1, const Version& v2) { return ((v1 == v2) or (v1 > v2)); }

#if FSFW_CPP_OSTREAM_ENABLED == 1
  /**
   * Print format to given ostream using format "major.minor.revision"
   * @param os
   * @param v
   * @return
   */
  friend std::ostream& operator<<(std::ostream& os, const Version& v);
#endif

  /**
   * Get version as format "major.minor.revision"
   * @param str
   * @param maxLen
   */
  void getVersion(char* str, size_t maxLen) const;
};

extern const Version FSFW_VERSION;

}  // namespace fsfw

#endif /* FSFW_SRC_FSFW_VERSION_H_ */