ObjFW
OFXMLElementBuilder.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
3  * Jonathan Schleifer <js@webkeks.org>
4  *
5  * All rights reserved.
6  *
7  * This file is part of ObjFW. It may be distributed under the terms of the
8  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
9  * the packaging of this file.
10  *
11  * Alternatively, it may be distributed under the terms of the GNU General
12  * Public License, either version 2 or 3, which can be found in the file
13  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
14  * file.
15  */
16 
17 #import "OFObject.h"
18 #import "OFXMLParser.h"
19 
20 OF_ASSUME_NONNULL_BEGIN
21 
22 @class OFMutableArray OF_GENERIC(ObjectType);
23 @class OFXMLElement;
24 @class OFXMLElementBuilder;
25 
44 - (void)elementBuilder: (OFXMLElementBuilder*)builder
45  didBuildElement: (OFXMLElement*)element;
46 
47 #ifdef OF_HAVE_OPTIONAL_PROTOCOLS
48 @optional
49 #endif
50 
61 - (void)elementBuilder: (OFXMLElementBuilder*)builder
62  didBuildParentlessNode: (OFXMLNode*)node;
63 
82 - (void)elementBuilder: (OFXMLElementBuilder*)builder
83  didNotExpectCloseTag: (OFString*)name
84  prefix: (nullable OFString*)prefix
85  namespace: (nullable OFString*)namespace_;
86 
95 - (OFString*)elementBuilder: (OFXMLElementBuilder*)builder
96  foundUnknownEntityNamed: (OFString*)entity;
97 @end
98 
110 {
111  OFMutableArray OF_GENERIC(OFXMLElement*) *_stack;
112  id <OFXMLElementBuilderDelegate> _delegate;
113 }
114 
115 #ifdef OF_HAVE_PROPERTIES
116 @property OF_NULLABLE_PROPERTY (assign)
117  id <OFXMLElementBuilderDelegate> delegate;
118 #endif
119 
125 + (instancetype)elementBuilder;
126 
132 - (void)setDelegate: (nullable id <OFXMLElementBuilderDelegate>)delegate;
133 
139 - (nullable id <OFXMLElementBuilderDelegate>)delegate;
140 @end
141 
142 @interface OFObject (OFXMLElementBuilderDelegate) <OFXMLElementBuilderDelegate>
143 @end
144 
145 OF_ASSUME_NONNULL_END
A protocol that needs to be implemented by delegates for OFXMLElementBuilder.
Definition: OFXMLElementBuilder.h:33
A class which stores an XML element.
Definition: OFXMLElement.h:35
The root class for all other classes inside ObjFW.
Definition: OFObject.h:364
An abstract class for storing, adding and removing objects in an array.
Definition: OFMutableArray.h:46
A class for handling strings.
Definition: OFString.h:91
A class implementing the OFXMLParserDelegate protocol that can build OFXMLElements from the document ...
Definition: OFXMLElementBuilder.h:109
A class which stores an XML element.
Definition: OFXMLNode.h:27
A protocol that needs to be implemented by delegates for OFXMLParser.
Definition: OFXMLParser.h:37