aboutsummaryrefslogtreecommitdiff
path: root/Foundation/GTMNSString+XML.h
diff options
context:
space:
mode:
authorGravatar thomasvl <thomasvl@7dc7ac4e-7543-0410-b95c-c1676fc8e2a3>2008-01-28 20:19:42 +0000
committerGravatar thomasvl <thomasvl@7dc7ac4e-7543-0410-b95c-c1676fc8e2a3>2008-01-28 20:19:42 +0000
commit2a5219567634ab7ab74314ff3615132becadff4a (patch)
tree8e6f447544e5eaf460da741bf57771f929b4a70c /Foundation/GTMNSString+XML.h
initial drop of a few sources to start things out
Diffstat (limited to 'Foundation/GTMNSString+XML.h')
-rw-r--r--Foundation/GTMNSString+XML.h39
1 files changed, 39 insertions, 0 deletions
diff --git a/Foundation/GTMNSString+XML.h b/Foundation/GTMNSString+XML.h
new file mode 100644
index 0000000..ed2d161
--- /dev/null
+++ b/Foundation/GTMNSString+XML.h
@@ -0,0 +1,39 @@
+//
+// GTMNSString+XML.h
+//
+// Copyright 2007-2008 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not
+// use this file except in compliance with the License. You may obtain a copy
+// of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations under
+// the License.
+//
+
+#import <Foundation/Foundation.h>
+
+/// Utilities for NSStrings containing XML
+@interface NSString (GTMNSStringXMLAdditions)
+
+/// Get a string where characters that need escaping for XML are escaped and invalid characters removed
+//
+/// This call escapes '&', '<, '>', '\'', '"' per the xml spec and removes all
+/// invalid characters as defined by Section 2.2 of the xml spec.
+///
+/// For obvious reasons this call is only safe once.
+//
+// Returns:
+// Autoreleased NSString
+//
+- (NSString *)gtm_stringByEscapingForXML;
+
+// There is no stringByUnescapingFromXML because the XML parser will do this.
+// The above api is here just incase you need to create XML yourself.
+
+@end