Swiftgram/Source/Details/ASMutableAttributedStringBuilder.h
appleguy 465abb1ded [License] Simplify the Texture license to be pure Apache 2 (removing ASDK-Licenses). (#1077)
* [License] Simplify the Texture license to be pure Apache 2 (removing ASDK-Licenses)

With permission of the Facebook Open Source team, we are simplifying the Texture
license so that clients can rely on the Apache 2 terms that most of Texture is
already covered by. This means that code originally forked from AsyncDisplayKit
will be re-licensed from "BSD 3-clause + PATENTS v2" to Apache 2 without a
PATENTS file.

After getting confirmation that the updates to these core files look good, we'll
propagate this new license header to all files (in this same PR) and get sign-off
from all parties before landing.

* [License] Update all Texture source files to be pure Apache 2.

* Changelog entry for Apache 2 license update.

* Revert "[License] Update all Texture source files to be pure Apache 2."

This reverts commit ffa0fbbba9717d871dd16c4b07539f2f8208fc2b.

* [License] Update all Texture source files to be pure Apache 2, maintaining copyrights.

* [License] Update CONTRIBUTING, README, Podspec & Dangerfile.
2018-08-28 07:39:18 -07:00

66 lines
2.9 KiB
Objective-C

//
// ASMutableAttributedStringBuilder.h
// Texture
//
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
//
#import <Foundation/Foundation.h>
#import <AsyncDisplayKit/ASBaseDefines.h>
NS_ASSUME_NONNULL_BEGIN
/*
* Use this class to compose new attributed strings. You may use the normal
* attributed string calls on this the same way you would on a normal mutable
* attributed string, but it coalesces your changes into transactions on the
* actual string allowing improvements in performance.
*
* @discussion This is a use-once and throw away class for each string you make.
* Since this class is designed for increasing performance, we actually hand
* back the internally managed mutable attributed string in the
* `composedAttributedString` call. So once you make that call, any more
* changes will actually modify the string that was handed back to you in that
* method.
*
* Combination of multiple calls into single attribution is managed through
* merging of attribute dictionaries over ranges. For best performance, call
* collections of attributions over a single range together. So for instance,
* don't call addAttributes for range1, then range2, then range1 again. Group
* them together so you call addAttributes for both range1 together, and then
* range2.
*
* Also please note that switching between addAttribute and setAttributes in the
* middle of composition is a bad idea for performance because they have
* semantically different meanings, and trigger a commit of the pending
* attributes.
*
* Please note that ALL of the standard NSString methods are left unimplemented.
*/
AS_SUBCLASSING_RESTRICTED
@interface ASMutableAttributedStringBuilder : NSMutableAttributedString
- (instancetype)initWithString:(NSString *)str attributes:(nullable NSDictionary<NSString *, id> *)attrs;
- (instancetype)initWithAttributedString:(NSAttributedString *)attrStr;
- (void)replaceCharactersInRange:(NSRange)range withString:(NSString *)str;
- (void)setAttributes:(nullable NSDictionary<NSString *, id> *)attrs range:(NSRange)range;
- (void)addAttribute:(NSString *)name value:(id)value range:(NSRange)range;
- (void)addAttributes:(NSDictionary<NSString *, id> *)attrs range:(NSRange)range;
- (void)removeAttribute:(NSString *)name range:(NSRange)range;
- (void)replaceCharactersInRange:(NSRange)range withAttributedString:(NSAttributedString *)attrString;
- (void)insertAttributedString:(NSAttributedString *)attrString atIndex:(NSUInteger)loc;
- (void)appendAttributedString:(NSAttributedString *)attrString;
- (void)deleteCharactersInRange:(NSRange)range;
- (void)setAttributedString:(NSAttributedString *)attrString;
- (NSMutableAttributedString *)composedAttributedString;
@end
NS_ASSUME_NONNULL_END