Home | History | Annotate | Download | only in base
      1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef BASE_VERSION_H_
      6 #define BASE_VERSION_H_
      7 
      8 #include <stdint.h>
      9 
     10 #include <iosfwd>
     11 #include <string>
     12 #include <vector>
     13 
     14 #include "base/base_export.h"
     15 
     16 namespace base {
     17 
     18 // Version represents a dotted version number, like "1.2.3.4", supporting
     19 // parsing and comparison.
     20 class BASE_EXPORT Version {
     21  public:
     22   // The only thing you can legally do to a default constructed
     23   // Version object is assign to it.
     24   Version();
     25 
     26   Version(const Version& other);
     27 
     28   // Initializes from a decimal dotted version number, like "0.1.1".
     29   // Each component is limited to a uint16_t. Call IsValid() to learn
     30   // the outcome.
     31   explicit Version(const std::string& version_str);
     32 
     33   // Initializes from a vector of components, like {1, 2, 3, 4}. Call IsValid()
     34   // to learn the outcome.
     35   explicit Version(std::vector<uint32_t> components);
     36 
     37   ~Version();
     38 
     39   // Returns true if the object contains a valid version number.
     40   bool IsValid() const;
     41 
     42   // Returns true if the version wildcard string is valid. The version wildcard
     43   // string may end with ".*" (e.g. 1.2.*, 1.*). Any other arrangement with "*"
     44   // is invalid (e.g. 1.*.3 or 1.2.3*). This functions defaults to standard
     45   // Version behavior (IsValid) if no wildcard is present.
     46   static bool IsValidWildcardString(const std::string& wildcard_string);
     47 
     48   // Returns -1, 0, 1 for <, ==, >.
     49   int CompareTo(const Version& other) const;
     50 
     51   // Given a valid version object, compare if a |wildcard_string| results in a
     52   // newer version. This function will default to CompareTo if the string does
     53   // not end in wildcard sequence ".*". IsValidWildcard(wildcard_string) must be
     54   // true before using this function.
     55   int CompareToWildcardString(const std::string& wildcard_string) const;
     56 
     57   // Return the string representation of this version.
     58   const std::string GetString() const;
     59 
     60   const std::vector<uint32_t>& components() const { return components_; }
     61 
     62  private:
     63   std::vector<uint32_t> components_;
     64 };
     65 
     66 BASE_EXPORT bool operator==(const Version& v1, const Version& v2);
     67 BASE_EXPORT bool operator!=(const Version& v1, const Version& v2);
     68 BASE_EXPORT bool operator<(const Version& v1, const Version& v2);
     69 BASE_EXPORT bool operator<=(const Version& v1, const Version& v2);
     70 BASE_EXPORT bool operator>(const Version& v1, const Version& v2);
     71 BASE_EXPORT bool operator>=(const Version& v1, const Version& v2);
     72 BASE_EXPORT std::ostream& operator<<(std::ostream& stream, const Version& v);
     73 
     74 }  // namespace base
     75 
     76 #endif  // BASE_VERSION_H_
     77