Lines Matching +full:document +full:- +full:file
2 * @file yaml.h
5 * Include the header file with the code:
79 /** The character type (UTF-8 octet). */
102 /** The default UTF-8 encoding. */
104 /** The UTF-16-LE encoding with BOM. */
106 /** The UTF-16-BE encoding with BOM. */
137 /** Cannot compose a YAML document. */
173 /** The single-quoted scalar style. */
175 /** The double-quoted scalar style. */
219 /** A STREAM-START token. */
221 /** A STREAM-END token. */
224 /** A VERSION-DIRECTIVE token. */
226 /** A TAG-DIRECTIVE token. */
228 /** A DOCUMENT-START token. */
230 /** A DOCUMENT-END token. */
233 /** A BLOCK-SEQUENCE-START token. */
235 /** A BLOCK-MAPPING-START token. */
237 /** A BLOCK-END token. */
240 /** A FLOW-SEQUENCE-START token. */
242 /** A FLOW-SEQUENCE-END token. */
244 /** A FLOW-MAPPING-START token. */
246 /** A FLOW-MAPPING-END token. */
249 /** A BLOCK-ENTRY token. */
251 /** A FLOW-ENTRY token. */
359 /** A STREAM-START event. */
361 /** A STREAM-END event. */
364 /** A DOCUMENT-START event. */
366 /** A DOCUMENT-END event. */
374 /** A SEQUENCE-START event. */
376 /** A SEQUENCE-END event. */
379 /** A MAPPING-START event. */
381 /** A MAPPING-END event. */
396 /** The document encoding. */
400 /** The document parameters (for @c YAML_DOCUMENT_START_EVENT). */
413 /** Is the document indicator implicit? */
417 /** The document end parameters (for @c YAML_DOCUMENT_END_EVENT). */
419 /** Is the document end indicator implicit? */
441 /** Is the tag optional for any non-plain style? */
481 * Create the STREAM-START event.
494 * Create the STREAM-END event.
505 * Create the DOCUMENT-START event.
517 * @param[in] implicit If the document start indicator is
531 * Create the DOCUMENT-END event.
537 * @param[in] implicit If the document end indicator is implicit.
573 * non-plain style.
587 * Create a SEQUENCE-START event.
608 * Create a SEQUENCE-END event.
619 * Create a MAPPING-START event.
640 * Create a MAPPING-END event.
704 /** The forward definition of a document node structure. */
779 /** The document structure. */
782 /** The document nodes. */
803 /** Is the document start indicator implicit? */
805 /** Is the document end indicator implicit? */
808 /** The beginning of the document. */
810 /** The end of the document. */
816 * Create a YAML document.
818 * @param[out] document An empty document object.
825 * @param[in] start_implicit If the document start indicator is
827 * @param[in] end_implicit If the document end indicator is
834 yaml_document_initialize(yaml_document_t *document,
841 * Delete a YAML document and all its nodes.
843 * @param[in,out] document A document object.
847 yaml_document_delete(yaml_document_t *document);
850 * Get a node of a YAML document.
855 * @param[in] document A document object.
862 yaml_document_get_node(yaml_document_t *document, int index);
865 * Get the root of a YAML document node.
867 * The root object is the first object added to the document.
872 * An empty document produced by the parser signifies the end of a YAML
875 * @param[in] document A document object.
877 * @returns the node object or @c NULL if the document is empty.
881 yaml_document_get_root_node(yaml_document_t *document);
884 * Create a SCALAR node and attach it to the document.
888 * @param[in,out] document A document object.
898 yaml_document_add_scalar(yaml_document_t *document,
903 * Create a SEQUENCE node and attach it to the document.
907 * @param[in,out] document A document object.
915 yaml_document_add_sequence(yaml_document_t *document,
919 * Create a MAPPING node and attach it to the document.
923 * @param[in,out] document A document object.
931 yaml_document_add_mapping(yaml_document_t *document,
937 * @param[in,out] document A document object.
945 yaml_document_append_sequence_item(yaml_document_t *document,
951 * @param[in,out] document A document object.
960 yaml_document_append_mapping_pair(yaml_document_t *document,
1013 /** Expect STREAM-START. */
1015 /** Expect the beginning of an implicit document. */
1017 /** Expect DOCUMENT-START. */
1019 /** Expect the content of a document. */
1021 /** Expect DOCUMENT-END. */
1100 /** The problematic value (@c -1 is none). */
1124 /** Standard (string or file) input data. */
1136 /** File input data. */
1137 FILE *file; member
1302 /** The currently parsed document. */
1303 yaml_document_t *document; member
1351 * Set a file input.
1353 * @a file should be a file object open for reading. The application is
1354 * responsible for closing the @a file.
1357 * @param[in] file An open file.
1361 yaml_parser_set_input_file(yaml_parser_t *parser, FILE *file);
1435 * Parse the input stream and produce the next YAML document.
1440 * If the produced document has no root node, it means that the document
1444 * produced document object using the yaml_document_delete() function.
1451 * @param[out] document An empty document object.
1457 yaml_parser_load(yaml_parser_t *parser, yaml_document_t *document);
1486 /** Expect STREAM-START. */
1488 /** Expect the first DOCUMENT-START or STREAM-END. */
1490 /** Expect DOCUMENT-START or STREAM-END. */
1492 /** Expect the content of a document. */
1494 /** Expect DOCUMENT-END. */
1573 /** Standard (string or file) output data. */
1585 /** File output data. */
1586 FILE *file; member
1631 /** Allow unescaped non-ASCII characters? */
1687 /** Is it the document root context? */
1702 /** If the last character was an indentation character (' ', '-', '?', ':')? */
1704 /** If an explicit document end is required? */
1763 /** The information associated with the document nodes. */
1769 /** The currently emitted document. */
1770 yaml_document_t *document; member
1821 * Set a file output.
1823 * @a file should be a file object open for writing. The application is
1824 * responsible for closing the @a file.
1827 * @param[in] file An open file.
1831 yaml_emitter_set_output_file(yaml_emitter_t *emitter, FILE *file);
1878 * Set the preferred line width. @c -1 means unlimited.
1888 * Set if unescaped non-ASCII characters are allowed.
1951 * Emit a YAML document.
1955 * responsibility for the document object and destroys its content after
1956 * it is emitted. The document object is destroyed even if the function fails.
1959 * @param[in,out] document A document object.
1965 yaml_emitter_dump(yaml_emitter_t *emitter, yaml_document_t *document);