Changeset 178 for libyaml/trunk/include/yaml/yaml.h

Timestamp:

05/26/06 17:46:47 (7 years ago)

Author:

xi

Message:

Doxygenify the header file.

Add basic reader fields to the parser structure.

Start implementing basic parser functions.

File:

• libyaml/trunk/include/yaml/yaml.h (modified) (3 diffs)

libyaml/trunk/include/yaml/yaml.h

@@ -3 +3 @@
  * @brief Public interface for libyaml.
  * 
- * Include the header file with
+ * Include the header file with the code:
  * @code
  * #include <yaml/yaml.h>
@@ -18 +18 @@
 #include <stdlib.h>
 
-#include "yaml_version.h"
-#include "yaml_error.h"
-
-typedef enum {
-    YAML_DETECT_ENCODING,
+/**
+ * @defgroup version Version Information
+ * @{
+ */
+
+/**
+ * Get the library version as a string.
+ *
+ * @returns The function returns the pointer to a static string of the form
+ * @c "X.Y.Z", where @c X is the major version number, @c Y is a minor version
+ * number, and @c Z is the patch version number.
+ */
+
+const char *
+yaml_get_version_string(void);
+
+/**
+ * Get the library version numbers.
+ *
+ * @param[out]  major   Major version number.
+ * @param[out]  minor   Minor version number.
+ * @param[out]  patch   Patch version number.
+ */
+
+void
+yaml_get_version(int *major, int *minor, int *patch);
+
+/** @} */
+
+/**
+ * @defgroup basic Basic Types
+ * @{
+ */
+
+/** The character type. */
+typedef unsigned char yaml_char_t;
+
+/** The stream encoding. */
+typedef enum {
+    YAML_ANY_ENCODING,
     YAML_UTF8_ENCODING,
     YAML_UTF16LE_ENCODING,
     YAML_UTF16BE_ENCODING
 } yaml_encoding_t;
+
+/** @} */
+
+/*
+
+typedef enum {
+    YAML_NO_ERROR,
+
+    YAML_MEMORY_ERROR,
+
+    YAML_READER_ERROR,
+    YAML_SCANNER_ERROR,
+    YAML_PARSER_ERROR,
+
+    YAML_WRITER_ERROR,
+    YAML_EMITTER_ERROR
+} yaml_error_type_t;
 
 typedef enum {
@@ -183 +235 @@
 } yaml_event_t;
 
+*/
+
+
+/**
+ * @defgroup parser Parser Definitions
+ * @{
+ */
+
+/**
+ * The prototype of a read handler.
+ *
+ * The read handler is called when the parser needs to read more bytes from the
+ * source.  The handler should write not more than @a size bytes to the @a
+ * buffer.  The number of written bytes should be set to the @a length variable.
+ *
+ * @param[in]   ext     A pointer to an application data specified by
+ *                      @c yaml_parser_set_read_handler.
+ * @param[out]  buffer  The buffer to write the data from the source.
+ * @param[in]   size    The size of the buffer.
+ * @param[out]  length  The actual number of bytes read from the source.
+ *
+ * @returns On success, the handler should return @c 1.  If the handler failed,
+ * the returned value should be @c 0.  On EOF, the handler should set the
+ * @a length to @c 0 and return @c 1.
+ */
+typedef int yaml_read_handler_t(void *ext, yaml_char_t *buffer, size_t size,
+        size_t *length);
+
+
+/**
+ * The parser structure.
+ *
+ * All members are internal.  Manage the structure using the @c yaml_parser_
+ * family of functions.
+ */
+
+typedef struct {
+
+    /**
+     * @name Reader stuff
+     * @{
+     */
+
+    /** Read handler */
+    yaml_read_handler_t *reader;
+
+    /** A pointer for passing to the read handler. */
+    void *reader_ext;
+
+    /** EOF flag */
+    int eof;
+
+    /** The pointer to the beginning of the working buffer. */
+    yaml_char_t *buffer;
+
+    /** The pointer to the current character in the working buffer. */
+    yaml_char_t *pointer;
+
+    /** The remaining undecoded characters. */
+    unsigned char *raw_buffer;
+
+    /** The size of the raw buffer. */
+    size_t raw_buffer_size;
+
+    /** The input encoding. */
+    yaml_encoding_t encoding;
+
+    /**
+     * @}
+     */
+
+} yaml_parser_t;
+
+/**
+ * Create a new parser.
+ *
+ * This function creates a new parser object.  An application is responsible
+ * for destroying the object using the @c yaml_parser_delete function.
+ *
+ * @returns A new parser object; @c NULL on error.
+ */
+
+yaml_parser_t *
+yaml_parser_new(void);
+
+/**
+ * Destroy a parser.
+ *
+ * @param[in]   parser  A parser object.
+ */
+
+void
+yaml_parser_delete(yaml_parser_t *parser);
+
+/** @} */
+
 /*
-typedef struct {
-} yaml_parser_t;
-
 typedef struct {
 } yaml_emitter_t;