formattedvalue.h

Go to the documentation of this file.

// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html

#ifndef __FORMATTEDVALUE_H__
#define __FORMATTEDVALUE_H__

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/appendable.h"
#include "unicode/fpositer.h"
#include "unicode/unistr.h"
#include "unicode/uformattedvalue.h"

U_NAMESPACE_BEGIN

// The following cannot have #ifndef U_HIDE_DRAFT_API because
// class FormattedValue depends on it, and FormattedValue cannot be
// hidden becauseclass FormattedNumber (stable ICU 60) depends on it.
#ifndef U_FORCE_HIDE_DRAFT_API

class U_I18N_API ConstrainedFieldPosition : public UMemory {
  public:

    ConstrainedFieldPosition();

    ~ConstrainedFieldPosition();

#ifndef U_HIDE_DRAFT_API

    void reset();

    void constrainCategory(int32_t category);

    void constrainField(int32_t category, int32_t field);

    inline int32_t getCategory() const {
        return fCategory;
    }

    inline int32_t getField() const {
        return fField;
    }

    inline int32_t getStart() const {
        return fStart;
    }

    inline int32_t getLimit() const {
        return fLimit;
    }


    inline int64_t getInt64IterationContext() const {
        return fContext;
    }

    void setInt64IterationContext(int64_t context);

    UBool matchesField(int32_t category, int32_t field) const;

    void setState(
        int32_t category,
        int32_t field,
        int32_t start,
        int32_t limit);
#endif  /* U_HIDE_DRAFT_API */

  private:
    int64_t fContext = 0LL;
    int32_t fField = 0;
    int32_t fStart = 0;
    int32_t fLimit = 0;
#ifndef U_HIDE_DRAFT_API
    int32_t fCategory = UFIELD_CATEGORY_UNDEFINED;
#else   /* U_HIDE_DRAFT_API */
    int32_t fCategory = 0;
#endif  /* U_HIDE_DRAFT_API */
    int8_t fConstraint = 0;
};

// The following cannot have #ifndef U_HIDE_DRAFT_API because
// class FormattedNumber (stable ICU 60) depends on it.
class U_I18N_API FormattedValue /* not : public UObject because this is an interface/mixin class */ {
  public:
    virtual ~FormattedValue();

    virtual UnicodeString toString(UErrorCode& status) const = 0;

    virtual UnicodeString toTempString(UErrorCode& status) const = 0;

    virtual Appendable& appendTo(Appendable& appendable, UErrorCode& status) const = 0;

    virtual UBool nextPosition(ConstrainedFieldPosition& cfpos, UErrorCode& status) const = 0;
};
#endif  // U_FORCE_HIDE_DRAFT_API

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // __FORMATTEDVALUE_H__