28.3.2 Object classes representing semantic–version parsers ¶

Objects of class mbfl_semver_parser represent the configuration and state of the parser used to decompose semantic–version specification string–representations into their components.

mbfl_default_object_declare(SEMVER_PARSER)

mbfl_semver_parser_make_default _(SEMVER_PARSER)

mbfl_declare_varref(PLV)
mbfl_declare_varref(AUIBM)

mbfl_semver_parser_parse_leading_v_var                     _(PLV)   _(SEMVER_PARSER)
mbfl_semver_parser_accept_underscore_in_build_metadata_var _(AUIBM) _(SEMVER_PARSER)

"$PLV"          ⇒ optional
"$AUIBM"        ⇒ false

Class: mbfl_semver_parser ¶

Superclass: mbfl_default_object ¶

Metaclass: mbfl_default_class ¶

Class of objects representing parsers for semantic–version specification string-representations.

When the data variable of an object of this class is used as parameter to function: in this documentation that parameter is named SEMVER_PARSER.

Constructor on mbfl_semver_parser_t: mbfl_semver_parser_make_default SEMVER_PARSER ¶

Initialise an already declared object of class mbfl_semver_parser with the default values for the supported options.

The option ‘parse_leading_v’ is set to ‘optional’.

The option ‘accept_underscore_in_build_metadata’ is set to ‘false’.

If SEMVER_PARSER has already been initialised by a previous call to a constructor: the old options profile is deleted.

Predicate on mbfl_semver_parser_t: mbfl_semver_parser_is_a OBJ ¶

Return true if OBJ is the data variable of an object of class mbfl_semver_parser; otherwise return false.

Accessor on mbfl_semver_parser_t: mbfl_semver_parser_parse_leading_v_var _RV SEMVER_PARSER ¶

Mutator on mbfl_semver_parser_t: mbfl_semver_parser_parse_leading_v_set SEMVER_PARSER OPTION_VALUE ¶

Accessor and mutator for the configuration option: accept a leading ‘v’ character in the semantic–version specification to parse. Possible values for OPTION_VALUE are: ‘mandatory’, ‘missing’, ‘optional’. When successful return true; otherwise return false.

Accessor on mbfl_semver_parser_t: mbfl_semver_parser_accept_underscore_in_build_metadata_var _RV SEMVER_PARSER ¶

Mutator on mbfl_semver_parser_t: mbfl_semver_parser_accept_underscore_in_build_metadata_set SEMVER_PARSER OPTION_VALUE ¶

Accessor and mutator for the configuration option: accept underscore characters ‘_’ in the build metadata of the semantic–version specification to parse. Possible values for OPTION_VALUE are: ‘true’, ‘false’. When successful return true; otherwise return false.

Accessor on mbfl_semver_parser_t: mbfl_semver_parser_error_message_var _RV SEMVER_PARSER ¶

Mutator on mbfl_semver_parser_t: mbfl_semver_parser_error_message_set SEMVER_PARSER MESSAGE_STRING ¶

Accessor and mutator for the error message string: if mbfl_semver_parse() returns failure, this value is non–empty. When successful return true; otherwise return false.