Changes between Version 2 and Version 3 of LibYAML

Timestamp:

05/16/06 14:01:18 (7 years ago)

Author:

xi

Comment:

--

LibYAML

@@ -103 +103 @@
    * `end_mark` - the position of the event end; `offset` (in bytes), `index` (in characters),
      `line` and `column` (starting from `0`).
+
+== API ==
+
+Note: the API may change drastically. You may also check the header file:
+http://pyyaml.org/browser/libyaml/trunk/include/yaml.h.
+
+=== Parser API Synopsis ===
+
+{{{
+#!c
+#include <yaml.h>
+
+yaml_parser_t *parser;
+yaml_event_t *event;
+
+/* Create the Parser object. */
+parser = yaml_parser_new();
+
+/* Set a string input. */
+char *input = "...";
+size_t length = strlen(input);
+
+yaml_parser_set_string_input(parser, input, length);
+
+/* Set a file input. */
+FILE *input = fopen("...", "rb");
+
+yaml_parser_set_file_input(parser, input);
+
+/* Set a generic reader. */
+void *ext = ...;
+int read_handler(void *ext, char *buffer, int size, int *length) {
+    /* ... */
+    *buffer = ...;
+    *length = ...;
+    /* ... */
+    return error ? 0 : 1;
+}
+
+yaml_parser_set_input(parser, read_handler, ext);
+
+/* Read the event sequence. */
+do {
+    /* Get the next event. */
+    event = yaml_parser_get_event(parser);
+
+    if (!event) goto error;
+
+    /*
+      ...
+      Process the event.
+      ...
+    */
+
+    /* The application is responsible for destroing the event object. */
+    yaml_event_delete(event);
+
+} while(event->type != YAML_STREAM_END_EVENT);
+
+/* Destroy the Parser object. */
+yaml_parser_delete(parser);
+
+/* On error. */
+error:
+
+/* Error type: YAML_READER_ERROR, YAML_SCANNER_ERROR, YAML_PARSER_ERROR. */
+yaml_error_t error;
+
+/* What parser was doing when the problem occured (may be NULL). */
+char *context;
+
+/* The starting position of the context (valid only if context != NULL). */
+yaml_mark_t context_mark;
+
+/* The problem description. */
+char *problem;
+
+/* The exact position of the problematic place in the stream. */
+yaml_mark_t problem_mark;
+
+/* Get the error data. */
+yaml_parser_get_error(&error, &context, &context_mark, &problem, &problem_mark);
+
+/*
+  ...
+  Report the problem to the user.
+  ...
+*/
+
+/* Destroy the Parser object. */
+yaml_parser_delete(parser);
+}}}