:orphan:

.. index:: pair: enum; tapi_file_chunk_spec_kind
.. _doxid-group__ts__tapi__file_1gac24bd8170a98eceaaefac1a31217eb05:

enum tapi_file_chunk_spec_kind
==============================

Overview
~~~~~~~~

The kind of a chunk in :ref:`tapi_file_chunk_spec <doxid-structtapi__file__chunk__spec>`. :ref:`More...<details-group__ts__tapi__file_1gac24bd8170a98eceaaefac1a31217eb05>`

.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_file.h>

	enum tapi_file_chunk_spec_kind {
	    :ref:`TAPI_FILE_CHUNK_SPEC_KIND_END<doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05acdd23903e459bda68217144ee462dc54>`,
	    :ref:`TAPI_FILE_CHUNK_SPEC_KIND_LITERAL<doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05abcf04b780ee87cb732e77d036942a6e9>`,
	    :ref:`TAPI_FILE_CHUNK_SPEC_KIND_PATTERN<doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05ab0fc6c5ae6c5f6841bc1d07ffdb97148>`,
	    :ref:`TAPI_FILE_CHUNK_SPEC_KIND_COMPOUND<doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05ac29e8e5fe86768b7cde3aa990a02f7d1>`,
	};

.. _details-group__ts__tapi__file_1gac24bd8170a98eceaaefac1a31217eb05:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

The kind of a chunk in :ref:`tapi_file_chunk_spec <doxid-structtapi__file__chunk__spec>`.

Enum Values
-----------

.. index:: pair: enumvalue; TAPI_FILE_CHUNK_SPEC_KIND_END
.. _doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05acdd23903e459bda68217144ee462dc54:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	TAPI_FILE_CHUNK_SPEC_KIND_END

The last chunk in the list.

.. index:: pair: enumvalue; TAPI_FILE_CHUNK_SPEC_KIND_LITERAL
.. _doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05abcf04b780ee87cb732e77d036942a6e9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	TAPI_FILE_CHUNK_SPEC_KIND_LITERAL

The literal chunk: *spec* is treated as a literal sequence of characters.

If *maxlen* is not zero, it is treated as the size of the string, otherwise *spec* must be zero-terminated.

*minlen* may be used to specify the length of the chunk (see ``fitlen`` of :ref:`te_file_write_string() <doxid-group__te__tools__te__file_1ga4ac6b6c3cfb36612372dd5f5efd2c201>` for the exact semantics).

.. index:: pair: enumvalue; TAPI_FILE_CHUNK_SPEC_KIND_PATTERN
.. _doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05ab0fc6c5ae6c5f6841bc1d07ffdb97148:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	TAPI_FILE_CHUNK_SPEC_KIND_PATTERN

The simple pattern chunk: *spec* is treated as a block pattern as in :ref:`te_compile_buf_pattern() <doxid-group__te__tools__te__bufs_1gaa4275bb7d02946345ae3921d8724319d>`.

*minlen* and *maxlen* are used to determine the length of the generated block as in :ref:`te_make_spec_buf() <doxid-group__te__tools__te__bufs_1gad199bfbfaf12fa053438ee921b465b72>`.

.. index:: pair: enumvalue; TAPI_FILE_CHUNK_SPEC_KIND_COMPOUND
.. _doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05ac29e8e5fe86768b7cde3aa990a02f7d1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	TAPI_FILE_CHUNK_SPEC_KIND_COMPOUND

The compound chunk: *nested* is a list of sub-chunks terminated by a :ref:`TAPI_FILE_CHUNK_SPEC_KIND_END <doxid-group__ts__tapi__file_1ggac24bd8170a98eceaaefac1a31217eb05acdd23903e459bda68217144ee462dc54>`.

*minlen* and *maxlen* are used to determine the number of times the list of sub-chunks is reused.