wtf/unicode/Collator.h

   1 /*
   2  * Copyright (C) 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef WTF_Collator_h
  30 #define WTF_Collator_h
  31
  32 #include <wtf/FastAllocBase.h>
  33 #include <wtf/Noncopyable.h>
  34 #include <wtf/PassOwnPtr.h>
  35 #include <wtf/unicode/Unicode.h>
  36
  37 #if USE(ICU_UNICODE) && !UCONFIG_NO_COLLATION
  38 struct UCollator;
  39 #endif
  40
  41 namespace WTF {
  42
  43     class Collator {
  44         WTF_MAKE_NONCOPYABLE(Collator); WTF_MAKE_FAST_ALLOCATED;
  45     public:
  46         enum Result { Equal = 0, Greater = 1, Less = -1 };
  47
  48         Collator(const char* locale); // Parsing is lenient; e.g. language identifiers (such as "en-US") are accepted, too.
  49         ~Collator();
  50         void setOrderLowerFirst(bool);
  51
  52         static PassOwnPtr<Collator> userDefault();
  53
  54         Result collate(const ::UChar*, size_t, const ::UChar*, size_t) const;
  55
  56     private:
  57 #if USE(ICU_UNICODE) && !UCONFIG_NO_COLLATION
  58         void createCollator() const;
  59         void releaseCollator();
  60         mutable UCollator* m_collator;
  61 #endif
  62         char* m_locale;
  63         bool m_lowerFirst;
  64     };
  65 }
  66
  67 using WTF::Collator;
  68
  69 #endif