Back to index

lightning-sunbird  0.9+nobinonly
nsEscape.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Sean Su <ssu@netscape.com>
00024  *   Revision checked in on 01/03/22 by ssu@netscape.com, derived from:
00025  *   mozilla/xpcom/io/nsEscape.h
00026  *   mozilla/xpcom/io/nsEscape.cpp
00027  *
00028  * Alternatively, the contents of this file may be used under the terms of
00029  * either of the GNU General Public License Version 2 or later (the "GPL"),
00030  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00031  * in which case the provisions of the GPL or the LGPL are applicable instead
00032  * of those above. If you wish to allow use of your version of this file only
00033  * under the terms of either the GPL or the LGPL, and not to allow others to
00034  * use your version of this file under the terms of the MPL, indicate your
00035  * decision by deleting the provisions above and replace them with the notice
00036  * and other provisions required by the GPL or the LGPL. If you do not delete
00037  * the provisions above, a recipient may use your version of this file under
00038  * the terms of any one of the MPL, the GPL or the LGPL.
00039  *
00040  * ***** END LICENSE BLOCK ***** */
00041 
00042 #ifndef _ESCAPE_H_
00043 #define _ESCAPE_H_
00044 
00045 #define NS_COM
00046 #define PRUnichar char
00047 
00048 /* valid mask values for NET_Escape() and NET_EscapedSize(). */
00049 typedef enum {
00050        url_XAlphas          = (1<<0)
00051 ,      url_XPAlphas  = (1<<1)
00052 ,      url_Path             = (1<<2)
00053 } nsEscapeMask;
00054 
00055 #ifdef __cplusplus
00056 extern "C" {
00057 #endif
00058 NS_COM char * nsEscape(const char * str, nsEscapeMask mask);
00059        /* Caller must use nsCRT::free() on the result */
00060 
00061 NS_COM char * nsUnescape(char * str);
00062        /* decode % escaped hex codes into character values,
00063         * modifies the parameter, returns the same buffer
00064         */
00065 
00066 NS_COM char * nsEscapeCount(const char * str, PRInt32 len, nsEscapeMask mask, PRInt32* out_len);
00067        /* Like nsEscape, but if out_len is non-null, return result string length
00068         * in *out_len, and uses len instead of NUL termination.
00069         * Caller must use nsCRT::free() on the result.
00070         */
00071 NS_COM PRInt32 nsUnescapeCount (char * str);
00072        /* decode % escaped hex codes into character values,
00073         * modifies the parameter buffer, returns the length of the result
00074         * (result may contain \0's).
00075         */
00076 
00077 #ifdef __cplusplus
00078 }
00079 #endif
00080 
00081 #endif //  _ESCAPE_H_
00082