;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2018, 2021 Mathieu Othacehe <othacehe@gnu.org>
;;; Copyright © 2020 Florian Pelz <pelzflorian@pelzflorian.de>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu installer keymap)
  #:use-module (guix records)
  #:use-module (sxml match)
  #:use-module (sxml simple)
  #:use-module (ice-9 binary-ports)
  #:use-module (ice-9 ftw)
  #:use-module (ice-9 match)
  #:use-module (ice-9 regex)
  #:export (<x11-keymap-model>
            x11-keymap-model
            make-x11-keymap-model
            x11-keymap-model?
            x11-keymap-model-name
            x11-keymap-mode</td></tr></table>
<table class='tabs'><tr><td>
<a href='/AGH-engineering-thesis/about/'>about</a><a href='/AGH-engineering-thesis/'>summary</a><a href='/AGH-engineering-thesis/refs/?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>refs</a><a href='/AGH-engineering-thesis/log/tests/stack_machine_old_multiinstructions_load_store/test.v'>log</a><a class='active' href='/AGH-engineering-thesis/tree/tests/stack_machine_old_multiinstructions_load_store/test.v?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>tree</a><a href='/AGH-engineering-thesis/commit/tests/stack_machine_old_multiinstructions_load_store/test.v?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>commit</a><a href='/AGH-engineering-thesis/diff/tests/stack_machine_old_multiinstructions_load_store/test.v?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>diff</a></td><td class='form'><form class='right' method='get' action='/AGH-engineering-thesis/log/tests/stack_machine_old_multiinstructions_load_store/test.v'>
<input type='hidden' name='id' value='43f4e586acf76f3ec08d5892ba784ba6ac5d1932'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/AGH-engineering-thesis/tree/?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>root</a>/<a href='/AGH-engineering-thesis/tree/tests?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>tests</a>/<a href='/AGH-engineering-thesis/tree/tests/stack_machine_old_multiinstructions_load_store?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>stack_machine_old_multiinstructions_load_store</a>/<a href='/AGH-engineering-thesis/tree/tests/stack_machine_old_multiinstructions_load_store/test.v?id=43f4e586acf76f3ec08d5892ba784ba6ac5d1932'>test.v</a></div><div class='content'><div class='error'>Path not found</div>
</div> <!-- class=content -->
                         <div class=footer>generated by
                             <a href="https://git.zx2c4.com/cgit/about/">
                                 cgit
                             </a>
                         </div>
                        </div> <!-- id=cgit -->
</body>
</html>
               ;; configItem is: <!ELEMENT configItem
                  ;; (name,shortDescription*,description*,vendor?,
                  ;; countryList?,languageList?,hwList?)>
                  ;;
                  ;; shortDescription and description are optional elements
                  ;; but sxml-match does not support default values for
                  ;; elements (only attributes). So to avoid writing as many
                  ;; patterns as existing possibilities, gather all the
                  ;; remaining elements but name in REST-VARIANT.
                  (configItem
                   (name ,name)
                   . ,rest-variant))
                 (x11-keymap-variant
                  (name name)
                  (description (maybe-empty
                                (assoc-ref rest-variant 'description))))]))

  (define (layout l)
    (sxml-match l
                [(layout
                  (configItem
                   (name ,name)
                   . ,rest-layout)
                  (variantList ,[variant -> v] ...))
                 (x11-keymap-layout
                  (name name)
                  (synopsis (maybe-empty
                             (assoc-ref rest-layout 'shortDescription)))
                  (description (maybe-empty
                                (assoc-ref rest-layout 'description)))
                  (variants (list v ...)))]
                [(layout
                  (configItem
                   (name ,name)
                   . ,rest-layout))
                 (x11-keymap-layout
                  (name name)
                  (synopsis (maybe-empty
                             (assoc-ref rest-layout 'shortDescription)))
                  (description (maybe-empty
                                (assoc-ref rest-layout 'description)))
                  (variants '()))]))

  (let ((sxml (call-with-input-file file
                (lambda (port)
                  (xml->sxml port #:trim-whitespace? #t)))))
    (match
        (sxml-match sxml
                    [(*TOP*
                      ,pi
                      (xkbConfigRegistry
                       (@ . ,ignored)
                       (modelList ,[model -> m] ...)
                       (layoutList ,[layout -> l] ...)
                       . ,rest))
                     (list
                      (list m ...)
                      (list l ...))])
      ((models layouts)
       (values models layouts)))))

(define (kmscon-update-keymap model layout variant options)
  "Update kmscon keymap with the provided MODEL, LAYOUT, VARIANT and OPTIONS."
  (and=>
   (getenv "KEYMAP_UPDATE")
   (lambda (keymap-file)
     (unless (file-exists? keymap-file)
       (error "Unable to locate keymap update file"))

     ;; See file gnu/packages/patches/kmscon-runtime-keymap-switch.patch.
     ;; This dirty hack makes possible to update kmscon keymap at runtime by
     ;; writing an X11 keyboard model, layout and variant to a named pipe
     ;; referred by KEYMAP_UPDATE environment variable.
     (call-with-output-file keymap-file
       (lambda (port)
         (format port model)
         (put-u8 port 0)

         (format port layout)
         (put-u8 port 0)

         (format port (or variant ""))
         (put-u8 port 0)

         (format port (or options ""))
         (put-u8 port 0))))))