:orphan: .. index:: pair: group; Integral sets .. _doxid-group__te__tools__te__intset: Integral sets ============= .. toctree:: :hidden: struct_te_charset.rst struct_te_intset_ops.rst Overview ~~~~~~~~ Generic functions to operate on integral sets. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`te_intset_ops` :ref:`te_intset_ops`; typedef struct :ref:`te_charset` :ref:`te_charset`; // structs struct :ref:`te_charset`; struct :ref:`te_intset_ops`; // global variables const :ref:`te_intset_ops` :ref:`te_bits_intset`; const :ref:`te_intset_ops` :ref:`te_charset_intset`; const :ref:`te_intset_ops` :ref:`te_fdset_intset`; // global functions :ref:`te_errno` :ref:`te_intset_generic_parse`(const :ref:`te_intset_ops`* ops, int minval, int maxval, const char* str, void* val); char* :ref:`te_intset_generic2string`(const :ref:`te_intset_ops`* ops, int minval, int maxval, const void* val); bool :ref:`te_intset_generic_is_subset`(const :ref:`te_intset_ops`* ops, int minval, int maxval, const void* subset, const void* superset); void :ref:`te_intset_generic_add_range`(const :ref:`te_intset_ops`* ops, void* val, int first, int last); void :ref:`te_intset_generic_remove_range`(const :ref:`te_intset_ops`* ops, void* val, int first, int last); static :ref:`te_errno` :ref:`te_bits_parse`(const char* str, uint64_t* val); static char* :ref:`te_bits2string`(uint64_t val); static void :ref:`te_charset_clear`(:ref:`te_charset`* cset); static void :ref:`te_charset_add_range`(:ref:`te_charset`* cset, uint8_t minbyte, uint8_t maxbyte); static void :ref:`te_charset_remove_range`(:ref:`te_charset`* cset, uint8_t minbyte, uint8_t maxbyte); static bool :ref:`te_charset_check`(const :ref:`te_charset`* cset, uint8_t byte); void :ref:`te_charset_add_from_string`(:ref:`te_charset`* cset, const char* str); void :ref:`te_charset_get_bytes`(const :ref:`te_charset`* cset, uint8_t buf[static UINT8_MAX+1]); bool :ref:`te_charset_check_bytes`(const :ref:`te_charset`* cset, size_t len, const uint8_t* bytes); static :ref:`te_errno` :ref:`te_fdset_parse`(const char* str, fd_set* fdset); static char* :ref:`te_fdset2string`(int nfds, const fd_set* fdset); static bool :ref:`te_fdset_is_subset`(int nfds, const fd_set* sub, const fd_set* super); // macros #define :ref:`TE_CHARSET_INIT` .. _details-group__te__tools__te__intset: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Generic functions to operate on integral sets. The functions in this module use dynamic dispatching, so they may not be suitable for use in really performance-critical cases. Typedefs -------- .. index:: pair: typedef; te_intset_ops .. _doxid-group__te__tools__te__intset_1ga11fab2e60049a96e32c8ad877b97c35f: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_intset_ops` te_intset_ops A description of a specific intset type. .. index:: pair: typedef; te_charset .. _doxid-group__te__tools__te__intset_1ga4a2667c06b395ba95b30ee248a328fb1: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_charset` te_charset Character set or class. Global Variables ---------------- .. index:: pair: variable; te_bits_intset .. _doxid-group__te__tools__te__intset_1gabad7b5cdbcacb8aa846900d6bfbadafe: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`te_intset_ops` te_bits_intset A description of 64-bit integer as a bit set .. index:: pair: variable; te_charset_intset .. _doxid-group__te__tools__te__intset_1ga02bf2dc7fe81c88666fa052141f7fda9: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`te_intset_ops` te_charset_intset Description of a :ref:`te_charset ` as an intset. .. index:: pair: variable; te_fdset_intset .. _doxid-group__te__tools__te__intset_1gab5b8d50b06b1a73dab224c3d5b73b3fc: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`te_intset_ops` te_fdset_intset Description of POSIX fd_set as an integral set. Global Functions ---------------- .. index:: pair: function; te_intset_generic_parse .. _doxid-group__te__tools__te__intset_1ga1972869d6add1ef5e18bf193e6971c37: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_intset_generic_parse(const :ref:`te_intset_ops`* ops, int minval, int maxval, const char* str, void* val) Convert a string to an integral set. The string ``str`` is a comma-separated list of single numbers and ranges, e.g. ``1``,2-10,100. The set ``val`` will be cleared before parsing. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ops - intset type description * - minval - minimum possible value in a set * - maxval - maximum possible value in a set * - str - string to parse * - val - target value .. rubric:: Returns: status code .. index:: pair: function; te_intset_generic2string .. _doxid-group__te__tools__te__intset_1ga525f434c8951f326d3dcd439989339ad: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* te_intset_generic2string(const :ref:`te_intset_ops`* ops, int minval, int maxval, const void* val) Convert an integral set to a string. The resulting string may be passed to :ref:`te_intset_generic_parse() ` yielding the original set. Sequences of consecutive numbers are represented as ranges ``N-M``. ``maxval`` should be less than ``INT_MAX`` and in general the function is not very efficient if ``maxval`` is too high. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ops - intset type description * - minval - minimum possible value in a set * - maxval - maximum possible value in a set * - val - intset .. rubric:: Returns: a string representation or ``NULL`` in case of an error (it should be free()'d) .. index:: pair: function; te_intset_generic_is_subset .. _doxid-group__te__tools__te__intset_1gafcd891095135c092980dd4abdaa5472d: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool te_intset_generic_is_subset(const :ref:`te_intset_ops`* ops, int minval, int maxval, const void* subset, const void* superset) Tests whether ``subset`` is really a subset of ``superset``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ops - intset type description * - minval - minimum possible value in a set * - maxval - maximum possible value in a set * - subset - a subset to test * - superset - its superset .. rubric:: Returns: ``true`` iff ``subset`` is a subset of ``superset`` .. index:: pair: function; te_intset_generic_add_range .. _doxid-group__te__tools__te__intset_1gaf2fd4704edebb8002deaa9a067515ba1: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_intset_generic_add_range(const :ref:`te_intset_ops`* ops, void* val, int first, int last) Add a contiguous range of integers to the set ``val``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ops - intset type description * - val - intset * - first - start of the range * - last - end of the range .. index:: pair: function; te_intset_generic_remove_range .. _doxid-group__te__tools__te__intset_1gaf328d8b38c11612b1047ac5900caeddf: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_intset_generic_remove_range(const :ref:`te_intset_ops`* ops, void* val, int first, int last) Remove a contiguous range of integers from the set ``val``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ops - intset type description * - val - intset * - first - start of the range * - last - end of the range .. index:: pair: function; te_bits_parse .. _doxid-group__te__tools__te__intset_1ga655a0820302beb652b939806d9af7f40: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` te_bits_parse(const char* str, uint64_t* val) Convert a string to a 64-bit integer treated as a bit set. The string ``str`` is a comma-separated list of single numbers and ranges, e.g. ``1``,2-10,63. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - input string * - val - resulting value .. rubric:: Returns: status code .. rubric:: See also: :ref:`te_intset_generic_parse ` .. index:: pair: function; te_bits2string .. _doxid-group__te__tools__te__intset_1gad312845086564d56401712800ffcb94e: .. ref-code-block:: cpp :class: doxyrest-title-code-block static char* te_bits2string(uint64_t val) Convert a 64-bit integer treated as a bit set to a string. Sequences of consecutive bits are represented as ranges ``N-M``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - val - input integer .. rubric:: Returns: a string representation or ``NULL`` in case of an error (it should be free()'d) .. rubric:: See also: :ref:`te_intset_generic2string ` .. index:: pair: function; te_charset_clear .. _doxid-group__te__tools__te__intset_1ga2f70ca3de98ec685ab804d6f4cb9359f: .. ref-code-block:: cpp :class: doxyrest-title-code-block static void te_charset_clear(:ref:`te_charset`* cset) Clear the character set ``cset``. .. index:: pair: function; te_charset_add_range .. _doxid-group__te__tools__te__intset_1ga8eebd16ab8dc6b2bb04a4045d8a2a5e5: .. ref-code-block:: cpp :class: doxyrest-title-code-block static void te_charset_add_range(:ref:`te_charset`* cset, uint8_t minbyte, uint8_t maxbyte) Add a contiguous range of characters to a charset. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cset - character set * - minbyte - starting character * - maxbyte - end character .. index:: pair: function; te_charset_remove_range .. _doxid-group__te__tools__te__intset_1gaf2fb95dd346ea7e008b0e3ccaa6abc54: .. ref-code-block:: cpp :class: doxyrest-title-code-block static void te_charset_remove_range(:ref:`te_charset`* cset, uint8_t minbyte, uint8_t maxbyte) Remove a contiguous range of characters from a charset. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cset - character set * - minbyte - starting character * - maxbyte - end character .. index:: pair: function; te_charset_check .. _doxid-group__te__tools__te__intset_1ga0a8aeb65396a6fc3b3f1a697f6bc0ddc: .. ref-code-block:: cpp :class: doxyrest-title-code-block static bool te_charset_check(const :ref:`te_charset`* cset, uint8_t byte) Check whether a ``byte`` is in a charset ``cset``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cset - character set * - byte - a byte to check .. rubric:: Returns: ``true`` iff ``byte`` is in ``cset`` .. index:: pair: function; te_charset_add_from_string .. _doxid-group__te__tools__te__intset_1ga2df43b982a23ba5d0ad3ddb85769afcf: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_charset_add_from_string(:ref:`te_charset`* cset, const char* str) Add all characters from ``str`` to a charset ``cset``. The terminating zero character is *not* added. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cset - character set * - str - characters to add .. index:: pair: function; te_charset_get_bytes .. _doxid-group__te__tools__te__intset_1gae80499351ef057eb153f7117c59c99d3: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_charset_get_bytes(const :ref:`te_charset`* cset, uint8_t buf[static UINT8_MAX+1]) Get all bytes set in ``cset`` as a contiguous array. The number of stores bytes is equal to :ref:`te_charset::n_items `. Essentially, it is an inverse of :ref:`te_charset_add_from_string() `, however, it does *not* produce a zero-terminated string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cset - character set * - buf - buffer for resulting bytes (should be at least 256 bytes long) .. index:: pair: function; te_charset_check_bytes .. _doxid-group__te__tools__te__intset_1gaaef64d44045c2528705e0eef2e269e0a: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool te_charset_check_bytes(const :ref:`te_charset`* cset, size_t len, const uint8_t* bytes) Check that all ``bytes`` belong to a charset ``cset``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cset - character set * - len - length of ``bytes`` * - bytes - data to check .. rubric:: Returns: ``true`` if all ``bytes`` are in ``cset``. .. index:: pair: function; te_fdset_parse .. _doxid-group__te__tools__te__intset_1ga9e8e9080bb9980570559a1ae94d89708: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` te_fdset_parse(const char* str, fd_set* fdset) Convert a string to a fd_set. The string ``str`` is a comma-separated list of single numbers and ranges, e.g. ``1``,2-10,511. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - string to parse * - fdset - resulting FD set .. rubric:: Returns: status code .. rubric:: See also: :ref:`te_intset_generic_parse ` .. index:: pair: function; te_fdset2string .. _doxid-group__te__tools__te__intset_1ga7b7279f10b57290011e49b2071a32adf: .. ref-code-block:: cpp :class: doxyrest-title-code-block static char* te_fdset2string(int nfds, const fd_set* fdset) Convert an FD set to a string. Sequences of consecutive FD numbers are represented as ranges ``N-M``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - nfds - highest FD number in ``fdset`` plus 1 (the same as with POSIX select()) * - fdset - FD set .. rubric:: Returns: a string representation or ``NULL`` in case of an error. (it should be free()'d) .. rubric:: See also: :ref:`te_intset_generic2string ` .. index:: pair: function; te_fdset_is_subset .. _doxid-group__te__tools__te__intset_1ga6f506c311758ebae7ac7f32e13060de9: .. ref-code-block:: cpp :class: doxyrest-title-code-block static bool te_fdset_is_subset(int nfds, const fd_set* sub, const fd_set* super) Check whether a FD set ``sub`` is a subset of ``super``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - nfds - highest FD number in ``fdset`` plus 1 (the same as with POSIX select()) * - sub - FD set to test * - super - FD superset .. rubric:: Returns: ``true`` iff ``sub`` is a subset of ``super`` Macros ------ .. index:: pair: define; TE_CHARSET_INIT .. _doxid-group__te__tools__te__intset_1ga0a2d10ea5d93ed074d46b4e7e55889ed: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TE_CHARSET_INIT Static initialiser for :ref:`te_charset `.