Back to index

lightning-sunbird  0.9+nobinonly
nsUrlClassifierUtils.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Url Classifier code
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Google Inc.
00018  * Portions created by the Initial Developer are Copyright (C) 2007
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #ifndef nsUrlClassifierUtils_h_
00038 #define nsUrlClassifierUtils_h_
00039 
00040 #include "nsIUrlClassifierUtils.h"
00041 
00042 class nsUrlClassifierUtils : public nsIUrlClassifierUtils
00043 {
00044 public:
00045   nsUrlClassifierUtils();
00046   ~nsUrlClassifierUtils() {};
00047 
00048   NS_DECL_ISUPPORTS
00049   NS_DECL_NSIURLCLASSIFIERUTILS
00050 
00051   // This function will encode all "special" characters in typical url encoding,
00052   // that is %hh where h is a valid hex digit.  The characters which are encoded
00053   // by this function are any ascii characters under 32(control characters and
00054   // space), 37(%), and anything 127 or above (special characters).  Url is the
00055   // string to encode, ret is the encoded string.  Function returns true if
00056   // ret != url.
00057   PRBool SpecialEncode(const nsACString & url, nsACString & _retval);
00058 
00059 private:
00060   // Disallow copy constructor
00061   nsUrlClassifierUtils(const nsUrlClassifierUtils&);
00062 
00063   // Function to tell if we should encode a character.
00064   PRBool ShouldURLEscape(const unsigned char c) const;
00065 };
00066 
00067 #endif // nsUrlClassifierUtils_h_