diff --git a/doc/html/annotated.html b/doc/html/annotated.html new file mode 100644 index 0000000..4fc50f0 --- /dev/null +++ b/doc/html/annotated.html @@ -0,0 +1,45 @@ + + + + +json-c: Data Structures + + + + + + +
+

Data Structures

Here are the data structures with brief descriptions: + + + + + + + + + + +
array_list
json_object::data
json_object
json_object_iter
json_object_iterator
json_tokener
json_tokener_srec
lh_entry
lh_table
printbuf
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/arraylist_8h.html b/doc/html/arraylist_8h.html new file mode 100644 index 0000000..7c00cd0 --- /dev/null +++ b/doc/html/arraylist_8h.html @@ -0,0 +1,246 @@ + + + + +json-c: arraylist.h File Reference + + + + + + +
+

arraylist.h File Reference

+ + + + + + + + + + + + + + +

Data Structures

struct  array_list

Defines

#define ARRAY_LIST_DEFAULT_SIZE   32

Typedefs

typedef void( array_list_free_fn )(void *data)

Functions

struct array_list * array_list_new (array_list_free_fn *free_fn)
void array_list_free (struct array_list *al)
void * array_list_get_idx (struct array_list *al, int i)
int array_list_put_idx (struct array_list *al, int i, void *data)
int array_list_add (struct array_list *al, void *data)
int array_list_length (struct array_list *al)
void array_list_sort (struct array_list *arr, int(*compar)(const void *, const void *))
+

Define Documentation

+ +
+
+ + + + +
#define ARRAY_LIST_DEFAULT_SIZE   32
+
+
+ +
+
+

Typedef Documentation

+ +
+
+ + + + +
typedef void( array_list_free_fn)(void *data)
+
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
int array_list_add (struct array_list *  al,
void *  data 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void array_list_free (struct array_list *  al ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void* array_list_get_idx (struct array_list *  al,
int  i 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
int array_list_length (struct array_list *  al ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + +
struct array_list* array_list_new (array_list_free_fn *  free_fn )  [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int array_list_put_idx (struct array_list *  al,
int  i,
void *  data 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void array_list_sort (struct array_list *  arr,
int(*)(const void *, const void *)  compar 
)
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:46 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/bits_8h.html b/doc/html/bits_8h.html new file mode 100644 index 0000000..aa44692 --- /dev/null +++ b/doc/html/bits_8h.html @@ -0,0 +1,161 @@ + + + + +json-c: bits.h File Reference + + + + + + +
+

bits.h File Reference

+ + + + + + + +

Defines

#define json_min(a, b)   ((a) < (b) ? (a) : (b))
#define json_max(a, b)   ((a) > (b) ? (a) : (b))
#define hexdigit(x)   (((x) <= '9') ? (x) - '0' : ((x) & 7) + 9)
#define error_ptr(error)   ((void*)error)
#define error_description(error)   (json_tokener_errors[error])
#define is_error(ptr)   (ptr == NULL)
+

Define Documentation

+ +
+
+ + + + + + + + + +
#define error_description(error  )    (json_tokener_errors[error])
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define error_ptr(error  )    ((void*)error)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define hexdigit(x  )    (((x) <= '9') ? (x) - '0' : ((x) & 7) + 9)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define is_error(ptr  )    (ptr == NULL)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define json_max(a,
b  )    ((a) > (b) ? (a) : (b))
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define json_min(a,
b  )    ((a) < (b) ? (a) : (b))
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:46 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/classes.html b/doc/html/classes.html new file mode 100644 index 0000000..d3824e4 --- /dev/null +++ b/doc/html/classes.html @@ -0,0 +1,41 @@ + + + + +json-c: Alphabetical List + + + + + + +
+

Data Structure Index

A | D | J | L | P
+ +
  A  
+		json_object::data   json_object_iter   json_tokener_srec   lh_table   
array_list   
  J  
+		json_object_iterator   
  L  
+
  P  
+
  D  
+		json_object   json_tokener   lh_entry   printbuf   
A | D | J | L | P
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/debug_8h.html b/doc/html/debug_8h.html new file mode 100644 index 0000000..95f8b8c --- /dev/null +++ b/doc/html/debug_8h.html @@ -0,0 +1,399 @@ + + + + +json-c: debug.h File Reference + + + + + + +
+

debug.h File Reference

+ + + + + + + + + + + + + + + + + + +

Defines

#define __STRING(x)   #x
#define JASSERT(cond)   do {} while(0)
#define MC_ABORT(x,...)   mc_abort(x, ##__VA_ARGS__)
#define MC_ERROR(x,...)   mc_error(x, ##__VA_ARGS__)
#define MC_SET_DEBUG(x)   if (0) mc_set_debug(x)
#define MC_GET_DEBUG()   (0)
#define MC_SET_SYSLOG(x)   if (0) mc_set_syslog(x)
#define MC_DEBUG(x,...)   if (0) mc_debug(x, ##__VA_ARGS__)
#define MC_INFO(x,...)   if (0) mc_info(x, ##__VA_ARGS__)

Functions

void mc_set_debug (int debug)
int mc_get_debug (void)
void mc_set_syslog (int syslog)
void mc_abort (const char *msg,...)
void mc_debug (const char *msg,...)
void mc_error (const char *msg,...)
void mc_info (const char *msg,...)
+

Define Documentation

+ +
+
+ + + + + + + + + +
#define __STRING(x  )    #x
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define JASSERT(cond  )    do {} while(0)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define MC_ABORT(x,
...  )    mc_abort(x, ##__VA_ARGS__)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define MC_DEBUG(x,
...  )    if (0) mc_debug(x, ##__VA_ARGS__)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define MC_ERROR(x,
...  )    mc_error(x, ##__VA_ARGS__)
+
+
+ +
+
+ +
+
+ + + + +  + + + + +
#define MC_GET_DEBUG( )    (0)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define MC_INFO(x,
...  )    if (0) mc_info(x, ##__VA_ARGS__)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define MC_SET_DEBUG(x  )    if (0) mc_set_debug(x)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define MC_SET_SYSLOG(x  )    if (0) mc_set_syslog(x)
+
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void mc_abort (const char *  msg,
  ... 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void mc_debug (const char *  msg,
  ... 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void mc_error (const char *  msg,
  ... 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
int mc_get_debug (void  ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void mc_info (const char *  msg,
  ... 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void mc_set_debug (int  debug ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void mc_set_syslog (int  syslog ) 
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/deprecated.html b/doc/html/deprecated.html new file mode 100644 index 0000000..77dc91f --- /dev/null +++ b/doc/html/deprecated.html @@ -0,0 +1,39 @@ + + + + +json-c: Deprecated List + + + + + + +
+ + +

Deprecated List

+
+
Global json_object_object_get (struct json_object *obj, const char *key)
+
Please use json_object_object_get_ex
+
+

+
+
Global lh_table_lookup (struct lh_table *t, const void *k)
+
Use lh_table_lookup_ex instead.
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/doxygen.css b/doc/html/doxygen.css new file mode 100644 index 0000000..d6aaf28 --- /dev/null +++ b/doc/html/doxygen.css @@ -0,0 +1,545 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #3030f0; +} + +a.codeRef { + color: #3030f0; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} + +td.indexkey { + background-color: #e8eef2; + font-weight: bold; + border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #f0f0f0; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #666; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memTemplParams { + color: #606060; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; + margin-bottom: 10px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto { + border-top: 1px solid #84b0c7; + border-left: 1px solid #84b0c7; + border-right: 1px solid #84b0c7; + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + /* firefox specific markup */ + background-image: -moz-linear-gradient(rgba(228, 233, 245, 1.0) 0%, rgba(193, 205, 232, 1.0) 100%); + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(rgba(228, 233, 245, 1.0)), to(rgba(193, 205, 232, 1.0))); + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + +} + +.memdoc { + border-bottom: 1px solid #84b0c7; + border-left: 1px solid #84b0c7; + border-right: 1px solid #84b0c7; + padding: 2px 5px; + background-color: #eef3f5; + border-top-width: 0; + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} + +table.doxtable { + border-collapse:collapse; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #153788; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #254798; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + diff --git a/doc/html/doxygen.png b/doc/html/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/doc/html/doxygen.png differ diff --git a/doc/html/files.html b/doc/html/files.html new file mode 100644 index 0000000..0eb2fee --- /dev/null +++ b/doc/html/files.html @@ -0,0 +1,47 @@ + + + + +json-c: File Index + + + + + + +
+

File List

Here is a list of all files with brief descriptions: + + + + + + + + + + + + +
arraylist.h
bits.h
debug.h
json.h
json_inttypes.h
json_object.h
json_object_iterator.hJson-c forces clients to use its private data structures for JSON Object iteration. This API corrects that by abstracting the private json-c details
json_object_private.h
json_tokener.h
json_util.h
linkhash.h
printbuf.h
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/functions.html b/doc/html/functions.html new file mode 100644 index 0000000..1cb50a3 --- /dev/null +++ b/doc/html/functions.html @@ -0,0 +1,306 @@ + + + + +json-c: Data Fields + + + + + + +
+Here is a list of all struct and union fields with links to the structures/unions they belong to: + +

- _ -

+ + +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- d -

+ + +

- e -

+ + +

- f -

+ + +

- h -

+ + +

- i -

+ + +

- k -

+ + +

- l -

+ + +

- n -

+ + +

- o -

+ + +

- p -

+ + +

- q -

+ + +

- r -

+ + +

- s -

+ + +

- t -

+ + +

- u -

+ + +

- v -

+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/functions_vars.html b/doc/html/functions_vars.html new file mode 100644 index 0000000..4a9e620 --- /dev/null +++ b/doc/html/functions_vars.html @@ -0,0 +1,306 @@ + + + + +json-c: Data Fields - Variables + + + + + + +
+  + +

- _ -

+ + +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- d -

+ + +

- e -

+ + +

- f -

+ + +

- h -

+ + +

- i -

+ + +

- k -

+ + +

- l -

+ + +

- n -

+ + +

- o -

+ + +

- p -

+ + +

- q -

+ + +

- r -

+ + +

- s -

+ + +

- t -

+ + +

- u -

+ + +

- v -

+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals.html b/doc/html/globals.html new file mode 100644 index 0000000..6400b5e --- /dev/null +++ b/doc/html/globals.html @@ -0,0 +1,657 @@ + + + + +json-c: Data Fields + + + + + + +
+Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to: + +

- _ -

+ + +

- a -

+ + +

- e -

+ + +

- f -

+ + +

- h -

+ + +

- i -

+ + +

- j -

+ + +

- l -

+ + +

- m -

+ + +

- p -

+ + +

- s -

+ + +

- t -

+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals_defs.html b/doc/html/globals_defs.html new file mode 100644 index 0000000..4855185 --- /dev/null +++ b/doc/html/globals_defs.html @@ -0,0 +1,205 @@ + + + + +json-c: Data Fields + + + + + + +
+  + +

- _ -

+ + +

- a -

+ + +

- e -

+ + +

- f -

+ + +

- h -

+ + +

- i -

+ + +

- j -

+ + +

- l -

+ + +

- m -

+ + +

- p -

+ + +

- t -

+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals_enum.html b/doc/html/globals_enum.html new file mode 100644 index 0000000..4adee68 --- /dev/null +++ b/doc/html/globals_enum.html @@ -0,0 +1,55 @@ + + + + +json-c: Data Fields + + + + + + +
+  +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals_eval.html b/doc/html/globals_eval.html new file mode 100644 index 0000000..4e90ad5 --- /dev/null +++ b/doc/html/globals_eval.html @@ -0,0 +1,182 @@ + + + + +json-c: Data Fields + + + + + + +
+  + +

- j -

+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html new file mode 100644 index 0000000..add6cd8 --- /dev/null +++ b/doc/html/globals_func.html @@ -0,0 +1,339 @@ + + + + +json-c: Data Fields + + + + + + +
+  + +

- a -

+ + +

- j -

+ + +

- l -

+ + +

- m -

+ + +

- p -

+ + +

- s -

+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals_type.html b/doc/html/globals_type.html new file mode 100644 index 0000000..dc1aefc --- /dev/null +++ b/doc/html/globals_type.html @@ -0,0 +1,88 @@ + + + + +json-c: Data Fields + + + + + + +
+  +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/globals_vars.html b/doc/html/globals_vars.html new file mode 100644 index 0000000..f35f9c5 --- /dev/null +++ b/doc/html/globals_vars.html @@ -0,0 +1,55 @@ + + + + +json-c: Data Fields + + + + + + +
+  +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 0000000..5baf1b7 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,27 @@ + + + + +json-c: Main Page + + + + + + +
+

json-c Documentation

0.10

+
Generated on Sat Apr 28 15:52:46 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json_8h.html b/doc/html/json_8h.html new file mode 100644 index 0000000..3b531d2 --- /dev/null +++ b/doc/html/json_8h.html @@ -0,0 +1,35 @@ + + + + +json-c: json.h File Reference + + + + + + +
+

json.h File Reference

+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json__inttypes_8h.html b/doc/html/json__inttypes_8h.html new file mode 100644 index 0000000..980a119 --- /dev/null +++ b/doc/html/json__inttypes_8h.html @@ -0,0 +1,35 @@ + + + + +json-c: json_inttypes.h File Reference + + + + + + +
+

json_inttypes.h File Reference

+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json__object_8h.html b/doc/html/json__object_8h.html new file mode 100644 index 0000000..d417ba1 --- /dev/null +++ b/doc/html/json__object_8h.html @@ -0,0 +1,1354 @@ + + + + +json-c: json_object.h File Reference + + + + + + +
+

json_object.h File Reference

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  json_object_iter

Defines

#define JSON_OBJECT_DEF_HASH_ENTRIES   16
#define JSON_C_TO_STRING_PLAIN   0
#define JSON_C_TO_STRING_SPACED   (1<<0)
#define JSON_C_TO_STRING_PRETTY   (1<<1)
#define FALSE   ((json_bool)0)
#define TRUE   ((json_bool)1)
#define json_object_object_foreach(obj, key, val)
#define json_object_object_foreachC(obj, iter)   for(iter.entry = json_object_get_object(obj)->head; (iter.entry ? (iter.key = (char*)iter.entry->k, iter.val = (struct json_object*)iter.entry->v, iter.entry) : 0); iter.entry = iter.entry->next)

Typedefs

typedef int json_bool
typedef struct printbuf printbuf
typedef struct lh_table lh_table
typedef struct array_list array_list
typedef struct json_object json_object
typedef struct json_object_iter json_object_iter
typedef struct json_tokener json_tokener
typedef enum json_type json_type

Enumerations

enum  json_type {
+  json_type_null, +json_type_boolean, +json_type_double, +json_type_int, +
+  json_type_object, +json_type_array, +json_type_string +
+ }

Functions

struct json_object * json_object_get (struct json_object *obj)
void json_object_put (struct json_object *obj)
int json_object_is_type (struct json_object *obj, enum json_type type)
enum json_type json_object_get_type (struct json_object *obj)
const char * json_object_to_json_string (struct json_object *obj)
const char * json_object_to_json_string_ext (struct json_object *obj, int flags)
struct json_object * json_object_new_object (void)
struct lh_table * json_object_get_object (struct json_object *obj)
void json_object_object_add (struct json_object *obj, const char *key, struct json_object *val)
struct json_object * json_object_object_get (struct json_object *obj, const char *key)
json_bool json_object_object_get_ex (struct json_object *obj, const char *key, struct json_object **value)
void json_object_object_del (struct json_object *obj, const char *key)
struct json_object * json_object_new_array (void)
struct array_list * json_object_get_array (struct json_object *obj)
int json_object_array_length (struct json_object *obj)
void json_object_array_sort (struct json_object *jso, int(*sort_fn)(const void *, const void *))
int json_object_array_add (struct json_object *obj, struct json_object *val)
int json_object_array_put_idx (struct json_object *obj, int idx, struct json_object *val)
struct json_object * json_object_array_get_idx (struct json_object *obj, int idx)
struct json_object * json_object_new_boolean (json_bool b)
json_bool json_object_get_boolean (struct json_object *obj)
struct json_object * json_object_new_int (int32_t i)
struct json_object * json_object_new_int64 (int64_t i)
int32_t json_object_get_int (struct json_object *obj)
int64_t json_object_get_int64 (struct json_object *obj)
struct json_object * json_object_new_double (double d)
double json_object_get_double (struct json_object *obj)
struct json_object * json_object_new_string (const char *s)
struct json_object * json_object_new_string_len (const char *s, int len)
const char * json_object_get_string (struct json_object *obj)
int json_object_get_string_len (struct json_object *obj)

Variables

const char * json_number_chars
const char * json_hex_chars
+

Define Documentation

+ +
+
+ + + + +
#define FALSE   ((json_bool)0)
+
+
+ +
+
+ +
+
+ + + + +
#define JSON_C_TO_STRING_PLAIN   0
+
+
+

A flag for the json_object_to_json_string_ext() and json_object_to_file_ext() functions which causes the output to have no extra whitespace or formatting applied.

+ +
+
+ +
+
+ + + + +
#define JSON_C_TO_STRING_PRETTY   (1<<1)
+
+
+

A flag for the json_object_to_json_string_ext() and json_object_to_file_ext() functions which causes the output to be formatted.

+

See the "Two Space Tab" option at http://jsonformatter.curiousconcept.com/ for an example of the format.

+ +
+
+ +
+
+ + + + +
#define JSON_C_TO_STRING_SPACED   (1<<0)
+
+
+

A flag for the json_object_to_json_string_ext() and json_object_to_file_ext() functions which causes the output to have minimal whitespace inserted to make things slightly more readable.

+ +
+
+ +
+
+ + + + +
#define JSON_OBJECT_DEF_HASH_ENTRIES   16
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
#define json_object_object_foreach(obj,
key,
val  ) 
+
+
+Value:
char *key; struct json_object *val; struct lh_entry *entry; \
+ for(entry = json_object_get_object(obj)->head; (entry ? (key = (char*)entry->k, val = (struct json_object*)entry->v, entry) : 0); entry = entry->next)
+

Iterate through all keys and values of an object

+
Parameters:
+ + + + +
obj the json_object instance
key the local name for the char* key variable defined in the body
val the local name for the json_object* object variable defined in the body
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define json_object_object_foreachC(obj,
iter  )    for(iter.entry = json_object_get_object(obj)->head; (iter.entry ? (iter.key = (char*)iter.entry->k, iter.val = (struct json_object*)iter.entry->v, iter.entry) : 0); iter.entry = iter.entry->next)
+
+
+

Iterate through all keys and values of an object (ANSI C Safe)

+
Parameters:
+ + + +
obj the json_object instance
iter the object iterator
+
+
+ +
+
+ +
+
+ + + + +
#define TRUE   ((json_bool)1)
+
+
+ +
+
+

Typedef Documentation

+ +
+
+ + + + +
typedef struct array_list array_list
+
+
+ +
+
+ +
+
+ + + + +
typedef int json_bool
+
+
+ +
+
+ +
+
+ + + + +
typedef struct json_object json_object
+
+
+ +
+
+ +
+
+ + + + +
typedef struct json_object_iter json_object_iter
+
+
+ +
+
+ +
+
+ + + + +
typedef struct json_tokener json_tokener
+
+
+ +
+
+ +
+
+ + + + +
typedef enum json_type json_type
+
+
+ +
+
+ +
+
+ + + + +
typedef struct lh_table lh_table
+
+
+ +
+
+ +
+
+ + + + +
typedef struct printbuf printbuf
+
+
+ +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum json_type
+
+
+
Enumerator:
+ + + + + + + +
json_type_null  +
json_type_boolean  +
json_type_double  +
json_type_int  +
json_type_object  +
json_type_array  +
json_type_string  +
+
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
int json_object_array_add (struct json_object *  obj,
struct json_object *  val 
)
+
+
+

Add an element to the end of a json_object of type json_type_array

+

The reference count will *not* be incremented. This is to make adding fields to objects in code more compact. If you want to retain a reference to an added object you must wrap the passed object with json_object_get

+
Parameters:
+ + + +
obj the json_object instance
val the json_object to be added
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
struct json_object* json_object_array_get_idx (struct json_object *  obj,
int  idx 
) [read]
+
+
+

Get the element at specificed index of the array (a json_object of type json_type_array)

+
Parameters:
+ + + +
obj the json_object instance
idx the index to get the element at
+
+
+
Returns:
the json_object at the specified index (or NULL)
+ +
+
+ +
+
+ + + + + + + + + +
int json_object_array_length (struct json_object *  obj ) 
+
+
+

Get the length of a json_object of type json_type_array

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
an int
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int json_object_array_put_idx (struct json_object *  obj,
int  idx,
struct json_object *  val 
)
+
+
+

Insert or replace an element at a specified index in an array (a json_object of type json_type_array)

+

The reference count will *not* be incremented. This is to make adding fields to objects in code more compact. If you want to retain a reference to an added object you must wrap the passed object with json_object_get

+

The reference count of a replaced object will be decremented.

+

The array size will be automatically be expanded to the size of the index if the index is larger than the current size.

+
Parameters:
+ + + + +
obj the json_object instance
idx the index to insert the element at
val the json_object to be added
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void json_object_array_sort (struct json_object *  jso,
int(*)(const void *, const void *)  sort_fn 
)
+
+
+

Sorts the elements of jso of type json_type_array

+

Pointers to the json_object pointers will be passed as the two arguments to

+
Parameters:
+ + + +
obj the json_object instance
sort_fn a sorting function
+
+
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_get (struct json_object *  obj )  [read]
+
+
+

Increment the reference count of json_object, thereby grabbing shared ownership of obj.

+
Parameters:
+ + +
obj the json_object instance
+
+
+ +
+
+ +
+
+ + + + + + + + + +
struct array_list* json_object_get_array (struct json_object *  obj )  [read]
+
+
+

Get the arraylist of a json_object of type json_type_array

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
an arraylist
+ +
+
+ +
+
+ + + + + + + + + +
json_bool json_object_get_boolean (struct json_object *  obj ) 
+
+
+

Get the json_bool value of a json_object

+

The type is coerced to a json_bool if the passed object is not a json_bool. integer and double objects will return FALSE if there value is zero or TRUE otherwise. If the passed object is a string it will return TRUE if it has a non zero length. If any other object type is passed TRUE will be returned if the object is not NULL.

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
a json_bool
+ +
+
+ +
+
+ + + + + + + + + +
double json_object_get_double (struct json_object *  obj ) 
+
+
+

Get the double floating point value of a json_object

+

The type is coerced to a double if the passed object is not a double. integer objects will return their double conversion. Strings will be parsed as a double. If no conversion exists then 0.0 is returned and errno is set to EINVAL. null is equivalent to 0 (no error values set)

+

If the value is too big to fit in a double, then the value is set to the closest infinity with errno set to ERANGE. If strings cannot be converted to their double value, then EINVAL is set & NaN is returned.

+

Arrays of length 0 are interpreted as 0 (with no error flags set). Arrays of length 1 are effectively cast to the equivalent object and converted using the above rules. All other arrays set the error to EINVAL & return NaN.

+

NOTE: Set errno to 0 directly before a call to this function to determine whether or not conversion was successful (it does not clear the value for you).

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
a double floating point number
+ +
+
+ +
+
+ + + + + + + + + +
int32_t json_object_get_int (struct json_object *  obj ) 
+
+
+

Get the int value of a json_object

+

The type is coerced to a int if the passed object is not a int. double objects will return their integer conversion. Strings will be parsed as an integer. If no conversion exists then 0 is returned and errno is set to EINVAL. null is equivalent to 0 (no error values set)

+

Note that integers are stored internally as 64-bit values. If the value of too big or too small to fit into 32-bit, INT32_MAX or INT32_MIN are returned, respectively.

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
an int
+ +
+
+ +
+
+ + + + + + + + + +
int64_t json_object_get_int64 (struct json_object *  obj ) 
+
+
+

Get the int value of a json_object

+

The type is coerced to a int64 if the passed object is not a int64. double objects will return their int64 conversion. Strings will be parsed as an int64. If no conversion exists then 0 is returned.

+

NOTE: Set errno to 0 directly before a call to this function to determine whether or not conversion was successful (it does not clear the value for you).

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
an int64
+ +
+
+ +
+
+ + + + + + + + + +
struct lh_table* json_object_get_object (struct json_object *  obj )  [read]
+
+
+

Get the hashtable of a json_object of type json_type_object

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
a linkhash
+ +
+
+ +
+
+ + + + + + + + + +
const char* json_object_get_string (struct json_object *  obj ) 
+
+
+

Get the string value of a json_object

+

If the passed object is not of type json_type_string then the JSON representation of the object is returned.

+

The returned string memory is managed by the json_object and will be freed when the reference count of the json_object drops to zero.

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
a string
+ +
+
+ +
+
+ + + + + + + + + +
int json_object_get_string_len (struct json_object *  obj ) 
+
+
+

Get the string length of a json_object

+

If the passed object is not of type json_type_string then zero will be returned.

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
int
+ +
+
+ +
+
+ + + + + + + + + +
enum json_type json_object_get_type (struct json_object *  obj ) 
+
+
+

Get the type of the json_object. See also json_type_to_name() to turn this into a string suitable, for instance, for logging.

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
type being one of: json_type_null (i.e. obj == NULL), json_type_boolean, json_type_double, json_type_int, json_type_object, json_type_array, json_type_string,
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int json_object_is_type (struct json_object *  obj,
enum json_type  type 
)
+
+
+

Check if the json_object is of a given type

+
Parameters:
+ + + +
obj the json_object instance
type one of: json_type_null (i.e. obj == NULL), json_type_boolean, json_type_double, json_type_int, json_type_object, json_type_array, json_type_string,
+
+
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_array (void  )  [read]
+
+
+

Create a new empty json_object of type json_type_array

+
Returns:
a json_object of type json_type_array
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_boolean (json_bool  b )  [read]
+
+
+

Create a new empty json_object of type json_type_boolean

+
Parameters:
+ + +
b a json_bool TRUE or FALSE (0 or 1)
+
+
+
Returns:
a json_object of type json_type_boolean
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_double (double  d )  [read]
+
+
+

Create a new empty json_object of type json_type_double

+
Parameters:
+ + +
d the double
+
+
+
Returns:
a json_object of type json_type_double
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_int (int32_t  i )  [read]
+
+
+

Create a new empty json_object of type json_type_int Note that values are stored as 64-bit values internally. To ensure the full range is maintained, use json_object_new_int64 instead.

+
Parameters:
+ + +
i the integer
+
+
+
Returns:
a json_object of type json_type_int
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_int64 (int64_t  i )  [read]
+
+
+

Create a new empty json_object of type json_type_int

+
Parameters:
+ + +
i the integer
+
+
+
Returns:
a json_object of type json_type_int
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_object (void  )  [read]
+
+
+

Create a new empty object with a reference count of 1. The caller of this object initially has sole ownership. Remember, when using json_object_object_add or json_object_array_put_idx, ownership will transfer to the object/array. Call json_object_get if you want to maintain shared ownership or also add this object as a child of multiple objects or arrays. Any ownerships you acquired but did not transfer must be released through json_object_put.

+
Returns:
a json_object of type json_type_object
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_new_string (const char *  s )  [read]
+
+
+

Create a new empty json_object of type json_type_string

+

A copy of the string is made and the memory is managed by the json_object

+
Parameters:
+ + +
s the string
+
+
+
Returns:
a json_object of type json_type_string
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
struct json_object* json_object_new_string_len (const char *  s,
int  len 
) [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void json_object_object_add (struct json_object *  obj,
const char *  key,
struct json_object *  val 
)
+
+
+

Add an object field to a json_object of type json_type_object

+

The reference count will *not* be incremented. This is to make adding fields to objects in code more compact. If you want to retain a reference to an added object, independent of the lifetime of obj, you must wrap the passed object with json_object_get.

+

Upon calling this, the ownership of val transfers to obj. Thus you must make sure that you do in fact have ownership over this object. For instance, json_object_new_object will give you ownership until you transfer it, whereas json_object_object_get does not.

+
Parameters:
+ + + + +
obj the json_object instance
key the object field name (a private copy will be duplicated)
val a json_object or NULL member to associate with the given field
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void json_object_object_del (struct json_object *  obj,
const char *  key 
)
+
+
+

Delete the given json_object field

+

The reference count will be decremented for the deleted object. If there are no more owners of the value represented by this key, then the value is freed. Otherwise, the reference to the value will remain in memory.

+
Parameters:
+ + + +
obj the json_object instance
key the object field name
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
struct json_object* json_object_object_get (struct json_object *  obj,
const char *  key 
) [read]
+
+
+

Get the json_object associate with a given object field

+

*No* reference counts will be changed. There is no need to manually adjust reference counts through the json_object_put/json_object_get methods unless you need to have the child (value) reference maintain a different lifetime than the owning parent (obj). Ownership of the returned value is retained by obj (do not do json_object_put unless you have done a json_object_get). If you delete the value from obj (json_object_object_del) and wish to access the returned reference afterwards, make sure you have first gotten shared ownership through json_object_get (& don't forget to do a json_object_put or transfer ownership to prevent a memory leak).

+
Parameters:
+ + + +
obj the json_object instance
key the object field name
+
+
+
Returns:
the json_object associated with the given field name
+
Deprecated:
Please use json_object_object_get_ex
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
json_bool json_object_object_get_ex (struct json_object *  obj,
const char *  key,
struct json_object **  value 
)
+
+
+

Get the json_object associated with a given object field.

+

This returns true if the key is found, false in all other cases (including if obj isn't a json_type_object).

+

*No* reference counts will be changed. There is no need to manually adjust reference counts through the json_object_put/json_object_get methods unless you need to have the child (value) reference maintain a different lifetime than the owning parent (obj). Ownership of value is retained by obj.

+
Parameters:
+ + + + +
obj the json_object instance
key the object field name
value a pointer where to store a reference to the json_object associated with the given field name.
+
+
+

It is safe to pass a NULL value.

+
Returns:
whether or not the key exists
+ +
+
+ +
+
+ + + + + + + + + +
void json_object_put (struct json_object *  obj ) 
+
+
+

Decrement the reference count of json_object and free if it reaches zero. You must have ownership of obj prior to doing this or you will cause an imbalance in the reference count.

+
Parameters:
+ + +
obj the json_object instance
+
+
+ +
+
+ +
+
+ + + + + + + + + +
const char* json_object_to_json_string (struct json_object *  obj ) 
+
+
+

Stringify object to json format. Equivalent to json_object_to_json_string_ext(obj, JSON_C_TO_STRING_SPACED)

+
Parameters:
+ + +
obj the json_object instance
+
+
+
Returns:
a string in JSON format
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
const char* json_object_to_json_string_ext (struct json_object *  obj,
int  flags 
)
+
+
+

Stringify object to json format

+
Parameters:
+ + + +
obj the json_object instance
flags formatting options, see JSON_C_TO_STRING_PRETTY and other constants
+
+
+
Returns:
a string in JSON format
+ +
+
+

Variable Documentation

+ +
+
+ + + + +
const char* json_hex_chars
+
+
+ +
+
+ +
+
+ + + + +
const char* json_number_chars
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json__object__iterator_8h.html b/doc/html/json__object__iterator_8h.html new file mode 100644 index 0000000..33a650b --- /dev/null +++ b/doc/html/json__object__iterator_8h.html @@ -0,0 +1,270 @@ + + + + +json-c: json_object_iterator.h File Reference + + + + + + +
+

json_object_iterator.h File Reference

+

json-c forces clients to use its private data structures for JSON Object iteration. This API corrects that by abstracting the private json-c details. +More...

+ + + + + + + + + + + +

Data Structures

struct  json_object_iterator

Functions

struct json_object_iterator json_object_iter_init_default (void)
struct json_object_iterator json_object_iter_begin (struct json_object *obj)
struct json_object_iterator json_object_iter_end (const struct json_object *obj)
void json_object_iter_next (struct json_object_iterator *iter)
const char * json_object_iter_peek_name (const struct json_object_iterator *iter)
struct json_object * json_object_iter_peek_value (const struct json_object_iterator *iter)
json_bool json_object_iter_equal (const struct json_object_iterator *iter1, const struct json_object_iterator *iter2)
+

Detailed Description

+

json-c forces clients to use its private data structures for JSON Object iteration. This API corrects that by abstracting the private json-c details.

+

Copyright (c) 2009-2012 Hewlett-Packard Development Company, L.P.

+

This library is free software; you can redistribute it and/or modify it under the terms of the MIT license. See COPYING for details.

+

API attributes:
+ * Thread-safe: NO
+ * Reentrant: NO

+

Function Documentation

+ +
+
+ + + + + + + + + +
struct json_object_iterator json_object_iter_begin (struct json_object *  obj )  [read]
+
+
+

Retrieves an iterator to the first pair of the JSON Object.

+
Warning:
Any modification of the underlying pair invalidates all iterators to that pair.
+
Parameters:
+ + +
obj JSON Object instance (MUST be of type json_object)
+
+
+
Returns:
json_object_iterator If the JSON Object has at least one pair, on return, the iterator refers to the first pair. If the JSON Object doesn't have any pairs, the returned iterator is equivalent to the "end" iterator for the same JSON Object instance.
+
 struct json_object_iterator it;
+ struct json_object_iterator itEnd;
+ struct json_object* obj;
+
+ obj = json_tokener_parse("{'first':'george', 'age':100}");
+ it = json_object_iter_begin(obj);
+ itEnd = json_object_iter_end(obj);
+
+ while (!json_object_iter_equal(&it, &itEnd)) {
+     printf("%s\n",
+            json_object_iter_peek_name(&it));
+     json_object_iter_next(&it);
+ }
+
+
+
+ +
+
+ + + + + + + + + +
struct json_object_iterator json_object_iter_end (const struct json_object *  obj )  [read]
+
+
+

Retrieves the iterator that represents the position beyond the last pair of the given JSON Object instance.

+
Warning:
Do NOT write code that assumes that the "end" iterator value is NULL, even if it is so in a particular instance of the implementation.
+
Note:
The reason we do not (and MUST NOT) provide "json_object_iter_is_end(json_object_iterator* iter)" type of API is because it would limit the underlying representation of name/value containment (or force us to add additional, otherwise unnecessary, fields to the iterator structure). The "end" iterator and the equality test method, on the other hand, permit us to cleanly abstract pretty much any reasonable underlying representation without burdening the iterator structure with unnecessary data.
+
+For performance reasons, memorize the "end" iterator prior to any loop.
+
Parameters:
+ + +
obj JSON Object instance (MUST be of type json_object)
+
+
+
Returns:
json_object_iterator On return, the iterator refers to the "end" of the Object instance's pairs (i.e., NOT the last pair, but "beyond the last + pair" value)
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
json_bool json_object_iter_equal (const struct json_object_iterator *  iter1,
const struct json_object_iterator *  iter2 
)
+
+
+

Tests two iterators for equality. Typically used to test for end of iteration by comparing an iterator to the corresponding "end" iterator (that was derived from the same JSON Object instance).

+
Note:
The reason we do not (and MUST NOT) provide "json_object_iter_is_end(json_object_iterator* iter)" type of API is because it would limit the underlying representation of name/value containment (or force us to add additional, otherwise unnecessary, fields to the iterator structure). The equality test method, on the other hand, permits us to cleanly abstract pretty much any reasonable underlying representation.
+
Parameters:
+ + + +
iter1 Pointer to first valid, non-NULL iterator
iter2 POinter to second valid, non-NULL iterator
+
+
+
Warning:
if a NULL iterator pointer or an uninitialized or invalid iterator, or iterators derived from different JSON Object instances are passed, bad things will happen!
+
Returns:
json_bool non-zero if iterators are equal (i.e., both reference the same name/value pair or are both at "end"); zero if they are not equal.
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object_iterator json_object_iter_init_default (void  )  [read]
+
+
+

Initializes an iterator structure to a "default" value that is convenient for initializing an iterator variable to a default state (e.g., initialization list in a class' constructor).

+
 struct json_object_iterator iter = json_object_iter_init_default();
+ MyClass() : iter_(json_object_iter_init_default())
+
Note:
The initialized value doesn't reference any specific pair, is considered an invalid iterator, and MUST NOT be passed to any json-c API that expects a valid iterator.
+
+User and internal code MUST NOT make any assumptions about and dependencies on the value of the "default" iterator value.
+
Returns:
json_object_iterator
+ +
+
+ +
+
+ + + + + + + + + +
void json_object_iter_next (struct json_object_iterator *  iter ) 
+
+
+

Returns an iterator to the next pair, if any

+
Warning:
Any modification of the underlying pair invalidates all iterators to that pair.
+
Parameters:
+ + +
iter [IN/OUT] Pointer to iterator that references a name/value pair; MUST be a valid, non-end iterator. WARNING: bad things will happen if invalid or "end" iterator is passed. Upon return will contain the reference to the next pair if there is one; if there are no more pairs, will contain the "end" iterator value, which may be compared against the return value of json_object_iter_end() for the same JSON Object instance.
+
+
+ +
+
+ +
+
+ + + + + + + + + +
const char* json_object_iter_peek_name (const struct json_object_iterator *  iter ) 
+
+
+

Returns a const pointer to the name of the pair referenced by the given iterator.

+
Parameters:
+ + +
iter pointer to iterator that references a name/value pair; MUST be a valid, non-end iterator.
+
+
+
Warning:
bad things will happen if an invalid or "end" iterator is passed.
+
Returns:
const char* Pointer to the name of the referenced name/value pair. The name memory belongs to the name/value pair, will be freed when the pair is deleted or modified, and MUST NOT be modified or freed by the user.
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_object_iter_peek_value (const struct json_object_iterator *  iter )  [read]
+
+
+

Returns a pointer to the json-c instance representing the value of the referenced name/value pair, without altering the instance's reference count.

+
Parameters:
+ + +
iter pointer to iterator that references a name/value pair; MUST be a valid, non-end iterator.
+
+
+
Warning:
bad things will happen if invalid or "end" iterator is passed.
+
Returns:
struct json_object* Pointer to the json-c value instance of the referenced name/value pair; the value's reference count is not changed by this function: if you plan to hold on to this json-c node, take a look at json_object_get() and json_object_put(). IMPORTANT: json-c API represents the JSON Null value as a NULL json_object instance pointer.
+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json__object__private_8h.html b/doc/html/json__object__private_8h.html new file mode 100644 index 0000000..2918e45 --- /dev/null +++ b/doc/html/json__object__private_8h.html @@ -0,0 +1,68 @@ + + + + +json-c: json_object_private.h File Reference + + + + + + +
+

json_object_private.h File Reference

+ + + + + + +

Data Structures

struct  json_object
union  json_object::data

Typedefs

typedef void( json_object_delete_fn )(struct json_object *o)
typedef int( json_object_to_json_string_fn )(struct json_object *o, struct printbuf *pb, int level, int flags)
+

Typedef Documentation

+ +
+
+ + + + +
typedef void( json_object_delete_fn)(struct json_object *o)
+
+
+ +
+
+ +
+
+ + + + +
typedef int( json_object_to_json_string_fn)(struct json_object *o, struct printbuf *pb, int level, int flags)
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json__tokener_8h.html b/doc/html/json__tokener_8h.html new file mode 100644 index 0000000..fe95ef8 --- /dev/null +++ b/doc/html/json__tokener_8h.html @@ -0,0 +1,449 @@ + + + + +json-c: json_tokener.h File Reference + + + + + + +
+

json_tokener.h File Reference

+ + + + + + + + + + + + + + + + + + + +

Data Structures

struct  json_tokener_srec
struct  json_tokener

Defines

#define JSON_TOKENER_MAX_DEPTH   32

Enumerations

enum  json_tokener_error {
+  json_tokener_success, +json_tokener_continue, +json_tokener_error_depth, +json_tokener_error_parse_eof, +
+  json_tokener_error_parse_unexpected, +json_tokener_error_parse_null, +json_tokener_error_parse_boolean, +json_tokener_error_parse_number, +
+  json_tokener_error_parse_array, +json_tokener_error_parse_object_key_name, +json_tokener_error_parse_object_key_sep, +json_tokener_error_parse_object_value_sep, +
+  json_tokener_error_parse_string, +json_tokener_error_parse_comment +
+ }
enum  json_tokener_state {
+  json_tokener_state_eatws, +json_tokener_state_start, +json_tokener_state_finish, +json_tokener_state_null, +
+  json_tokener_state_comment_start, +json_tokener_state_comment, +json_tokener_state_comment_eol, +json_tokener_state_comment_end, +
+  json_tokener_state_string, +json_tokener_state_string_escape, +json_tokener_state_escape_unicode, +json_tokener_state_boolean, +
+  json_tokener_state_number, +json_tokener_state_array, +json_tokener_state_array_add, +json_tokener_state_array_sep, +
+  json_tokener_state_object_field_start, +json_tokener_state_object_field, +json_tokener_state_object_field_end, +json_tokener_state_object_value, +
+  json_tokener_state_object_value_add, +json_tokener_state_object_sep +
+ }

Functions

const char * json_tokener_error_desc (enum json_tokener_error jerr)
enum json_tokener_error json_tokener_get_error (struct json_tokener *tok)
struct json_tokener * json_tokener_new (void)
void json_tokener_free (struct json_tokener *tok)
void json_tokener_reset (struct json_tokener *tok)
struct json_object * json_tokener_parse (const char *str)
struct json_object * json_tokener_parse_verbose (const char *str, enum json_tokener_error *error)
struct json_object * json_tokener_parse_ex (struct json_tokener *tok, const char *str, int len)

Variables

const char * json_tokener_errors []
+

Define Documentation

+ +
+
+ + + + +
#define JSON_TOKENER_MAX_DEPTH   32
+
+
+ +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum json_tokener_error
+
+
+
Enumerator:
+ + + + + + + + + + + + + + +
json_tokener_success  +
json_tokener_continue  +
json_tokener_error_depth  +
json_tokener_error_parse_eof  +
json_tokener_error_parse_unexpected  +
json_tokener_error_parse_null  +
json_tokener_error_parse_boolean  +
json_tokener_error_parse_number  +
json_tokener_error_parse_array  +
json_tokener_error_parse_object_key_name  +
json_tokener_error_parse_object_key_sep  +
json_tokener_error_parse_object_value_sep  +
json_tokener_error_parse_string  +
json_tokener_error_parse_comment  +
+
+
+ +
+
+ +
+
+ + + + +
enum json_tokener_state
+
+
+
Enumerator:
+ + + + + + + + + + + + + + + + + + + + + + +
json_tokener_state_eatws  +
json_tokener_state_start  +
json_tokener_state_finish  +
json_tokener_state_null  +
json_tokener_state_comment_start  +
json_tokener_state_comment  +
json_tokener_state_comment_eol  +
json_tokener_state_comment_end  +
json_tokener_state_string  +
json_tokener_state_string_escape  +
json_tokener_state_escape_unicode  +
json_tokener_state_boolean  +
json_tokener_state_number  +
json_tokener_state_array  +
json_tokener_state_array_add  +
json_tokener_state_array_sep  +
json_tokener_state_object_field_start  +
json_tokener_state_object_field  +
json_tokener_state_object_field_end  +
json_tokener_state_object_value  +
json_tokener_state_object_value_add  +
json_tokener_state_object_sep  +
+
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + +
const char* json_tokener_error_desc (enum json_tokener_error  jerr ) 
+
+
+

Given an error previously returned by json_tokener_get_error(), return a human readable description of the error.

+
Returns:
a generic error message is returned if an invalid error value is provided.
+ +
+
+ +
+
+ + + + + + + + + +
void json_tokener_free (struct json_tokener *  tok ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + +
enum json_tokener_error json_tokener_get_error (struct json_tokener *  tok ) 
+
+
+

Retrieve the error caused by the last call to json_tokener_parse_ex(), or json_tokener_success if there is no error.

+

When parsing a JSON string in pieces, if the tokener is in the middle of parsing this will return json_tokener_continue.

+

See also json_tokener_error_desc().

+ +
+
+ +
+
+ + + + + + + + + +
struct json_tokener* json_tokener_new (void  )  [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + +
struct json_object* json_tokener_parse (const char *  str )  [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
struct json_object* json_tokener_parse_ex (struct json_tokener *  tok,
const char *  str,
int  len 
) [read]
+
+
+

Parse a string and return a non-NULL json_object if a valid JSON value is found. The string does not need to be a JSON object or array; it can also be a string, number or boolean value.

+

A partial JSON string can be parsed. If the parsing is incomplete, NULL will be returned and json_tokener_get_error() will be return json_tokener_continue. json_tokener_parse_ex() can then be called with additional bytes in str to continue the parsing.

+

If json_tokener_parse_ex() returns NULL and the error anything other than json_tokener_continue, a fatal error has occurred and parsing must be halted. Then tok object must not be re-used until json_tokener_reset() is called.

+

When a valid JSON value is parsed, a non-NULL json_object will be returned. Also, json_tokener_get_error() will return json_tokener_success. Be sure to check the type with json_object_is_type() or json_object_get_type() before using the object.

+

XXX this shouldn't use internal fields: Trailing characters after the parsed value do not automatically cause an error. It is up to the caller to decide whether to treat this as an error or to handle the additional characters, perhaps by parsing another json value starting from that point.

+

Extra characters can be detected by comparing the tok->char_offset against the length of the last len parameter passed in.

+

The tokener does not maintain an internal buffer so the caller is responsible for calling json_tokener_parse_ex with an appropriate str parameter starting with the extra characters.

+

Example:

+
json_object *jobj = NULL;
+const char *mystring = NULL;
+int stringlen = 0;
+enum json_tokener_error jerr;
+do {
+        mystring = ...  // get JSON string, e.g. read from file, etc...
+        stringlen = strlen(mystring);
+        jobj = json_tokener_parse_ex(tok, mystring, stringlen);
+} while ((jerr = json_tokener_get_error(tok)) == json_tokener_continue);
+if (jerr != json_tokener_success)
+{
+        fprintf(stderr, "Error: %s\n", json_tokener_error_desc(jerr));
+        // Handle errors, as appropriate for your application.
+}
+if (tok->char_offset < stringlen) // XXX shouldn't access internal fields
+{
+        // Handle extra characters after parsed object as desired.
+        // e.g. issue an error, parse another object from that point, etc...
+}
+// Success, use jobj here.
+
Parameters:
+ + + + +
tok a json_tokener previously allocated with json_tokener_new()
str an string with any valid JSON expression, or portion of. This does not need to be null terminated.
len the length of str
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
struct json_object* json_tokener_parse_verbose (const char *  str,
enum json_tokener_error *  error 
) [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void json_tokener_reset (struct json_tokener *  tok ) 
+
+
+ +
+
+

Variable Documentation

+ +
+
+ + + + +
const char* json_tokener_errors[]
+
+
+

XXX do not use json_tokener_errors directly. After v0.10 this will be removed.

+

See json_tokener_error_desc() instead.

+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/json__util_8h.html b/doc/html/json__util_8h.html new file mode 100644 index 0000000..5a544ea --- /dev/null +++ b/doc/html/json__util_8h.html @@ -0,0 +1,182 @@ + + + + +json-c: json_util.h File Reference + + + + + + +
+

json_util.h File Reference

+ + + + + + + + +

Defines

#define JSON_FILE_BUF_SIZE   4096

Functions

struct json_object * json_object_from_file (const char *filename)
int json_object_to_file (char *filename, struct json_object *obj)
int json_object_to_file_ext (char *filename, struct json_object *obj, int flags)
int json_parse_int64 (const char *buf, int64_t *retval)
const char * json_type_to_name (enum json_type o_type)
+

Define Documentation

+ +
+
+ + + + +
#define JSON_FILE_BUF_SIZE   4096
+
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + +
struct json_object* json_object_from_file (const char *  filename )  [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int json_object_to_file (char *  filename,
struct json_object *  obj 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int json_object_to_file_ext (char *  filename,
struct json_object *  obj,
int  flags 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int json_parse_int64 (const char *  buf,
int64_t *  retval 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
const char* json_type_to_name (enum json_type  o_type ) 
+
+
+

Return a string describing the type of the object. e.g. "int", or "object", etc...

+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/linkhash_8h.html b/doc/html/linkhash_8h.html new file mode 100644 index 0000000..b250287 --- /dev/null +++ b/doc/html/linkhash_8h.html @@ -0,0 +1,767 @@ + + + + +json-c: linkhash.h File Reference + + + + + + +
+

linkhash.h File Reference

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  lh_entry
struct  lh_table

Defines

#define LH_PRIME   0x9e370001UL
#define LH_LOAD_FACTOR   0.66
#define LH_EMPTY   (void*)-1
#define LH_FREED   (void*)-2
#define lh_foreach(table, entry)   for(entry = table->head; entry; entry = entry->next)
#define lh_foreach_safe(table, entry, tmp)   for(entry = table->head; entry && ((tmp = entry->next) || 1); entry = tmp)

Typedefs

typedef void( lh_entry_free_fn )(struct lh_entry *e)
typedef unsigned long( lh_hash_fn )(const void *k)
typedef int( lh_equal_fn )(const void *k1, const void *k2)

Functions

unsigned long lh_ptr_hash (const void *k)
int lh_ptr_equal (const void *k1, const void *k2)
unsigned long lh_char_hash (const void *k)
int lh_char_equal (const void *k1, const void *k2)
struct lh_table * lh_table_new (int size, const char *name, lh_entry_free_fn *free_fn, lh_hash_fn *hash_fn, lh_equal_fn *equal_fn)
struct lh_table * lh_kchar_table_new (int size, const char *name, lh_entry_free_fn *free_fn)
struct lh_table * lh_kptr_table_new (int size, const char *name, lh_entry_free_fn *free_fn)
void lh_table_free (struct lh_table *t)
int lh_table_insert (struct lh_table *t, void *k, const void *v)
struct lh_entry * lh_table_lookup_entry (struct lh_table *t, const void *k)
const void * lh_table_lookup (struct lh_table *t, const void *k)
json_bool lh_table_lookup_ex (struct lh_table *t, const void *k, void **v)
int lh_table_delete_entry (struct lh_table *t, struct lh_entry *e)
int lh_table_delete (struct lh_table *t, const void *k)
void lh_abort (const char *msg,...)
void lh_table_resize (struct lh_table *t, int new_size)
+

Define Documentation

+ +
+
+ + + + +
#define LH_EMPTY   (void*)-1
+
+
+

sentinel pointer value for empty slots

+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define lh_foreach(table,
entry  )    for(entry = table->head; entry; entry = entry->next)
+
+
+

Convenience list iterator.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
#define lh_foreach_safe(table,
entry,
tmp  )    for(entry = table->head; entry && ((tmp = entry->next) || 1); entry = tmp)
+
+
+

lh_foreach_safe allows calling of deletion routine while iterating.

+ +
+
+ +
+
+ + + + +
#define LH_FREED   (void*)-2
+
+
+

sentinel pointer value for freed slots

+ +
+
+ +
+
+ + + + +
#define LH_LOAD_FACTOR   0.66
+
+
+

The fraction of filled hash buckets until an insert will cause the table to be resized. This can range from just above 0 up to 1.0.

+ +
+
+ +
+
+ + + + +
#define LH_PRIME   0x9e370001UL
+
+
+

golden prime used in hash functions

+ +
+
+

Typedef Documentation

+ +
+
+ + + + +
typedef void( lh_entry_free_fn)(struct lh_entry *e)
+
+
+

callback function prototypes

+ +
+
+ +
+
+ + + + +
typedef int( lh_equal_fn)(const void *k1, const void *k2)
+
+
+

callback function prototypes

+ +
+
+ +
+
+ + + + +
typedef unsigned long( lh_hash_fn)(const void *k)
+
+
+

callback function prototypes

+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void lh_abort (const char *  msg,
  ... 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int lh_char_equal (const void *  k1,
const void *  k2 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
unsigned long lh_char_hash (const void *  k ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
struct lh_table* lh_kchar_table_new (int  size,
const char *  name,
lh_entry_free_fn *  free_fn 
) [read]
+
+
+

Convenience function to create a new linkhash table with char keys.

+
Parameters:
+ + + + +
size initial table size.
name table name.
free_fn callback function used to free memory for entries.
+
+
+
Returns:
a pointer onto the linkhash table.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
struct lh_table* lh_kptr_table_new (int  size,
const char *  name,
lh_entry_free_fn *  free_fn 
) [read]
+
+
+

Convenience function to create a new linkhash table with ptr keys.

+
Parameters:
+ + + + +
size initial table size.
name table name.
free_fn callback function used to free memory for entries.
+
+
+
Returns:
a pointer onto the linkhash table.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int lh_ptr_equal (const void *  k1,
const void *  k2 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + +
unsigned long lh_ptr_hash (const void *  k ) 
+
+
+

Pre-defined hash and equality functions

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int lh_table_delete (struct lh_table *  t,
const void *  k 
)
+
+
+

Delete a record from the table. If a callback free function is provided then it is called for the for the item being deleted.

+
Parameters:
+ + + +
t the table to delete from.
k a pointer to the key to delete.
+
+
+
Returns:
0 if the item was deleted.
+
+-1 if it was not found.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int lh_table_delete_entry (struct lh_table *  t,
struct lh_entry *  e 
)
+
+
+

Delete a record from the table. If a callback free function is provided then it is called for the for the item being deleted.

+
Parameters:
+ + + +
t the table to delete from.
e a pointer to the entry to delete.
+
+
+
Returns:
0 if the item was deleted.
+
+-1 if it was not found.
+ +
+
+ +
+
+ + + + + + + + + +
void lh_table_free (struct lh_table *  t ) 
+
+
+

Free a linkhash table. If a callback free function is provided then it is called for all entries in the table.

+
Parameters:
+ + +
t table to free.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int lh_table_insert (struct lh_table *  t,
void *  k,
const void *  v 
)
+
+
+

Insert a record into the table.

+
Parameters:
+ + + + +
t the table to insert into.
k a pointer to the key to insert.
v a pointer to the value to insert.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
const void* lh_table_lookup (struct lh_table *  t,
const void *  k 
)
+
+
+

Lookup a record into the table

+
Parameters:
+ + + +
t the table to lookup
k a pointer to the key to lookup
+
+
+
Returns:
a pointer to the found value or NULL if it does not exist.
+
Deprecated:
Use lh_table_lookup_ex instead.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
struct lh_entry* lh_table_lookup_entry (struct lh_table *  t,
const void *  k 
) [read]
+
+
+

Lookup a record into the table.

+
Parameters:
+ + + +
t the table to lookup
k a pointer to the key to lookup
+
+
+
Returns:
a pointer to the record structure of the value or NULL if it does not exist.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
json_bool lh_table_lookup_ex (struct lh_table *  t,
const void *  k,
void **  v 
)
+
+
+

Lookup a record in the table

+
Parameters:
+ + + + +
t the table to lookup
k a pointer to the key to lookup
v a pointer to a where to store the found value (set to NULL if it doesn't exist).
+
+
+
Returns:
whether or not the key was found
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
struct lh_table* lh_table_new (int  size,
const char *  name,
lh_entry_free_fn *  free_fn,
lh_hash_fn *  hash_fn,
lh_equal_fn *  equal_fn 
) [read]
+
+
+

Create a new linkhash table.

+
Parameters:
+ + + + + + +
size initial table size. The table is automatically resized although this incurs a performance penalty.
name the table name.
free_fn callback function used to free memory for entries when lh_table_free or lh_table_delete is called. If NULL is provided, then memory for keys and values must be freed by the caller.
hash_fn function used to hash keys. 2 standard ones are defined: lh_ptr_hash and lh_char_hash for hashing pointer values and C strings respectively.
equal_fn comparison function to compare keys. 2 standard ones defined: lh_ptr_hash and lh_char_hash for comparing pointer values and C strings respectively.
+
+
+
Returns:
a pointer onto the linkhash table.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void lh_table_resize (struct lh_table *  t,
int  new_size 
)
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/pages.html b/doc/html/pages.html new file mode 100644 index 0000000..49847f2 --- /dev/null +++ b/doc/html/pages.html @@ -0,0 +1,31 @@ + + + + +json-c: Page Index + + + + + + +
+

Related Pages

Here is a list of all related documentation pages: +
+
Generated on Sat Apr 28 15:52:46 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/printbuf_8h.html b/doc/html/printbuf_8h.html new file mode 100644 index 0000000..2cbaa70 --- /dev/null +++ b/doc/html/printbuf_8h.html @@ -0,0 +1,264 @@ + + + + +json-c: printbuf.h File Reference + + + + + + +
+

printbuf.h File Reference

+ + + + + + + + + + + + +

Data Structures

struct  printbuf

Defines

#define printbuf_memappend_fast(p, bufptr, bufsize)
#define printbuf_length(p)   ((p)->bpos)

Functions

struct printbuf * printbuf_new (void)
int printbuf_memappend (struct printbuf *p, const char *buf, int size)
int printbuf_memset (struct printbuf *pb, int offset, int charvalue, int len)
int sprintbuf (struct printbuf *p, const char *msg,...)
void printbuf_reset (struct printbuf *p)
void printbuf_free (struct printbuf *p)
+

Define Documentation

+ +
+
+ + + + + + + + + +
#define printbuf_length(p  )    ((p)->bpos)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
#define printbuf_memappend_fast(p,
bufptr,
bufsize  ) 
+
+
+Value:
do {                                                         \
+  if ((p->size - p->bpos) > bufsize) {                       \
+    memcpy(p->buf + p->bpos, (bufptr), bufsize);             \
+    p->bpos += bufsize;                                      \
+    p->buf[p->bpos]= '\0';                                   \
+  } else {  printbuf_memappend(p, (bufptr), bufsize); }      \
+} while (0)
+
+
+
+

Function Documentation

+ +
+
+ + + + + + + + + +
void printbuf_free (struct printbuf *  p ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int printbuf_memappend (struct printbuf *  p,
const char *  buf,
int  size 
)
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int printbuf_memset (struct printbuf *  pb,
int  offset,
int  charvalue,
int  len 
)
+
+
+

Set len bytes of the buffer to charvalue, starting at offset offset. Similar to calling memset(x, charvalue, len);

+

The memory allocated for the buffer is extended as necessary.

+

If offset is -1, this starts at the end of the current data in the buffer.

+ +
+
+ +
+
+ + + + + + + + + +
struct printbuf* printbuf_new (void  )  [read]
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void printbuf_reset (struct printbuf *  p ) 
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int sprintbuf (struct printbuf *  p,
const char *  msg,
  ... 
)
+
+
+ +
+
+
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structarray__list.html b/doc/html/structarray__list.html new file mode 100644 index 0000000..ba2aa57 --- /dev/null +++ b/doc/html/structarray__list.html @@ -0,0 +1,96 @@ + + + + +json-c: array_list Struct Reference + + + + + + +
+

array_list Struct Reference

+ + + + + +

Data Fields

void ** array
int length
int size
array_list_free_fn * free_fn
+

Field Documentation

+ +
+
+ + + + +
void** array_list::array
+
+
+ +
+
+ +
+
+ + + + +
array_list_free_fn* array_list::free_fn
+
+
+ +
+
+ +
+
+ + + + +
int array_list::length
+
+
+ +
+
+ +
+
+ + + + +
int array_list::size
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structjson__object.html b/doc/html/structjson__object.html new file mode 100644 index 0000000..c8f389c --- /dev/null +++ b/doc/html/structjson__object.html @@ -0,0 +1,126 @@ + + + + +json-c: json_object Struct Reference + + + + + + +
+

json_object Struct Reference

+ + + + + + + + + +

Data Structures

union  data

Data Fields

enum json_type o_type
json_object_delete_fn * _delete
json_object_to_json_string_fn * _to_json_string
int _ref_count
struct printbuf * _pb
union json_object::data o
+

Field Documentation

+ +
+
+ + + + +
json_object_delete_fn* json_object::_delete
+
+
+ +
+
+ +
+
+ + + + +
struct printbuf* json_object::_pb
+
+
+ +
+
+ +
+
+ + + + +
int json_object::_ref_count
+
+
+ +
+
+ +
+
+ + + + +
json_object_to_json_string_fn* json_object::_to_json_string
+
+
+ +
+
+ +
+
+ + + + +
union json_object::data json_object::o
+
+
+ +
+
+ +
+
+ + + + +
enum json_type json_object::o_type
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structjson__object__iter.html b/doc/html/structjson__object__iter.html new file mode 100644 index 0000000..098b6cd --- /dev/null +++ b/doc/html/structjson__object__iter.html @@ -0,0 +1,82 @@ + + + + +json-c: json_object_iter Struct Reference + + + + + + +
+

json_object_iter Struct Reference

+ + + + +

Data Fields

char * key
struct json_object * val
struct lh_entry * entry
+

Field Documentation

+ +
+
+ + + + +
struct lh_entry* json_object_iter::entry
+
+
+ +
+
+ +
+
+ + + + +
char* json_object_iter::key
+
+
+ +
+
+ +
+
+ + + + +
struct json_object* json_object_iter::val
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structjson__object__iterator.html b/doc/html/structjson__object__iterator.html new file mode 100644 index 0000000..786f3ec --- /dev/null +++ b/doc/html/structjson__object__iterator.html @@ -0,0 +1,56 @@ + + + + +json-c: json_object_iterator Struct Reference + + + + + + +
+

json_object_iterator Struct Reference

+ + +

Data Fields

const void * opaque_
+

Detailed Description

+

The opaque iterator that references a name/value pair within a JSON Object instance or the "end" iterator value.

+

Field Documentation

+ +
+
+ + + + +
const void* json_object_iterator::opaque_
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structjson__tokener.html b/doc/html/structjson__tokener.html new file mode 100644 index 0000000..7c89951 --- /dev/null +++ b/doc/html/structjson__tokener.html @@ -0,0 +1,180 @@ + + + + +json-c: json_tokener Struct Reference + + + + + + +
+

json_tokener Struct Reference

+ + + + + + + + + + + +

Data Fields

char * str
struct printbuf * pb
int depth
int is_double
int st_pos
int char_offset
enum json_tokener_error err
unsigned int ucs_char
char quote_char
struct json_tokener_srec stack [JSON_TOKENER_MAX_DEPTH]
+

Field Documentation

+ +
+
+ + + + +
int json_tokener::char_offset
+
+
+ +
+
+ +
+
+ + + + +
int json_tokener::depth
+
+
+ +
+
+ +
+
+ + + + +
enum json_tokener_error json_tokener::err
+
+
+ +
+
+ +
+
+ + + + +
int json_tokener::is_double
+
+
+ +
+
+ +
+
+ + + + +
struct printbuf* json_tokener::pb
+
+
+ +
+
+ +
+
+ + + + +
char json_tokener::quote_char
+
+
+ +
+
+ +
+
+ + + + +
int json_tokener::st_pos
+
+
+ +
+
+ +
+
+ + + + +
struct json_tokener_srec json_tokener::stack[JSON_TOKENER_MAX_DEPTH]
+
+
+ +
+
+ +
+
+ + + + +
char* json_tokener::str
+
+
+ +
+
+ +
+
+ + + + +
unsigned int json_tokener::ucs_char
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structjson__tokener__srec.html b/doc/html/structjson__tokener__srec.html new file mode 100644 index 0000000..5fada3a --- /dev/null +++ b/doc/html/structjson__tokener__srec.html @@ -0,0 +1,96 @@ + + + + +json-c: json_tokener_srec Struct Reference + + + + + + +
+

json_tokener_srec Struct Reference

+ + + + + +

Data Fields

enum json_tokener_state state saved_state
struct json_object * obj
struct json_object * current
char * obj_field_name
+

Field Documentation

+ +
+
+ + + + +
struct json_object* json_tokener_srec::current
+
+
+ +
+
+ +
+
+ + + + +
struct json_object* json_tokener_srec::obj
+
+
+ +
+
+ +
+
+ + + + +
char* json_tokener_srec::obj_field_name
+
+
+ +
+
+ +
+
+ + + + +
enum json_tokener_state state json_tokener_srec::saved_state
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structlh__entry.html b/doc/html/structlh__entry.html new file mode 100644 index 0000000..6c95138 --- /dev/null +++ b/doc/html/structlh__entry.html @@ -0,0 +1,102 @@ + + + + +json-c: lh_entry Struct Reference + + + + + + +
+

lh_entry Struct Reference

+ + + + + +

Data Fields

void * k
const void * v
struct lh_entry * next
struct lh_entry * prev
+

Detailed Description

+

An entry in the hash table

+

Field Documentation

+ +
+
+ + + + +
void* lh_entry::k
+
+
+

The key.

+ +
+
+ +
+
+ + + + +
struct lh_entry* lh_entry::next
+
+
+

The next entry

+ +
+
+ +
+
+ + + + +
struct lh_entry* lh_entry::prev
+
+
+

The previous entry.

+ +
+
+ +
+
+ + + + +
const void* lh_entry::v
+
+
+

The value.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structlh__table.html b/doc/html/structlh__table.html new file mode 100644 index 0000000..25bb330 --- /dev/null +++ b/doc/html/structlh__table.html @@ -0,0 +1,249 @@ + + + + +json-c: lh_table Struct Reference + + + + + + +
+

lh_table Struct Reference

+ + + + + + + + + + + + + + + +

Data Fields

int size
int count
int collisions
int resizes
int lookups
int inserts
int deletes
const char * name
struct lh_entry * head
struct lh_entry * tail
struct lh_entry * table
lh_entry_free_fn * free_fn
lh_hash_fn * hash_fn
lh_equal_fn * equal_fn
+

Detailed Description

+

The hash table structure.

+

Field Documentation

+ +
+
+ + + + +
int lh_table::collisions
+
+
+

Number of collisions.

+ +
+
+ +
+
+ + + + +
int lh_table::count
+
+
+

Numbers of entries.

+ +
+
+ +
+
+ + + + +
int lh_table::deletes
+
+
+

Number of deletes.

+ +
+
+ +
+
+ + + + +
lh_equal_fn* lh_table::equal_fn
+
+
+ +
+
+ +
+
+ + + + +
lh_entry_free_fn* lh_table::free_fn
+
+
+

A pointer onto the function responsible for freeing an entry.

+ +
+
+ +
+
+ + + + +
lh_hash_fn* lh_table::hash_fn
+
+
+ +
+
+ +
+
+ + + + +
struct lh_entry* lh_table::head
+
+
+

The first entry.

+ +
+
+ +
+
+ + + + +
int lh_table::inserts
+
+
+

Number of inserts.

+ +
+
+ +
+
+ + + + +
int lh_table::lookups
+
+
+

Number of lookups.

+ +
+
+ +
+
+ + + + +
const char* lh_table::name
+
+
+

Name of the hash table.

+ +
+
+ +
+
+ + + + +
int lh_table::resizes
+
+
+

Number of resizes.

+ +
+
+ +
+
+ + + + +
int lh_table::size
+
+
+

Size of our hash.

+ +
+
+ +
+
+ + + + +
struct lh_entry* lh_table::table
+
+
+ +
+
+ +
+
+ + + + +
struct lh_entry* lh_table::tail
+
+
+

The last entry.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/structprintbuf.html b/doc/html/structprintbuf.html new file mode 100644 index 0000000..eb101d2 --- /dev/null +++ b/doc/html/structprintbuf.html @@ -0,0 +1,82 @@ + + + + +json-c: printbuf Struct Reference + + + + + + +
+

printbuf Struct Reference

+ + + + +

Data Fields

char * buf
int bpos
int size
+

Field Documentation

+ +
+
+ + + + +
int printbuf::bpos
+
+
+ +
+
+ +
+
+ + + + +
char* printbuf::buf
+
+
+ +
+
+ +
+
+ + + + +
int printbuf::size
+
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ + diff --git a/doc/html/tab_b.gif b/doc/html/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/doc/html/tab_b.gif differ diff --git a/doc/html/tab_l.gif b/doc/html/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/doc/html/tab_l.gif differ diff --git a/doc/html/tab_r.gif b/doc/html/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/doc/html/tab_r.gif differ diff --git a/doc/html/tabs.css b/doc/html/tabs.css new file mode 100644 index 0000000..a444163 --- /dev/null +++ b/doc/html/tabs.css @@ -0,0 +1,105 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs #MSearchBox +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; +} diff --git a/doc/html/unionjson__object_1_1data.html b/doc/html/unionjson__object_1_1data.html new file mode 100644 index 0000000..2e8514f --- /dev/null +++ b/doc/html/unionjson__object_1_1data.html @@ -0,0 +1,155 @@ + + + + +json-c: json_object::data Union Reference + + + + + + +
+

json_object::data Union Reference

+ + + + + + + + + + +

Data Fields

json_bool c_boolean
double c_double
int64_t c_int64
struct lh_table * c_object
struct array_list * c_array
struct {
   char *   str
   int   len
} c_string
+

Field Documentation

+ +
+
+ + + + +
struct array_list* json_object::data::c_array
+
+
+ +
+
+ +
+
+ + + + +
json_bool json_object::data::c_boolean
+
+
+ +
+
+ +
+
+ + + + +
double json_object::data::c_double
+
+
+ +
+
+ +
+
+ + + + +
int64_t json_object::data::c_int64
+
+
+ +
+
+ +
+
+ + + + +
struct lh_table* json_object::data::c_object
+
+
+ +
+
+ +
+
+ + + + +
struct { ... } json_object::data::c_string
+
+
+ +
+
+ +
+
+ + + + +
int json_object::data::len
+
+
+ +
+
+ +
+
+ + + + +
char* json_object::data::str
+
+
+ +
+
+
The documentation for this union was generated from the following file: +
+
Generated on Sat Apr 28 15:52:47 2012 for json-c by  + +doxygen 1.6.3
+ +