libdap++ Updated for version 3.8.2

escaping.h

Go to the documentation of this file.
00001 
00002 // -*- mode: c++; c-basic-offset:4 -*-
00003 
00004 // This file is part of libdap, A C++ implementation of the OPeNDAP Data
00005 // Access Protocol.
00006 
00007 // Copyright (c) 2002,2003 OPeNDAP, Inc.
00008 // Author: James Gallagher <jgallagher@opendap.org>
00009 //
00010 // This library is free software; you can redistribute it and/or
00011 // modify it under the terms of the GNU Lesser General Public
00012 // License as published by the Free Software Foundation; either
00013 // version 2.1 of the License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00023 //
00024 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
00025 
00026 // (c) COPYRIGHT URI/MIT 1999
00027 // Please read the full copyright statement in the file COPYRIGHT_URI.
00028 //
00029 // Authors:
00030 //      jhrg,jimg       James Gallagher <jgallagher@gso.uri.edu>
00031 
00032 // Declarations for identifier escaping and un-escaping functions.
00033 
00034 #ifndef _escaping_h
00035 #define _escaping_h
00036 
00037 #include <string>
00038 
00039 using std::string;
00040 
00041 namespace libdap
00042 {
00043 
00044 string hexstring(unsigned char val);
00045 string unhexstring(string s);
00046 string octstring(unsigned char val);
00047 string unoctstring(string s);
00048 
00049 // The original set of allowed characters was: [0-9a-zA-Z_%]
00050 // The characters accepted in DAP2 ids: [-+a-zA-Z0-9_/%.\\#*]; everything
00051 // else must be escaped.  Note that for some inscrutable reason, we've been
00052 // escaping '*'.
00053 
00054 // The characters allowable in an id in a URI (see RFC 2396):
00055 // [-A-Za-z0-9_.!~*'()].
00056 
00057 string id2www(string s, const string &allowable = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-+_/.\\*");
00058 
00059 // This is what DAP2 allows in a ce: [-+a-zA-Z0-9_/%.\\#]
00060 string id2www_ce(string s, const string &allowable = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-+_/.\\");
00061 
00062 string www2id(const string &in, const string &escape = "%",
00063               const string &except = "");
00064 
00065 // Include these for compatibility with the old names. 7/19/2001 jhrg
00066 #define id2dods id2www
00067 #define dods2id www2id
00068 
00069 string octal_to_hex(const string &octal_digits);
00070 
00071 string id2xml(string in, const string &not_allowed = "><&'\"");
00072 string xml2id(string in);
00073 
00074 string esc2underscore(string s);
00075 string char2ASCII(string s, const string escape = "%[0-7][0-9a-fA-F]");
00076 string escattr(string s);
00077 string unescattr(string s);
00078 
00079 string munge_error_message(string msg);
00080 
00081 string unescape_double_quotes(string source);
00082 string escape_double_quotes(string source);
00083 
00084 } // namespace libdap
00085 
00086 #endif // _escaping_h
00087