/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: NPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Netscape Public License * Version 1.1 (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.mozilla.org/NPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the NPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the NPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ /* First checked in on 98/12/03 by John R. McMullen, derived from net.h/mkparse.c. */ #ifndef _ESCAPE_H_ #define _ESCAPE_H_ #include "prtypes.h" #include "nscore.h" #include "nsError.h" #include "nsString.h" /* valid mask values for NET_Escape() and NET_EscapedSize(). */ typedef enum { url_XAlphas = PR_BIT(0) , url_XPAlphas = PR_BIT(1) , url_Path = PR_BIT(2) } nsEscapeMask; #ifdef __cplusplus extern "C" { #endif NS_COM char * nsEscape(const char * str, nsEscapeMask mask); /* Caller must use nsCRT::free() on the result */ NS_COM char * nsUnescape(char * str); /* decode % escaped hex codes into character values, * modifies the parameter, returns the same buffer */ NS_COM char * nsEscapeCount(const char * str, PRInt32 len, nsEscapeMask mask, PRInt32* out_len); /* Like nsEscape, but if out_len is non-null, return result string length * in *out_len, and uses len instead of NUL termination. * Caller must use nsCRT::free() on the result. */ NS_COM PRInt32 nsUnescapeCount (char * str); /* decode % escaped hex codes into character values, * modifies the parameter buffer, returns the length of the result * (result may contain \0's). */ NS_COM char * nsEscapeHTML(const char * string); NS_COM PRUnichar * nsEscapeHTML2(const PRUnichar *aSourceBuffer, PRInt32 aSourceBufferLen = -1); /* * Escape problem char's for HTML display */ /** * DEPRECATED API: use NS_EscapeURL/NS_UnescapeURL instead */ NS_COM nsresult nsStdEscape(const char* str, PRInt16 mask, nsCString &result); NS_COM nsresult nsStdUnescape(char* str, char **result); #ifdef __cplusplus } #endif /** * NS_EscapeURL/NS_UnescapeURL constants for |flags| parameter: */ enum EscapeMask { /** url components **/ esc_Scheme = PR_BIT(0), esc_Username = PR_BIT(1), esc_Password = PR_BIT(2), esc_Host = PR_BIT(3), esc_Directory = PR_BIT(4), esc_FileBaseName = PR_BIT(5), esc_FileExtension = PR_BIT(6), esc_FilePath = esc_Directory | esc_FileBaseName | esc_FileExtension, esc_Param = PR_BIT(7), esc_Query = PR_BIT(8), esc_Ref = PR_BIT(9), /** special flags **/ esc_Forced = PR_BIT(10), /* forces escaping of existing escape sequences */ esc_OnlyASCII = PR_BIT(11), /* causes non-ascii octets to be skipped */ esc_OnlyNonASCII = PR_BIT(12), /* causes ascii octets to be skipped */ esc_AlwaysCopy = PR_BIT(13) /* copy input to result buf even if escaping is unnecessary */ }; /** * NS_EscapeURL * * Escapes invalid char's in an URL segment. Has no side-effect if the URL * segment is already escaped. Otherwise, the escaped URL segment is appended * to |result|. * * @param str url segment string * @param len url segment string length (-1 if unknown) * @param flags url segment type flag * @param result result buffer, untouched if part is already escaped * * @return TRUE if escaping was performed, FALSE otherwise. */ NS_COM PRBool NS_EscapeURL(const char *str, PRInt32 len, PRInt16 flags, nsACString &result); /** * Expands URL escape sequences... beware embedded null bytes! * * @param str url string to unescape * @param len length of |str| * @param flags only esc_OnlyNonASCII and esc_AlwaysCopy are recognized * @param result result buffer, untouched if |str| is already unescaped * * @return TRUE if unescaping was performed, FALSE otherwise. */ NS_COM PRBool NS_UnescapeURL(const char *str, PRInt32 len, PRInt16 flags, nsACString &result); /** returns resultant string length **/ inline PRInt32 NS_UnescapeURL(char *str) { return nsUnescapeCount(str); } /** * string friendly versions... */ inline const nsACString & NS_EscapeURL(const nsASingleFragmentCString &part, PRInt16 partType, nsACString &result) { const char *temp; if (NS_EscapeURL(part.BeginReading(temp), part.Length(), partType, result)) return result; return part; } inline const nsACString & NS_UnescapeURL(const nsASingleFragmentCString &str, PRInt16 flags, nsACString &result) { const char *temp; if (NS_UnescapeURL(str.BeginReading(temp), str.Length(), flags, result)) return result; return str; } // inline unescape inline nsAFlatCString & NS_UnescapeURL(nsAFlatCString &str) { str.SetLength(nsUnescapeCount((char*)str.get())); return str; } #endif // _ESCAPE_H_