kc3-lang/libxkbcommon/src/compose/parser.h

• Show log

  Commit

• Hash : a1770132
  Author :
  Date : 2023-09-25T11:41:48
  

  Compose: add iterator API
  
  Allow users to iterate the entries in a compose table. This is useful
  for other projects which want programmable access to the sequences,
  without having to write their own parser.
  
  - New API:
    - `xkb_compose_table_entry_sequence`;
    - `xkb_compose_table_entry_keysym`;
    - `xkb_compose_table_entry_utf8`;
    - `xkb_compose_table_iterator_new`;
    - `xkb_compose_table_iterator_free`;
    - `xkb_compose_table_iterator_next`.
  - Add tests in `test/compose.c`.
  - Add benchmark for compose traversal.
  - `tools/compose.c`:
    - Print entries instead of just validating them.
    - Add `--file` option.
    - TODO: make this tool part of the xkbcli commands.
  
  Co-authored-by: Pierre Le Marre <dev@wismill.eu>
  Co-authored-by: Ran Benita <ran@unusedvar.com>
  Signed-off-by: Ran Benita <ran@unusedvar.com>
  

Download

• src/compose/parser.h

• /*
   * Copyright © 2013 Ran Benita <ran234@gmail.com>
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the "Software"),
   * to deal in the Software without restriction, including without limitation
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   * and/or sell copies of the Software, and to permit persons to whom the
   * Software is furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice (including the next
   * paragraph) shall be included in all copies or substantial portions of the
   * Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   * DEALINGS IN THE SOFTWARE.
   */
  
  #ifndef COMPOSE_PARSER_H
  #define COMPOSE_PARSER_H
  
  #define MAX_LHS_LEN 10
  #define MAX_INCLUDE_DEPTH 5
  
  bool
  parse_string(struct xkb_compose_table *table,
               const char *string, size_t len,
               const char *file_name);
  
  bool
  parse_file(struct xkb_compose_table *table,
             FILE *file, const char *file_name);
  
  #endif
  

Download