yaml  0.2.5
Data Structures | Typedefs | Enumerations | Functions
Events

Data Structures

struct  yaml_event_s
 The event structure. More...
 

Typedefs

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 {
  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...
 

Functions

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, const yaml_char_t *anchor)
 Create an ALIAS event. More...
 
int yaml_scalar_event_initialize (yaml_event_t *event, const yaml_char_t *anchor, const yaml_char_t *tag, const 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, const yaml_char_t *anchor, const 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, const yaml_char_t *anchor, const 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...
 

Detailed Description

Typedef Documentation

◆ yaml_event_type_t

typedef enum yaml_event_type_e yaml_event_type_t

Event types.

◆ yaml_event_t

typedef struct yaml_event_s yaml_event_t

The event structure.

Enumeration Type Documentation

◆ yaml_event_type_e

enum yaml_event_type_e

Event types.

Enumerator
YAML_NO_EVENT 

An empty event.

YAML_STREAM_START_EVENT 

A STREAM-START event.

YAML_STREAM_END_EVENT 

A STREAM-END event.

YAML_DOCUMENT_START_EVENT 

A DOCUMENT-START event.

YAML_DOCUMENT_END_EVENT 

A DOCUMENT-END event.

YAML_ALIAS_EVENT 

An ALIAS event.

YAML_SCALAR_EVENT 

A SCALAR event.

YAML_SEQUENCE_START_EVENT 

A SEQUENCE-START event.

YAML_SEQUENCE_END_EVENT 

A SEQUENCE-END event.

YAML_MAPPING_START_EVENT 

A MAPPING-START event.

YAML_MAPPING_END_EVENT 

A MAPPING-END event.

Function Documentation

◆ yaml_stream_start_event_initialize()

int yaml_stream_start_event_initialize ( yaml_event_t *  event,
yaml_encoding_t  encoding 
)

Create the STREAM-START event.

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

◆ yaml_stream_end_event_initialize()

int yaml_stream_end_event_initialize ( yaml_event_t *  event)

Create the STREAM-END event.

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

◆ yaml_document_start_event_initialize()

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.

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

Parameters
[out]eventAn empty event object.
[in]version_directiveThe YAML directive value or NULL.
[in]tag_directives_startThe beginning of the TAG directives list.
[in]tag_directives_endThe end of the TAG directives list.
[in]implicitIf the document start indicator is implicit.
Returns
1 if the function succeeded, 0 on error.

◆ yaml_document_end_event_initialize()

int yaml_document_end_event_initialize ( yaml_event_t *  event,
int  implicit 
)

Create the DOCUMENT-END event.

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

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

◆ yaml_alias_event_initialize()

int yaml_alias_event_initialize ( yaml_event_t *  event,
const yaml_char_t *  anchor 
)

Create an ALIAS event.

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

◆ yaml_scalar_event_initialize()

int yaml_scalar_event_initialize ( yaml_event_t *  event,
const yaml_char_t *  anchor,
const yaml_char_t *  tag,
const yaml_char_t *  value,
int  length,
int  plain_implicit,
int  quoted_implicit,
yaml_scalar_style_t  style 
)

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
[out]eventAn empty event object.
[in]anchorThe scalar anchor or NULL.
[in]tagThe scalar tag or NULL.
[in]valueThe scalar value.
[in]lengthThe length of the scalar value.
[in]plain_implicitIf the tag may be omitted for the plain style.
[in]quoted_implicitIf the tag may be omitted for any non-plain style.
[in]styleThe scalar style.
Returns
1 if the function succeeded, 0 on error.

◆ yaml_sequence_start_event_initialize()

int yaml_sequence_start_event_initialize ( yaml_event_t *  event,
const yaml_char_t *  anchor,
const yaml_char_t *  tag,
int  implicit,
yaml_sequence_style_t  style 
)

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
[out]eventAn empty event object.
[in]anchorThe sequence anchor or NULL.
[in]tagThe sequence tag or NULL.
[in]implicitIf the tag may be omitted.
[in]styleThe sequence style.
Returns
1 if the function succeeded, 0 on error.

◆ yaml_sequence_end_event_initialize()

int yaml_sequence_end_event_initialize ( yaml_event_t *  event)

Create a SEQUENCE-END event.

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

◆ yaml_mapping_start_event_initialize()

int yaml_mapping_start_event_initialize ( yaml_event_t *  event,
const yaml_char_t *  anchor,
const yaml_char_t *  tag,
int  implicit,
yaml_mapping_style_t  style 
)

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
[out]eventAn empty event object.
[in]anchorThe mapping anchor or NULL.
[in]tagThe mapping tag or NULL.
[in]implicitIf the tag may be omitted.
[in]styleThe mapping style.
Returns
1 if the function succeeded, 0 on error.

◆ yaml_mapping_end_event_initialize()

int yaml_mapping_end_event_initialize ( yaml_event_t *  event)

Create a MAPPING-END event.

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

◆ yaml_event_delete()

void yaml_event_delete ( yaml_event_t *  event)

Free any memory allocated for an event object.

Parameters
[in,out]eventAn event object.
Generated by   doxygen 1.8.14