ObjFW
OFString+XMLUnescaping.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3.0 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13  * version 3.0 for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * version 3.0 along with this program. If not, see
17  * <https://www.gnu.org/licenses/>.
18  */
19 
20 #import "OFString.h"
21 
22 OF_ASSUME_NONNULL_BEGIN
23 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 extern int _OFString_XMLUnescaping_reference OF_VISIBILITY_HIDDEN;
30 #ifdef __cplusplus
31 }
32 #endif
33 
34 #ifdef OF_HAVE_BLOCKS
35 
43 typedef OFString *_Nullable (^OFStringXMLUnescapingBlock)(OFString *string,
44  OFString *entity);
45 #endif
46 
66 - (nullable OFString *)string: (OFString *)string
67  containsUnknownEntityNamed: (OFString *)entity;
68 @end
69 
70 @interface OFString (XMLUnescaping)
74 @property (readonly, nonatomic) OFString *stringByXMLUnescaping;
75 
84 - (OFString *)stringByXMLUnescapingWithDelegate:
85  (nullable id <OFStringXMLUnescapingDelegate>)delegate;
86 
87 #ifdef OF_HAVE_BLOCKS
88 
96 - (OFString *)stringByXMLUnescapingWithBlock: (OFStringXMLUnescapingBlock)block;
97 #endif
98 @end
99 
100 OF_ASSUME_NONNULL_END
The root class for all other classes inside ObjFW.
Definition: OFObject.h:690
OFString *(^ OFStringXMLUnescapingBlock)(OFString *string, OFString *entity)
A block which is called to replace unknown XML entities in an XML string.
Definition: OFString+XMLUnescaping.h:43
OFString * stringByXMLUnescaping
The string with XML entities unescapted.
Definition: OFString+XMLUnescaping.h:74
A class for handling strings.
Definition: OFString.h:142
A protocol that needs to be implemented by delegates for stringByXMLUnescapingWithHandler:.