xpcom/base/nsIVersionComparator.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 /**
   9  * Version strings are dot-separated sequences of version-parts.
  10  *
  11  * A version-part consists of up to four parts, all of which are optional:
  12  *
  13  * <number-a><string-b><number-c><string-d (everything else)>
  14  *
  15  * A version-part may also consist of a single asterisk "*" which indicates
  16  * "infinity".
  17  *
  18  * Numbers are base-10, and are zero if left out.
  19  * Strings are compared bytewise.
  20  *
  21  * For additional backwards compatibility, if "string-b" is "+" then
  22  * "number-a" is incremented by 1 and "string-b" becomes "pre".
  23  *
  24  * 1.0pre1
  25  * < 1.0pre2
  26  *   < 1.0 == 1.0.0 == 1.0.0.0
  27  *     < 1.1pre == 1.1pre0 == 1.0+
  28  *       < 1.1pre1a
  29  *         < 1.1pre1
  30  *           < 1.1pre10a
  31  *             < 1.1pre10
  32  *
  33  * Although not required by this interface, it is recommended that
  34  * numbers remain within the limits of a signed char, i.e. -127 to 128.
  35  */
  36 [scriptable, uuid(e6cd620a-edbb-41d2-9e42-9a2ffc8107f3)]
  37 interface nsIVersionComparator : nsISupports
  38 {
  39   /**
  40    * Compare two version strings
  41    * @param   A   The first version
  42    * @param   B   The second version
  43    * @returns < 0 if A < B
  44    *          = 0 if A == B
  45    *          > 0 if A > B
  46    */
  47   long compare(in ACString A, in ACString B);
  48 };
  49