/gecko_api/include/nsXPCOMGlue.h

http://firefox-mac-pdf.googlecode.com/ · 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. #ifndef nsXPCOMGlue_h__
  39. #define nsXPCOMGlue_h__
  40. #include "nscore.h"
  41. class nsILocalFile;
  42. /**
  43. * The following function is available in both the standalone and
  44. * dynamically linked versions of the glue.
  45. */
  46. struct GREVersionRange {
  47. const char *lower;
  48. PRBool lowerInclusive;
  49. const char *upper;
  50. PRBool upperInclusive;
  51. };
  52. struct GREProperty {
  53. const char *property;
  54. const char *value;
  55. };
  56. /**
  57. * Locate the path of the xpcom shared library from a GRE with specified
  58. * properties.
  59. *
  60. * @param versions An array of version ranges: if any version range
  61. * matches, the GRE is considered acceptable.
  62. * @param versionsLength The length of the versions array.
  63. * @param properties A null-terminated list of GRE property/value pairs
  64. * which must all be satisfied.
  65. * @param propertiesLength Length of the properties array.
  66. * @param buffer A buffer to be filled with the appropriate path. If
  67. * the "local" GRE is specified (via the USE_LOCAL_GRE
  68. * environment variable, for example), this buffer
  69. * will be set to the empty string.
  70. * @param buflen The length of buffer. This must be at least
  71. * PATH_MAX/MAXPATHLEN.
  72. * @throws NS_ERROR_FAILURE if an appropriate GRE could not be found.
  73. * @note The properties parameter is ignored on macintosh, because of the
  74. * manner in which the XUL frameworks are installed by version.
  75. * @note Currently this uses a "first-fit" algorithm, it does not select
  76. * the newest available GRE.
  77. */
  78. extern "C" NS_COM_GLUE nsresult
  79. GRE_GetGREPathWithProperties(const GREVersionRange *versions,
  80. PRUint32 versionsLength,
  81. const GREProperty *properties,
  82. PRUint32 propertiesLength,
  83. char *buffer, PRUint32 buflen);
  84. #ifdef XPCOM_GLUE
  85. /**
  86. * The following functions are only available in the standalone glue.
  87. */
  88. /**
  89. * Initialize the XPCOM glue by dynamically linking against the XPCOM
  90. * shared library indicated by xpcomFile.
  91. */
  92. extern "C" NS_HIDDEN_(nsresult)
  93. XPCOMGlueStartup(const char* xpcomFile);
  94. typedef void (*NSFuncPtr)();
  95. struct nsDynamicFunctionLoad
  96. {
  97. const char *functionName;
  98. NSFuncPtr *function;
  99. };
  100. /**
  101. * Dynamically load functions from libxul.
  102. *
  103. * @throws NS_ERROR_NOT_INITIALIZED if XPCOMGlueStartup() was not called or
  104. * if the libxul DLL was not found.
  105. * @throws NS_ERROR_LOSS_OF_SIGNIFICANT_DATA if only some of the required
  106. * functions were found.
  107. */
  108. extern "C" NS_HIDDEN_(nsresult)
  109. XPCOMGlueLoadXULFunctions(const nsDynamicFunctionLoad *symbols);
  110. /**
  111. * Finish the XPCOM glue after it is no longer needed.
  112. */
  113. extern "C" NS_HIDDEN_(nsresult)
  114. XPCOMGlueShutdown();
  115. #endif // XPCOM_GLUE
  116. #endif // nsXPCOMGlue_h__