netwerk/protocol/about/public/nsAboutProtocolUtils.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is nsAboutProtocolUtils.
  15  *
  16  * The Initial Developer of the Original Code is the Mozilla Foundation.
  17  * Portions created by the Initial Developer are Copyright (C) 2005
  18  * the Initial Developer. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *   L. David Baron <dbaron@dbaron.org> (original author)
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsIURI.h"
  38 #include "nsString.h"
  39 #include "nsReadableUtils.h"
  40 #include "nsIAboutModule.h"
  41
  42 inline nsresult
  43 NS_GetAboutModuleName(nsIURI *aAboutURI, nsCString& aModule)
  44 {
  45 #ifdef DEBUG
  46     {
  47         PRBool isAbout;
  48         NS_ASSERTION(NS_SUCCEEDED(aAboutURI->SchemeIs("about", &isAbout)) &&
  49                      isAbout,
  50                      "should be used only on about: URIs");
  51     }
  52 #endif
  53
  54     nsresult rv = aAboutURI->GetPath(aModule);
  55     NS_ENSURE_SUCCESS(rv, rv);
  56
  57     PRInt32 f = aModule.FindCharInSet(NS_LITERAL_CSTRING("#?"));
  58     if (f != kNotFound) {
  59         aModule.Truncate(f);
  60     }
  61
  62     // convert to lowercase, as all about: modules are lowercase
  63     ToLowerCase(aModule);
  64     return NS_OK;
  65 }
  66
  67 inline nsresult
  68 NS_GetAboutModule(nsIURI *aAboutURI, nsIAboutModule** aModule)
  69 {
  70   NS_PRECONDITION(aAboutURI, "Must have URI");
  71
  72   nsCAutoString contractID;
  73   nsresult rv = NS_GetAboutModuleName(aAboutURI, contractID);
  74   if (NS_FAILED(rv)) return rv;
  75
  76   // look up a handler to deal with "what"
  77   contractID.Insert(NS_LITERAL_CSTRING(NS_ABOUT_MODULE_CONTRACTID_PREFIX), 0);
  78
  79   return CallGetService(contractID.get(), aModule);
  80 }