Back to index

lightning-sunbird  0.9+nobinonly
nsServiceManagerUtils.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 XPCOM.
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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsServiceManagerUtils_h__
00039 #define nsServiceManagerUtils_h__
00040 
00041 #include "nsIServiceManager.h"
00042 #include "nsCOMPtr.h"
00043 
00044 inline
00045 const nsGetServiceByCID
00046 do_GetService(const nsCID& aCID)
00047 {
00048     return nsGetServiceByCID(aCID);
00049 }
00050 
00051 inline
00052 const nsGetServiceByCIDWithError
00053 do_GetService(const nsCID& aCID, nsresult* error)
00054 {
00055     return nsGetServiceByCIDWithError(aCID, error);
00056 }
00057 
00058 inline
00059 const nsGetServiceByContractID
00060 do_GetService(const char* aContractID)
00061 {
00062     return nsGetServiceByContractID(aContractID);
00063 }
00064 
00065 inline
00066 const nsGetServiceByContractIDWithError
00067 do_GetService( const char* aContractID, nsresult* error)
00068 {
00069     return nsGetServiceByContractIDWithError(aContractID, error);
00070 }
00071 
00072 class nsGetServiceFromCategory : public nsCOMPtr_helper
00073 {
00074  public:
00075     nsGetServiceFromCategory(const char* aCategory, const char* aEntry,
00076                              nsresult* aErrorPtr)
00077         : mCategory(aCategory),
00078         mEntry(aEntry),
00079         mErrorPtr(aErrorPtr)
00080         {
00081             // nothing else to do
00082         }
00083     
00084     virtual nsresult NS_FASTCALL operator()( const nsIID&, void** ) const;
00085  protected:
00086     const char*                 mCategory;
00087     const char*                 mEntry;
00088     nsresult*                   mErrorPtr;
00089 };
00090 
00091 inline
00092 const nsGetServiceFromCategory
00093 do_GetServiceFromCategory( const char* category, const char* entry,
00094                            nsresult* error = 0)
00095 {
00096     return nsGetServiceFromCategory(category, entry, error);
00097 }
00098 
00099 NS_COM_GLUE nsresult
00100 CallGetService(const nsCID &aClass, const nsIID &aIID, void **aResult);
00101 
00102 NS_COM_GLUE nsresult
00103 CallGetService(const char *aContractID, const nsIID &aIID, void **aResult);
00104 
00105 // type-safe shortcuts for calling |GetService|
00106 template <class DestinationType>
00107 inline
00108 nsresult
00109 CallGetService( const nsCID &aClass,
00110                 DestinationType** aDestination)
00111 {
00112     NS_PRECONDITION(aDestination, "null parameter");
00113     
00114     return CallGetService(aClass,
00115                           NS_GET_IID(DestinationType),
00116                           NS_REINTERPRET_CAST(void**, aDestination));
00117 }
00118 
00119 template <class DestinationType>
00120 inline
00121 nsresult
00122 CallGetService( const char *aContractID,
00123                 DestinationType** aDestination)
00124 {
00125     NS_PRECONDITION(aContractID, "null parameter");
00126     NS_PRECONDITION(aDestination, "null parameter");
00127     
00128     return CallGetService(aContractID,
00129                           NS_GET_IID(DestinationType),
00130                           NS_REINTERPRET_CAST(void**, aDestination));
00131 }
00132 
00133 #endif