Changeset 266

Timestamp:

01/03/08 22:33:04 (9 months ago)

Author:

xi

Message:

Drop doxygen support, add more API documentation, API changes.

Files:

• libyaml/trunk/README (modified) (3 diffs)
• libyaml/trunk/doc (deleted)
• libyaml/trunk/include/Makefile.am (modified) (1 diff)
• libyaml/trunk/include/yaml.h (modified) (60 diffs)

libyaml/trunk/README

@@ -1 +1 @@
-LibYAML - A C library for parsing and emitting YAML.
-
-The project is in an early stage of development.
-
-To build and install the library, run:
@@ -14 +12 @@
-# make install
-
-
+
+
+
+
-'http://pyyaml.org/wiki/LibYAML'.
-
@@ -26 +27 @@
-under the MIT license.  See the file LICENSE for more details.
-
-
-
+
+
+

libyaml/trunk/include/Makefile.am

@@ -1 +1 @@
-INCLUDES = yaml.h
-DOXYGEN_CFG = $(top_srcdir)/doc/doxygen.cfg
-
-nobase_include_HEADERS = $(INCLUDES)
-
-if DOXYGEN
-
-html: $(INCLUDES) $(DOXYGEN_CFG)
-        PACKAGE=$(PACKAGE) VERSION=$(VERSION) top_srcdir=$(top_srcdir) top_builddir=$(top_builddir) doxygen $(DOXYGEN_CFG)
-
-endif
-
-distclean-local:
-        -rm -rf $(top_builddir)/doc/html
-
-dist-hook: html
-        cp -a $(top_builddir)/doc/html $(top_distdir)/doc

libyaml/trunk/include/yaml.h

@@ -1 @@
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-#ifndef YAML_H
@@ -20 +33 @@
-#include <string.h>
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-#ifdef WIN32
@@ -39 +64 @@
-#endif
-
- @} */
-
-
-
-
-/
-
-
+***************************************************************************
+
+
+
+
+ The major, minor and patch version numbers of LibYAML.
+
+
-#define YAML_VERSION_MAJOR  0
-
-/** The minor version number. */
-#define YAML_VERSION_MINOR  2
-
-/** The patch version number. */
-#define YAML_VERSION_PATCH  0
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
- * Get the library version numbers at runtime.
- *
-
-
-
+
+
+
+
+
+
+
- */
-
@@ -74 +97 @@
-yaml_get_version(int *major, int *minor, int *patch);
-
-*
+
- * Get the library version as a string at runtime.
- *
-
-
-
+
- */
-
@@ -85 +106 @@
-yaml_get_version_string(void);
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_error_type_e {
-* No error i
+ No error wa
-    YAML_NO_ERROR,
-
-*
+
-    YAML_MEMORY_ERROR,
-
-*
+
-    YAML_READER_ERROR,
-* Cannot decode
+ Cannot decode a character in
-    YAML_DECODER_ERROR,
-*
+
-    YAML_SCANNER_ERROR,
-* Cannot parse a YAML production
+ Cannot parse a YAML event
-    YAML_PARSER_ERROR,
-*
+
-    YAML_COMPOSER_ERROR,
-
-*
+
-    YAML_WRITER_ERROR,
-*
+
-    YAML_EMITTER_ERROR,
-*
+
-    YAML_SERIALIZER_ERROR,
-
-* Cannot resolve an implicit
+ Cannot resolve an implicit YAML node
-    YAML_RESOLVER_ERROR
-} yaml_error_type_t;
-
-
+
+
+
+
+
+
+
+
-typedef struct yaml_mark_s {
-* The character number
+ The number of the character in the input stream
-    size_t index;
-
-
+
-    size_t line;
-
-
+
-    size_t column;
-} yaml_mark_t;
-
-
+
+
+
+
+
+
+
-typedef struct yaml_error_s {
-
-*
+
-    yaml_error_type_t type;
-
-* The detailed error information
+ The specific information for each error type
-    union {
-
-*
-while reading the stream (@c YAML_READER_ERROR 
-@c YAML_DECODER_ERROR
+
+occured while reading the input stream (relevant f
+`YAML_READER_ERROR` and `YAML_DECODER_ERROR`
-         */
-        struct {
-*
+
-            const char *problem;
-* The stream offset
+ The position in the input stream, in bytes
-            size_t offset;
-* The problematic octet or character (@c -1
+ The problematic octet or character (`-1`
-            int value;
-        } reading;
-
-
-
-
+
+
+
+
-         */
-        struct {
-
-
-
+
+
-            const char *context;
-* The context mark (if @c problem_mark is not @c NULL). *
+ The context mark (if `context` is not `NULL`). 
-            yaml_mark_t context_mark;
-*
+
-            const char *problem;
-*
+
-            yaml_mark_t problem_mark;
-        } loading;
-
-
+
+
+
+
-        struct {
-*
+
-            const char *problem;
-* The stream offset
+ The position in the output stream, in bytes
-            size_t offset;
-        } writing;
-
-
-
+
+
+
-         */
-        struct {
-*
+
-            const char *problem;
-        } dumping;
-
-
+
+
+
+
-        struct {
-*
+
-            const char *problem;
-        } resolving;
@@ -199 +242 @@
-} yaml_error_t;
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- */
-
@@ -212 +270 @@
-yaml_error_message(yaml_error_t *error, char *buffer, size_t capacity);
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-typedef unsigned char yaml_char_t;
-
-
+
+
+
+
+
+
-typedef struct yaml_version_directive_s {
-*
+
-    int major;
-*
+
-    int minor;
-} yaml_version_directive_t;
-
-
+
+
+
+
-typedef struct yaml_tag_directive_s {
-*
+
-    yaml_char_t *handle;
-*
+
-    yaml_char_t *prefix;
-} yaml_tag_directive_t;
-
-
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_encoding_e {
-* Let the parser choose the
+ The default/autodetected
-    YAML_ANY_ENCODING,
-* The default
+ The
-    YAML_UTF8_ENCODING,
-* The UTF-16-LE encoding with BOM
+ The UTF-16-LE encoding
-    YAML_UTF16LE_ENCODING,
-* The UTF-16-BE encoding with BOM
+ The UTF-16-BE encoding
-    YAML_UTF16BE_ENCODING
-} yaml_encoding_t;
-
-
+
+
+
+
+
+
+
+
-typedef enum yaml_break_e {
-*
+
-    YAML_ANY_BREAK,
-*
+
-    YAML_CR_BREAK,
-*
+
-    YAML_LN_BREAK,
-*
+
-    YAML_CRLN_BREAK
-} yaml_break_t;
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_scalar_style_e {
-*
+
-    YAML_ANY_SCALAR_STYLE,
-
-* The plain
+ The plain flow
-    YAML_PLAIN_SCALAR_STYLE,
-
-* The single-quoted
+ The single-quoted flow
-    YAML_SINGLE_QUOTED_SCALAR_STYLE,
-* The double-quoted
+ The double-quoted flow
-    YAML_DOUBLE_QUOTED_SCALAR_STYLE,
-
-* The literal
+ The literal block
-    YAML_LITERAL_SCALAR_STYLE,
-* The folded
+ The folded block
-    YAML_FOLDED_SCALAR_STYLE
-} yaml_scalar_style_t;
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_sequence_style_e {
-*
+
-    YAML_ANY_SEQUENCE_STYLE,
-
-
+
+
+
-    YAML_BLOCK_SEQUENCE_STYLE,
-    /** The flow sequence style. */
-    YAML_FLOW_SEQUENCE_STYLE
-} yaml_sequence_style_t;
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_mapping_style_e {
-*
+
-    YAML_ANY_MAPPING_STYLE,
-
-*
+
-    YAML_BLOCK_MAPPING_STYLE,
-*
+
-    YAML_FLOW_MAPPING_STYLE
-/*    YAML_FLOW_SET_MAPPING_STYLE   */
-} yaml_mapping_style_t;
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_token_type_e {
-* An empty
+ An empty unitialized
-    YAML_NO_TOKEN,
-
-*
+
-    YAML_STREAM_START_TOKEN,
-*
+
-    YAML_STREAM_END_TOKEN,
-
-*
+
-    YAML_VERSION_DIRECTIVE_TOKEN,
-*
+
-    YAML_TAG_DIRECTIVE_TOKEN,
-*
+
-    YAML_DOCUMENT_START_TOKEN,
-*
+
-    YAML_DOCUMENT_END_TOKEN,
-
-*
+
-    YAML_BLOCK_SEQUENCE_START_TOKEN,
-*
+
-    YAML_BLOCK_MAPPING_START_TOKEN,
-*
+
-    YAML_BLOCK_END_TOKEN,
-
-*
+
-    YAML_FLOW_SEQUENCE_START_TOKEN,
-*
+
-    YAML_FLOW_SEQUENCE_END_TOKEN,
-*
+
-    YAML_FLOW_MAPPING_START_TOKEN,
-*
+
-    YAML_FLOW_MAPPING_END_TOKEN,
-
-*
+
-    YAML_BLOCK_ENTRY_TOKEN,
-*
+
-    YAML_FLOW_ENTRY_TOKEN,
-*
+
-    YAML_KEY_TOKEN,
-*
+
-    YAML_VALUE_TOKEN,
-
-*
+
-    YAML_ALIAS_TOKEN,
-*
+
-    YAML_ANCHOR_TOKEN,
-*
+
-    YAML_TAG_TOKEN,
-*
+
-    YAML_SCALAR_TOKEN
-} yaml_token_type_t;
-
-
+
+
+
+
+
+
+
+
-typedef struct yaml_token_s {
-
-*
+
-    yaml_token_type_t type;
-
-*
+
-    union {
-
-* The stream start (for @c YAML_STREAM_START_TOKEN)
+ Extra data associated with a STREAM-START token
-        struct {
-*
+
-            yaml_encoding_t encoding;
-        } stream_start;
-
-* The version directive (for @c YAML_VERSION_DIRECTIVE_TOKEN)
+ Extra data associated with a VERSION-DIRECTIVE token
-        struct {
-*
+
-            int major;
-*
+
-            int minor;
-        } version_directive;
-
-* The tag directive (for @c YAML_TAG_DIRECTIVE_TOKEN)
+ Extra data associated with a TAG-DIRECTIVE token
-        struct {
-*
+
-            yaml_char_t *handle;
-*
+
-            yaml_char_t *prefix;
-        } tag_directive;
-
-* The alias (for @c YAML_ALIAS_TOKEN)
+ Extra data associated with an ALIAS token
-        struct {
-*
+
-            yaml_char_t *value;
-        } alias;
-
-* The anchor (for @c YAML_ANCHOR_TOKEN)
+ Extra data associated with an ANCHOR token
-        struct {
-*
+
-            yaml_char_t *value;
-        } anchor;
-
-* The tag (for @c YAML_TAG_TOKEN)
+ Extra data associated with a TAG token
-        struct {
-*
+
-            yaml_char_t *handle;
-*
+
-            yaml_char_t *suffix;
-        } tag;
-
-* The scalar value (for @c YAML_SCALAR_TOKEN)
+ Extra data associated with a SCALAR token
-        struct {
-*
+
-            yaml_char_t *value;
-*
+
-            size_t length;
-*
+
-            yaml_scalar_style_t style;
-        } scalar;
@@ -435 +609 @@
-    } data;
-
-*
+
-    yaml_mark_t start_mark;
-*
+
-    yaml_mark_t end_mark;
-
-} yaml_token_t;
-
-*
+
- * Allocate a new empty token object.
- *
-
+
+
+
+
+
- */
-
@@ -451 +629 @@
-yaml_token_new(void);
-
-
-
-
-
+
+
+
+
+
+
+
+
- */
-
@@ -460 +642 @@
-yaml_token_delete(yaml_token_t *token);
-
-*
+
- * Duplicate a token object.
- *
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- */
-
@@ -472 +665 @@
-yaml_token_duplicate(yaml_token_t *token, const yaml_token_t *model);
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
- */
-
-YAML_DECLARE(void)
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-typedef enum yaml_event_type_e {
-* An empty
+ An empty unitialized
-    YAML_NO_EVENT,
-
-*
+
-    YAML_STREAM_START_EVENT,
-*
+
-    YAML_STREAM_END_EVENT,
-
-*
+
-    YAML_DOCUMENT_START_EVENT,
-*
+
-    YAML_DOCUMENT_END_EVENT,
-
-*
+
-    YAML_ALIAS_EVENT,
-*
+
-    YAML_SCALAR_EVENT,
-
-*
+
-    YAML_SEQUENCE_START_EVENT,
-*
+
-    YAML_SEQUENCE_END_EVENT,
-
-*
+
-    YAML_MAPPING_START_EVENT,
-*
+
-    YAML_MAPPING_END_EVENT
-} yaml_event_type_t;
-
-
+
+
+
+
+
+
-typedef struct yaml_event_s {
-
-*
+
-    yaml_event_type_t type;
-
-*
+
-    union {
-        
-* The stream parameters (for @c YAML_STREAM_START_EVENT
+ The stream parameters (for `YAML_STREAM_START_EVENT`
-        struct {
-*
+
-            yaml_encoding_t encoding;
-        } stream_start;
-
-* The document parameters (for @c YAML_DOCUMENT_START_EVENT
+ The document parameters (for `YAML_DOCUMENT_START_EVENT`
-        struct {
-* The version directive
+ The version directive or `NULL` if not present
-            yaml_version_directive_t *version_directive;
-
-*
+
-            struct {
-* The beginning of the list
+ The beginning of the list or `NULL`
-                yaml_tag_directive_t *list;
-*
+
-                size_t length;
-* The capacity of the list
+ The capacity of the list (used internally)
-                size_t capacity;
-            } tag_directives;
-
-* Is the document indicator implicit?
+ Set if the document indicator is omitted.
-            int is_implicit;
-        } document_start;
-
-* The document end parameters (for @c YAML_DOCUMENT_END_EVENT
+ The document end parameters (for `YAML_DOCUMENT_END_EVENT`
-        struct {
-