X-Git-Url: http://andersk.mit.edu/gitweb/libyaml.git/blobdiff_plain/b46834b37908d8052738f5b150970b56dc629fd5..HEAD:/doc/html/group__events.html diff --git a/doc/html/group__events.html b/doc/html/group__events.html index cab6426..ab27d83 100644 --- a/doc/html/group__events.html +++ b/doc/html/group__events.html @@ -3,48 +3,41 @@ + + yaml: Events - + + - - - -
- - +
- - - - - -
+
yaml -  0.1.6 +  0.2.2
-
- - - -
+ + + + + + +
Data Structures | @@ -56,70 +49,91 @@
- - - - + + +

+

Data Structures

struct  yaml_event_s
 The event structure. More...

+

struct  yaml_event_s
 The event structure. More...
 
+ - - - - - + + + + + +

Typedefs

typedef enum yaml_event_type_e yaml_event_type_t
 Event types.
typedef struct yaml_event_s yaml_event_t
 The event structure.

+

typedef enum yaml_event_type_e yaml_event_type_t
 Event types. More...
 
typedef struct yaml_event_s yaml_event_t
 The event structure. More...
 
+ - - - + +

Enumerations

enum  yaml_event_type_e {
+
enum  yaml_event_type_e {
  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 -
+
}
 Event types. More...

+

 Event types. More...
 
+ - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

int yaml_stream_start_event_initialize (yaml_event_t *event, yaml_encoding_t encoding)
 Create the STREAM-START event.
int yaml_stream_end_event_initialize (yaml_event_t *event)
 Create the STREAM-END event.
int yaml_document_start_event_initialize (yaml_event_t *event, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int implicit)
 Create the DOCUMENT-START event.
int yaml_document_end_event_initialize (yaml_event_t *event, int implicit)
 Create the DOCUMENT-END event.
int yaml_alias_event_initialize (yaml_event_t *event, yaml_char_t *anchor)
 Create an ALIAS event.
int yaml_scalar_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, yaml_char_t *value, int length, int plain_implicit, int quoted_implicit, yaml_scalar_style_t style)
 Create a SCALAR event.
int yaml_sequence_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_sequence_style_t style)
 Create a SEQUENCE-START event.
int yaml_sequence_end_event_initialize (yaml_event_t *event)
 Create a SEQUENCE-END event.
int yaml_mapping_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_mapping_style_t style)
 Create a MAPPING-START event.
int yaml_mapping_end_event_initialize (yaml_event_t *event)
 Create a MAPPING-END event.
void yaml_event_delete (yaml_event_t *event)
 Free any memory allocated for an event object.
int yaml_stream_start_event_initialize (yaml_event_t *event, yaml_encoding_t encoding)
 Create the STREAM-START event. More...
 
int yaml_stream_end_event_initialize (yaml_event_t *event)
 Create the STREAM-END event. More...
 
int yaml_document_start_event_initialize (yaml_event_t *event, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int implicit)
 Create the DOCUMENT-START event. More...
 
int yaml_document_end_event_initialize (yaml_event_t *event, int implicit)
 Create the DOCUMENT-END event. More...
 
int yaml_alias_event_initialize (yaml_event_t *event, yaml_char_t *anchor)
 Create an ALIAS event. More...
 
int yaml_scalar_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, yaml_char_t *value, int length, int plain_implicit, int quoted_implicit, yaml_scalar_style_t style)
 Create a SCALAR event. More...
 
int yaml_sequence_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_sequence_style_t style)
 Create a SEQUENCE-START event. More...
 
int yaml_sequence_end_event_initialize (yaml_event_t *event)
 Create a SEQUENCE-END event. More...
 
int yaml_mapping_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_mapping_style_t style)
 Create a MAPPING-START event. More...
 
int yaml_mapping_end_event_initialize (yaml_event_t *event)
 Create a MAPPING-END event. More...
 
void yaml_event_delete (yaml_event_t *event)
 Free any memory allocated for an event object. More...
 
-

Typedef Documentation

- +

Detailed Description

+

Typedef Documentation

+ +

◆ yaml_event_type_t

+
@@ -127,14 +141,15 @@ Functions
typedef enum yaml_event_type_e yaml_event_type_t
-
-
+

Event types.

- + +

◆ yaml_event_t

+
@@ -142,15 +157,16 @@ Functions
typedef struct yaml_event_s yaml_event_t
-
-
+

The event structure.

-

Enumeration Type Documentation

- +

Enumeration Type Documentation

+ +

◆ yaml_event_type_e

+
@@ -158,57 +174,45 @@ Functions
enum yaml_event_type_e
-
-
+

Event types.

-
Enumerator:
- - - +
-Generated on Wed Mar 26 2014 13:55:01 for yaml by   +Generated by   doxygen - 1.7.6.1 + 1.8.14
-
YAML_NO_EVENT  -

An empty event.

+ + - - - - - - - - - -
Enumerator
YAML_NO_EVENT 

An empty event.

YAML_STREAM_START_EVENT  -

A STREAM-START event.

+
YAML_STREAM_START_EVENT 

A STREAM-START event.

YAML_STREAM_END_EVENT  -

A STREAM-END event.

+
YAML_STREAM_END_EVENT 

A STREAM-END event.

YAML_DOCUMENT_START_EVENT  -

A DOCUMENT-START event.

+
YAML_DOCUMENT_START_EVENT 

A DOCUMENT-START event.

YAML_DOCUMENT_END_EVENT  -

A DOCUMENT-END event.

+
YAML_DOCUMENT_END_EVENT 

A DOCUMENT-END event.

YAML_ALIAS_EVENT  -

An ALIAS event.

+
YAML_ALIAS_EVENT 

An ALIAS event.

YAML_SCALAR_EVENT  -

A SCALAR event.

+
YAML_SCALAR_EVENT 

A SCALAR event.

YAML_SEQUENCE_START_EVENT  -

A SEQUENCE-START event.

+
YAML_SEQUENCE_START_EVENT 

A SEQUENCE-START event.

YAML_SEQUENCE_END_EVENT  -

A SEQUENCE-END event.

+
YAML_SEQUENCE_END_EVENT 

A SEQUENCE-END event.

YAML_MAPPING_START_EVENT  -

A MAPPING-START event.

+
YAML_MAPPING_START_EVENT 

A MAPPING-START event.

YAML_MAPPING_END_EVENT  -

A MAPPING-END event.

+
YAML_MAPPING_END_EVENT 

A MAPPING-END event.

- - -

Function Documentation

- +

Function Documentation

+ +

◆ yaml_stream_start_event_initialize()

+
- + @@ -225,53 +229,55 @@ Functions
int yaml_stream_start_event_initialize int yaml_stream_start_event_initialize ( yaml_event_t *  event,
-
-
+

Create the STREAM-START event.

-
Parameters:
+
Parameters
[out]eventAn empty event object.
[in]encodingThe stream encoding.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_stream_end_event_initialize()

+
- +
int yaml_stream_end_event_initialize int yaml_stream_end_event_initialize ( yaml_event_t *  event)
-
-
+

Create the STREAM-END event.

-
Parameters:
+
Parameters
[out]eventAn empty event object.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_document_start_event_initialize()

+
- + @@ -306,12 +312,11 @@ Functions
int yaml_document_start_event_initialize int yaml_document_start_event_initialize ( yaml_event_t *  event,
-
-
+

Create the DOCUMENT-START event.

The implicit argument is considered as a stylistic parameter and may be ignored by the emitter.

-
Parameters:
+
Parameters
@@ -321,16 +326,18 @@ Functions
[out]eventAn empty event object.
[in]version_directiveThe YAML directive value or NULL.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_document_end_event_initialize()

+
- + @@ -347,28 +354,29 @@ Functions
int yaml_document_end_event_initialize int yaml_document_end_event_initialize ( yaml_event_t *  event,
-
-
+

Create the DOCUMENT-END event.

The implicit argument is considered as a stylistic parameter and may be ignored by the emitter.

-
Parameters:
+
Parameters
[out]eventAn empty event object.
[in]implicitIf the document end indicator is implicit.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_alias_event_initialize()

+
- + @@ -385,27 +393,28 @@ Functions
int yaml_alias_event_initialize int yaml_alias_event_initialize ( yaml_event_t *  event,
-
-
+

Create an ALIAS event.

-
Parameters:
+
Parameters
[out]eventAn empty event object.
[in]anchorThe anchor value.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_scalar_event_initialize()

+
- + @@ -458,13 +467,12 @@ Functions
int yaml_scalar_event_initialize int yaml_scalar_event_initialize ( yaml_event_t *  event,
-
-
+

Create a SCALAR event.

The style argument may be ignored by the emitter.

Either the tag attribute or one of the plain_implicit and quoted_implicit flags must be set.

-
Parameters:
+
Parameters
@@ -477,16 +485,18 @@ Functions
[out]eventAn empty event object.
[in]anchorThe scalar anchor or NULL.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_sequence_start_event_initialize()

+
- + @@ -521,13 +531,12 @@ Functions
int yaml_sequence_start_event_initialize int yaml_sequence_start_event_initialize ( yaml_event_t *  event,
-
-
+

Create a SEQUENCE-START event.

The style argument may be ignored by the emitter.

Either the tag attribute or the implicit flag must be set.

-
Parameters:
+
Parameters
@@ -537,42 +546,45 @@ Functions
[out]eventAn empty event object.
[in]anchorThe sequence anchor or NULL.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_sequence_end_event_initialize()

+
- +
int yaml_sequence_end_event_initialize int yaml_sequence_end_event_initialize ( yaml_event_t *  event)
-
-
+

Create a SEQUENCE-END event.

-
Parameters:
+
Parameters
[out]eventAn empty event object.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_mapping_start_event_initialize()

+
- + @@ -607,13 +619,12 @@ Functions
int yaml_mapping_start_event_initialize int yaml_mapping_start_event_initialize ( yaml_event_t *  event,
-
-
+

Create a MAPPING-START event.

The style argument may be ignored by the emitter.

Either the tag attribute or the implicit flag must be set.

-
Parameters:
+
Parameters
@@ -623,53 +634,55 @@ Functions
[out]eventAn empty event object.
[in]anchorThe mapping anchor or NULL.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_mapping_end_event_initialize()

+
- +
int yaml_mapping_end_event_initialize int yaml_mapping_end_event_initialize ( yaml_event_t *  event)
-
-
+

Create a MAPPING-END event.

-
Parameters:
+
Parameters
[out]eventAn empty event object.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_event_delete()

+
- +
void yaml_event_delete void yaml_event_delete ( yaml_event_t *  event)
-
-
+

Free any memory allocated for an event object.

-
Parameters:
+
Parameters
[in,out]eventAn event object.
@@ -679,13 +692,11 @@ Functions