:orphan: .. index:: pair: group; convenience macros for option .. _doxid-group__tapi__job__opt__bind__constructors: convenience macros for option ============================= .. toctree:: :hidden: Overview ~~~~~~~~ description :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // macros #define :ref:`TAPI_JOB_OPT_ADDR_PORT_PTR`(_prefix, _concat_prefix, _struct, _field) #define :ref:`TAPI_JOB_OPT_ADDR_PORT_PTR_TYPE` #define :ref:`TAPI_JOB_OPT_ARRAY`(_struct, _lenfield, _arrfield, ...) #define :ref:`TAPI_JOB_OPT_ARRAY_GEN`(func_, prefix_, concat_prefix_, sep_, suffix_, struct_, lenfield_, arrfield_, is_ptr_, ...) #define :ref:`TAPI_JOB_OPT_ARRAY_PTR`(struct_, lenfield_, arrfield_, ...) #define :ref:`TAPI_JOB_OPT_BOOL`(_prefix, _struct, _field) #define :ref:`TAPI_JOB_OPT_BOOL_TYPE` #define :ref:`TAPI_JOB_OPT_CONTENT`(optname_, ...) #define :ref:`TAPI_JOB_OPT_DOUBLE`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_DOUBLE_TYPE` #define :ref:`TAPI_JOB_OPT_DUMMY`(_prefix) #define :ref:`TAPI_JOB_OPT_EMBED_ARRAY`(_prefix, _concat_prefix, _sep, _suffix, _struct, _lenfield, _arrfield, ...) #define :ref:`TAPI_JOB_OPT_EMBED_ARRAY_PTR`(prefix_, concat_prefix_, sep_, suffix_, struct_, lenfield_, arrfield_, ...) #define :ref:`TAPI_JOB_OPT_ENUM`(_prefix, _concat_prefix, _struct, _field, _map) #define :ref:`TAPI_JOB_OPT_ENUM_BOOL`(_prefix, _concat_prefix, _struct, _field, _map) #define :ref:`TAPI_JOB_OPT_ENUM_BOOL3`(_prefix, _concat_prefix, _struct, _field, _map) #define :ref:`TAPI_JOB_OPT_ENUM_UNDEF` #define :ref:`TAPI_JOB_OPT_OFFSETOF_CHK_SIZE`(_struct, _field, _exptype) #define :ref:`TAPI_JOB_OPT_OMIT_UINT` #define :ref:`TAPI_JOB_OPT_QUOTED_STRING`(prefix_, quotation_mark_, struct_, field_) #define :ref:`TAPI_JOB_OPT_QUOTED_STRING_TYPE` #define :ref:`TAPI_JOB_OPT_SOCKADDR_PTR`(_prefix, _concat_prefix, _struct, _field) #define :ref:`TAPI_JOB_OPT_SOCKADDR_PTR_TYPE` #define :ref:`TAPI_JOB_OPT_SOCKADDR_SUBNET`(prefix_, concat_prefix_, struct_, field_) #define :ref:`TAPI_JOB_OPT_SOCKADDR_SUBNET_TYPE` #define :ref:`TAPI_JOB_OPT_SOCKPORT_PTR`(_prefix, _concat_prefix, _struct, _field) #define :ref:`TAPI_JOB_OPT_SOCKPORT_PTR_TYPE` #define :ref:`TAPI_JOB_OPT_STRING`(_prefix, _concat_prefix, _struct, _field) #define :ref:`TAPI_JOB_OPT_STRING_TYPE` #define :ref:`TAPI_JOB_OPT_STRUCT`(_prefix, _concat_prefix, _sep, _suffix, ...) #define :ref:`TAPI_JOB_OPT_UINT`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_UINTMAX_T`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_UINTMAX_T_TYPE` #define :ref:`TAPI_JOB_OPT_UINT_OMITTABLE`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_UINT_OMITTABLE_TYPE` #define :ref:`TAPI_JOB_OPT_UINT_T`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_UINT_TYPE` #define :ref:`TAPI_JOB_OPT_UINT_T_HEX`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_UINT_T_HEX_TYPE` #define :ref:`TAPI_JOB_OPT_UINT_T_OCTAL`(_prefix, _concat_prefix, _suffix, _struct, _field) #define :ref:`TAPI_JOB_OPT_UINT_T_OCTAL_TYPE` #define :ref:`TAPI_JOB_OPT_UINT_T_TYPE` .. _details-group__tapi__job__opt__bind__constructors: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ description Macros ------ .. index:: pair: define; TAPI_JOB_OPT_ADDR_PORT_PTR .. _doxid-group__tapi__job__opt__bind__constructors_1ga33a9c63a3deaffb1439b90cb9d5c1342: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ADDR_PORT_PTR(_prefix, _concat_prefix, _struct, _field) Bind ``struct sockaddr *`` argument (formatted as "address:port"). The argument won't be included in command line if the field is ``NULL``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _struct - Option struct. * - _field - Field name of the address in option struct. .. index:: pair: define; TAPI_JOB_OPT_ADDR_PORT_PTR_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga92ad95c2ecfd73ff30fdd22c17118fac: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ADDR_PORT_PTR_TYPE Value type used in :ref:`TAPI_JOB_OPT_ADDR_PORT_PTR() `. .. index:: pair: define; TAPI_JOB_OPT_ARRAY .. _doxid-group__tapi__job__opt__bind__constructors_1gab55685aede972d6dac2f3f2e68d96115: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ARRAY(_struct, _lenfield, _arrfield, ...) Bind ``:ref:`tapi_job_opt_array ``` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _struct - Option struct. * - _lenfield - Field name of the array length in the option struct (``size_t``). * - _arrfield - Field name of the array data field. It must be the genuine inline array, not a pointer, and it must come after the ``_lenfield`` * - ... - Binding for a element (must be a valid initializer list for :ref:`tapi_job_opt_bind `, e.g as provided by convenience macros; the argument is a vararg because members of the list are treated by the preprocessor as individual macro arguments). The offset of the binding shall be that of ``_arrfield[0]`` (mind the index) for field size checks to work correctly. .. index:: pair: define; TAPI_JOB_OPT_ARRAY_GEN .. _doxid-group__tapi__job__opt__bind__constructors_1ga32e5711ff265cddabfa3b13ab1f4b0bc: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ARRAY_GEN(func_, prefix_, concat_prefix_, sep_, suffix_, struct_, lenfield_, arrfield_, is_ptr_, ...) Generic macro to bind :ref:`tapi_job_opt_array ` argument. This macros shall *never* be used directly. .. rubric:: See also: :ref:`TAPI_JOB_OPT_ARRAY() `, :ref:`TAPI_JOB_OPT_EMBED_ARRAY() `, :ref:`TAPI_JOB_OPT_ARRAY_PTR() `, :ref:`TAPI_JOB_OPT_EMBED_ARRAY_PTR() `, .. index:: pair: define; TAPI_JOB_OPT_ARRAY_PTR .. _doxid-group__tapi__job__opt__bind__constructors_1ga4fc37fbcb5bd530cbef9ece30a47c5ec: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ARRAY_PTR(struct_, lenfield_, arrfield_, ...) Bind :ref:`tapi_job_opt_array ` argument with pointer to array. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - struct\_ - Option struct. * - lenfield\_ - Field name of the array length in the option struct (size_t). * - arrfield\_ - Field name of the pointer to array data field. It must be the pointer to array, and it must come after the ``lenfield_``. * - ... - Binding for a element (must be a valid initializer list for :ref:`tapi_job_opt_bind `, e.g as provided by convenience macros; the argument is a vararg because members of the list are treated by the preprocessor as individual macro arguments). To set the correct offset, use :ref:`TAPI_JOB_OPT_CONTENT() ` wrapper. .. index:: pair: define; TAPI_JOB_OPT_BOOL .. _doxid-group__tapi__job__opt__bind__constructors_1gab5233d11d92d718a904cf9b02b463c53: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_BOOL(_prefix, _struct, _field) Bind ``bool`` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _struct - Option struct. * - _field - Field name of the bool in option struct. .. index:: pair: define; TAPI_JOB_OPT_BOOL_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga45076cac97f32397165810e96b3d559c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_BOOL_TYPE Value type used in :ref:`TAPI_JOB_OPT_BOOL() `. .. index:: pair: define; TAPI_JOB_OPT_CONTENT .. _doxid-group__tapi__job__opt__bind__constructors_1ga00a5c47eea130d9a51b55385ebd8994d: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_CONTENT(optname_, ...) An adaptor for indirect struct fields. Macros for option formatting would not work with indirect non-struct values, since they calculate offset of a field from the start of a struct. This adaptor creates an anonymous structure with a field of a correct type. For example, there is the following structure with a field: .. ref-code-block:: cpp typedef struct binds { size_t argc; const char **argv; } binds; Where ``argv`` is an pointer to an array of strings of ``argc`` length. This field can be processed as follows: .. ref-code-block:: cpp TAPI_JOB_OPT_ARRAY_PTR(binds, argc, argv, TAPI_JOB_OPT_CONTENT(TAPI_JOB_OPT_STRING(NULL, false)) New formatting macros shall define a ``*_TYPE`` macro for this adaptor to work (for example, :ref:`TAPI_JOB_OPT_STRING_TYPE() `). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - optname\_ - Name of the macro. * - ... - Arguments required for the macro. Except for the last two: type and field. .. index:: pair: define; TAPI_JOB_OPT_DOUBLE .. _doxid-group__tapi__job__opt__bind__constructors_1ga25fc5a076a57259c8074643c2dfe698c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_DOUBLE(_prefix, _concat_prefix, _suffix, _struct, _field) Bind ``tapi_job_opt_double_t`` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name in option struct. .. index:: pair: define; TAPI_JOB_OPT_DOUBLE_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1gab076a84b663a51f700d5ffa514abc7d8: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_DOUBLE_TYPE Value type used in :ref:`TAPI_JOB_OPT_DOUBLE() `. .. index:: pair: define; TAPI_JOB_OPT_DUMMY .. _doxid-group__tapi__job__opt__bind__constructors_1gae20f2748769899269a748c8140ab6ca4: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_DUMMY(_prefix) Bind none argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Option name. .. index:: pair: define; TAPI_JOB_OPT_EMBED_ARRAY .. _doxid-group__tapi__job__opt__bind__constructors_1gacbbfd9ef6390a30e3d43a98ceed83f35: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_EMBED_ARRAY(_prefix, _concat_prefix, _sep, _suffix, _struct, _lenfield, _arrfield, ...) Bind ``:ref:`tapi_job_opt_array ``` argument. Unlike :ref:`TAPI_JOB_OPT_ARRAY() `, all array elements will be packed into a single argument, separated by ``_sep``. This combined argument may have a ``_prefix`` and a ``_suffix``, like e.g. :ref:`TAPI_JOB_OPT_UINT() ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate the prefix with an argument if ``true``. * - _sep - Array element separator. * - _suffix - Argument suffix. * - _struct - Option struct. * - _lenfield - Field name of the array length in the option struct (``size_t``). * - _arrfield - Field name of the array data field. It must be the genuine inline array, not a pointer, and it must come after the ``_lenfield``. * - ... - Binding for a element (must be a valid initializer list for :ref:`tapi_job_opt_bind `, e.g as provided by convenience macros; the argument is a vararg because members of the list are treated by the preprocessor as individual macro arguments). The offset of the binding shall be that of ``_arrfield[0]`` (mind the index) for field size checks to work correctly. .. index:: pair: define; TAPI_JOB_OPT_EMBED_ARRAY_PTR .. _doxid-group__tapi__job__opt__bind__constructors_1gac62c02ce0563199db5af3bb7451d75df: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_EMBED_ARRAY_PTR(prefix_, concat_prefix_, sep_, suffix_, struct_, lenfield_, arrfield_, ...) Bind :ref:`tapi_job_opt_array ` argument with pointer to array. Unlike :ref:`TAPI_JOB_OPT_ARRAY_PTR() `, all array elements will be packed into a single argument, separated by ``sep_``. This combined argument may have a ``prefix_`` and a ``suffix_``, like e.g. :ref:`TAPI_JOB_OPT_UINT() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - prefix\_ - Argument prefix. * - concat_prefix\_ - Concatenate the prefix with an argument if ``true``. * - sep\_ - Array element separator. * - suffix\_ - Argument suffix. * - struct\_ - Option struct. * - lenfield\_ - Field name of the array length in the option struct (size_t). * - arrfield\_ - Field name of the pointer to array data field. It must be the pointer to array, and it must come after the ``lenfield_``. * - ... - Binding for a element (must be a valid initializer list for :ref:`tapi_job_opt_bind `, e.g as provided by convenience macros; the argument is a vararg because members of the list are treated by the preprocessor as individual macro arguments). To set the correct offset, use :ref:`TAPI_JOB_OPT_CONTENT() ` wrapper. .. index:: pair: define; TAPI_JOB_OPT_ENUM .. _doxid-group__tapi__job__opt__bind__constructors_1ga3b047b890de22035f40b4fc18bcf8476: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ENUM(_prefix, _concat_prefix, _struct, _field, _map) Bind an enumeration argument using a custom mapping ``_map`` from values to strings. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _struct - Option struct. * - _field - Field name of the enumeration in option struct. The field must have the same size as int. In most (if not all) standard ABIs this means ``enum`` -typed fields may be freely used. There is a compile-check for that constraint. * - _map - Enumeration mapping (:ref:`te_enum_map ` array) .. index:: pair: define; TAPI_JOB_OPT_ENUM_BOOL .. _doxid-group__tapi__job__opt__bind__constructors_1gad2f9d8f0a66c69fdb9534b965bcf6192: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ENUM_BOOL(_prefix, _concat_prefix, _struct, _field, _map) Bind a boolean argument using a custom mapping ``_map`` from values to strings. Constrast with TAPI_JOB_OPT_BOOL which adds or omits the parameterless option depending on the booleanb value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _struct - Option struct. * - _field - Field name of the boolean in option struct. The field must have the same size as int. In most (if not all) standard ABIs this means ``enum`` -typed fields may be freely used. There is a compile-check for that constraint. * - _map - Enumeration mapping (:ref:`te_enum_map ` array). The map shall contain two elements for ``true`` and ``false`` .. index:: pair: define; TAPI_JOB_OPT_ENUM_BOOL3 .. _doxid-group__tapi__job__opt__bind__constructors_1gaca87290354b5eecc5b6502d8469bb0dc: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ENUM_BOOL3(_prefix, _concat_prefix, _struct, _field, _map) Bind a ternary boolean argument using a custom mapping ``_map`` from values to strings. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _struct - Option struct. * - _field - Field name of the boolean in option struct. The field must have the same size as int. In most (if not all) standard ABIs this means ``enum`` -typed fields may be freely used. There is a compile-check for that constraint. * - _map - Enumeration mapping (:ref:`te_enum_map ` array). The map shall contain two elements for ``TE_BOOL3_TRUE`` and ``TE_BOOL3_FALSE``. .. index:: pair: define; TAPI_JOB_OPT_ENUM_UNDEF .. _doxid-group__tapi__job__opt__bind__constructors_1gac8ea45550e21d29749ee620af1f57bee: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_ENUM_UNDEF Undefined value for enum option .. index:: pair: define; TAPI_JOB_OPT_OFFSETOF_CHK_SIZE .. _doxid-group__tapi__job__opt__bind__constructors_1gaa343934a6da5367196ce04754fb88b79: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_OFFSETOF_CHK_SIZE(_struct, _field, _exptype) An auxiliary wrapper that provides an offset of the ``_field`` in the ``_struct`` statically checking that its size is the same as the size of ``_exptype`` .. index:: pair: define; TAPI_JOB_OPT_OMIT_UINT .. _doxid-group__tapi__job__opt__bind__constructors_1ga14a3bbcba7a68d22493a6398ab411653: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_OMIT_UINT The value is used to omit uint argument when it is bound with :ref:`TAPI_JOB_OPT_UINT_OMITTABLE `. .. index:: pair: define; TAPI_JOB_OPT_QUOTED_STRING .. _doxid-group__tapi__job__opt__bind__constructors_1gab314482e8e3a28a1bc862e7bc5484661: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_QUOTED_STRING(prefix_, quotation_mark_, struct_, field_) Bind char \* argument (formatted as ```` string). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - prefix\_ - Argument prefix. * - quotation_mark\_ - Quote symbol. * - struct\_ - Option struct. * - field\_ - Field name of the string in option struct. .. index:: pair: define; TAPI_JOB_OPT_QUOTED_STRING_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1gaf252c91da9e51c5aeeaca8d431d3766b: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_QUOTED_STRING_TYPE Value type used in :ref:`TAPI_JOB_OPT_QUOTED_STRING() `. .. index:: pair: define; TAPI_JOB_OPT_SOCKADDR_PTR .. _doxid-group__tapi__job__opt__bind__constructors_1ga38c77a7dc644b552fc4cd0d48c80578a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_SOCKADDR_PTR(_prefix, _concat_prefix, _struct, _field) Bind ``struct sockaddr *`` argument. The argument won't be included to command line if the field is ``NULL``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true`` * - _struct - Option struct. * - _field - Field name of the string in option struct. .. index:: pair: define; TAPI_JOB_OPT_SOCKADDR_PTR_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga467a640b4e3bead717c2405480727180: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_SOCKADDR_PTR_TYPE Value type used in :ref:`TAPI_JOB_OPT_SOCKADDR_PTR() `. .. index:: pair: define; TAPI_JOB_OPT_SOCKADDR_SUBNET .. _doxid-group__tapi__job__opt__bind__constructors_1gaf932b5921c10237a48ec409eb81c0c40: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_SOCKADDR_SUBNET(prefix_, concat_prefix_, struct_, field_) Bind :ref:`te_sockaddr_subnet ` argument (formatted as ``addr/prefix_len``). The argument won't be included in command line if the field is ``NULL``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - prefix\_ - Argument prefix. * - concat_prefix\_ - Concatenate prefix with argument if ``true``. * - struct\_ - Option struct. * - field\_ - Field name of the subnet in option struct. .. index:: pair: define; TAPI_JOB_OPT_SOCKADDR_SUBNET_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1gac7167e7c70e777772f370b18d228e7f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_SOCKADDR_SUBNET_TYPE Value type used in :ref:`TAPI_JOB_OPT_SOCKADDR_SUBNET() `. .. index:: pair: define; TAPI_JOB_OPT_SOCKPORT_PTR .. _doxid-group__tapi__job__opt__bind__constructors_1ga6fb0b94b06cc137184224342542162f9: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_SOCKPORT_PTR(_prefix, _concat_prefix, _struct, _field) Bind ``struct sockaddr *`` argument (formatted as "port"). The argument won't be included in command line if the field is ``NULL``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _struct - Option struct. * - _field - Field name of the address in option struct. .. index:: pair: define; TAPI_JOB_OPT_SOCKPORT_PTR_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga8b8a5632c9176c9b2add58da198638ed: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_SOCKPORT_PTR_TYPE Value type used in :ref:`TAPI_JOB_OPT_SOCKPORT_PTR() `. .. index:: pair: define; TAPI_JOB_OPT_STRING .. _doxid-group__tapi__job__opt__bind__constructors_1ga7cdc41c5fb9c0018d46c9d26f7a56e5c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_STRING(_prefix, _concat_prefix, _struct, _field) Bind ``char *`` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true`` * - _struct - Option struct. * - _field - Field name of the string in option struct. .. index:: pair: define; TAPI_JOB_OPT_STRING_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga3098b3a04b7f2fe304b655d0f716dd0c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_STRING_TYPE Value type used in :ref:`TAPI_JOB_OPT_STRING() `. .. index:: pair: define; TAPI_JOB_OPT_STRUCT .. _doxid-group__tapi__job__opt__bind__constructors_1ga3156c98fd06de285235796441731f814: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_STRUCT(_prefix, _concat_prefix, _sep, _suffix, ...) Bind ``:ref:`tapi_job_opt_struct ``` argument. Unlike :ref:`TAPI_JOB_OPT_ARRAY() ` and :ref:`TAPI_JOB_OPT_EMBED_ARRAY() `, it allows to create structures with different types of variables and output them using a separator ``_sep``. This combined argument may have a ``_prefix`` and a ``_suffix``, like e.g. :ref:`TAPI_JOB_OPT_UINT() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate the prefix with an argument if ``true``. * - _sep - Array element separator. * - _suffix - Argument suffix. * - ... - Bindings for elements (must be a valid initializer list for :ref:`tapi_job_opt_bind `, e.g as provided by convenience macros; the argument is a vararg because members of the list are treated by the preprocessor as individual macro arguments). .. index:: pair: define; TAPI_JOB_OPT_UINT .. _doxid-group__tapi__job__opt__bind__constructors_1ga58a618ba06a360d01a22a217f124fe36: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT(_prefix, _concat_prefix, _suffix, _struct, _field) Bind ``unsigned int`` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true`` * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name of the uint in option struct. .. index:: pair: define; TAPI_JOB_OPT_UINTMAX_T .. _doxid-group__tapi__job__opt__bind__constructors_1ga642d418ff4fc4cba24fba38977e6f85c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINTMAX_T(_prefix, _concat_prefix, _suffix, _struct, _field) Bind ``tapi_job_opt_uintmax_t`` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name in option struct. .. index:: pair: define; TAPI_JOB_OPT_UINTMAX_T_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1gab82606d8085f65bc56348ac8ecc5e143: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINTMAX_T_TYPE Value type used in :ref:`TAPI_JOB_OPT_UINTMAX_T() `. .. index:: pair: define; TAPI_JOB_OPT_UINT_OMITTABLE .. _doxid-group__tapi__job__opt__bind__constructors_1ga912789de77684a6da3ba3a14f6f592a7: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_OMITTABLE(_prefix, _concat_prefix, _suffix, _struct, _field) Similar to :ref:`TAPI_JOB_OPT_UINT `, but the argument will not be included in command line options if argument's value is equal to :ref:`TAPI_JOB_OPT_OMIT_UINT `. This implies that the real argument's value cannot be equal to the value of :ref:`TAPI_JOB_OPT_OMIT_UINT `. This macro is deprecated, use tapi_job_uint_t with :ref:`TAPI_JOB_OPT_UINT_T() ` instead. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true`` * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name of the uint in option struct. .. index:: pair: define; TAPI_JOB_OPT_UINT_OMITTABLE_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1gae3c705c60f2d57945ca52f2a61a5627a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_OMITTABLE_TYPE Value type used in :ref:`TAPI_JOB_OPT_UINT_OMITTABLE() `. .. index:: pair: define; TAPI_JOB_OPT_UINT_T .. _doxid-group__tapi__job__opt__bind__constructors_1ga7fe191e62e131d8fcbc58b2365d3d82f: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_T(_prefix, _concat_prefix, _suffix, _struct, _field) Bind ``tapi_job_opt_uint_t`` argument. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name in option struct. .. index:: pair: define; TAPI_JOB_OPT_UINT_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga5b7daa6b7b4898b587357c889fdbd8e1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_TYPE Value type used in :ref:`TAPI_JOB_OPT_UINT() `. .. index:: pair: define; TAPI_JOB_OPT_UINT_T_HEX .. _doxid-group__tapi__job__opt__bind__constructors_1ga556e982b3e3e66c17f44aac69df7f3bb: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_T_HEX(_prefix, _concat_prefix, _suffix, _struct, _field) Bind ``tapi_job_opt_uint_t`` argument, specifying it in hexadecimal format in command line. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name in option struct. .. index:: pair: define; TAPI_JOB_OPT_UINT_T_HEX_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga36dfff4e344f6181b8b6a1d03f46ce1a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_T_HEX_TYPE Value type used in :ref:`TAPI_JOB_OPT_UINT_T_HEX() `. .. index:: pair: define; TAPI_JOB_OPT_UINT_T_OCTAL .. _doxid-group__tapi__job__opt__bind__constructors_1ga83573dccccbef6743b6267b2dcc85aea: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_T_OCTAL(_prefix, _concat_prefix, _suffix, _struct, _field) Bind ``tapi_job_opt_uint_t`` argument, specifying it in octal format in command line. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _prefix - Argument prefix. * - _concat_prefix - Concatenate prefix with argument if ``true``. * - _suffix - Argument suffix. * - _struct - Option struct. * - _field - Field name in option struct. .. index:: pair: define; TAPI_JOB_OPT_UINT_T_OCTAL_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga173c5dd2982ca88e37e4d53aff704213: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_T_OCTAL_TYPE Value type used in :ref:`TAPI_JOB_OPT_UINT_T_OCTAL() `. .. index:: pair: define; TAPI_JOB_OPT_UINT_T_TYPE .. _doxid-group__tapi__job__opt__bind__constructors_1ga6f064f905782c954d29813d91e634750: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_JOB_OPT_UINT_T_TYPE Value type used in :ref:`TAPI_JOB_OPT_UINT_T() `.