Add skeletal NSXML work as requested.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@27824 72102866-910b-0410-8b05-ffd578937521
2025-05-31 08:41:03 +00:00 · 2009-02-09 16:16:11 +00:00 · 2009-02-09 16:16:11 +00:00 · 910deff1a6
commit 910deff1a6
parent 2f24254d4f
21 changed files with 2553 additions and 4 deletions
--- a/Headers/Foundation/NSXMLElement.h
+++ b/Headers/Foundation/NSXMLElement.h
@ -0,0 +1,203 @@
+/* Interface for NSXMLElement for GNUStep
+   Copyright (C) 2008 Free Software Foundation, Inc.
+
+   Written by:  Richard Frith-Macdonald <rfm@gnu.org>
+   Created: September 2008
+
+   This file is part of the GNUstep Base Library.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 3 of the License, or (at your option) any later version.
+   
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free
+   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02111 USA.
+*/
+
+#ifndef __NSXMLElement_h_GNUSTEP_BASE_INCLUDE
+#define __NSXMLElement_h_GNUSTEP_BASE_INCLUDE
+#import	<GNUstepBase/GSVersionMacros.h>
+
+#import <Foundation/NSXMLNode.h>
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+
+@class NSDictionary, NSEnumerator, NSMutableArray;
+
+/**
+ * Represents an XML element.<br />
+ */
+@interface NSXMLElement : NSXMLNode
+{
+@protected
+  NSString              *_name;
+  NSMutableArray        *_attributes;
+  NSMutableArray        *_namespaces;
+  NSArray               *_children;
+  BOOL                   _childrenHaveMutated;
+  uint8_t               _unused[sizeof(void*)- 1];
+  NSString              *_URI;	
+  NSInteger             _prefixIndex;
+}
+
+/**
+ * Initialises the receiver with the given name.
+ */
+- (id) initWithName: (NSString*)name;
+
+/**
+ * Initialises the receiver with the given name and namespace URI.
+ */
+- (id) initWithName: (NSString*)name URI: (NSString*)URI;
+
+/**
+ * Initialises the receiver as a text node with the given name and content.
+ */
+- (id) initWithName: (NSString*)name stringValue: (NSString*)string;
+
+/**
+ * Initialises the receiver by parsing the XML string supplied.
+ */
+- (id) initWithXMLString: (NSString*)string error: (NSError**)error;
+
+/**
+ * Searches for and returns all child elements which match name.
+ */
+- (NSArray*) elementsForName: (NSString*)name;
+
+/**
+ * Searches for and returns all child elements which match localName
+ * and the specified URI.
+ */
+- (NSArray*) elementsForLocalName: (NSString*)localName URI: (NSString*)URI;
+
+/**
+ * Adds the supplied attribute to the receiver (ignoring if it has a duplicate
+ * name).
+ */
+- (void) addAttribute: (NSXMLNode*)attribute;
+
+/**
+ * Removes the named attribute.
+ */
+- (void) removeAttributeForName: (NSString*)name;
+
+/**
+ * Sets the attributes of the receiver, ignoring all but the first of any
+ * duplicates.
+ */
+- (void) setAttributes: (NSArray*)attributes;
+
+/**
+ * Sets attributes from the supplkied dictionary.
+ */
+- (void) setAttributesAsDictionary: (NSDictionary*)attributes;
+
+/**
+ * Returns the receiver's attributes.
+ */
+- (NSArray*) attributes;
+
+/**
+ * Returns the named attribute.
+ */
+- (NSXMLNode*) attributeForName: (NSString*)name;
+
+/**
+ * Returns the attribute matching localName and URI.
+ */
+- (NSXMLNode*) attributeForLocalName: (NSString*)localName
+                                  URI: (NSString*)URI;
+
+/**
+ * Adds a namespace unless the name is a duplicate.
+ */
+- (void) addNamespace: (NSXMLNode*)aNamespace;
+
+/**
+ * Removes a named namespace.
+ */
+- (void) removeNamespaceForPrefix: (NSString*)name;
+
+/**
+ * Sets the namespaces for the receiver, ignoring all but the first
+ * of any duplicates.
+ */
+- (void) setNamespaces: (NSArray*)namespaces;
+
+/**
+ * Returns the namespaces of the receiver.
+ */
+- (NSArray*) namespaces;
+
+/**
+ * Returns the namespace for the specified prefix in the receiver.
+ */
+- (NSXMLNode*) namespaceForPrefix: (NSString*)name;
+
+/**
+ * Returns the namespace found by searching the chain of namespaces.
+ */
+- (NSXMLNode*) resolveNamespaceForName: (NSString*)name;
+
+/**
+ * Returns the URI by searching the chain of namespaces.
+ */
+- (NSString*) resolvePrefixForNamespaceURI: (NSString*)namespaceURI;
+
+/**
+ * Inerts a child node.
+ */
+- (void) insertChild: (NSXMLNode*)child atIndex: (NSUInteger)index;
+
+/**
+ * Inserts a number of children.
+ */
+- (void) insertChildren: (NSArray*)children atIndex: (NSUInteger)index;
+
+/**
+ * Removes a child node.
+ */
+- (void) removeChildAtIndex: (NSUInteger)index;
+
+/**
+ * Replaces all existing child nodes with those from the array.
+ */
+- (void) setChildren: (NSArray*)children;
+
+/**
+ * Adds a child after existing children.
+ */
+- (void) addChild: (NSXMLNode*)child;
+
+/**
+ * Replaces the child at the specified index.
+ */
+- (void) replaceChildAtIndex: (NSUInteger)index withNode: (NSXMLNode*)node;
+
+/**
+ * Merges adjacent text nodes. If a node's value is the empty string,
+ * and preserve is NO, it is removed.<br />
+ * This should be called with a value of NO before using
+ * XQuery or XPath.
+ */
+- (void) normalizeAdjacentTextNodesPreservingCDATA: (BOOL)preserve;
+
+@end
+
+#if	defined(__cplusplus)
+}
+#endif
+
+#endif /*__NSXMLElement_h_GNUSTEP_BASE_INCLUDE */