keymap: add xkb_keymap_new_from_buffer()

The current API doesn't allow the caller to create keymaps from mmap()'ed
files. The problem is, xkb_keymap_new_from_string() requires a terminating
0 byte. However, there is no way to guarantee that when using mmap() so a
user currently has to copy the whole file just to get the terminating zero
byte (assuming they cannot use xkb_keymap_new_from_file()).

This adds a new entry xkb_keymap_new_from_buffer() which takes a memory
location and the buffer size in bytes.

Internally, we depend on yy_scan_{string,byte}() helpers. According to
flex documentation these already copy the input string because they are
wrappers around yy_scan_buffer().
yy_scan_buffer() on the other hand has some insane requirements. The
buffer must be writeable and the last two bytes must be ASCII-NUL. But the
buffer may contain other 0 bytes just fine.

Because we don't want these constraints in our public API,
xkb_keymap_new_from_buffer() needs to create a copy of the input memory.
But it then calls yy_scan_buffer() directly. Hence, we have the same
number of buffer-copies as with *_from_string() but without the
terminating 0 requirement.
The explicit yy_scan_buffer() call is preferred over yy_scan_byte() so the
buffer-copy operation is not hidden somewhere in flex.

Maybe some day we no longer depend on flex and can have a zero-copy API. A
user could mmap() a file and it would get parsed right from this buffer.
But until then, we shouldn't expose this limitation in the API but instead
provide an API that some day can work with zero-copy.

Signed-off-by: David Herrmann <dh.herrmann@gmail.com>

[ran: rebased on top of my branch]
Conflicts:
	Makefile.am
	src/xkbcomp/xkbcomp.c

5 files changed, 108 insertions, 0 deletions

diff --git a/src/keymap.c b/src/keymap.c
index b468f94..3df183a 100644
--- a/src/keymap.c
+++ b/src/keymap.c
@@ -222,6 +222,43 @@ xkb_keymap_new_from_string(struct xkb_context *ctx,
 }
 
 XKB_EXPORT struct xkb_keymap *
+xkb_keymap_new_from_buffer(struct xkb_context *ctx,
+                           const char *buffer, size_t length,
+                           enum xkb_keymap_format format,
+                           enum xkb_keymap_compile_flags flags)
+{
+    struct xkb_keymap *keymap;
+    const struct xkb_keymap_format_ops *ops;
+
+    ops = get_keymap_format_ops(format);
+    if (!ops || !ops->keymap_new_from_string) {
+        log_err_func(ctx, "unsupported keymap format: %d\n", format);
+        return NULL;
+    }
+
+    if (flags & ~(XKB_MAP_COMPILE_PLACEHOLDER)) {
+        log_err_func(ctx, "unrecognized flags: %#x\n", flags);
+        return NULL;
+    }
+
+    if (!buffer) {
+        log_err_func1(ctx, "no buffer specified\n");
+        return NULL;
+    }
+
+    keymap = xkb_keymap_new(ctx, format, flags);
+    if (!keymap)
+        return NULL;
+
+    if (!ops->keymap_new_from_buffer(keymap, buffer, length)) {
+        xkb_keymap_unref(keymap);
+        return NULL;
+    }
+
+    return keymap;
+}
+
+XKB_EXPORT struct xkb_keymap *
 xkb_keymap_new_from_file(struct xkb_context *ctx,
                          FILE *file,
                          enum xkb_keymap_format format,
diff --git a/src/keymap.h b/src/keymap.h
index 12a2771..c6b884d 100644
--- a/src/keymap.h
+++ b/src/keymap.h
@@ -440,6 +440,8 @@ struct xkb_keymap_format_ops {
                                   const struct xkb_rule_names *names);
     bool (*keymap_new_from_string)(struct xkb_keymap *keymap,
                                    const char *string);
+    bool (*keymap_new_from_buffer)(struct xkb_keymap *keymap,
+                                   const char *buffer, size_t length);
     bool (*keymap_new_from_file)(struct xkb_keymap *keymap, FILE *file);
     char *(*keymap_get_as_string)(struct xkb_keymap *keymap);
 };
diff --git a/src/xkbcomp/scanner.l b/src/xkbcomp/scanner.l
index 5ccf3e9..f30462d 100644
--- a/src/xkbcomp/scanner.l
+++ b/src/xkbcomp/scanner.l
@@ -267,6 +267,38 @@ XkbParseString(struct xkb_context *ctx, const char *string,
     return xkb_file;
 }
 
+/*
+ * yy_scan_buffer() requires the last two bytes of \buf to be 0. These two bytes
+ * are not scanned. Other zero bytes in the buffer are scanned normally, though.
+ * Due to these terminating zeroes, \length must be greater than 2.
+ * Furthermore, the buffer must be writable and you cannot make any assumptions
+ * about it after the scanner finished.
+ * All this must be guaranteed by the caller of this function!
+ */
+XkbFile *
+XkbParseBuffer(struct xkb_context *ctx, char *buf, size_t length,
+               const char *file_name)
+{
+    yyscan_t scanner;
+    struct scanner_extra extra;
+    YY_BUFFER_STATE state;
+    XkbFile *xkb_file;
+
+    if (!init_scanner(&scanner, &extra, ctx, file_name))
+        return NULL;
+
+    xkb_file = NULL;
+    state = yy_scan_buffer(buf, length, scanner);
+    if (state) {
+        xkb_file = parse(ctx, scanner, NULL);
+        yy_delete_buffer(state, scanner);
+    }
+
+    clear_scanner(scanner);
+
+    return xkb_file;
+}
+
 XkbFile *
 XkbParseFile(struct xkb_context *ctx, FILE *file,
              const char *file_name, const char *map)
diff --git a/src/xkbcomp/xkbcomp-priv.h b/src/xkbcomp/xkbcomp-priv.h
index 51c033f..4d421b5 100644
--- a/src/xkbcomp/xkbcomp-priv.h
+++ b/src/xkbcomp/xkbcomp-priv.h
@@ -48,6 +48,10 @@ XkbFile *
 XkbParseString(struct xkb_context *ctx, const char *string,
                const char *file_name);
 
+XkbFile *
+XkbParseBuffer(struct xkb_context *ctx, char *buf, size_t length,
+               const char *file_name);
+
 void
 FreeXkbFile(XkbFile *file);
 
diff --git a/src/xkbcomp/xkbcomp.c b/src/xkbcomp/xkbcomp.c
index cc4b3ef..b9a1b5f 100644
--- a/src/xkbcomp/xkbcomp.c
+++ b/src/xkbcomp/xkbcomp.c
@@ -114,6 +114,38 @@ text_v1_keymap_new_from_string(struct xkb_keymap *keymap, const char *string)
 }
 
 static bool
+text_v1_keymap_new_from_buffer(struct xkb_keymap *keymap,
+                               const char *buffer, size_t length)
+{
+    bool ok;
+    XkbFile *xkb_file;
+    char *buf;
+
+    buf = malloc(length + 2);
+    if (!buf) {
+        log_err(keymap->ctx, "Cannot allocate memory for keymap\n");
+        return NULL;
+    }
+
+    /* yy_scan_buffer requires two terminating zero bytes */
+    memcpy(buf, buffer, length);
+    buf[length] = 0;
+    buf[length + 1] = 0;
+
+    xkb_file = XkbParseBuffer(keymap->ctx, buf, length + 2, "input");
+    if (!xkb_file) {
+        log_err(keymap->ctx, "Failed to parse input xkb file\n");
+        free(buf);
+        return NULL;
+    }
+
+    ok = compile_keymap_file(keymap, xkb_file);
+    FreeXkbFile(xkb_file);
+    free(buf);
+    return ok;
+}
+
+static bool
 text_v1_keymap_new_from_file(struct xkb_keymap *keymap, FILE *file)
 {
     bool ok;
@@ -133,6 +165,7 @@ text_v1_keymap_new_from_file(struct xkb_keymap *keymap, FILE *file)
 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_buffer = text_v1_keymap_new_from_buffer,
     .keymap_new_from_file = text_v1_keymap_new_from_file,
     .keymap_get_as_string = text_v1_keymap_get_as_string,
 };