/*
-Copyright 2009 Dan Nicholson
-
-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 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 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.
-
-Except as contained in this notice, the names of the authors or their
-institutions shall not be used in advertising or otherwise to promote the
-sale, use or other dealings in this Software without prior written
-authorization from the authors.
-*/
+ * Copyright © 2009 Dan Nicholson
+ * Copyright © 2012 Intel Corporation
+ * Copyright © 2012 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.
+ *
+ * Authors: Dan Nicholson <dbn.lists@gmail.com>
+ * Ran Benita <ran234@gmail.com>
+ * Daniel Stone <daniel@fooishbar.org>
+ */
+
+#include "config.h"
#include "xkbcomp-priv.h"
-#include "xkbrules.h"
-#include "parseutils.h"
-
-/* Global warning level */
-unsigned int warningLevel = 0;
-
-#define ISEMPTY(str) (!(str) || (strlen(str) == 0))
-
-static XkbFile *
-XkbKeymapFileFromComponents(const struct xkb_component_names * ktcsg)
-{
- XkbFile *keycodes, *types, *compat, *symbols;
- IncludeStmt *inc;
-
- inc = IncludeCreate(ktcsg->keycodes, MergeDefault);
- keycodes = CreateXKBFile(XkmKeyNamesIndex, NULL, (ParseCommon *)inc, 0);
-
- inc = IncludeCreate(ktcsg->types, MergeDefault);
- types = CreateXKBFile(XkmTypesIndex, NULL, (ParseCommon *)inc, 0);
- AppendStmt(&keycodes->common, &types->common);
-
- inc = IncludeCreate(ktcsg->compat, MergeDefault);
- compat = CreateXKBFile(XkmCompatMapIndex, NULL, (ParseCommon *)inc, 0);
- AppendStmt(&keycodes->common, &compat->common);
-
- inc = IncludeCreate(ktcsg->symbols, MergeDefault);
- symbols = CreateXKBFile(XkmSymbolsIndex, NULL, (ParseCommon *)inc, 0);
- AppendStmt(&keycodes->common, &symbols->common);
-
- return CreateXKBFile(XkmKeymapFile,
- ktcsg->keymap ? ktcsg->keymap : strdup(""),
- &keycodes->common, 0);
-}
-
-static struct xkb_component_names *
-XkbComponentsFromRules(struct xkb_context *context,
- const char *rules,
- const XkbRF_VarDefsPtr defs)
-{
- FILE *rulesFile = NULL;
- char *rulesPath = NULL;
- XkbRF_RulesPtr loaded = NULL;
- struct xkb_component_names * names = NULL;
- int i;
-
- rulesFile = XkbFindFileInPath(context, rules, XkmRulesFile, &rulesPath);
- if (!rulesFile) {
- ERROR("could not find \"%s\" rules in XKB path\n", rules);
- ERROR("%d include paths searched:\n",
- xkb_context_num_include_paths(context));
- for (i = 0; i < xkb_context_num_include_paths(context); i++)
- ERROR("\t%s\n", xkb_context_include_path_get(context, i));
- return NULL;
- }
+#include "rules.h"
- if (!(loaded = uTypedCalloc(1, XkbRF_RulesRec))) {
- ERROR("failed to allocate XKB rules\n");
- goto unwind_file;
- }
-
- if (!XkbcRF_LoadRules(rulesFile, loaded)) {
- ERROR("failed to load XKB rules \"%s\"\n", rulesPath);
- goto unwind_file;
- }
-
- if (!(names = uTypedCalloc(1, struct xkb_component_names))) {
- ERROR("failed to allocate XKB components\n");
- goto unwind_file;
- }
-
- if (!XkbcRF_GetComponents(loaded, defs, names)) {
- free(names->keymap);
- free(names->keycodes);
- free(names->types);
- free(names->compat);
- free(names->symbols);
- free(names);
- names = NULL;
- ERROR("no components returned from XKB rules \"%s\"\n", rulesPath);
- }
-
-unwind_file:
- XkbcRF_Free(loaded);
- if (rulesFile)
- fclose(rulesFile);
- free(rulesPath);
- return names;
-}
-
-_X_EXPORT struct xkb_keymap *
-xkb_map_new_from_names(struct xkb_context *context,
- const struct xkb_rule_names *rmlvo)
+static bool
+compile_keymap_file(struct xkb_keymap *keymap, XkbFile *file)
{
- XkbRF_VarDefsRec defs;
- struct xkb_component_names *names;
- struct xkb_keymap *xkb;
-
- if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
- ERROR("rules and layout required to generate XKB keymap\n");
- return NULL;
+ if (file->file_type != FILE_TYPE_KEYMAP) {
+ log_err(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Cannot compile a %s file alone into a keymap\n",
+ xkb_file_type_to_string(file->file_type));
+ return false;
}
- defs.model = rmlvo->model;
- defs.layout = rmlvo->layout;
- defs.variant = rmlvo->variant;
- defs.options = rmlvo->options;
-
- names = XkbComponentsFromRules(context, rmlvo->rules, &defs);
- if (!names) {
- ERROR("failed to generate XKB components from rules \"%s\"\n",
- rmlvo->rules);
- return NULL;
+ if (!CompileKeymap(file, keymap, MERGE_OVERRIDE)) {
+ log_err(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Failed to compile keymap\n");
+ return false;
}
- xkb = xkb_map_new_from_kccgst(context, names);
-
- free(names->keymap);
- free(names->keycodes);
- free(names->types);
- free(names->compat);
- free(names->symbols);
- free(names);
-
- return xkb;
+ return true;
}
-static XkbFile *
-XkbChooseMap(XkbFile *file, const char *name)
-{
- XkbFile *map = file;
-
- /* map specified? */
- if (name) {
- while (map) {
- if (map->name && strcmp(map->name, name) == 0)
- break;
- map = (XkbFile *) map->common.next;
- }
-
- if (!map)
- ERROR("no map named \"%s\" in input file\n", name);
- }
- else if (file->common.next) {
- /* look for map with XkbLC_Default flag. */
- for (; map; map = (XkbFile *) map->common.next) {
- if (map->flags & XkbLC_Default)
- break;
- }
-
- if (!map) {
- map = file;
- WARN("no map specified, but components have several\n");
- WARN("using the first defined map, \"%s\"\n",
- map->name ? map->name : "");
- }
- }
-
- return map;
-}
-
-static struct xkb_keymap *
-compile_keymap(struct xkb_context *context, XkbFile *file)
-{
- XkbFile *mapToUse;
- struct xkb_keymap * xkb = NULL;
-
- /* Find map to use */
- mapToUse = XkbChooseMap(file, NULL);
- if (!mapToUse)
- goto err;
-
- switch (mapToUse->type) {
- case XkmSemanticsFile:
- case XkmLayoutFile:
- case XkmKeymapFile:
- break;
- default:
- ERROR("file type %d not handled\n", mapToUse->type);
- goto err;
- }
-
- xkb = CompileKeymap(context, mapToUse);
- if (!xkb)
- goto err;
-
-err:
- FreeXKBFile(file);
- XkbcFreeAllAtoms();
- return xkb;
-}
-
-_X_EXPORT struct xkb_keymap *
-xkb_map_new_from_kccgst(struct xkb_context *context,
- const struct xkb_component_names *kccgst)
+static bool
+text_v1_keymap_new_from_names(struct xkb_keymap *keymap,
+ const struct xkb_rule_names *rmlvo)
{
+ bool ok;
+ struct xkb_component_names kccgst;
XkbFile *file;
- if (!kccgst) {
- ERROR("no components specified\n");
- return NULL;
- }
+ log_dbg(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Compiling from RMLVO: rules '%s', model '%s', layout '%s', "
+ "variant '%s', options '%s'\n",
+ rmlvo->rules, rmlvo->model, rmlvo->layout, rmlvo->variant,
+ rmlvo->options);
- if (ISEMPTY(kccgst->keycodes)) {
- ERROR("keycodes required to generate XKB keymap\n");
- return NULL;
+ ok = xkb_components_from_rules(keymap->ctx, rmlvo, &kccgst);
+ if (!ok) {
+ log_err(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Couldn't look up rules '%s', model '%s', layout '%s', "
+ "variant '%s', options '%s'\n",
+ rmlvo->rules, rmlvo->model, rmlvo->layout, rmlvo->variant,
+ rmlvo->options);
+ return false;
}
- if (ISEMPTY(kccgst->compat)) {
- ERROR("compat map required to generate XKB keymap\n");
- return NULL;
- }
+ log_dbg(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Compiling from KcCGST: keycodes '%s', types '%s', "
+ "compat '%s', symbols '%s'\n",
+ kccgst.keycodes, kccgst.types, kccgst.compat, kccgst.symbols);
- if (ISEMPTY(kccgst->types)) {
- ERROR("types required to generate XKB keymap\n");
- return NULL;
- }
+ file = XkbFileFromComponents(keymap->ctx, &kccgst);
- if (ISEMPTY(kccgst->symbols)) {
- ERROR("symbols required to generate XKB keymap\n");
- return NULL;
- }
+ free(kccgst.keycodes);
+ free(kccgst.types);
+ free(kccgst.compat);
+ free(kccgst.symbols);
- if (!(file = XkbKeymapFileFromComponents(kccgst))) {
- ERROR("failed to generate parsed XKB file from components\n");
- return NULL;
+ if (!file) {
+ log_err(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Failed to generate parsed XKB file from components\n");
+ return false;
}
- return compile_keymap(context, file);
+ ok = compile_keymap_file(keymap, file);
+ FreeXkbFile(file);
+ return ok;
}
-_X_EXPORT struct xkb_keymap *
-xkb_map_new_from_string(struct xkb_context *context,
- const char *string,
- enum xkb_keymap_format format)
+static bool
+text_v1_keymap_new_from_string(struct xkb_keymap *keymap,
+ const char *string, size_t len)
{
- XkbFile *file;
+ bool ok;
+ XkbFile *xkb_file;
- if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
- ERROR("unsupported keymap format %d\n", format);
- return NULL;
+ xkb_file = XkbParseString(keymap->ctx, string, len, "(input string)", NULL);
+ if (!xkb_file) {
+ log_err(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Failed to parse input xkb string\n");
+ return false;
}
- if (!string) {
- ERROR("no string specified to generate XKB keymap\n");
- return NULL;
- }
-
- if (!XKBParseString(string, "input", &file) || !file) {
- ERROR("failed to parse input xkb file\n");
- return NULL;
- }
-
- return compile_keymap(context, file);
+ ok = compile_keymap_file(keymap, xkb_file);
+ FreeXkbFile(xkb_file);
+ return ok;
}
-_X_EXPORT struct xkb_keymap *
-xkb_map_new_from_fd(struct xkb_context *context,
- int fd,
- enum xkb_keymap_format format)
+static bool
+text_v1_keymap_new_from_file(struct xkb_keymap *keymap, FILE *file)
{
- XkbFile *file;
- FILE *fptr;
-
- if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
- ERROR("unsupported keymap format %d\n", format);
- return NULL;
- }
-
- if (fd < 0) {
- ERROR("no file specified to generate XKB keymap\n");
- return NULL;
- }
+ bool ok;
+ XkbFile *xkb_file;
- fptr = fdopen(fd, "r");
- if (!fptr) {
- ERROR("couldn't associate fd with file pointer\n");
- return NULL;
+ xkb_file = XkbParseFile(keymap->ctx, file, "(unknown file)", NULL);
+ if (!xkb_file) {
+ log_err(keymap->ctx, XKB_LOG_MESSAGE_NO_ID,
+ "Failed to parse input xkb file\n");
+ return false;
}
- if (!XKBParseFile(fptr, "(unknown file)", &file) || !file) {
- ERROR("failed to parse input xkb file\n");
- return NULL;
- }
-
- return compile_keymap(context, file);
-}
-
-_X_EXPORT struct xkb_keymap *
-xkb_map_ref(struct xkb_keymap *xkb)
-{
- xkb->refcnt++;
- return xkb;
+ ok = compile_keymap_file(keymap, xkb_file);
+ FreeXkbFile(xkb_file);
+ return ok;
}
-_X_EXPORT void
-xkb_map_unref(struct xkb_keymap *xkb)
-{
- if (--xkb->refcnt > 0)
- return;
-
- XkbcFreeKeyboard(xkb);
-}
+const struct xkb_keymap_format_ops text_v1_keymap_format_ops = {
+ .keymap_new_from_names = text_v1_keymap_new_from_names,
+ .keymap_new_from_string = text_v1_keymap_new_from_string,
+ .keymap_new_from_file = text_v1_keymap_new_from_file,
+ .keymap_get_as_string = text_v1_keymap_get_as_string,
+};