kc3-lang/libxkbcommon/src/xkbcomp/include.h

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Pierre Le Marre
  Date : 2023-11-06 21:53:51
  Hash : 00e3058e
  Message : Prevent recursive includes of keymap components - Add check for recursive includes of keymap components. It relies on limiting the include depth. The threshold is currently to 15, which seems reasonable with plenty of margin for keymaps in the wild. - Add corresponding new log message `recursive-include`. - Add tests for recursive includes.

• src/xkbcomp/include.h

• /************************************************************
   * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
   *
   * Permission to use, copy, modify, and distribute this
   * software and its documentation for any purpose and without
   * fee is hereby granted, provided that the above copyright
   * notice appear in all copies and that both that copyright
   * notice and this permission notice appear in supporting
   * documentation, and that the name of Silicon Graphics not be
   * used in advertising or publicity pertaining to distribution
   * of the software without specific prior written permission.
   * Silicon Graphics makes no representation about the suitability
   * of this software for any purpose. It is provided "as is"
   * without any express or implied warranty.
   *
   * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
   * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
   * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
   * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
   * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
   * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
   * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
   * THE USE OR PERFORMANCE OF THIS SOFTWARE.
   *
   ********************************************************/
  
  #ifndef XKBCOMP_INCLUDE_H
  #define XKBCOMP_INCLUDE_H
  
  /* Reasonable threshold, with plenty of margin for keymaps in the wild */
  #define INCLUDE_MAX_DEPTH 15
  
  bool
  ParseIncludeMap(char **str_inout, char **file_rtrn, char **map_rtrn,
                  char *nextop_rtrn, char **extra_data);
  
  FILE *
  FindFileInXkbPath(struct xkb_context *ctx, const char *name,
                    enum xkb_file_type type, char **pathRtrn,
                    unsigned int *offset);
  
  bool
  ExceedsIncludeMaxDepth(struct xkb_context *ctx, unsigned int include_depth);
  
  XkbFile *
  ProcessIncludeFile(struct xkb_context *ctx, IncludeStmt *stmt,
                     enum xkb_file_type file_type);
  
  #endif