/gecko_api/include/prsystem.h

http://firefox-mac-pdf.googlecode.com/ · C++ Header · 140 lines · 22 code · 20 blank · 98 comment · 0 complexity · 432dd49b6887289594258b3d0bca0b53 MD5 · raw file

  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  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 the Netscape Portable Runtime (NSPR).
  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-2000
  20. * the Initial Developer. All Rights Reserved.
  21. *
  22. * Contributor(s):
  23. *
  24. * Alternatively, the contents of this file may be used under the terms of
  25. * either the GNU General Public License Version 2 or later (the "GPL"), or
  26. * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27. * in which case the provisions of the GPL or the LGPL are applicable instead
  28. * of those above. If you wish to allow use of your version of this file only
  29. * under the terms of either the GPL or the LGPL, and not to allow others to
  30. * use your version of this file under the terms of the MPL, indicate your
  31. * decision by deleting the provisions above and replace them with the notice
  32. * and other provisions required by the GPL or the LGPL. If you do not delete
  33. * the provisions above, a recipient may use your version of this file under
  34. * the terms of any one of the MPL, the GPL or the LGPL.
  35. *
  36. * ***** END LICENSE BLOCK ***** */
  37. #ifndef prsystem_h___
  38. #define prsystem_h___
  39. /*
  40. ** API to NSPR functions returning system info.
  41. */
  42. #include "prtypes.h"
  43. PR_BEGIN_EXTERN_C
  44. /*
  45. ** Get the host' directory separator.
  46. ** Pathnames are then assumed to be of the form:
  47. ** [<sep><root_component><sep>]*(<component><sep>)<leaf_name>
  48. */
  49. NSPR_API(char) PR_GetDirectorySeparator(void);
  50. /*
  51. ** OBSOLETE -- the function name is misspelled.
  52. ** Use PR_GetDirectorySeparator instead.
  53. */
  54. NSPR_API(char) PR_GetDirectorySepartor(void);
  55. /*
  56. ** Get the host' path separator.
  57. ** Paths are assumed to be of the form:
  58. ** <directory>[<sep><directory>]*
  59. */
  60. NSPR_API(char) PR_GetPathSeparator(void);
  61. /* Types of information available via PR_GetSystemInfo(...) */
  62. typedef enum {
  63. PR_SI_HOSTNAME, /* the hostname with the domain name (if any)
  64. * removed */
  65. PR_SI_SYSNAME,
  66. PR_SI_RELEASE,
  67. PR_SI_ARCHITECTURE,
  68. PR_SI_HOSTNAME_UNTRUNCATED /* the hostname exactly as configured
  69. * on the system */
  70. } PRSysInfo;
  71. /*
  72. ** If successful returns a null termintated string in 'buf' for
  73. ** the information indicated in 'cmd'. If unseccussful the reason for
  74. ** the failure can be retrieved from PR_GetError().
  75. **
  76. ** The buffer is allocated by the caller and should be at least
  77. ** SYS_INFO_BUFFER_LENGTH bytes in length.
  78. */
  79. #define SYS_INFO_BUFFER_LENGTH 256
  80. NSPR_API(PRStatus) PR_GetSystemInfo(PRSysInfo cmd, char *buf, PRUint32 buflen);
  81. /*
  82. ** Return the number of bytes in a page
  83. */
  84. NSPR_API(PRInt32) PR_GetPageSize(void);
  85. /*
  86. ** Return log2 of the size of a page
  87. */
  88. NSPR_API(PRInt32) PR_GetPageShift(void);
  89. /*
  90. ** PR_GetNumberOfProcessors() -- returns the number of CPUs
  91. **
  92. ** Description:
  93. ** PR_GetNumberOfProcessors() extracts the number of processors
  94. ** (CPUs available in an SMP system) and returns the number.
  95. **
  96. ** Parameters:
  97. ** none
  98. **
  99. ** Returns:
  100. ** The number of available processors or -1 on error
  101. **
  102. */
  103. NSPR_API(PRInt32) PR_GetNumberOfProcessors( void );
  104. /*
  105. ** PR_GetPhysicalMemorySize() -- returns the amount of system RAM
  106. **
  107. ** Description:
  108. ** PR_GetPhysicalMemorySize() determines the amount of physical RAM
  109. ** in the system and returns the size in bytes.
  110. **
  111. ** Parameters:
  112. ** none
  113. **
  114. ** Returns:
  115. ** The amount of system RAM, or 0 on failure.
  116. **
  117. */
  118. NSPR_API(PRUint64) PR_GetPhysicalMemorySize(void);
  119. PR_END_EXTERN_C
  120. #endif /* prsystem_h___ */