xpcom/base/nsIVersionComparator.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Application Update Service
  16  *
  17  * The Initial Developer of the Original Code is Google Inc.
  18  * Portions created by the Initial Developer are Copyright (C) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *  Ben Goodger <ben@mozilla.org>
  23  *  Benjamin Smedberg <benjamin@smedbergs.us>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 /**
  42  * Version strings are dot-separated sequences of version-parts.
  43  *
  44  * A version-part consists of up to four parts, all of which are optional:
  45  *
  46  * <number-a><string-b><number-c><string-d (everything else)>
  47  *
  48  * A version-part may also consist of a single asterisk "*" which indicates
  49  * "infinity".
  50  *
  51  * Numbers are base-10, and are zero if left out.
  52  * Strings are compared bytewise.
  53  *
  54  * For additional backwards compatibility, if "string-b" is "+" then
  55  * "number-a" is incremented by 1 and "string-b" becomes "pre".
  56  *
  57  * 1.0pre1
  58  * < 1.0pre2
  59  *   < 1.0 == 1.0.0 == 1.0.0.0
  60  *     < 1.1pre == 1.1pre0 == 1.0+
  61  *       < 1.1pre1a
  62  *         < 1.1pre1
  63  *           < 1.1pre10a
  64  *             < 1.1pre10
  65  *
  66  * Although not required by this interface, it is recommended that
  67  * numbers remain within the limits of a signed char, i.e. -127 to 128.
  68  */
  69 [scriptable, uuid(e6cd620a-edbb-41d2-9e42-9a2ffc8107f3)]
  70 interface nsIVersionComparator : nsISupports
  71 {
  72   /**
  73    * Compare two version strings
  74    * @param   A   The first version
  75    * @param   B   The second version
  76    * @returns < 0 if A < B
  77    *          = 0 if A == B
  78    *          > 0 if A > B
  79    */
  80   long compare(in ACString A, in ACString B);
  81 };
  82