;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2012, 2013, 2014, 2019 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2016 Efraim Flashner <efraim@flashner.co.il>
;;;
;;; 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 packages flex)
  #:use-module (guix licenses)
  #:use-module (guix packages)
  #:use-module (guix download)
  #:use-module (guix build-system gnu)
  #:use-module (guix utils)
  #:use-module (gnu packages)
  #:use-module (gnu packages m4)
  #:use-module (gnu packages man)
  #:use-module (gnu packages bison)
  #:use-module (srfi srfi-1))

(define-public flex
  (package
    (name "flex")
    (version "2.6.4")
    (source (origin
              (method url-fetch)
              (uri (string-append
                    "https://github.com/westes/flex"
                    "/releases/download/v" version "/"
                    "flex-" version ".tar.gz"))
              (sha256
               (base32
                "15g9bv236nzi665p9ggqjlfn4dwck5835vf0bbw2cz7h5c1swyp8"))))
    (build-system gnu-build-system)
    (inputs
     (let ((bison-for-tests
            (package
              (inherit bison)
              (arguments
               ;; Disable tests, since they require flex.
               (substitute-keyword-arguments (package-arguments bison)
                 ((#:tests? _ #f) #f)))
              (inputs (alist-delete "flex" (package-inputs bison))))))
       `(("bison" ,bison-for-tests))))
    ;; m4 is not present in PATH when cross-building
    (native-inputs
     `(("help2man" ,help2man)
       ("m4" ,m4)))
    (propagated-inputs `(("m4" ,m4)))
    (home-page "https://github.com/westes/flex")
    (synopsis "Fast lexical analyser generator")
    (description
     "Flex is a tool for generating scanners.  A scanner, sometimes
called a tokenizer, is a program which recognizes lexical patterns in
text.  The flex program reads user-specified input files, or its standard
input if no file names are given, for a description of a scanner to
generate.  The description is in the form of pairs of regular expressions
and C code, called rules.  Flex generates a C source file named,
\"lex.yy.c\", which defines the function yylex().  The file \"lex.yy.c\"
can be compiled and linked to produce an executable.  When the executable
is run, it analyzes its input for occurrences of text matching the
regular expressions for each rule.  Whenever it finds a match, it
executes the corresponding C code.")
    (license (non-copyleft "file://COPYING"
                           "See COPYING in the distribution."))))
test-on-test-end-gnu]: Conditionally print elapsed time.  Record it as the
optional metadata in the test result file (.trs).
* doc/guix.texi (Running the Test Suite): Document it.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:28:46 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=26a66d0feaab7626c4053071d5557394931fe14b'>build: test-driver.scm: Allow running as a standalone script.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm: Add an exec-based shebang and set the script
executable bit.
(main): Insert a newline after the version string is printed with --version.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:28:46 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=93a628c4e4f4a7f6665190f3c52a417daebaf28a'>build: test-driver.scm: Add a new '--errors-only' option.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm (show-help): Add the help text for the
new '--errors-only' option.
(%options): Add the errors-only option.
(test-runner-gnu): Add the errors-only? parameter and update doc.  Move the
logging of the test data after the test has completed, so a choice can be made
whether to keep it or discard it based on the value of the test result.
(main): Pass the errors-only? option to the driver.
* doc/guix.texi (Running the Test Suite): Document the new option.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:28:37 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=a1ea2acb376c8a74f41ce0e683680417207b365a'>build: test-driver.scm: Add test cases filtering options.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm (show-help): Add help text for the new --select
and --exclude options.
(%options): Add the new select and exclude options.
(test-runner-gnu): Pass them to the test runner.  Update doc.
(test-match-name*, test-match-name*/negated, %test-match-all): New variables.
(main): Compute the test specifier based on the values of the new options and
apply it to the current test runner when running the test file.
* doc/guix.texi (Running the Test Suite): Document the new options.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:23:41 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=346210b1b2130112dd5f894c1d40afb37c1c51a5'>build: test-driver.scm: Enable colored test results by default.</a><span class='msg-avail'>...<span class='msg-tooltip'>The Automake parallel test harness does its own smart detection of the
terminal color capability and always provides the --color-tests argument to
the driver.  This change defaults the --color-tests argument to true when the
test driver is run on its own (not via Automake).

* build-aux/test-driver.scm (main): Set the default value of the --color-tests
argument to true when it's not explicitly provided.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:23:41 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=13f299b2c98cce0ede3a8a37dd11832fdb3827bb'>build: test-driver.scm: Make output redirection optional.</a><span class='msg-avail'>...<span class='msg-tooltip'>This makes it easier (and less surprising) for users to experiment with the
custom Scheme test driver directly.  The behavior is unchanged from Automake's
point of view.

* build-aux/test-driver.scm (main): Make the --log-file and --trs-file
arguments optional and update doc.  Only open, redirect and close a port to a log file when
the --log-file option is provided.  Only open and close a port to a trs file
when the --trs-file option is provided.
(test-runner-gnu): Set OUT-PORT parameter default value to the current output
port.  Set the TRS-PORT parameter default value to a void port.  Update doc.
</span></span></td><td>Maxim Cournoyer</td></tr>