# GONMarkupParser

**Repository Path**: mirrors/GONMarkupParser

## Basic Information

- **Project Name**: GONMarkupParser
- **Description**: GONMarkupParser 是从 XML/HTML 构建 NSAttributedString，类似 iOS 的字符串
- **Primary Language**: Objective-C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/gonmarkupparser
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-09-28
- **Last Updated**: 2023-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GONMarkupParser
Easily build NSAttributedString from XML/HTML like strings.

## Demo
![ScreenShot](https://github.com/nicolasgoutaland/GONMarkupParser/blob/master/Assets/sample.gif)

## TL;DR;
```
    NSString *inputText = @"Simple input text, using a preconfigured parser.\n<color value=\"red\">This text will be displayed in red</>.\n<font size="8">This one will be displayed in small</>.\nNow a list:\n<ul><li>First item</><li>Second item</><li><color value="blue">Third blue item</></><li><b><color value="green">Fourth bold green item<//>";

    // No custom configuration, use default tags only

    // Affect text to label
    label.attributedText = [[GONMarkupParserManager sharedParser] attributedStringFromString:inputText                  
                                                                                       error:nil];
    // You can also use [label setMarkedUpText:inputText];
````
![ScreenShot](https://raw.github.com/nicolasgoutaland/GONMarkupParser/master/Assets/GONMarkupParser-example1.png)

Need a more complex example  ?

```
    NSString *inputText = @"Simple input text, using a preconfigured parser.\n<red>This text will be displayed in red</>.\n<small>This one will be displayed in small</>.\n<pwet>This one is a custom one, to demonstrate how easy it is to declare a new markup.</>";

    // Set your custom configuration here
#ifdef DEBUG
    [GONMarkupParserManager sharedParser].logLevel = GONMarkupParserLogLevelAll; // Fuck yeah, error debugging
#endif
    
    // Set default string configuration
    [[GONMarkupParserManager sharedParser].defaultConfiguration setObject:[UIFont systemFontOfSize:25.0] forKey:NSFontAttributeName];
    
    // Add a custom markup, that will center text when used, and display it in pink.
    NSMutableParagraphStyle *defaultParagraphStyle = [[NSParagraphStyle defaultParagraphStyle] mutableCopy];
    defaultParagraphStyle.alignment = NSTextAlignmentCenter;
    [[GONMarkupParserManager sharedParser] addMarkup:[GONMarkupSimple simpleMarkup:@"pwet"
                                                                             style:@{
                                                                                     NSParagraphStyleAttributeName : defaultParagraphStyle,
                                                                                     NSForegroundColorAttributeName : [@"pink" representedColor] // NSString+Color
                                                                                     }
                                                                   mergingStrategy:GONMarkupSimpleMergingStrategyMergeAll]];
    
    // Add add font markup, to display small text when encountered
    [[GONMarkupParserManager sharedParser] addMarkup:[GONMarkupNamedFont namedFontMarkup:[UIFont systemFontOfSize:12.0] forTag:@"small"]];

    // Add a convenient tag for red color
    [[GONMarkupParserManager sharedParser] addMarkup:[GONMarkupNamedColor namedColorMarkup:[UIColor redColor]
                                                                                    forTag:@"red"]];

    // Affect text to label
    label.attributedText = [[GONMarkupParserManager sharedParser] attributedStringFromString:inputText                  
                                                                                       error:nil];
````
![ScreenShot](https://raw.github.com/nicolasgoutaland/GONMarkupParser/master/Assets/GONMarkupParser-example2.png)



## Description
Creating rich text under iOS can be cumbersome, needing a lot of code.<br/>
The main goal of GONMarkupParser is to provide an easy to use syntax, near XML/HTML, but more flexible.<br/>
Some others projects exists, allowing you to build NSAttributedString from HTML, but my main goal here was to focus on text semantic. In fact, the parser will detect registered markups and apply style on text.<br/>
The purpose of this was to be able to generate different outputs from the same input string, without editing its content, but editing the markups style.<br/>

GONMarkupParser is **not** an out of the box solution to parse HTML files.

## Installation
__CocoaPods__:
    `pod 'GONMarkupParser'`<br/>
__Manual__: Copy the __Classes__ folder in your project. You will also need to __manually__ install [NSString+Color](https://github.com/nicolasgoutaland/NSString-Color). Seriously, consider using [cocoapods](http://cocoapods.org) instead ;) <br/>

Import wanted headers in your project. .pch is a good place ;)<br/>
__GONMarkupParser_All.h__ will reference all library headers, whereas __GONMarkupDefaultMarkups.h__ only references default markup classes.

## Usage
- instantiate a new __GONMarkupParser__ or use the  __+ GONMarkupParserManager sharedParser__ one.
- configure your parser adding supported tags, default ones, custom ones, etc...
- parse input string and retrieve result __NSMutableAttributedString__ using __- attributedStringFromString:error:__ method from __GONMarkupParser__
- you can also set text on __UILabel__ / __UITextField__ / __UITextView__ / __UIButton__ by using [__setMarkedUpText:__](#available-uikit-categories) methods

## How does it work ?
![ScreenShot](https://raw.github.com/nicolasgoutaland/GONMarkupParser/master/Assets/GONMarkupParser-howdoesitworks.gif)

To fully understand how style will be applied to string, you have to imagine a [LIFO stack](http://en.wikipedia.org/wiki/LIFO_(computing)) composed of style description.<br/>
Each time a new markup is found, current style configuration will be saved then stacked. New configuration will be the previous one, updated by current markup configuration.<br/>
Each time a closing markup is found, current style configuration is popped out, and previous one restored.

## Syntax
Syntax is pretty easy. It's like XML, but non valid one, to be easier and faster to write.
- Each markup  should be contained between __<__ and __>__ characters
 - __&lt;strong&gt;__
- Like XML, closing markup should start with __/__ character. You can omit markup name in closing tag. If closing tag isn't matching currently opened one, an error will be generated, no crash will occur and generated text may not be be as expected
 - __&lt;/strong&gt;__, __</>__
- You can also close all opened markup by using __<//>__

### Examples
```
 This is a <strong>valid</strong> string with some <color value="red">red <b>bold text</b></color>.
 This is a <strong>valid</>string with some <color value="red">red <b>bold text</></>.
 This is a <strong>valid</Hakuna> string with some <color value="red">red <b>bold text</mata></ta>. // Will work but generates an error
 This is a <strong>valid</> string with some <color value="red">red <b>bold text<//>.
```

## Parser
### Constructor
__GONMarkupParser__ class provide two class constructors.
- __+ defaultMarkupParser__ is a parser with all default tags registered (See [Default tags summary](#default-tags) for more information)
- __+ emptyMarkgiupParser__ is a parser without any registered tags

### Properties
A parser can have a pre / post processing block, that will be called prior and after parsing. This allows you to perform some string replace before parsing for example. 

Parsers have two interesting properties :
- __replaceNewLineCharactersFromInputString__, is intended to strip all newlines characters from input string. Use __br__ markup to add new lines. Default is __NO__.
- __replaceHTMLCharactersFromOutputString__, is intended to replace all HTML entities contained in string, after parsing. Default is __YES__.

__defaultConfiguration__ will contains default style configuration for generated attributed string. Content should be valid attributes parameters, as you may pass to __- addAttributes:range:__ of __NSMutableAttributedString__ objects. For default text color, you can set __NSForegroundColorAttributeName__ for example.

For debugging purpose, you can configure __debugLevel__ property.

__assertOnError__ property is also available to generate an assert when an error is encountered.

### Configuration
A parser must have some registered markups to correctly handling strings.<br/>
Use __- addMarkup:__, __- addMarkups:__, __- removeMarkups:__ and __- removeAllMarkups__ methods for that purpose.<br/>
__A markup can be added to only one parser at a time.__

### Registered fonts
To simplify fonts uses, you can register then using __- registerFont:forKey:__ method, then referencing them using given key.<br/>
Very useful with __&lt;font&gt;__ markup, allowing you to directly use code instead of full font name. You can also use codes such as __mainFont__, __titleFont__ to easily update them later throught all your strings.

## GONMarkupParserManager
### sharedParser
A shared parser is available, so you don't have to create one and reference it throught all your application.<br/>
Shared parser is configured with all default markups.

### Parsers registration
You can register some parser to this class, allowing you to use them from different places in your application.

## Available UIKit Categories
__UILabel__/__UITextField__/__UITextView__<br/>
2 methods were added to UILabel, UITextField and UITextView, allowing you to easily update its attributed string using a markedup one.<br/>
- __- setMarkedUpText:(NSString *)text parser:(GONMarkupParser *)parser__ will use given parser to handle string and generate attributed one.
- __- setMarkedUpText:(NSString *)text__ will use shared one, aka __[GONMarkupParserManager sharedParser]__

If no parser default configuration is set for __NSForegroundColorAttributeName__, __NSFontAttributeName__ and NSParagraphStyleAttributeName, components __textColor__, __textAlignment__ and __font__ properties will be used as default.

You are strongly encouraged to use these methods if you want to use your component style as default parser configuration.

## Anchor support
Anchor support is supported using __&lt;a href="..."&gt;__ markup.<br/>
If __NSAttributedString__ is displayed in a UITextView, you can handle user clicks on it.<br/>
Be sure your UITextView is __non editable__, __selectable__ and have its __delegate__ set.<br/>
Then, in your delegate, implements<br/>
```- (BOOL)textView:(UITextView *)textView shouldInteractWithURL:(NSURL *)URL inRange:(NSRange)characterRange``` <br/>
method.

Color style won't be applied to links. You have to use __linkTextAttributes__ attribute from your __UITextView__ to set it.

## Default tags
### Summary
| Tag        | Class | Parameters           | Effect |
|:-------------:|-------------| -----|---|
| **left** | GONMarkupAlignment | none | Force text alignment to left |
| **right** | GONMarkupAlignment | none |  Force text alignment to right |
| **center** | GONMarkupAlignment | none | Force text alignment to center |
| **justified** | GONMarkupAlignment | none | Force text alignment to justified |
| **natural** | GONMarkupAlignment | none | Force text alignment to natural  |
| **color**      | GONMarkupColor | **value** | Set text color. For supported __value__ syntaxes, check [NSString+Color](https://github.com/nicolasgoutaland/NSString-Color) [__representedColor__](https://github.com/nicolasgoutaland/NSString-Color#example) method. |
| **N/A**      | GONMarkupNamedColor | none | Set text color. Can be used to reset text color to parser default one if specified color is nil |
| **font**      | GONMarkupFont | **size**, **name**, **color**  | Set text font, text size or both. Can be used also to set text color |
| **N/A**      | GONMarkupNamedFont | none  | Set text font and size. Can be used to reset font to parser default one if specified font is nil |
| **br**      | GONMarkupLineBreak | none | Add a new line |
| **ul**      | GONMarkupList | none  | Create an unordered list |
| **ol**      | GONMarkupList | none | Create an ordered list | 
| **li**      | GONMarkupListItem | none | Add a list item to current list |
| **p**      | GONMarkupParagraph | none | Specify a paragraph. A paragraph will automatically insert a new blanck line after it |
| **inc**      | GONMarkupInc | **value** | Increment text font size. If __value__ is missing, font will be increased by one point  |
| **dec**      | GONMarkupDec | **value** | Decrement text font size. If __value__ is missing, font will be decreased by one point  |
| **reset**      | GONMarkupReset | **all** | All enclosed text will use default parser configuration |
| **N/A**      | GONMarkupSimple | none | Apply a configuration to enclosed text |
| **b**      | GONMarkupBold | none | Set text to bold. Allows user to define an override block overrideBlock to provide another font. Useful to provide a medium font instead of bold one for example.|
| **strong**      | GONMarkupStrong | none | Set text to strong (bold). Allows user to define an override block overrideBlock to provide another font. Useful to provide a medium font instead of bold one for example.|
| **i**      | GONMarkupItalic | none | Set text to italic. Allows user to define an override block overrideBlock to provide another font. Useful to provide a medium italic font instead of bold italic one for example.|
| **sup**      | GONMarkupTextStyle | none | Set text to superscript |
| **sub**      | GONMarkupTextStyle | none | Set text to subscript |
| **u**      | GONMarkupLineStyle | __words__ to apply style only on words (true, **false**), __pattern__ (**solid**, dot, dash, dashdot, dashdotdot), __style__ (**single**, thick, double) and __color__ (Check [NSString+Color](https://github.com/nicolasgoutaland/NSString-Color) [__representedColor__](https://github.com/nicolasgoutaland/NSString-Color#example) method)| Underline text |
| **strike**      | GONMarkupLineStyle |  __words__ to apply style only on words (true, **false**), __pattern__ (**solid**, dot, dash, dashdot, dashdotdot), __style__ (**single**, thick, double) and __color__ (Check [NSString+Color](https://github.com/nicolasgoutaland/NSString-Color) [__representedColor__](https://github.com/nicolasgoutaland/NSString-Color#example) method)|strikethrough text |
| **a**      | GONMarkupAnchor | __href__ link value | Support an anchor link. See [Anchor support](#anchor-support) for more information. |
| **N/A**   | GONMarkupBlock | none | When encountered executes associated block |

### Reset
Reset is a special tag, allowing you to protect some parts of a string. You can also force markup to ignore default parser configuration by setting __all__ attribute.

![ScreenShot](https://raw.github.com/nicolasgoutaland/GONMarkupParser/master/Assets/GONMarkupParser-reset.gif)

## How to add new markup
You can add new markup in your application, to add new style, or to just add some semantic to your text, allowing you to update rendering, without changing input string.<br/>
There is 3 ways to do it.

### Adding a new simple marker
The simpler way to add a new markup in your application is to use one of theses 3 following classes :
- __GONMarkupNamedColor__, allows you to add a markup that updates text color
- __GONMarkupNamedFont__, allows you to add a markup that updates text font
- __GONMarkupSimple__, allows you to add a markup that updates all text attributes. Dictionary is intended to be the same as you may pass to configure an __NSMutableAttributedString__ using -setAttributes:range: method.

#### Example
```
    // Retrieve shared parser
    GONMarkupParser *parser = [GONMarkupParserManager sharedParser];
    
    // Add a named color markup
    [parser addMarkup:[GONMarkupNamedColor namedColorMarkup:[UIColor redColor]
               forTag:@"red"]];

    // Add a named font markup
    [parser addMarkup:[GONMarkupNamedFont namedFontMarkup:[UIFont systemFontOfSize:12.0] 
               forTag:@"small"]];

    // Add a custom markup, that will center text when used, and display it in pink.
    NSMutableParagraphStyle *defaultParagraphStyle = [[NSParagraphStyle defaultParagraphStyle] mutableCopy];
    defaultParagraphStyle.alignment = NSTextAlignmentCenter;
    [parser addMarkup:[GONMarkupSimple simpleMarkup:@"pwet"
                                              style:@{
                                                        NSParagraphStyleAttributeName : defaultParagraphStyle,
                                                        NSForegroundColorAttributeName : [@"pink" representedColor] // NSString+Color
                                                     }
                                    mergingStrategy:GONMarkupSimpleMergingStrategyMergeAll]];
````

### Adding a new block based marker
For more complexe markup, you can add __GONMarkupBlock__ instances.<br />

It have blocks 5 parameters :
- __openingMarkupBlock__, called when markup opening is found. Used to pushed your custom configuration to stack
- __closingMarkupBlock__, called once markup is closed.
- __updatedContentStringBlock__, called right after __closingMarkupBlock__, allowing you to override returned string
- __prefixStringForContextBlock__, called right after __openingMarkupBlock__, allowing you to return a prefix
- __suffixStringForContextBlock__, called right after __openingMarkupBlock__, allowing you to return a suffix

#### Example
```
    // Retrieve shared parser
    GONMarkupParser *parser = [GONMarkupParserManager sharedParser];
    
    // Custom markup, based on block
    GONMarkupBlock *markupBlock = [GONMarkupBlock blockMarkup:@"custom"];
    markupBlock.openingMarkupBlock = ^(NSMutableDictionary *configurationDictionary, NSString *tag, NSMutableDictionary *context, NSDictionary *attributes) {
        // Update font size
        [configurationDictionary setObject:[UIFont boldSystemFontOfSize:69.0]
                                    forKey:NSFontAttributeName];
        
        // Update text color
        [configurationDictionary setObject:[@"brown" representedColor]
                                    forKey:NSForegroundColorAttributeName];
    };

    [parser addMarkup:markupBlock];
````

### Creating a new GONMarkup subclass
You can add a custom markup by subclassing __GONMarkup__  class.

Adding a new markup by subclassing is useful if you want to reuse your markups between several projets, or to implement more complex behavior. When subclassing, you have access to a shared object, allowing you to persists data and share it between each markup handling.

For examples, have a look a currently defined markups ;)
See __GONMarkupList__ and __GONMarkupListItem__ for an implementation using shared context.

## Troubleshooting
### Some text is missing
Check that your markup is correctly registered and that your tags are right balanced.

### When using &lt; / &gt;, some text is missing
Use &amp;lt; and &amp;gt; in text.

### Text color is still applied after my tag is closed.
This is caused by __NSAttributedString__ internal behavior. Once a color is set, it is applied until a new one is set.<br/>
To prevent this problem, be sure to have set a default text color in your parser (__defaultConfiguration__ / __NSForegroundColorAttributeName__ key). You can use __setMarkedUpText:__ on __UILabel__ / __UITextField__ to use default component configuration.

### Text style isn't applied to my link
See [Anchor support](#anchor-support) for more information.

### I am encountering some crashes when using custom font
Be sure to use correct font name, or that font code you are using is correctly registered to your parser. <br/>
Want to dump all available fonts on your device and check real names ?<br/>
Have a look [at DUMP_FONT_LIST() here](https://github.com/nicolasgoutaland/GONMacros#gonutilsmacrosh)

### No new lines are inserted using __&lt;br&gt;__
*__&lt;br&gt;__* alone is not valid in __GONMarkupParser__. Be sure to use __&lt;br/&gt;__.

### Color isn't applied
Check that you color value synthax is correct.<br/>
For more information on supported synthax, have a look at [NSString+UIColor here](https://github.com/nicolasgoutaland/NSString-Color#nsstringcolor-), that is used to compute colors from your string values.

### Did Kim Kardashian broke the Internet ?
No, definitely not. I was still able to push to GitHub yesterday.

## Evolutions
- Allow indentation prefix in lists customisation
- Implement **NSCoder** in parser and Markers
- Allow **copy** on parsers / markers
- Improve closing tag

## Contributors
See the [Contributors page](https://github.com/nicolasgoutaland/GONMarkupParser/graphs/contributors) on github.

## Changelog
Changelog can be found [here](https://github.com/nicolasgoutaland/GONMarkupParser/blob/master/CHANGELOG.md)