intl/lwbrk/public/nsIWordBreaker.h

   1 /* -*- Mode: C++; 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 mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #ifndef nsIWordBreaker_h__
  38 #define nsIWordBreaker_h__
  39
  40 #include "nsISupports.h"
  41
  42 #include "nscore.h"
  43
  44 #define NS_WORDBREAKER_NEED_MORE_TEXT -1
  45
  46 // {E86B3379-BF89-11d2-B3AF-00805F8A6670}
  47 #define NS_IWORDBREAKER_IID \
  48 { 0xe86b3379, 0xbf89, 0x11d2, \
  49    { 0xb3, 0xaf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
  50
  51 typedef struct {
  52   PRUint32 mBegin;
  53   PRUint32 mEnd;
  54 } nsWordRange;
  55
  56 class nsIWordBreaker : public nsISupports
  57 {
  58 public:
  59   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IWORDBREAKER_IID)
  60
  61   virtual PRBool BreakInBetween(const PRUnichar* aText1 , PRUint32 aTextLen1,
  62                                 const PRUnichar* aText2 ,
  63                                 PRUint32 aTextLen2) = 0;
  64   virtual nsWordRange FindWord(const PRUnichar* aText1 , PRUint32 aTextLen1,
  65                                PRUint32 aOffset) = 0;
  66   virtual PRInt32 NextWord(const PRUnichar* aText, PRUint32 aLen,
  67                            PRUint32 aPos) = 0;
  68
  69   virtual PRInt32 PrevWord(const PRUnichar* aText, PRUint32 aLen,
  70                            PRUint32 aPos) = 0;
  71
  72 };
  73
  74 NS_DEFINE_STATIC_IID_ACCESSOR(nsIWordBreaker, NS_IWORDBREAKER_IID)
  75
  76 #endif  /* nsIWordBreaker_h__ */