1 | /* $NetBSD: prop_array.h,v 1.14 2016/05/31 09:29:25 pgoyette Exp $ */ |
---|---|

2 | |

3 | /*- |

4 | * Copyright (c) 2006, 2009 The NetBSD Foundation, Inc. |

5 | * All rights reserved. |

6 | * |

7 | * This code is derived from software contributed to The NetBSD Foundation |

8 | * by Jason R. Thorpe. |

9 | * |

10 | * Redistribution and use in source and binary forms, with or without |

11 | * modification, are permitted provided that the following conditions |

12 | * are met: |

13 | * 1. Redistributions of source code must retain the above copyright |

14 | * notice, this list of conditions and the following disclaimer. |

15 | * 2. Redistributions in binary form must reproduce the above copyright |

16 | * notice, this list of conditions and the following disclaimer in the |

17 | * documentation and/or other materials provided with the distribution. |

18 | * |

19 | * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS |

20 | * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |

21 | * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |

22 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS |

23 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |

24 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |

25 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |

26 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |

27 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |

28 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |

29 | * POSSIBILITY OF SUCH DAMAGE. |

30 | */ |

31 | |

32 | #ifndef _PROPLIB_PROP_ARRAY_H_ |

33 | #define _PROPLIB_PROP_ARRAY_H_ |

34 | |

35 | #include <prop/prop_object.h> |

36 | |

37 | typedef struct _prop_array *prop_array_t; |

38 | |

39 | __BEGIN_DECLS |

40 | prop_array_t prop_array_create(void); |

41 | prop_array_t prop_array_create_with_capacity(unsigned int); |

42 | |

43 | prop_array_t prop_array_copy(prop_array_t); |

44 | prop_array_t prop_array_copy_mutable(prop_array_t); |

45 | |

46 | unsigned int prop_array_capacity(prop_array_t); |

47 | unsigned int prop_array_count(prop_array_t); |

48 | bool prop_array_ensure_capacity(prop_array_t, unsigned int); |

49 | |

50 | void prop_array_make_immutable(prop_array_t); |

51 | bool prop_array_mutable(prop_array_t); |

52 | |

53 | prop_object_iterator_t prop_array_iterator(prop_array_t); |

54 | |

55 | prop_object_t prop_array_get(prop_array_t, unsigned int); |

56 | bool prop_array_set(prop_array_t, unsigned int, prop_object_t); |

57 | bool prop_array_add(prop_array_t, prop_object_t); |

58 | void prop_array_remove(prop_array_t, unsigned int); |

59 | |

60 | bool prop_array_equals(prop_array_t, prop_array_t); |

61 | |

62 | char * prop_array_externalize(prop_array_t); |

63 | prop_array_t prop_array_internalize(const char *); |

64 | |

65 | bool prop_array_externalize_to_file(prop_array_t, const char *); |

66 | prop_array_t prop_array_internalize_from_file(const char *); |

67 | |

68 | #if defined(__NetBSD__) |

69 | struct plistref; |

70 | |

71 | #if !defined(_KERNEL) && !defined(_STANDALONE) |

72 | bool prop_array_externalize_to_pref(prop_array_t, struct plistref *); |

73 | bool prop_array_internalize_from_pref(const struct plistref *, |

74 | prop_array_t *); |

75 | int prop_array_send_ioctl(prop_array_t, int, unsigned long); |

76 | int prop_array_recv_ioctl(int, unsigned long, prop_array_t *); |

77 | int prop_array_send_syscall(prop_array_t, struct plistref *); |

78 | int prop_array_recv_syscall(const struct plistref *, |

79 | prop_array_t *); |

80 | #elif defined(_KERNEL) |

81 | int prop_array_copyin(const struct plistref *, prop_array_t *); |

82 | int prop_array_copyout(struct plistref *, prop_array_t); |

83 | int prop_array_copyin_ioctl(const struct plistref *, const u_long, |

84 | prop_array_t *); |

85 | int prop_array_copyout_ioctl(struct plistref *, const u_long, |

86 | prop_array_t); |

87 | #endif |

88 | #endif /* __NetBSD__ */ |

89 | |

90 | /* |

91 | * Utility routines to make it more convenient to work with values |

92 | * stored in dictionaries. |

93 | */ |

94 | bool prop_array_get_bool(prop_array_t, unsigned int, |

95 | bool *); |

96 | bool prop_array_set_bool(prop_array_t, unsigned int, |

97 | bool); |

98 | |

99 | bool prop_array_get_int8(prop_array_t, unsigned int, |

100 | int8_t *); |

101 | bool prop_array_get_uint8(prop_array_t, unsigned int, |

102 | uint8_t *); |

103 | bool prop_array_set_int8(prop_array_t, unsigned int, |

104 | int8_t); |

105 | bool prop_array_set_uint8(prop_array_t, unsigned int, |

106 | uint8_t); |

107 | |

108 | bool prop_array_get_int16(prop_array_t, unsigned int, |

109 | int16_t *); |

110 | bool prop_array_get_uint16(prop_array_t, unsigned int, |

111 | uint16_t *); |

112 | bool prop_array_set_int16(prop_array_t, unsigned int, |

113 | int16_t); |

114 | bool prop_array_set_uint16(prop_array_t, unsigned int, |

115 | uint16_t); |

116 | |

117 | bool prop_array_get_int32(prop_array_t, unsigned int, |

118 | int32_t *); |

119 | bool prop_array_get_uint32(prop_array_t, unsigned int, |

120 | uint32_t *); |

121 | bool prop_array_set_int32(prop_array_t, unsigned int, |

122 | int32_t); |

123 | bool prop_array_set_uint32(prop_array_t, unsigned int, |

124 | uint32_t); |

125 | |

126 | bool prop_array_get_int64(prop_array_t, unsigned int, |

127 | int64_t *); |

128 | bool prop_array_get_uint64(prop_array_t, unsigned int, |

129 | uint64_t *); |

130 | bool prop_array_set_int64(prop_array_t, unsigned int, |

131 | int64_t); |

132 | bool prop_array_set_uint64(prop_array_t, unsigned int, |

133 | uint64_t); |

134 | |

135 | bool prop_array_add_int8(prop_array_t, int8_t); |

136 | bool prop_array_add_uint8(prop_array_t, uint8_t); |

137 | |

138 | bool prop_array_add_int16(prop_array_t, int16_t); |

139 | bool prop_array_add_uint16(prop_array_t, uint16_t); |

140 | |

141 | bool prop_array_add_int32(prop_array_t, int32_t); |

142 | bool prop_array_add_uint32(prop_array_t, uint32_t); |

143 | |

144 | bool prop_array_add_int64(prop_array_t, int64_t); |

145 | bool prop_array_add_uint64(prop_array_t, uint64_t); |

146 | |

147 | bool prop_array_add_cstring(prop_array_t, const char *); |

148 | bool prop_array_get_cstring(prop_array_t, unsigned int, |

149 | char **); |

150 | bool prop_array_set_cstring(prop_array_t, unsigned int, |

151 | const char *); |

152 | |

153 | bool prop_array_add_cstring_nocopy(prop_array_t, const char *); |

154 | bool prop_array_get_cstring_nocopy(prop_array_t, |

155 | unsigned int, |

156 | const char **); |

157 | bool prop_array_set_cstring_nocopy(prop_array_t, |

158 | unsigned int, |

159 | const char *); |

160 | |

161 | bool prop_array_add_and_rel(prop_array_t, prop_object_t); |

162 | |

163 | __END_DECLS |

164 | |

165 | #endif /* _PROPLIB_PROP_ARRAY_H_ */ |

166 |