The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/libprop/prop_dictionary.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: prop_dictionary.h,v 1.14 2011/09/30 22:08:18 jym 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_DICTIONARY_H_
   33 #define _PROPLIB_PROP_DICTIONARY_H_
   34 
   35 #include <libprop/prop_object.h>
   36 
   37 typedef struct _prop_dictionary *prop_dictionary_t;
   38 typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t;
   39 
   40 __BEGIN_DECLS
   41 prop_dictionary_t prop_dictionary_create(void);
   42 prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int);
   43 
   44 prop_dictionary_t prop_dictionary_copy(prop_dictionary_t);
   45 prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t);
   46 
   47 unsigned int    prop_dictionary_count(prop_dictionary_t);
   48 bool            prop_dictionary_ensure_capacity(prop_dictionary_t,
   49                                                 unsigned int);
   50 
   51 void            prop_dictionary_make_immutable(prop_dictionary_t);
   52 bool            prop_dictionary_mutable(prop_dictionary_t);
   53 
   54 prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t);
   55 prop_array_t    prop_dictionary_all_keys(prop_dictionary_t);
   56 
   57 prop_object_t   prop_dictionary_get(prop_dictionary_t, const char *);
   58 bool            prop_dictionary_set(prop_dictionary_t, const char *,
   59                                     prop_object_t);
   60 void            prop_dictionary_remove(prop_dictionary_t, const char *);
   61 
   62 prop_object_t   prop_dictionary_get_keysym(prop_dictionary_t,
   63                                            prop_dictionary_keysym_t);
   64 bool            prop_dictionary_set_keysym(prop_dictionary_t,
   65                                            prop_dictionary_keysym_t,
   66                                            prop_object_t);
   67 void            prop_dictionary_remove_keysym(prop_dictionary_t,
   68                                               prop_dictionary_keysym_t);
   69 
   70 bool            prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t);
   71 
   72 char *          prop_dictionary_externalize(prop_dictionary_t);
   73 prop_dictionary_t prop_dictionary_internalize(const char *);
   74 
   75 bool            prop_dictionary_externalize_to_file(prop_dictionary_t,
   76                                                     const char *);
   77 prop_dictionary_t prop_dictionary_internalize_from_file(const char *);
   78 
   79 const char *    prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t);
   80 
   81 bool            prop_dictionary_keysym_equals(prop_dictionary_keysym_t,
   82                                               prop_dictionary_keysym_t);
   83 
   84 struct plistref;
   85 
   86 #if !defined(_KERNEL) && !defined(_STANDALONE)
   87 bool            prop_dictionary_externalize_to_pref(prop_dictionary_t, struct plistref *);
   88 bool            prop_dictionary_internalize_from_pref(const struct plistref *,
   89                                                       prop_dictionary_t *);
   90 int             prop_dictionary_send_ioctl(prop_dictionary_t, int,
   91                                            unsigned long);
   92 int             prop_dictionary_recv_ioctl(int, unsigned long,
   93                                            prop_dictionary_t *);
   94 int             prop_dictionary_sendrecv_ioctl(prop_dictionary_t,
   95                                                int, unsigned long,
   96                                                prop_dictionary_t *);
   97 int             prop_dictionary_send_syscall(prop_dictionary_t,
   98                      struct plistref *);
   99 int             prop_dictionary_recv_syscall(const struct plistref *,
  100                                            prop_dictionary_t *);
  101 #elif defined(_KERNEL)
  102 int             prop_dictionary_copyin(const struct plistref *,
  103                                        prop_dictionary_t *);
  104 int             prop_dictionary_copyout(struct plistref *,
  105                                        prop_dictionary_t);
  106 int             prop_dictionary_copyin_ioctl(const struct plistref *,
  107                                              const u_long,
  108                                              prop_dictionary_t *);
  109 int             prop_dictionary_copyout_ioctl(struct plistref *,
  110                                               const u_long,
  111                                               prop_dictionary_t);
  112 #endif
  113 
  114 /*
  115  * Utility routines to make it more convenient to work with values
  116  * stored in dictionaries.
  117  */
  118 bool            prop_dictionary_get_dict(prop_dictionary_t, const char *,
  119                                          prop_dictionary_t *);
  120 bool            prop_dictionary_get_bool(prop_dictionary_t, const char *,
  121                                          bool *);
  122 bool            prop_dictionary_set_bool(prop_dictionary_t, const char *,
  123                                          bool);
  124 
  125 bool            prop_dictionary_get_int8(prop_dictionary_t, const char *,
  126                                          int8_t *);
  127 bool            prop_dictionary_get_uint8(prop_dictionary_t, const char *,
  128                                           uint8_t *);
  129 bool            prop_dictionary_set_int8(prop_dictionary_t, const char *,
  130                                          int8_t);
  131 bool            prop_dictionary_set_uint8(prop_dictionary_t, const char *,
  132                                           uint8_t);
  133 
  134 bool            prop_dictionary_get_int16(prop_dictionary_t, const char *,
  135                                           int16_t *);
  136 bool            prop_dictionary_get_uint16(prop_dictionary_t, const char *,
  137                                            uint16_t *);
  138 bool            prop_dictionary_set_int16(prop_dictionary_t, const char *,
  139                                           int16_t);
  140 bool            prop_dictionary_set_uint16(prop_dictionary_t, const char *,
  141                                            uint16_t);
  142 
  143 bool            prop_dictionary_get_int32(prop_dictionary_t, const char *,
  144                                           int32_t *);
  145 bool            prop_dictionary_get_uint32(prop_dictionary_t, const char *,
  146                                            uint32_t *);
  147 bool            prop_dictionary_set_int32(prop_dictionary_t, const char *,
  148                                           int32_t);
  149 bool            prop_dictionary_set_uint32(prop_dictionary_t, const char *,
  150                                            uint32_t);
  151 
  152 bool            prop_dictionary_get_int64(prop_dictionary_t, const char *,
  153                                           int64_t *);
  154 bool            prop_dictionary_get_uint64(prop_dictionary_t, const char *,
  155                                            uint64_t *);
  156 bool            prop_dictionary_set_int64(prop_dictionary_t, const char *,
  157                                           int64_t);
  158 bool            prop_dictionary_set_uint64(prop_dictionary_t, const char *,
  159                                            uint64_t);
  160 
  161 bool            prop_dictionary_get_cstring(prop_dictionary_t, const char *,
  162                                              char **);
  163 bool            prop_dictionary_set_cstring(prop_dictionary_t, const char *,
  164                                             const char *);
  165 
  166 bool            prop_dictionary_get_cstring_nocopy(prop_dictionary_t,
  167                                                    const char *,
  168                                                    const char **);
  169 bool            prop_dictionary_set_cstring_nocopy(prop_dictionary_t,
  170                                                    const char *,
  171                                                    const char *);
  172 
  173 bool            prop_dictionary_set_and_rel(prop_dictionary_t,
  174                                                    const char *,
  175                                                    prop_object_t);
  176 
  177 __END_DECLS
  178 
  179 #endif /* _PROPLIB_PROP_DICTIONARY_H_ */

Cache object: 7c79efb81cdf06c9a24fd500894c17a3


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.