Subject: [bug#58528] [PATCH] gnu: Services: Add espeakup service.

From: Hunter Jozwiak <[email-masked]>
Date: Sat, 15 Oct 2022 08:09:48 -0700

"(" <[email-masked]> writes:

Heya,
>
> On Fri Oct 14, 2022 at 9:09 PM BST, wrote:
>>
>> diff –git a/doc/guix.texi b/doc/guix.texi index dbf4ca9be9..73dc647ca5
>> 100644 — a/doc/guix.texi + b/doc/guix.texi @@ -17572,6 +17572,7 @@
>> Services
>>
>> @menu * Base Services:: Essential system services. +* Accessibility
>> Services:: For those with various impairments. * Scheduled Job Execution::
>> The mcron service. * Log Rotation:: The rottlog service. * Networking
>> Setup:: Setting up network interfaces. @@ -18793,6 +18794,24 @@ Base
>> Services (local-file "sway-greetd.conf")))))))) @end lisp @end deftp +@node
>> Accessibility Services +@subsection Accessibility Services
>> +%espeakup-configuration +@c %start of fragment + +@deftp {Data Type}
>> espeakup-configuration +Available @code{espeakup-configuration} fields are:
>> + +@table @asis +@item @code{default-voice} (default: @code{"en-US"})
>> (type: string) +Set the voice that espeak-ng should use by default. + +@end
>> table + +@end deftp + + +@c %end of fragment
>>
>
> Remember to add your copyright notice to the manual's copyright section.
>
> + (define-module (gnu services accessibility)
>>
>
> Since this is a new file, you'll need to update ``gnu/local.mk''
> accordingly.
>
> +
>>
>
> Remove this empty line after the ``;;; Copyright …'' line.
>
> + #:export (espeakup-configuration espeakup-service-type))
>>
>
> You should probably put each variable here on a new line.
>
> + +;; Espeakup service
>>
>
> Instead of this, do this:
>
> ^L ;;; ;;; Espeakup. ;;;
>
> The ^L is a control character, not a literal ``L''. Look at one of the
> other files and copy their ^L in. Also, add another newline after this
> "section comment".
>
> +(define-configuration/no-serialization espeakup-configuration +
>> (default-voice (string "en-US") + "Set the voice that espeak-ng should use
>> by default."))
>>
>
> Funky indentation here, and there needs to be a field for customizing the
> ``espeakup'' package to use. Should be:
>
> (define-configuration/no-serialization espeakup-configuration (espeakup
> (file-like espeakup) "Set the package providing the @code{/bin/espeakup}
> command.") (default-voice (string "en-US") "Set the voice that espeak-ng
> should use by default."))
>
> +(define (espeakup-shepherd-service config) + (list (shepherd-service
>> (provision '(espeakup)) + (documentation "The espeak-ng bridge to
>> speakup.") + (requirement '(user-processes)) + (start
>> #~(make-forkexec-constructor (list (string-append #[image: $espeakup
>> </div></blockquote> </div></blockquote> &gt;&gt; + &gt;&gt; /bin/espeakup
>> &gt;&gt; + -v &gt;&gt; + &gt;&gt; #$](espeakup-configuration-default-voice
>>
>>>
>>> + config))))) + (stop #~(make-kill-destructor)))))
>>>>
>>>
>>> Again, indentation is off here, and there's a small issue with
>>> ``string-append'' being used where ``file-append'' should be. Try this
>>> instead:
>>>
>>> (define (espeakup-shepherd-service config) (list (shepherd-service
>>> (provision '(espeakup)) (requirement '(user-processes)) (documentation "Run
>>> espeakup, the espeak-ng bridge to speakup.") (start
>>> #~(make-forkexec-constructor (list #[image: $(file-append
>>> (espeakup-configuration-espeakup config) </div></blockquote> &gt;
>>> /bin/espeakup) &gt; -v #$](espeakup-configuration-default-voice
>>> config))))
>>>>
>>>> (stop #~(make-kill-destructor)))))
>>>>
>>>> +(define espeakup-service-type + (service-type (name 'espeakup) +
>>>>> (description + "A lightweight connector between espeak and speakup.") +
>>>>> (extensions (list (service-extension + shepherd-root-service-type +
>>>>> espeakup-shepherd-service) + (service-extension +
>>>>> kernel-module-loader-service-type + (const (list "speakupsoft"))))) +
>>>>> (default-value (espeakup-configuration))))
>>>>>
>>>>
>>>> Here too; try this:
>>>>
>>>> (define espeakup-service-type (service-type (name 'espeakup)
>>>> (extensions (list (service-extension shepherd-root-service-type
>>>> espeakup-shepherd-services) (service-extension
>>>> kernel-module-loader-service-type (const (list "speakupsoft")))))
>>>> (default-value (espeakup-configuration)) (description "Configure and run
>>>> espeakup, a lightweight bridge between espeak-ng and speakup.")))
>>>>
>>>> – (
>>>>
>>>
From 6e9a454aa4f69c19c2e0bb4b109b4e86bb627a60 Mon Sep 17 00:00:00 2001
Message-Id: <6e9a[email-masked]>
From: Hunter Jozwiak <[email-masked]>
Date: Fri, 14 Oct 2022 15:45:21 -0400
Subject: [PATCH] gnu: Services: Add espeakup service.

* gnu/services/accessibility.scm: add espeakup-configuration,
espeakup-shepherd-service, and espeakup-service-type.
* gnu/local.mk: wire it in.
* doc/guix.texi (Accessibility Services): Document the espeakup configuration.
---
 doc/guix.texi                  | 23 ++++++++++++
 gnu/local.mk                   |  2 ++
 gnu/services/accessibility.scm | 66 ++++++++++++++++++++++++++++++++++
 3 files changed, 91 insertions(+)
 create mode 100644 gnu/services/accessibility.scm

diff --git a/doc/guix.texi b/doc/guix.texi
index bdff4004d0..b9633f0ae5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -109,6 +109,7 @@
 Copyright @copyright{} 2022 Simon Streit@*
 Copyright @copyright{} 2022 (@*
 Copyright @copyright{} 2022 John Kehayias@*
+Copyright @copyright{} 2022 Hunter Jozwiak@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -17585,6 +17586,7 @@ Services
 
 @menu
 * Base Services::               Essential system services.
+* Accessibility Services:: For those with various impairments.
 * Scheduled Job Execution::     The mcron service.
 * Log Rotation::                The rottlog service.
 * Networking Setup::            Setting up network interfaces.
@@ -18806,6 +18808,27 @@ Base Services
               (local-file "sway-greetd.conf"))))))))
 @end lisp
 @end deftp
+@node Accessibility Services
+@subsection Accessibility Services
+%espeakup-configuration
+@c %start of fragment
+
+@deftp {Data Type} espeakup-configuration
+Available @code{espeakup-configuration} fields are:
+
+@table @asis
+@item @code{espeakup} (default: @code{espeakup}) (type: file-like)
+Set the package providing the @code{/bin/espeakup} command.
+
+@item @code{default-voice} (default: @code{"en-US"}) (type: string)
+Set the voice that espeak-ng should use by default.
+
+@end table
+
+@end deftp
+
+
+@c %end of fragment
 
 @node Scheduled Job Execution
 @subsection Scheduled Job Execution
diff --git a/gnu/local.mk b/gnu/local.mk
index 1bd4722db4..ce0dcbb301 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -55,6 +55,7 @@
 # Copyright © 2022 Hilton Chain <[email-masked]>
 # Copyright © 2022 Alex Griffin <[email-masked]>
 # Copyright © 2022 ( <[email-masked]>
+# Copyright © 2022 Hunter Jozwiak <[email-masked]>
 #
 # This file is part of GNU Guix.
 #
@@ -643,6 +644,7 @@ GNU_SYSTEM_MODULES =				\
   %D%/packages/zwave.scm			\
 						\
   %D%/services.scm				\
+  %D%/services/accessibility.scm					\
   %D%/services/admin.scm			\
   %D%/services/audio.scm                        \
   %D%/services/auditd.scm			\
diff --git a/gnu/services/accessibility.scm b/gnu/services/accessibility.scm
new file mode 100644
index 0000000000..7c29c7fec6
--- /dev/null
+++ b/gnu/services/accessibility.scm
@@ -0,0 +1,66 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2022 Hunter Jozwiak <[email-masked]>
+;;;
+;;; 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 services accessibility)
+  #:use-module (gnu packages accessibility)
+  #:use-module (gnu services)
+  #:use-module (gnu services configuration)
+  #:use-module (gnu services linux)
+  #:use-module (gnu services shepherd)
+  #:use-module (guix gexp)
+  #:use-module (guix records)
+  #:export (espeakup-configuration
+            espeakup-service-type))
+
+
+;;;
+;;; Espeakup
+
+(define-configuration/no-serialization espeakup-configuration
+  (espeakup
+   (file-like espeakup)
+   "Set the package providing the @code{/bin/espeakup} command.")
+  (default-voice
+    (string "en-US")
+    "Set the voice that espeak-ng should use by default."))
+
+(define (espeakup-shepherd-service config)
+  (list (shepherd-service
+         (provision '(espeakup))
+         (requirement '(user-processes))
+         (documentation "Run espeakup, the espeak-ng bridge to speakup.")
+         (start
+          #~(make-forkexec-constructor
+             (list #$(file-append (espeakup-configuration-espeakup config)
+               "/bin/espeakup")
+               "-v" #$(espeakup-configuration-default-voice config))))
+         (stop #~(make-kill-destructor)))))
+
+(define espeakup-service-type
+  (service-type
+   (name 'espeakup)
+   (extensions
+    (list (service-extension
+           shepherd-root-service-type
+           espeakup-shepherd-service)
+     (service-extension
+           kernel-module-loader-service-type
+           (const (list "speakup_soft")))))
+   (default-value (espeakup-configuration))
+   (description
+    "Configure and run espeakup, a lightweight bridge between espeak-ng and speakup.")))
-- 
2.38.0