_simple.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. /*
  2. * Copyright (c) 2006, 2010, 2013 Apple Inc. All rights reserved.
  3. *
  4. * @APPLE_LICENSE_HEADER_START@
  5. *
  6. * This file contains Original Code and/or Modifications of Original Code
  7. * as defined in and that are subject to the Apple Public Source License
  8. * Version 2.0 (the 'License'). You may not use this file except in
  9. * compliance with the License. Please obtain a copy of the License at
  10. * http://www.opensource.apple.com/apsl/ and read it before using this
  11. * file.
  12. *
  13. * The Original Code and all software distributed under the License are
  14. * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15. * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16. * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18. * Please see the License for the specific language governing rights and
  19. * limitations under the License.
  20. *
  21. * @APPLE_LICENSE_HEADER_END@
  22. */
  23. #ifndef _SYSTEM_SIMPLE_H_
  24. #define _SYSTEM_SIMPLE_H_
  25. #include <sys/cdefs.h>
  26. #include <stdarg.h>
  27. #include <Availability.h>
  28. typedef void *_SIMPLE_STRING;
  29. typedef const char *_esc_func(unsigned char);
  30. __BEGIN_DECLS
  31. /*
  32. * A simplified vfprintf variant. The format string is interpreted with
  33. * arguments from the va_list, and the results are written to the given
  34. * file descriptor.
  35. */
  36. void _simple_vdprintf(int __fd, const char *__fmt, va_list __ap) __printflike(2, 0);
  37. /*
  38. * A simplified fprintf variant. The format string is interpreted with
  39. * arguments from the variable argument list, and the results are written
  40. * to the given file descriptor.
  41. */
  42. void _simple_dprintf(int __fd, const char *__fmt, ...) __printflike(2, 3);
  43. /*
  44. * A simplified string allocate routine. Pass the opaque pointer to structure
  45. * to _simple_*sprintf() routines. Use _simple_string() to retrieve the
  46. * current string (the string is guaranteed to be null terminated only on
  47. * the call to _simple_string()). Use _simple_sfree() to free the structure
  48. * and string memory.
  49. */
  50. _SIMPLE_STRING _simple_salloc(void);
  51. /*
  52. * The format string is interpreted with arguments from the va_list, and the
  53. * results are appended to the string maintained by the opaque structure, as
  54. * returned by a previous call to _simple_salloc(). Non-zero is returned on
  55. * out-of-memory error.
  56. */
  57. int _simple_vsprintf(_SIMPLE_STRING __b, const char *__fmt, va_list __ap) __printflike(2, 0);
  58. /*
  59. * The format string is interpreted with arguments from the variable argument
  60. * list, and the results are appended to the string maintained by the opaque
  61. * structure, as returned by a previous call to _simple_salloc(). Non-zero is
  62. * returned on out-of-memory error.
  63. */
  64. int _simple_sprintf(_SIMPLE_STRING __b, const char *__fmt, ...) __printflike(2, 3);
  65. /*
  66. * Like _simple_vsprintf(), except __esc is a function to call on each
  67. * character; the function returns NULL if the character should be passed
  68. * as is, otherwise, the returned character string is used instead.
  69. */
  70. int _simple_vesprintf(_SIMPLE_STRING __b, _esc_func __esc, const char *__fmt, va_list __ap) __printflike(3, 0);
  71. /*
  72. * Like _simple_sprintf(), except __esc is a function to call on each
  73. * character; the function returns NULL if the character should be passed
  74. * as is, otherwise, the returned character string is used instead.
  75. */
  76. int _simple_esprintf(_SIMPLE_STRING __b, _esc_func __esc, const char *__fmt, ...) __printflike(3, 4);
  77. /*
  78. * Return the null terminated string from the opaque structure, as returned
  79. * by a previous call to _simple_salloc().
  80. */
  81. char *_simple_string(_SIMPLE_STRING __b);
  82. /*
  83. * Reposition the pointer to the first null in the buffer. After a call to
  84. * _simple_string, the buffer can be modified, and shrunk.
  85. */
  86. void _simple_sresize(_SIMPLE_STRING __b);
  87. /*
  88. * Append the null-terminated string to the string associated with the opaque
  89. * structure. Non-zero is returned on out-of-memory error.
  90. */
  91. int _simple_sappend(_SIMPLE_STRING __b, const char *__str);
  92. /*
  93. * Like _simple_sappend(), except __esc is a function to call on each
  94. * character; the function returns NULL if the character should be passed
  95. * as is, otherwise, the returned character string is used instead.
  96. */
  97. int _simple_esappend(_SIMPLE_STRING __b, _esc_func __esc, const char *__str);
  98. /*
  99. * Write the string associated with the opaque structure to the file descriptor.
  100. */
  101. void _simple_put(_SIMPLE_STRING __b, int __fd);
  102. /*
  103. * Write the string associated with the opaque structure and a trailing newline,
  104. * to the file descriptor.
  105. */
  106. void _simple_putline(_SIMPLE_STRING __b, int __fd);
  107. /*
  108. * Free the opaque structure, and the associated string.
  109. */
  110. void _simple_sfree(_SIMPLE_STRING __b);
  111. /*
  112. * Simplified ASL log interface; does not use malloc. Unfortunately, this
  113. * requires knowledge of the format used by ASL.
  114. */
  115. #ifndef ASL_LEVEL_DEBUG
  116. #define ASL_LEVEL_EMERG 0
  117. #define ASL_LEVEL_ALERT 1
  118. #define ASL_LEVEL_CRIT 2
  119. #define ASL_LEVEL_ERR 3
  120. #define ASL_LEVEL_WARNING 4
  121. #define ASL_LEVEL_NOTICE 5
  122. #define ASL_LEVEL_INFO 6
  123. #define ASL_LEVEL_DEBUG 7
  124. #endif
  125. void _simple_asl_log(int __level, const char *__facility, const char *__message);
  126. void _simple_asl_log_prog(int level, const char *facility, const char *message, const char *progname);
  127. __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0)
  128. _SIMPLE_STRING _simple_asl_msg_new(void);
  129. __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0)
  130. void _simple_asl_msg_set(_SIMPLE_STRING __b, const char *__key, const char *__val);
  131. __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0)
  132. void _simple_asl_send(_SIMPLE_STRING __b);
  133. __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0)
  134. const char *_simple_getenv(const char *envp[], const char *var);
  135. __END_DECLS
  136. #endif /* _SYSTEM_SIMPLE_H_ */