xo-umbrella2/xo-tokenizer/docs/tokenizer-class.rst
Roland Conybeare 1f981a0636 git subrepo clone (merge) git@github.com:Rconybea/xo-tokenizer.git xo-tokenizer
subrepo:
  subdir:   "xo-tokenizer"
  merged:   "6e665ed7"
upstream:
  origin:   "git@github.com:Rconybea/xo-tokenizer.git"
  branch:   "main"
  commit:   "6e665ed7"
git-subrepo:
  version:  "0.4.9"
  origin:   "???"
  commit:   "???"
2026-06-06 22:25:50 -04:00

68 lines
1.4 KiB
ReStructuredText

.. _tokenizer-class:
Tokenizer
=========
Parse a Schematika character stream into lexical tokens
Context
-------
.. ditaa::
:--scale: 0.85
+-----------------------------------------+----------+
|cBLU tokenizer | |
+-----------------------------------------+ |
| scan_result | |
+-----------------+-----------------------+ |
| | tokenizer_error | buffer |
| token +-----------------------+ |
| | input_state | |
+-----------------+-----------------------+ |
| tokentype | span | |
+-----------------+-----------------------+----------+
.. code-block:: cpp
#include <xo/tokenizer/tokenizer.hpp>
.. uml::
:scale: 99%
:align: center
allowmixing
object tkz1<<tokenizer>>
tkz1 : input_state = ins1
object ins1<<input_state>>
ins1 : current_line = (9 * 8)
tkz1 o-- ins1
- Assemble a stream of lexical tokens from a text stream.
- Lexical errors reported via scan_result instance;
errors reported with detailed context
Class
-----
.. doxygenclass:: xo::scm::tokenizer
Instance Variables
------------------
.. doxygengroup:: tokenizer-instance-vars
Constructors
------------
.. doxygengroup:: tokenizer-ctors
Methods
-------
.. doxygengroup:: tokenizer-general-methods