Gecko [ armaneco.co.uk ]

Name	Size	Permission	Date
alphaindex.h	26.53 KB	-rw-r--r--	2023-02-22 12:55
appendable.h	8.53 KB	-rw-r--r--	2023-02-22 12:55
basictz.h	9.98 KB	-rw-r--r--	2023-02-22 12:55
brkiter.h	27.81 KB	-rw-r--r--	2023-02-22 12:55
bytestream.h	10.75 KB	-rw-r--r--	2023-02-22 12:55
bytestrie.h	20.78 KB	-rw-r--r--	2023-02-22 12:55
bytestriebuilder.h	7.48 KB	-rw-r--r--	2023-02-22 12:55
calendar.h	102.25 KB	-rw-r--r--	2023-02-22 12:55
caniter.h	7.47 KB	-rw-r--r--	2023-02-22 12:55
casemap.h	25.33 KB	-rw-r--r--	2023-02-22 12:55
char16ptr.h	7.22 KB	-rw-r--r--	2023-02-22 12:55
chariter.h	24.06 KB	-rw-r--r--	2023-02-22 12:55
choicfmt.h	23.98 KB	-rw-r--r--	2023-02-22 12:55
coleitr.h	13.78 KB	-rw-r--r--	2023-02-22 12:55
coll.h	56.27 KB	-rw-r--r--	2023-02-22 12:55
compactdecimalformat.h	6.88 KB	-rw-r--r--	2023-02-22 12:55
curramt.h	3.78 KB	-rw-r--r--	2023-02-22 12:55
currpinf.h	7.3 KB	-rw-r--r--	2023-02-22 12:55
currunit.h	4.02 KB	-rw-r--r--	2023-02-22 12:55
datefmt.h	40.71 KB	-rw-r--r--	2023-02-22 12:55
dbbi.h	1.19 KB	-rw-r--r--	2023-02-22 12:55
dcfmtsym.h	20.61 KB	-rw-r--r--	2023-02-22 12:55
decimfmt.h	87.57 KB	-rw-r--r--	2023-02-22 12:55
displayoptions.h	7.11 KB	-rw-r--r--	2023-02-22 12:55
docmain.h	7.21 KB	-rw-r--r--	2023-02-22 12:55
dtfmtsym.h	38.22 KB	-rw-r--r--	2023-02-22 12:55
dtintrv.h	3.85 KB	-rw-r--r--	2023-02-22 12:55
dtitvfmt.h	49.27 KB	-rw-r--r--	2023-02-22 12:55
dtitvinf.h	18.63 KB	-rw-r--r--	2023-02-22 12:55
dtptngen.h	28.69 KB	-rw-r--r--	2023-02-22 12:55
dtrule.h	8.69 KB	-rw-r--r--	2023-02-22 12:55
edits.h	20.74 KB	-rw-r--r--	2023-02-22 12:55
enumset.h	2.08 KB	-rw-r--r--	2023-02-22 12:55
errorcode.h	4.84 KB	-rw-r--r--	2023-02-22 12:55
fieldpos.h	8.7 KB	-rw-r--r--	2023-02-22 12:55
filteredbrk.h	5.37 KB	-rw-r--r--	2023-02-22 12:55
fmtable.h	24.43 KB	-rw-r--r--	2023-02-22 12:55
format.h	12.5 KB	-rw-r--r--	2023-02-22 12:55
formattedvalue.h	9.75 KB	-rw-r--r--	2023-02-22 12:55
fpositer.h	3.03 KB	-rw-r--r--	2023-02-22 12:55
gender.h	3.35 KB	-rw-r--r--	2023-02-22 12:55
gregocal.h	31.04 KB	-rw-r--r--	2023-02-22 12:55
icudataver.h	1.02 KB	-rw-r--r--	2023-02-22 12:55
icuplug.h	11.83 KB	-rw-r--r--	2023-02-22 12:55
idna.h	12.71 KB	-rw-r--r--	2023-02-22 12:55
listformatter.h	8.61 KB	-rw-r--r--	2023-02-22 12:55
localebuilder.h	11.08 KB	-rw-r--r--	2023-02-22 12:55
localematcher.h	26.84 KB	-rw-r--r--	2023-02-22 12:55
localpointer.h	19.36 KB	-rw-r--r--	2023-02-22 12:55
locdspnm.h	7.12 KB	-rw-r--r--	2023-02-22 12:55
locid.h	47.66 KB	-rw-r--r--	2023-02-22 12:55
measfmt.h	11.42 KB	-rw-r--r--	2023-02-22 12:55
measunit.h	106.33 KB	-rw-r--r--	2023-02-22 12:55
measure.h	4.33 KB	-rw-r--r--	2023-02-22 12:55
messagepattern.h	33.71 KB	-rw-r--r--	2023-02-22 12:55
msgfmt.h	44.17 KB	-rw-r--r--	2023-02-22 12:55
normalizer2.h	33.66 KB	-rw-r--r--	2023-02-22 12:55
normlzr.h	30.96 KB	-rw-r--r--	2023-02-22 12:55
nounit.h	2.25 KB	-rw-r--r--	2023-02-22 12:55
numberformatter.h	94.82 KB	-rw-r--r--	2023-02-22 12:55
numberrangeformatter.h	25.02 KB	-rw-r--r--	2023-02-22 12:55
numfmt.h	49.84 KB	-rw-r--r--	2023-02-22 12:55
numsys.h	7.22 KB	-rw-r--r--	2023-02-22 12:55
parseerr.h	3.08 KB	-rw-r--r--	2023-02-22 12:55
parsepos.h	5.57 KB	-rw-r--r--	2023-02-22 12:55
platform.h	28.55 KB	-rw-r--r--	2023-02-22 12:55
plurfmt.h	25.25 KB	-rw-r--r--	2023-02-22 12:55
plurrule.h	20.62 KB	-rw-r--r--	2023-02-22 12:55
ptypes.h	3.49 KB	-rw-r--r--	2023-02-22 12:55
putil.h	6.32 KB	-rw-r--r--	2023-02-22 12:55
rbbi.h	28.46 KB	-rw-r--r--	2023-02-22 12:55
rbnf.h	49.82 KB	-rw-r--r--	2023-02-22 12:55
rbtz.h	15.77 KB	-rw-r--r--	2023-02-22 12:55
regex.h	84.41 KB	-rw-r--r--	2023-02-22 12:55
region.h	9.18 KB	-rw-r--r--	2023-02-22 12:55
reldatefmt.h	22.22 KB	-rw-r--r--	2023-02-22 12:55
rep.h	9.37 KB	-rw-r--r--	2023-02-22 12:55
resbund.h	18.09 KB	-rw-r--r--	2023-02-22 12:55
schriter.h	6.1 KB	-rw-r--r--	2023-02-22 12:55
scientificnumberformatter.h	6.44 KB	-rw-r--r--	2023-02-22 12:55
search.h	22.22 KB	-rw-r--r--	2023-02-22 12:55
selfmt.h	14.35 KB	-rw-r--r--	2023-02-22 12:55
simpleformatter.h	12.59 KB	-rw-r--r--	2023-02-22 12:55
simpletz.h	45.65 KB	-rw-r--r--	2023-02-22 12:55
smpdtfmt.h	71.93 KB	-rw-r--r--	2023-02-22 12:55
sortkey.h	11.18 KB	-rw-r--r--	2023-02-22 12:55
std_string.h	1.05 KB	-rw-r--r--	2023-02-22 12:55
strenum.h	9.92 KB	-rw-r--r--	2023-02-22 12:55
stringoptions.h	5.79 KB	-rw-r--r--	2023-02-22 12:55
stringpiece.h	10.05 KB	-rw-r--r--	2023-02-22 12:55
stringtriebuilder.h	15.47 KB	-rw-r--r--	2023-02-22 12:55
stsearch.h	21.42 KB	-rw-r--r--	2023-02-22 12:55
symtable.h	4.27 KB	-rw-r--r--	2023-02-22 12:55
tblcoll.h	36.92 KB	-rw-r--r--	2023-02-22 12:55
timezone.h	43.81 KB	-rw-r--r--	2023-02-22 12:55
tmunit.h	3.4 KB	-rw-r--r--	2023-02-22 12:55
tmutamt.h	4.91 KB	-rw-r--r--	2023-02-22 12:55
tmutfmt.h	7.42 KB	-rw-r--r--	2023-02-22 12:55
translit.h	65.82 KB	-rw-r--r--	2023-02-22 12:55
tzfmt.h	42.93 KB	-rw-r--r--	2023-02-22 12:55
tznames.h	16.85 KB	-rw-r--r--	2023-02-22 12:55
tzrule.h	34.86 KB	-rw-r--r--	2023-02-22 12:55
tztrans.h	6.13 KB	-rw-r--r--	2023-02-22 12:55
ubidi.h	89.61 KB	-rw-r--r--	2023-02-22 12:55
ubiditransform.h	12.71 KB	-rw-r--r--	2023-02-22 12:55
ubrk.h	24.43 KB	-rw-r--r--	2023-02-22 12:55
ucal.h	60.68 KB	-rw-r--r--	2023-02-22 12:55
ucasemap.h	15.21 KB	-rw-r--r--	2023-02-22 12:55
ucat.h	5.35 KB	-rw-r--r--	2023-02-22 12:55
uchar.h	145.09 KB	-rw-r--r--	2023-02-22 12:55
ucharstrie.h	22.53 KB	-rw-r--r--	2023-02-22 12:55
ucharstriebuilder.h	7.48 KB	-rw-r--r--	2023-02-22 12:55
uchriter.h	13.42 KB	-rw-r--r--	2023-02-22 12:55
uclean.h	11.2 KB	-rw-r--r--	2023-02-22 12:55
ucnv.h	83.46 KB	-rw-r--r--	2023-02-22 12:55
ucnv_cb.h	6.58 KB	-rw-r--r--	2023-02-22 12:55
ucnv_err.h	20.98 KB	-rw-r--r--	2023-02-22 12:55
ucnvsel.h	6.24 KB	-rw-r--r--	2023-02-22 12:55
ucol.h	61.95 KB	-rw-r--r--	2023-02-22 12:55
ucoleitr.h	9.82 KB	-rw-r--r--	2023-02-22 12:55
uconfig.h	12.07 KB	-rw-r--r--	2023-02-22 12:55
ucpmap.h	5.54 KB	-rw-r--r--	2023-02-22 12:55
ucptrie.h	22.51 KB	-rw-r--r--	2023-02-22 12:55
ucsdet.h	14.69 KB	-rw-r--r--	2023-02-22 12:55
ucurr.h	16.72 KB	-rw-r--r--	2023-02-22 12:55
udat.h	62.36 KB	-rw-r--r--	2023-02-22 12:55
udata.h	15.63 KB	-rw-r--r--	2023-02-22 12:55
udateintervalformat.h	11.93 KB	-rw-r--r--	2023-02-22 12:55
udatpg.h	30.18 KB	-rw-r--r--	2023-02-22 12:55
udisplaycontext.h	5.94 KB	-rw-r--r--	2023-02-22 12:55
udisplayoptions.h	8.8 KB	-rw-r--r--	2023-02-22 12:55
uenum.h	7.79 KB	-rw-r--r--	2023-02-22 12:55
ufieldpositer.h	4.41 KB	-rw-r--r--	2023-02-22 12:55
uformattable.h	10.97 KB	-rw-r--r--	2023-02-22 12:55
uformattedvalue.h	12.25 KB	-rw-r--r--	2023-02-22 12:55
ugender.h	2.06 KB	-rw-r--r--	2023-02-22 12:55
uidna.h	33.43 KB	-rw-r--r--	2023-02-22 12:55
uiter.h	22.75 KB	-rw-r--r--	2023-02-22 12:55
uldnames.h	10.48 KB	-rw-r--r--	2023-02-22 12:55
ulistformatter.h	10.78 KB	-rw-r--r--	2023-02-22 12:55
uloc.h	54.66 KB	-rw-r--r--	2023-02-22 12:55
ulocdata.h	11.3 KB	-rw-r--r--	2023-02-22 12:55
umachine.h	15.73 KB	-rw-r--r--	2023-02-22 12:55
umisc.h	1.34 KB	-rw-r--r--	2023-02-22 12:55
umsg.h	24.25 KB	-rw-r--r--	2023-02-22 12:55
umutablecptrie.h	8.3 KB	-rw-r--r--	2023-02-22 12:55
unifilt.h	4 KB	-rw-r--r--	2023-02-22 12:55
unifunct.h	4.05 KB	-rw-r--r--	2023-02-22 12:55
unimatch.h	6.1 KB	-rw-r--r--	2023-02-22 12:55
unirepl.h	3.38 KB	-rw-r--r--	2023-02-22 12:55
uniset.h	66.12 KB	-rw-r--r--	2023-02-22 12:55
unistr.h	170.53 KB	-rw-r--r--	2023-02-22 12:55
unorm.h	20.55 KB	-rw-r--r--	2023-02-22 12:55
unorm2.h	24.68 KB	-rw-r--r--	2023-02-22 12:55
unum.h	56.6 KB	-rw-r--r--	2023-02-22 12:55
unumberformatter.h	30.26 KB	-rw-r--r--	2023-02-22 12:55
unumberrangeformatter.h	15.35 KB	-rw-r--r--	2023-02-22 12:55
unumsys.h	7.26 KB	-rw-r--r--	2023-02-22 12:55
uobject.h	10.68 KB	-rw-r--r--	2023-02-22 12:55
upluralrules.h	8.79 KB	-rw-r--r--	2023-02-22 12:55
uregex.h	71.99 KB	-rw-r--r--	2023-02-22 12:55
uregion.h	9.81 KB	-rw-r--r--	2023-02-22 12:55
ureldatefmt.h	17.04 KB	-rw-r--r--	2023-02-22 12:55
urename.h	135.69 KB	-rw-r--r--	2023-02-22 12:55
urep.h	5.38 KB	-rw-r--r--	2023-02-22 12:55
ures.h	36.54 KB	-rw-r--r--	2023-02-22 12:55
uscript.h	27.8 KB	-rw-r--r--	2023-02-22 12:55
usearch.h	39.21 KB	-rw-r--r--	2023-02-22 12:55
uset.h	44.19 KB	-rw-r--r--	2023-02-22 12:55
usetiter.h	9.63 KB	-rw-r--r--	2023-02-22 12:55
ushape.h	18 KB	-rw-r--r--	2023-02-22 12:55
uspoof.h	65.84 KB	-rw-r--r--	2023-02-22 12:55
usprep.h	8.19 KB	-rw-r--r--	2023-02-22 12:55
ustdio.h	38.56 KB	-rw-r--r--	2023-02-22 12:55
ustream.h	1.89 KB	-rw-r--r--	2023-02-22 12:55
ustring.h	72.36 KB	-rw-r--r--	2023-02-22 12:55
ustringtrie.h	3.15 KB	-rw-r--r--	2023-02-22 12:55
utext.h	58.08 KB	-rw-r--r--	2023-02-22 12:55
utf.h	7.87 KB	-rw-r--r--	2023-02-22 12:55
utf16.h	23.35 KB	-rw-r--r--	2023-02-22 12:55
utf32.h	763 B	-rw-r--r--	2023-02-22 12:55
utf8.h	30.83 KB	-rw-r--r--	2023-02-22 12:55
utf_old.h	45.8 KB	-rw-r--r--	2023-02-22 12:55
utmscale.h	13.78 KB	-rw-r--r--	2023-02-22 12:55
utrace.h	17.18 KB	-rw-r--r--	2023-02-22 12:55
utrans.h	25.54 KB	-rw-r--r--	2023-02-22 12:55
utypes.h	31.06 KB	-rw-r--r--	2023-02-22 12:55
uvernum.h	6.33 KB	-rw-r--r--	2023-02-22 12:55
uversion.h	5.99 KB	-rw-r--r--	2023-02-22 12:55
vtzone.h	20.68 KB	-rw-r--r--	2023-02-22 12:55

Rename

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*   Copyright (C) 2011-2012, International Business Machines
*   Corporation and others.  All Rights Reserved.
*******************************************************************************
*   file name:  appendable.h
*   encoding:   UTF-8
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 2010dec07
*   created by: Markus W. Scherer
*/

#ifndef __APPENDABLE_H__
#define __APPENDABLE_H__

/**
 * \file
 * \brief C++ API: Appendable class: Sink for Unicode code points and 16-bit code units (char16_ts).
 */

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#include "unicode/uobject.h"

U_NAMESPACE_BEGIN

class UnicodeString;

/**
 * Base class for objects to which Unicode characters and strings can be appended.
 * Combines elements of Java Appendable and ICU4C ByteSink.
 *
 * This class can be used in APIs where it does not matter whether the actual destination is
 * a UnicodeString, a char16_t[] array, a UnicodeSet, or any other object
 * that receives and processes characters and/or strings.
 *
 * Implementation classes must implement at least appendCodeUnit(char16_t).
 * The base class provides default implementations for the other methods.
 *
 * The methods do not take UErrorCode parameters.
 * If an error occurs (e.g., out-of-memory),
 * in addition to returning false from failing operations,
 * the implementation must prevent unexpected behavior (e.g., crashes)
 * from further calls and should make the error condition available separately
 * (e.g., store a UErrorCode, make/keep a UnicodeString bogus).
 * @stable ICU 4.8
 */
class U_COMMON_API Appendable : public UObject {
public:
    /**
     * Destructor.
     * @stable ICU 4.8
     */
    ~Appendable();

/**
     * Appends a 16-bit code unit.
     * @param c code unit
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool appendCodeUnit(char16_t c) = 0;

/**
     * Appends a code point.
     * The default implementation calls appendCodeUnit(char16_t) once or twice.
     * @param c code point 0..0x10ffff
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool appendCodePoint(UChar32 c);

/**
     * Appends a string.
     * The default implementation calls appendCodeUnit(char16_t) for each code unit.
     * @param s string, must not be NULL if length!=0
     * @param length string length, or -1 if NUL-terminated
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool appendString(const char16_t *s, int32_t length);

/**
     * Tells the object that the caller is going to append roughly
     * appendCapacity char16_ts. A subclass might use this to pre-allocate
     * a larger buffer if necessary.
     * The default implementation does nothing. (It always returns true.)
     * @param appendCapacity estimated number of char16_ts that will be appended
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool reserveAppendCapacity(int32_t appendCapacity);

/**
     * Returns a writable buffer for appending and writes the buffer's capacity to
     * *resultCapacity. Guarantees *resultCapacity>=minCapacity.
     * May return a pointer to the caller-owned scratch buffer which must have
     * scratchCapacity>=minCapacity.
     * The returned buffer is only valid until the next operation
     * on this Appendable.
     *
     * After writing at most *resultCapacity char16_ts, call appendString() with the
     * pointer returned from this function and the number of char16_ts written.
     * Many appendString() implementations will avoid copying char16_ts if this function
     * returned an internal buffer.
     *
     * Partial usage example:
     * \code
     *  int32_t capacity;
     *  char16_t* buffer = app.getAppendBuffer(..., &capacity);
     *  ... Write n char16_ts into buffer, with n <= capacity.
     *  app.appendString(buffer, n);
     * \endcode
     * In many implementations, that call to append will avoid copying char16_ts.
     *
     * If the Appendable allocates or reallocates an internal buffer, it should use
     * the desiredCapacityHint if appropriate.
     * If a caller cannot provide a reasonable guess at the desired capacity,
     * it should pass desiredCapacityHint=0.
     *
     * If a non-scratch buffer is returned, the caller may only pass
     * a prefix to it to appendString().
     * That is, it is not correct to pass an interior pointer to appendString().
     *
     * The default implementation always returns the scratch buffer.
     *
     * @param minCapacity required minimum capacity of the returned buffer;
     *                    must be non-negative
     * @param desiredCapacityHint desired capacity of the returned buffer;
     *                            must be non-negative
     * @param scratch default caller-owned buffer
     * @param scratchCapacity capacity of the scratch buffer
     * @param resultCapacity pointer to an integer which will be set to the
     *                       capacity of the returned buffer
     * @return a buffer with *resultCapacity>=minCapacity
     * @stable ICU 4.8
     */
    virtual char16_t *getAppendBuffer(int32_t minCapacity,
                                   int32_t desiredCapacityHint,
                                   char16_t *scratch, int32_t scratchCapacity,
                                   int32_t *resultCapacity);
};

/**
 * An Appendable implementation which writes to a UnicodeString.
 *
 * This class is not intended for public subclassing.
 * @stable ICU 4.8
 */
class U_COMMON_API UnicodeStringAppendable : public Appendable {
public:
    /**
     * Aliases the UnicodeString (keeps its reference) for writing.
     * @param s The UnicodeString to which this Appendable will write.
     * @stable ICU 4.8
     */
    explicit UnicodeStringAppendable(UnicodeString &s) : str(s) {}

/**
     * Destructor.
     * @stable ICU 4.8
     */
    ~UnicodeStringAppendable();

/**
     * Appends a 16-bit code unit to the string.
     * @param c code unit
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool appendCodeUnit(char16_t c) override;

/**
     * Appends a code point to the string.
     * @param c code point 0..0x10ffff
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool appendCodePoint(UChar32 c) override;

/**
     * Appends a string to the UnicodeString.
     * @param s string, must not be NULL if length!=0
     * @param length string length, or -1 if NUL-terminated
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool appendString(const char16_t *s, int32_t length) override;

/**
     * Tells the UnicodeString that the caller is going to append roughly
     * appendCapacity char16_ts.
     * @param appendCapacity estimated number of char16_ts that will be appended
     * @return true if the operation succeeded
     * @stable ICU 4.8
     */
    virtual UBool reserveAppendCapacity(int32_t appendCapacity) override;

private:
    UnicodeString &str;
};

U_NAMESPACE_END

#endif /* U_SHOW_CPLUSPLUS_API */

#endif  // __APPENDABLE_H__