/gecko_api/include/nsXPCOMGlue.h
C Header | 131 lines | 35 code | 15 blank | 81 comment | 0 complexity | f67eddd98d019a2e34095a0555627588 MD5 | raw file
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ 2/* ***** BEGIN LICENSE BLOCK ***** 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1 4 * 5 * The contents of this file are subject to the Mozilla Public License Version 6 * 1.1 (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * http://www.mozilla.org/MPL/ 9 * 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 12 * for the specific language governing rights and limitations under the 13 * License. 14 * 15 * The Original Code is mozilla.org code. 16 * 17 * The Initial Developer of the Original Code is 18 * Netscape Communications Corporation. 19 * Portions created by the Initial Developer are Copyright (C) 1998 20 * the Initial Developer. All Rights Reserved. 21 * 22 * Contributor(s): 23 * Benjamin Smedberg <benjamin@smedbergs.us> 24 * 25 * Alternatively, the contents of this file may be used under the terms of 26 * either of the GNU General Public License Version 2 or later (the "GPL"), 27 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), 28 * in which case the provisions of the GPL or the LGPL are applicable instead 29 * of those above. If you wish to allow use of your version of this file only 30 * under the terms of either the GPL or the LGPL, and not to allow others to 31 * use your version of this file under the terms of the MPL, indicate your 32 * decision by deleting the provisions above and replace them with the notice 33 * and other provisions required by the GPL or the LGPL. If you do not delete 34 * the provisions above, a recipient may use your version of this file under 35 * the terms of any one of the MPL, the GPL or the LGPL. 36 * 37 * ***** END LICENSE BLOCK ***** */ 38 39#ifndef nsXPCOMGlue_h__ 40#define nsXPCOMGlue_h__ 41 42#include "nscore.h" 43 44class nsILocalFile; 45 46/** 47 * The following function is available in both the standalone and 48 * dynamically linked versions of the glue. 49 */ 50 51struct GREVersionRange { 52 const char *lower; 53 PRBool lowerInclusive; 54 const char *upper; 55 PRBool upperInclusive; 56}; 57 58struct GREProperty { 59 const char *property; 60 const char *value; 61}; 62 63/** 64 * Locate the path of the xpcom shared library from a GRE with specified 65 * properties. 66 * 67 * @param versions An array of version ranges: if any version range 68 * matches, the GRE is considered acceptable. 69 * @param versionsLength The length of the versions array. 70 * @param properties A null-terminated list of GRE property/value pairs 71 * which must all be satisfied. 72 * @param propertiesLength Length of the properties array. 73 * @param buffer A buffer to be filled with the appropriate path. If 74 * the "local" GRE is specified (via the USE_LOCAL_GRE 75 * environment variable, for example), this buffer 76 * will be set to the empty string. 77 * @param buflen The length of buffer. This must be at least 78 * PATH_MAX/MAXPATHLEN. 79 * @throws NS_ERROR_FAILURE if an appropriate GRE could not be found. 80 * @note The properties parameter is ignored on macintosh, because of the 81 * manner in which the XUL frameworks are installed by version. 82 * @note Currently this uses a "first-fit" algorithm, it does not select 83 * the newest available GRE. 84 */ 85extern "C" NS_COM_GLUE nsresult 86GRE_GetGREPathWithProperties(const GREVersionRange *versions, 87 PRUint32 versionsLength, 88 const GREProperty *properties, 89 PRUint32 propertiesLength, 90 char *buffer, PRUint32 buflen); 91 92#ifdef XPCOM_GLUE 93 94/** 95 * The following functions are only available in the standalone glue. 96 */ 97 98/** 99 * Initialize the XPCOM glue by dynamically linking against the XPCOM 100 * shared library indicated by xpcomFile. 101 */ 102extern "C" NS_HIDDEN_(nsresult) 103XPCOMGlueStartup(const char* xpcomFile); 104 105typedef void (*NSFuncPtr)(); 106 107struct nsDynamicFunctionLoad 108{ 109 const char *functionName; 110 NSFuncPtr *function; 111}; 112 113/** 114 * Dynamically load functions from libxul. 115 * 116 * @throws NS_ERROR_NOT_INITIALIZED if XPCOMGlueStartup() was not called or 117 * if the libxul DLL was not found. 118 * @throws NS_ERROR_LOSS_OF_SIGNIFICANT_DATA if only some of the required 119 * functions were found. 120 */ 121extern "C" NS_HIDDEN_(nsresult) 122XPCOMGlueLoadXULFunctions(const nsDynamicFunctionLoad *symbols); 123 124/** 125 * Finish the XPCOM glue after it is no longer needed. 126 */ 127extern "C" NS_HIDDEN_(nsresult) 128XPCOMGlueShutdown(); 129 130#endif // XPCOM_GLUE 131#endif // nsXPCOMGlue_h__