listformatter.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*
*   Copyright (C) 2012-2016, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
*******************************************************************************
*   file name:  listformatter.h
*   encoding:   UTF-8
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 20120426
*   created by: Umesh P. Nair
*/
 
#ifndef __LISTFORMATTER_H__
#define __LISTFORMATTER_H__
 
#include "unicode/utypes.h"
 
#include "unicode/unistr.h"
#include "unicode/locid.h"
 
U_NAMESPACE_BEGIN
 
class FieldPositionIterator;
class FieldPositionHandler;
 
class Hashtable;
 
struct ListFormatInternal;
 
/* The following can't be #ifndef U_HIDE_INTERNAL_API, needed for other .h file declarations */
struct ListFormatData : public UMemory {
    UnicodeString twoPattern;
    UnicodeString startPattern;
    UnicodeString middlePattern;
    UnicodeString endPattern;
 
  ListFormatData(const UnicodeString& two, const UnicodeString& start, const UnicodeString& middle, const UnicodeString& end) :
      twoPattern(two), startPattern(start), middlePattern(middle), endPattern(end) {}
};
class U_I18N_API ListFormatter : public UObject{
 
  public:
 
    ListFormatter(const ListFormatter&);
 
    ListFormatter& operator=(const ListFormatter& other);
 
    static ListFormatter* createInstance(UErrorCode& errorCode);
 
    static ListFormatter* createInstance(const Locale& locale, UErrorCode& errorCode);
 
#ifndef U_HIDE_INTERNAL_API
 
    static ListFormatter* createInstance(const Locale& locale, const char* style, UErrorCode& errorCode);
#endif  /* U_HIDE_INTERNAL_API */
 
    virtual ~ListFormatter();
 
 
    UnicodeString& format(const UnicodeString items[], int32_t n_items,
        UnicodeString& appendTo, UErrorCode& errorCode) const;
 
#ifndef U_HIDE_DRAFT_API
 
    UnicodeString& format(const UnicodeString items[], int32_t n_items,
        UnicodeString & appendTo, FieldPositionIterator* posIter,
        UErrorCode& errorCode) const;
#endif  /* U_HIDE_DRAFT_API */
 
#ifndef U_HIDE_INTERNAL_API
 
    UnicodeString& format(
            const UnicodeString items[],
            int32_t n_items,
            UnicodeString& appendTo,
            int32_t index,
            int32_t &offset,
            UErrorCode& errorCode) const;
    ListFormatter(const ListFormatData &data, UErrorCode &errorCode);
    ListFormatter(const ListFormatInternal* listFormatterInternal);
#endif  /* U_HIDE_INTERNAL_API */
 
  private:
    static void initializeHash(UErrorCode& errorCode);
    static const ListFormatInternal* getListFormatInternal(const Locale& locale, const char *style, UErrorCode& errorCode);
    struct ListPatternsSink;
    static ListFormatInternal* loadListFormatInternal(const Locale& locale, const char* style, UErrorCode& errorCode);
 
    UnicodeString& format_(
        const UnicodeString items[], int32_t n_items, UnicodeString& appendTo,
        int32_t index, int32_t &offset, FieldPositionHandler* handler, UErrorCode& errorCode) const;
 
    ListFormatter();
 
    ListFormatInternal* owned;
    const ListFormatInternal* data;
};
 
U_NAMESPACE_END
 
#endif