~vonfry/lift-dfa

dfa54cec5e21627d5719fabba4c928b54795cd59 — Vonfry 2 years ago 1a6a891 + 8385a86 v0.1.0.0
Merge branch 'release/v0.1.0.0'
A .gitignore => .gitignore +417 -0
@@ 0,0 1,417 @@

# Created by https://www.gitignore.io/api/haskell,linux,macos,emacs,vim,latex
# Edit at https://www.gitignore.io/?templates=haskell,linux,macos,emacs,vim,latex

### Emacs ###
# -*- mode: gitignore; -*-
*~
\#*\#
/.emacs.desktop
/.emacs.desktop.lock
*.elc
auto-save-list
tramp
.\#*

# Org-mode
.org-id-locations
*_archive

# flymake-mode
*_flymake.*

# eshell files
/eshell/history
/eshell/lastdir

# elpa packages
/elpa/

# reftex files
*.rel

# AUCTeX auto folder
/auto/

# cask packages
.cask/
dist/

# Flycheck
flycheck_*.el

# server auth directory
/server/

# projectiles files
.projectile

# directory configuration
.dir-locals.el

# network security
/network-security.data


### Haskell ###
dist
dist-*
cabal-dev
*.o
*.hi
*.chi
*.chs.h
*.dyn_o
*.dyn_hi
.hpc
.hsenv
.cabal-sandbox/
cabal.sandbox.config
*.prof
*.aux
*.hp
*.eventlog
.stack-work/
cabal.project.local
cabal.project.local~
.HTF/
.ghc.environment.*

### LaTeX ###
## Core latex/pdflatex auxiliary files:
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.fmt
*.fot
*.cb
*.cb2
.*.lb

## Intermediate documents:
*.dvi
*.xdv
*-converted-to.*
# these rules might exclude image files for figures etc.
# *.ps
# *.eps
# *.pdf

## Generated if empty string is given at "Please type another file name for output:"
.pdf

## Bibliography auxiliary files (bibtex/biblatex/biber):
*.bbl
*.bcf
*.blg
*-blx.aux
*-blx.bib
*.run.xml

## Build tool auxiliary files:
*.fdb_latexmk
*.synctex
*.synctex(busy)
*.synctex.gz
*.synctex.gz(busy)
*.pdfsync

## Build tool directories for auxiliary files
# latexrun
latex.out/

## Auxiliary and intermediate files from other packages:
# algorithms
*.alg
*.loa

# achemso
acs-*.bib

# amsthm
*.thm

# beamer
*.nav
*.pre
*.snm
*.vrb

# changes
*.soc

# comment
*.cut

# cprotect
*.cpt

# elsarticle (documentclass of Elsevier journals)
*.spl

# endnotes
*.ent

# fixme
*.lox

# feynmf/feynmp
*.mf
*.mp
*.t[1-9]
*.t[1-9][0-9]
*.tfm

#(r)(e)ledmac/(r)(e)ledpar
*.end
*.?end
*.[1-9]
*.[1-9][0-9]
*.[1-9][0-9][0-9]
*.[1-9]R
*.[1-9][0-9]R
*.[1-9][0-9][0-9]R
*.eledsec[1-9]
*.eledsec[1-9]R
*.eledsec[1-9][0-9]
*.eledsec[1-9][0-9]R
*.eledsec[1-9][0-9][0-9]
*.eledsec[1-9][0-9][0-9]R

# glossaries
*.acn
*.acr
*.glg
*.glo
*.gls
*.glsdefs

# uncomment this for glossaries-extra (will ignore makeindex's style files!)
# *.ist

# gnuplottex
*-gnuplottex-*

# gregoriotex
*.gaux
*.gtex

# htlatex
*.4ct
*.4tc
*.idv
*.lg
*.trc
*.xref

# hyperref
*.brf

# knitr
*-concordance.tex
# TODO Comment the next line if you want to keep your tikz graphics files
*.tikz
*-tikzDictionary

# listings
*.lol

# luatexja-ruby
*.ltjruby

# makeidx
*.idx
*.ilg
*.ind

# minitoc
*.maf
*.mlf
*.mlt
*.mtc[0-9]*
*.slf[0-9]*
*.slt[0-9]*
*.stc[0-9]*

# minted
_minted*
*.pyg

# morewrites
*.mw

# nomencl
*.nlg
*.nlo
*.nls

# pax
*.pax

# pdfpcnotes
*.pdfpc

# sagetex
*.sagetex.sage
*.sagetex.py
*.sagetex.scmd

# scrwfile
*.wrt

# sympy
*.sout
*.sympy
sympy-plots-for-*.tex/

# pdfcomment
*.upa
*.upb

# pythontex
*.pytxcode
pythontex-files-*/

# tcolorbox
*.listing

# thmtools
*.loe

# TikZ & PGF
*.dpth
*.md5
*.auxlock

# todonotes
*.tdo

# vhistory
*.hst
*.ver

# easy-todo
*.lod

# xcolor
*.xcp

# xmpincl
*.xmpi

# xindy
*.xdy

# xypic precompiled matrices
*.xyc

# endfloat
*.ttt
*.fff

# Latexian
TSWLatexianTemp*

## Editors:
# WinEdt
*.bak
*.sav

# Texpad
.texpadtmp

# LyX
*.lyx~

# Kile
*.backup

# KBibTeX
*~[0-9]*

# auto folder when using emacs and auctex
./auto/*
*.el

# expex forward references with \gathertags
*-tags.tex

# standalone packages
*.sta

### LaTeX Patch ###
# glossaries
*.glstex

### Linux ###

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Vim ###
# Swap
[._]*.s[a-v][a-z]
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist

# Auto-generated tag files
tags

# Persistent undo
[._]*.un~

# Coc configuration directory
.vim

# End of https://www.gitignore.io/api/haskell,linux,macos,emacs,vim,latex

latex.out/

A .gitlab-ci.yml => .gitlab-ci.yml +24 -0
@@ 0,0 1,24 @@
default:
  image: nixos/nix:latest
  cache:
    paths:
      - .nix

variables:
  GIT_SUBMODULE_STRATEGY: recursive
  LOCAL_NIX_STORE: $CI_PROJECT_DIR/.nix/store

nix:
  before_script:
    - nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgs
    - nix-channel --update
    # refs: https://nixos.wiki/wiki/Nix_on_Travis
    - mkdir -p $LOCAL_NIX_STORE
    - mkdir -p /etc/nix
    - echo "substituters = https://cache.nixos.org/ file://$LOCAL_NIX_STORE" | tee -a /etc/nix/nix.conf > /dev/null
    - echo 'require-sigs = false' | tee -a /etc/nix/nix.conf > /dev/null
  script:
    - nix-build -E "(import <nixpkgs> {}).haskellPackages.callPackage ./. {}"
  after_script:
    - nix copy --to file://$LOCAL_NIX_STORE --all
  stage: build

A LICENSE => LICENSE +674 -0
@@ 0,0 1,674 @@
                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The GNU General Public License is a free, copyleft license for
software and other kinds of works.

  The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.  We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors.  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

  To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights.  Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received.  You must make sure that they, too, receive
or can get the source code.  And you must show them these terms so they
know their rights.

  Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

  For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software.  For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

  Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so.  This is fundamentally incompatible with the aim of
protecting users' freedom to change the software.  The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable.  Therefore, we
have designed this version of the GPL to prohibit the practice for those
products.  If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.

  Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary.  To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

  The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 3 of the GNU General Public License.

  "Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

  "The Program" refers to any copyrightable work licensed under this
License.  Each licensee is addressed as "you".  "Licensees" and
"recipients" may be individuals or organizations.

  To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy.  The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

  A "covered work" means either the unmodified Program or a work based
on the Program.

  To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy.  Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

  To "convey" a work means any kind of propagation that enables other
parties to make or receive copies.  Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

  An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License.  If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

  1. Source Code.

  The "source code" for a work means the preferred form of the work
for making modifications to it.  "Object code" means any non-source
form of a work.

  A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

  The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form.  A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

  The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities.  However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work.  For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

  The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

  The Corresponding Source for a work in source code form is that
same work.

  2. Basic Permissions.

  All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met.  This License explicitly affirms your unlimited
permission to run the unmodified Program.  The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work.  This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

  You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force.  You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright.  Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

  Conveying under any other circumstances is permitted solely under
the conditions stated below.  Sublicensing is not allowed; section 10
makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

  No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

  When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

  4. Conveying Verbatim Copies.

  You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

  You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

  You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

  A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit.  Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

  6. Conveying Non-Source Forms.

  You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

  A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

  A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling.  In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage.  For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product.  A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

  "Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source.  The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

  If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information.  But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

  The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed.  Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

  Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

  7. Additional Terms.

  "Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law.  If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

  When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it.  (Additional permissions may be written to require their own
removal in certain cases when you modify the work.)  You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

  Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

  All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10.  If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term.  If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

  If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

  Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

  8. Termination.

  You may not propagate or modify a covered work except as expressly
provided under this License.  Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

  However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

  Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

  Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

  9. Acceptance Not Required for Having Copies.

  You are not required to accept this License in order to receive or
run a copy of the Program.  Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance.  However,
nothing other than this License grants you permission to propagate or
modify any covered work.  These actions infringe copyright if you do
not accept this License.  Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

  10. Automatic Licensing of Downstream Recipients.

  Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License.  You are not responsible
for enforcing compliance by third parties with this License.

  An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations.  If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

  You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License.  For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

  11. Patents.

  A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.  The
work thus licensed is called the contributor's "contributor version".

  A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version.  For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

  Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

  In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement).  To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

  If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients.  "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

  If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

  A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License.  You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

  Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

  12. No Surrender of Others' Freedom.

  If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all.  For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

  13. Use with the GNU Affero General Public License.

  Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work.  The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

  14. Revised Versions of this License.

  The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

  Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.

  If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

  Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program 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.

    This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

  If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

    <program>  Copyright (C) <year>  <name of author>
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".

  You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.

  The GNU General Public License does not permit incorporating your program
into proprietary programs.  If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library.  If this is what you want to do, use the GNU Lesser General
Public License instead of this License.  But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

M app/Main.hs => app/Main.hs +122 -1
@@ 1,4 1,125 @@
{-# LANGUAGE MultiWayIf #-}

module Main where

import Floor
import Scheduler
import Scheduler.TaskQueue
import Lift
import Control.Concurrent (threadDelay)

import Data.List ( elem
                 , dropWhileEnd
                 , subsequences
                 )
import Data.Char ( isSpace
                 , toLower
                 )
import Options.Applicative

newtype Arguments = Arguments
  { floorsName :: String -- ^ a list of string for floors name, which are splited
                         -- by "," or spaces . Its count is used to create state mathine
  }

args :: Parser Arguments
args = Arguments
    <$> strOption
        ( showDefault
       <> value "B1,F0,F1,F2,F3,F4"
       <> metavar "LIST"
       <> help "a list of strting for floors name, which are splited by , or space.")


main :: IO ()
main = putStrLn "Hello, Haskell!"
main = mainDefault =<< execParser opts
  where
    opts = info (args <**> helper)
      ( fullDesc
     <> progDesc "Lift simulator by DFA for my homework."
     <> header "Lift simulator." )

mainDefault :: Arguments -> IO ()
mainDefault args = do
    putStrLn $ "Your floors: " ++ show floors
    mainLoop lift
  where
    floors :: FloorName
    floors = parseFloor $ floorsName args
    parseFloor = map trim . splitOneOf ", "
    lift = initLift { floorNames = floors }

mainLoop :: Lift -> IO ()
mainLoop lift = loop $ Right (lift, emptyTask)
  where
    loop :: Either String (Lift, TaskQueue) -> IO ()
    loop (Right (lift, tasks)) = do
        putStrLn "\n------"
        tasksIn <- getTask
        parseTaskin tasksIn lift tasks
    loop (Left msg) = putStrLn msg

    -- | This subfunction is the main state machine.
    -- This struct is not good. We should move this part into 'M.Lift'.
    -- And code a parse convert input string to special data for state
    -- machine input
    parseTaskin :: [String] -> Lift -> TaskQueue -> IO ()
    parseTaskin ["open"]   lift@(Lift _ (LiftMove _) _) tasks =
        parseTaskin ["_"] lift tasks
    parseTaskin ["close"]  lift@(Lift _ (LiftMove _) _) tasks =
        parseTaskin ["_"] lift tasks
    parseTaskin ["open"]  lift tasks = do
        putStrLn "Open"
        let lift' = onOpen lift
        threadDelay delayTime
        parseTaskin ["close"] lift' tasks
    parseTaskin ["close"] lift tasks  = do
        putStrLn "Close"
        let lift' = onClose lift
        threadDelay delayTime
        loop $ Right (lift', tasks)
    parseTaskin ["stop"] _ _ = loop $ Left "Stop"
    parseTaskin ["exception"] _ _ = loop $ Left "Exception"
    parseTaskin ["_"] _ Empty = loop $ Left "Finish"
    parseTaskin ["_"] lift tasks = do
        let (task, tasks') = popTask tasks lift
        putStrLn "do task"
        putStrLn $ "Current floor: " ++ show (floorNames lift !! curFloor lift)
        putStrLn $ "MoveTo: " ++ show (floorNames lift !! task)
        case doTask task lift of
            Left lift' -> parseTaskin ["open"] lift' tasks'
            Right (fl', lift') -> do
                threadDelay delayTime
                loop $ Right (lift', pushTask tasks' fl')
    parseTaskin taskin lift tasks =
        let tasks' = foldr (flip onFloor lift) tasks taskin
        in parseTaskin ["_"] lift tasks'

    delayTime = 5 * 10 ^ 5

getTask :: IO [String]
getTask = do
    putStrLn "Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:"
    t <- getLine
    if | elem t ["_", ""]   -> return ["_"]
       | isT t "close"      -> return ["close"]
       | isT t "open"       -> return ["open"]
       | isT t "stop"       -> return ["stop"]
       | isT t "exception"  -> return ["exception"]
       | otherwise    -> return $ parseTasks t
  where
    parseTasks :: String -> [String]
    parseTasks = map trim . splitOneOf ", "
    isT :: String -> String -> Bool
    isT t = elem (toLower <$> t) . subsequences

-- * help function

splitOneOf s =
    foldr (\a b'@(b:bs) ->
            if a `elem` s
                then "":b'
                else (a : b) : bs
        ) [""]

trim = dropWhileEnd isSpace . dropWhile isSpace

M default.nix => default.nix +22 -29
@@ 1,29 1,22 @@
{ nixpkgs ? import <nixpkgs> {}, compiler ? "default", doBenchmark ? false }:

let

  inherit (nixpkgs) pkgs;

  f = { mkDerivation, base, stdenv }:
      mkDerivation {
        pname = "lift";
        version = "0.1.0.0";
        src = ./.;
        isLibrary = false;
        isExecutable = true;
        executableHaskellDepends = [ base ];
        license = "unknown";
        hydraPlatforms = stdenv.lib.platforms.none;
      };

  haskellPackages = if compiler == "default"
                       then pkgs.haskellPackages
                       else pkgs.haskell.packages.${compiler};

  variant = if doBenchmark then pkgs.haskell.lib.doBenchmark else pkgs.lib.id;

  drv = variant (haskellPackages.callPackage f {});

in

  if pkgs.lib.inNixShell then drv.env else drv
{ mkDerivation
, base
, containers
, mtl
, hspec
, optparse-applicative
, stdenv }:
let basicDeps = [ base containers mtl ]; in
mkDerivation {
  pname = "lift";
  version = "0.1.0.0";
  src = ./.;
  isLibrary = true;
  isExecutable = true;
  libraryHaskellDepends = basicDeps ++ [  ];
  executableHaskellDepends = basicDeps ++ [ optparse-applicative ];
  testHaskellDepends = basicDeps ++ [ hspec ];
  testTarget = "spec";
  doHaddock = false;
  license = "unknown";
  hydraPlatforms = with stdenv.lib.platforms; darwin ++ linux;
}

A doc/report.tex => doc/report.tex +450 -0
@@ 0,0 1,450 @@
\documentclass{ctexrep}
\usepackage{fontspec,xltxtra,xunicode,hyperref}
%\usepackage[nofonts]{ctex}

\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{mathtools}
\usepackage{ulem}
\allowdisplaybreaks

\usepackage{float}
\usepackage{tabularx}
\usepackage{diagbox}
\usepackage{booktabs}
\usepackage{longtable}
\usepackage{enumitem}

\usepackage{graphicx}
\usepackage{tikz}
\usetikzlibrary{arrows.meta,automata}

% 英文字体,linux
\setmainfont{Liberation Serif}
\setsansfont{Liberation Sans}
\setmonofont{Liberation Mono}

% 中文字体,linux
\setCJKmainfont{Source Han Serif SC}
\setCJKsansfont{Source Han Sans SC}
\setCJKmonofont{Source Han Sans SC}

\usepackage[a4paper]{geometry}
\geometry{a4paper,left=2cm,right=2cm,top=2cm,bottom=2cm,includehead,includefoot}
\linespread{1}

\usepackage{verbatim}
\usepackage{listings}
\lstset{
  float=H,
  breaklines=true,
  basicstyle=\ttfamily,
  mathescape=true,
  numbers=left,
  numbersep=5pt,
  xleftmargin=20pt,
  frame=tb,
  framexleftmargin=20pt
}
\renewcommand{\lstlistingname}{代码}

% 页眉脚
\usepackage{fancyhdr}
\fancyhead[L]{\leftmark}
\fancyhead[C]{}
\fancyhead[R]{形式语言与自动机作业}
\fancyfoot[L]{}
\fancyfoot[C]{}
\fancyfoot[R]{\thepage}
\renewcommand{\headrulewidth}{0.4pt}
\renewcommand{\footrulewidth}{0.4pt}

\ctexset{
  section/format += \raggedright
}

% 信息
\title{使用自动机求解电梯问题 设计及使用说明书}
\author{冯若禹,201930310076}
\date{\today}

\begin{document}
\maketitle

\pagestyle{fancy}
\pagenumbering{roman}

\newpage

\tableofcontents

\newpage
\pagenumbering{arabic}
% 正文

\chapter{引言}
本文档为《形式语言与自动机》课程作业,包含设计与使用说明。相应的程序代码实现不在本文档内,请见额外的文件。

\section{题目}

电梯模拟程序,要求如下:
\begin{enumerate}
\item 分析电梯运行中的多种状态,设计一下有穷状态自动机来模拟电梯的运行过程
\item 实现电梯模拟程序并写出设计说明与使用说明
\end{enumerate}

\section{有穷状态机}
有限状态机(finite-state machine,FSM)又称有限状态自动机(finite-state automation,FSA),简称状态机,是表示有限个状态以及在这些状态之间的转移和动作等行为的数学计算模型。 它是一种抽象的机器。在一组有限的状态中,任何时间都有一个明确的状态。有限动态机可以通过一系列输入从一个状态变为另外一个状态,称为转移。一个有穷自动状态机包含一组状态、一个初始状态和一些引起转移的输入。有穷自动机有两种类型,确定有穷状态机和非确定有穷状态机。

\section{固定式升降梯}
用于楼层间的升降移动。其操作可大体分为电梯箱外部输入与电梯箱内部输入。

\subsection{箱内输入}
箱内输入主要为到达特定的楼层。输入后移动到指定的楼层。

此外还包含紧急停止、紧急呼叫、快速关门、保持开门等输入。

\subsection{箱外输入}
箱外输入向上或向下。代表本楼层的人意途向上或向下移动。

电梯未运行时(即等待),会移动到本楼层。

电梯在移动时,会在运行的方向,进行停靠。

\subsection{升降移动}
箱内与箱外所有楼层请求,以当前移动方向为正,根据距离大小进行优先级排序,距离小的优先级高。按优先级顺序进行楼层的停靠。相移动方向相反时,则执行完当前方向上所有移动后再进行反向移动。

\chapter{设计说明}
在引言中,说明了问题及与之相关的两个主要元素。本章根据上述描述设计模拟程序。

\section{问题分析}\label{sec:dfa}
电梯运行可以分解为两个子状态机,分别为运行状态和楼层状态。两组状态分别管理着不同的部分,共同运作使得电梯正常工作。

在实际开发过程中,将二者聚合为一个结构(状态集合),使代码结构更加易读。

\subsection{运行状态}
电梯运行,可以分为四种状态,异常/紧急停止、装载、升降、待机。输入为紧急停止、到达任务楼层、无就绪任务。其状态转移图如\ref{fig:running-dfa}。

\begin{figure}[H]
  \centering
  \begin{tikzpicture}[->,>={Stealth[round]},circle,auto,node distance=3cm]
    \node (S) {$S$};
    \node [draw,right of=S,node distance=1.5cm] (idle) {待机}
      edge[<-] (S);
    \node [draw,right of=idle] (move) {升降}
      edge[<-] node [above] {就绪任务} (idle);
    \node [draw,above of=move] (load) {装载}
      edge[<-,bend left]  node [right,scale=.8] {到达任务楼层} (move)
      edge[->,bend right] node [left, scale=.8] {就绪任务} (move)
      edge[->,bend right] node [above left, scale=.8] {无就绪任务} (idle);
    \node [draw, below of=move] (es) {紧急}
       edge[<-] node [right] {异常/紧急停止} (move)
       edge[<-] node [left] {异常/紧急停止} (idle)
       edge[<-,bend right=60] node [right] {异常/紧急停止} (load);
  \end{tikzpicture}
  \caption{\label{fig:running-dfa}运行状态转移图}
\end{figure}

其中,升降又分为两个状态,上升与下降,其状态转移由外部输入的任务与当前停留楼层进行决定。如果输入与停留层相同,则由上述自动机立刻转移至下一状态。

\subsection{楼层状态}
楼层状态为当前电梯所在楼层,在电梯运行中,则为上一个经过的楼层。其状态数与楼层数相同。输入包含上升与下降两种。其状态转移图如\ref{fig:floor-dfa}

\begin{figure}[H]
  \centering
  \begin{tikzpicture}[->,>={Stealth[round]},circle,auto,node distance=3cm]
    \node (S) {$S$};
    \node [right of=S,draw,node distance=1.5cm] (F0) {F0}
      edge[<-] (S);
    \node [draw,below of=F0, node distance=3cm]  (B1) {B1}
        edge[bend left] node [left] {上升} (F0)
        edge[<-,bend right] node [right] {下降} (F0);
    \node [draw,right of=F0]  (F1) {F1}
        edge[<-,bend left] node [below] {上升} (F0)
        edge[bend right] node [above] {下降} (F0);
    \node [draw,right of=F1]  (F2) {F2}
        edge[<-,bend left] node [below] {上升} (F1)
        edge[bend right] node [above] {下降} (F1);
    \node [right of=F2] (dots) {$\dots$}
        edge[<-,bend left] node [below] {上升} (F2)
        edge[bend right] node [above] {下降} (F2);
    \node [draw,right of=dots] (Fn) {Fn}
        edge[<-,bend left] node [below] {上升} (dots)
        edge[bend right] node [above] {下降} (dots);
  \end{tikzpicture}
  \caption{\label{fig:floor-dfa}楼层状态转移图}
\end{figure}

\section{软件环境}\label{sec:env}

\paragraph{编程语言}
Haskell2010/ghc 8

\paragraph{构建工具}
cabal、nix

\paragraph{测试系统}
macOS

\paragraph{可运行系统}
ghc/cabal支持的系统

\paragraph{执行类型}
CLI

\section{总体设计}
使用cli进行输入与输出必要的参数和运行结果。输入必要参数后,将任务请求交由任务队列,调度器根据当前状态进行优先级排序。再由调度器根据队列任务进行调度,执行相应的电梯状态转换模块函数,完成电梯的运作。

其中输入输出模块与执行队列模块应该是并行的。因为输入输出应该是实时接收,进入队列,而这一过程中,电梯仍处于运行过程。但由于本课程主要任务为使用自动机解决电梯调度,而非关注异步执行,所以简化为单一输入和输出。

由上所述,将软件分为三个模块,输入输出模块、状态转换模块、调度模块。其关系如图\ref{fig:module}。

\begin{figure}[H]
  \centering
  \begin{tikzpicture}[>={Stealth[round]},auto, node distance=3cm,every node/.style={draw,rectangle}]
    \node (io) {输入/输出};
    \node [right of=io] (call) {调度模块};
    \node [right of=call] (lift) {状态转换模块};

    \draw (call.175) edge[<-] (io.5);
    \draw (call.185) edge[->] (io.355);
    \draw (lift.176) edge[<-] (call.5);
    \draw (lift.183) edge[->] (call.355);
  \end{tikzpicture}
  \caption{\label{fig:module}系统模块}
\end{figure}

输入输出负责必要的参数。根据运行结果打印相应的值。在正常的电梯程序中,输出应为控制信号以及显示在电梯内外屏幕或者按钮指示灯亮起。但这里只是一个模拟程序,以打印字符为基准。

调试模块管理任务队列和状态转换。在输入输出中将参数交由任务队列,并控制调试器根据任务队列的值进行相应的操作。

状态转换模块即本程序的核心,以DFA来管理电梯的运行状态。其分析见\ref{sec:dfa}。

\section{模块设计}

\subsection{输入输出}\label{subsec:io}
设计cli输入参数,交由调度模块,取得返回值,输出运行结果。在实际中,输入输出应是异步执行,且输出为电梯的电机等执行器件,输入为按钮的电子信号,这里简化为文本输入与输出。如果需要对异步操作进行实现,对其模块进行重构,独立线程运行调度器。调度器设计与IO完全分离,故不包含主循环控制,循环控制由IO模块进行实现。

输入参数设计结构如\ref{lst:arguments}。

\begin{lstlisting}[language=Haskell,label=lst:arguments,caption=参数结构]
newtype Arguments = Arguments
  { floorsName :: String -- ^ a list of string for floors name, which are splited
                         -- by "," or spaces . Its count is used to create state mathine
  }
\end{lstlisting}

使用库\verb~optparse-applicative~,通过应用函子定义参数解析器,由IO单子调用完成参数的解析。

除参数外,输入输出模块还管理计算结果的输出,如电子控制信号的发送,以及等待执行元件返回工部的信号。这里模拟程序以此化简。以打印楼层名和相关执行动作来描绘运作工况。同时,以主循环每次循问输入的方法来获取输入的任务。同时,以进程的睡眠(0.5s)来模拟执行元件的运行时间。为了简化设计,不使用多线程管理主循环。

接收参数后,初始化各子模块,启动主循环。在主循环中,每一个循环内进行任务的输入、任务列表的检查、下一任务的执行等。

\subsection{调度模块}
调度模块包含一个任务队列,根据当前的楼层状态选取状态变更的操作,调用状态转换模块中的转移函数完成状态的转移。

其主要包含如\ref{lst:call}。调度模块与IO操作完全分离,如\ref{subsec{io}}所述,此模块不包含循环控制等功能。需要由IO模块进行实现并调用的主调度函数。

\begin{lstlisting}[language=Haskell,label=lst:call,caption=调度函数]
onFloor :: String -> Lift -> TaskQueue -> TaskQueue

doTask :: LiftFloor
       -> Lift
       -> Either Lift (LiftFloor, Lift)  

doFloorUp :: Lift -> Lift

doFloorDown :: Lift -> Lift

onOpen :: Lift -> Lift

onClose :: Lift -> Lift

doIdle :: Lift -> Lift

doLoad :: Lift -> Lift

onExcept :: Lift -> Lift

doExcept :: Lift -> Lift
\end{lstlisting}

\subsection{状态转换模块}
基于haskell标准库的\verb~State~单子进行设计。\verb~State~用于结构用于描述状态的转移。而\verb~State~单子可以非常便利的对转移函数进行组合。在本模块中,会对所有的操作进行细分,而后通过组合的方式来实现实际的调用需求。
\footnote{由于本课题较为简单,也可以使用\verb~Reader~单子进行实现,但\verb~State~单子更加符合语义。}

首先我们需要先定义状态结构,一共包含两个,分别为楼层状态与执行状态,由于结构简单,使用\verb~newtype~进行语法层面的打包,在运行期不会产生额外的打包与解包。其具体结构如\ref{lst:state}

\begin{lstlisting}[language=Haskell,label=lst:state,caption=状态结构]
type LiftFloor = Int

data LiftState = LiftIdle
               | LiftMove LiftMoveT
               | LiftLoad
               | LiftException
               deriving (Eq, Show, Read)

data LiftMoveT = LiftMoveUp | LiftMoveDown
    deriving (Eq, Show, Read)

caseMoveT :: f           -- ^ return if Up
          -> f           -- ^ return if Down
          -> LiftMoveT
          -> f
caseMoveT a _ LiftMoveUp   = a
caseMoveT _ b LiftMoveDown = b

data Lift = Lift { curFloor   :: LiftFloor
                 , curState   :: LiftState
                 , floorNames :: FloorName
                 }
            deriving (Eq, Show, Read)
\end{lstlisting}

根据需求,定义如\ref{lst:state-trans}的转移函数,具体实现此处略去。

\begin{lstlisting}[language=Haskell,label=lst:state-trans,caption=转移函数]
moveLUp :: State Lift LiftFloor

moveLDown :: State Lift LiftFloor

idleS :: State Lift LiftFloor

loadS :: State Lift LiftFloor

exceptS :: State Lift LiftFloor

moveSUp :: State Lift LiftFloor

moveSDown :: State Lift LiftFloor
\end{lstlisting}

\chapter{使用说明}
本文档包含本软件 (电梯模拟程序)的使用说明。主要从运行环境、编译及参数进行说明。

本软件是一个cli程序。

\section{运行环境}

参考\ref{sec:env}

\section{编译、安装}
没有外部依赖,可以使用nix或者cabal进行编译。

\subsection{cabal}
使用\verb~cabal build~及\verb~cabal install~进行编译与安装,安装过程可省略,在编译目录下执行文件即可。

\subsection{nix}
使用\verb~nix build~进行编译,安装可以使用\verb~nix-env~完成,运行文件在生成的\verb~result~目录下。

\section{开发文档}

使用\verb~cabal haddock~,根据需要的文档类型进行生成。

\section{软件运行}
在CLI下运行执行文件即可。

\subsection{CLI参数}
\begin{lstlisting}[label=lst:cli-args,caption=cli参数]
Lift simulator.

Usage: lift [LIST]
  Lift simulator by DFA for my homework.

Available options:
  LIST                     a list of strting for floors name, which are splited
                           by , or space. (default: "B1,F0,F1,F2,F3,F4")
  -h,--help                Show this help text
\end{lstlisting}

\subsection{运行实例}
\begin{lstlisting}[label=lst:instance,caption=运行样例]
Your floors: ["B1","F0","F1","F2","F3","F4"]

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:
F4,F2,F1,B1,F4
do task
Current floor: "B1"
MoveTo: "B1"
Open
Close

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "B1"
MoveTo: "F1"

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F0"
MoveTo: "F1"

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F1"
MoveTo: "F1"
Open
Close

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F1"
MoveTo: "F2"

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F2"
MoveTo: "F2"
Open
Close

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F2"
MoveTo: "F4"

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F3"
MoveTo: "F4"

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F4"
MoveTo: "F4"
Open
Close

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

do task
Current floor: "F4"
MoveTo: "F4"
Open
Close

------
Input tasks(floor name/(c)lose/(o)pen//(s)top/(e)xception)/[_]:

Finish
\end{lstlisting}

\end{document}

A lib/Floor.hs => lib/Floor.hs +8 -0
@@ 0,0 1,8 @@
-- | Floor information for cli and pass to scheduler.

module Floor where

type FloorName = [String]

floorCount :: FloorName -> Int
floorCount = length

A lib/Lift.hs => lib/Lift.hs +123 -0
@@ 0,0 1,123 @@
-- | Lift module contains lift data struct and its State transformation. They
-- are called by scheduler.

module Lift
  ( LiftFloor
  , LiftState(..)
  , Lift(..)
  , LiftMoveT(..)
  , caseMoveT
  , (-:-)
  , (-:)
  , moveLUp, moveLDown
  , idleS, loadS, exceptS, moveSUp, moveSDown
  , runState, evalState, execState, mapState, withState
  , initLift
  ) where

import Control.Monad.State

import Floor

-- * Data struct

-- | 'LiftFloor' must be bound by 'Num'.
type LiftFloor = Int

data LiftState = LiftIdle
               | LiftMove LiftMoveT
               | LiftLoad
               | LiftException
               deriving (Eq, Show, Read)

data LiftMoveT = LiftMoveUp | LiftMoveDown
    deriving (Eq, Show, Read)

caseMoveT :: f           -- ^ return if Up
          -> f           -- ^ return if Down
          -> LiftMoveT
          -> f
caseMoveT a _ LiftMoveUp   = a
caseMoveT _ b LiftMoveDown = b

data Lift = Lift { curFloor   :: LiftFloor
                 , curState   :: LiftState
                 , floorNames :: FloorName
                 }
            deriving (Eq, Show, Read)

initLift :: Lift
initLift = Lift  0 LiftIdle []

-- | Calculate the distance by a lift state and a floor.
-- Negative means the floor is different of the movement direction
(-:) :: Lift -> LiftFloor -> Int
(Lift floor (LiftMove direction) _) -: floor' =
    caseMoveT up down direction
  where
    up   = floor' - floor
    down = floor - floor'
(Lift floor _ _) -: floor' = abs $ floor - floor'

-- | Calculate the distance by a lift state and a floor. But it convert the
-- negative to the floor count plus its abs.
-- e.g. -1 -> count + 1
--
(-:-) :: Lift -> LiftFloor -> Int
fl@(Lift _ _ names) -:- fl' = convert $ fl -: fl'
  where
    convert x
        | x < 0     = abs x + floorCount names
        | otherwise = x

-- * State transformation

-- | move lift floor up, this state transformation don't change 'Lift.curState'
moveLUp :: State Lift LiftFloor
moveLUp = do
    s@(Lift fl _ names) <- get
    let fl' = if fl < floorCount names
                then fl + 1
                else fl
    put $ s { curFloor = fl' }
    return fl'

-- | move lift floor down, this state transformation don't change 'Lift.curState'
moveLDown :: State Lift LiftFloor
moveLDown = do
    s@(Lift fl _ _) <- get
    let fl' = if fl > 0
                then fl - 1
                else fl
    put $ s { curFloor = fl' }
    return fl'

idleS :: State Lift LiftFloor
idleS = do
    s <- get
    put $ s { curState = LiftIdle }
    return $ curFloor s

loadS :: State Lift LiftFloor
loadS = do
    s <- get
    put $ s { curState = LiftLoad }
    return $ curFloor s

exceptS :: State Lift LiftFloor
exceptS = do
    s <- get
    put $ s { curState = LiftException }
    return $ curFloor s

-- | move lift state to up, this state transformation do change 'curState'.
moveSUp :: State Lift LiftFloor
moveSUp = do
  modify $ \s -> s { curState = LiftMove LiftMoveUp }
  moveLUp

-- | move lift state to down, this state transformation do change 'curState'.
moveSDown :: State Lift LiftFloor
moveSDown = do
  modify $ \s -> s { curState = LiftMove LiftMoveDown }
  moveLDown

A lib/Scheduler.hs => lib/Scheduler.hs +60 -0
@@ 0,0 1,60 @@
-- | A scheduler is to get argument and call lift program to make it working.
-- This module contains a task queue and control unit, but the IO loop isn't
-- managed by this module, which should be done in IO module. And IO module
-- calls this module everytime neccessary.

module Scheduler where

import Lift
import Scheduler.TaskQueue
import Data.List
import Data.Maybe

-- | Add the floor into task queue
onFloor :: String -> Lift -> TaskQueue -> TaskQueue
onFloor s l q =  pushTask q $ s <! l

-- | do next task
doTask :: LiftFloor
       -> Lift
       -> Either Lift (LiftFloor, Lift)  -- ^ If next task is the same, it is
                                         -- 'Left', otherwise it is 'Right'. And
                                         -- the LiftFloor is the same as input.
doTask fl' l@(Lift fl _ _)
    | fl' == fl = Left $ doIdle l
    | fl' <  fl = Right (fl', doFloorDown l)
    | fl' >  fl = Right (fl', doFloorUp   l)

doFloorUp :: Lift -> Lift
doFloorUp = execState moveSUp

doFloorDown :: Lift -> Lift
doFloorDown = execState moveSDown

-- | open the lift door
onOpen :: Lift -> Lift
onOpen = doLoad

-- | close the lift door
onClose :: Lift -> Lift
onClose = doIdle

-- | idle
doIdle :: Lift -> Lift
doIdle = execState idleS

-- | load
doLoad :: Lift -> Lift
doLoad = execState loadS

-- | something error
onExcept :: Lift -> Lift
onExcept = doExcept

-- | something error
doExcept :: Lift -> Lift
doExcept = execState exceptS

-- | input a floorname and returnn its mapping for 'LiftFloor'.
(<!) :: String -> Lift -> LiftFloor
(<!) s (Lift _ _ names) = fromJust $ elemIndex s names

A lib/Scheduler/TaskQueue.hs => lib/Scheduler/TaskQueue.hs +41 -0
@@ 0,0 1,41 @@
-- | A queue for task.

module Scheduler.TaskQueue
  ( TaskQueue
  , popTask
  , pushTask
  , sortTask
  , taskCount
  , emptyTask
  , module Data.Sequence
  ) where

import Data.Sequence
import Control.Exception
import Lift

-- | 'TaskQueue' should satisficate @Eq a => Seq a@.
type TaskQueue = Seq LiftFloor

-- | Pop the next task by a task queue and current lift state.
popTask :: TaskQueue                -- ^ current task queue
        -> Lift                     -- ^ current lift state
        -> (LiftFloor, TaskQueue)   -- ^ @(next-floor, rest-queue)@
popTask t c = pop $ sortOn (sortTask c) t
  where
    pop Empty = (curFloor c, t)
    pop (x :<| xs) = (x, xs)

-- | Push a new task into the queue
pushTask :: TaskQueue -> LiftFloor -> TaskQueue
pushTask = (|>)

sortTask :: Lift
         -> LiftFloor
         -> Int         -- ^ distance
sortTask = (-:-)

taskCount = Data.Sequence.length

emptyTask :: TaskQueue
emptyTask = Empty

M lift.cabal => lift.cabal +27 -1
@@ 16,10 16,36 @@ maintainer:          shmtu@vonfry.name
build-type:          Simple
extra-source-files:  CHANGELOG.md

library
  exposed-modules:     Floor
                     , Lift
                     , Scheduler
                     , Scheduler.TaskQueue
  -- other-extensions:
  build-depends:       base >=4 && <5
                     , containers
                     , mtl
  hs-source-dirs:      lib
  default-language:    Haskell2010
    
executable lift
  main-is:             Main.hs
  -- other-modules:
  -- other-extensions:
  build-depends:       base >=4.12 && <4.13
  build-depends:       base >=4 && <5
                     , optparse-applicative
                     , lift
  hs-source-dirs:      app
  default-language:    Haskell2010

test-suite spec
    type:           exitcode-stdio-1.0
    main-is:        Spec.hs
    hs-source-dirs: test
    build-depends:  base >= 4 && < 5
                  , lift
                  , hspec
    other-modules:       Scheduler.TaskQueueSpec
                       , LiftSpec
                       , SchedulerSpec
    default-language:    Haskell2010
\ No newline at end of file

M readme.org => readme.org +12 -1
@@ 2,7 2,18 @@

A homework to code program to solve lift problem by dfa.

More detail please see [[doc][../doc]].
More detail please see [[doc][./doc]].


** *Notice*

The subfunction in main loop named ~parseTaskin~ is the main state machine.
This struct is not good. We should move this part into 'M.Lift'.
And code a parse convert input string to special data for state
machine input.

But this project is just for my project and it is enough for me to commit it, so
I won't modify this part any more.

** Build


A shell.nix => shell.nix +42 -0
@@ 0,0 1,42 @@
{ nixpkgs ? import <nixpkgs> {}, compiler ? "default", doBenchmark ? false }:

let

  inherit (nixpkgs) pkgs;

  f = { mkDerivation
      , base
      , containers
      , mtl
      , hspec
      , optparse-applicative
      , stdenv
      }:
        let basicDeps = [ base containers mtl ]; in
      mkDerivation {
        pname = "lift";
        version = "0.1.0.0";
        src = ./.;
        isLibrary = true;
        isExecutable = true;
        libraryHaskellDepends = basicDeps ++ [ ];
        executableHaskellDepends = basicDeps ++ [ optparse-applicative ];
        testHaskellDepends = basicDeps ++ [ hspec ];
        doHaddock = true;
        license = "GPLv3";
        hydraPlatforms = with pkgs.stdenv.lib.platforms; darwin ++ linux;
      };

  haskellPackages = if compiler == "default"
                       then pkgs.haskellPackages
                       else pkgs.haskell.packages.${compiler};

  variant = if doBenchmark then pkgs.haskell.lib.doBenchmark else pkgs.lib.id;

  drv = variant (haskellPackages.callPackage f {});

in

if pkgs.lib.inNixShell
  then drv.envFunc { withHoogle = true; }
  else drv

A test/LiftSpec.hs => test/LiftSpec.hs +42 -0
@@ 0,0 1,42 @@
module LiftSpec where

import Test.Hspec
import Lift

spec :: Spec
spec = describe "Lift" $ do
    context "move up" $ do
        it "fst" $ fst moveUpL `shouldBe` 4
        it "snd" $ ((==liftMoveUp) . snd) moveUpL `shouldBe` True
    context "move down" $ do
        it "fst" $ fst moveDownL `shouldBe` 2
        it "snd" $ ((==liftMoveDown) . snd) moveDownL `shouldBe` True
    context "idle" $ do
        it "fst" $ fst idleL `shouldBe` 3
        it "snd" $ ((==liftIdle) . snd) idleL `shouldBe` True
    context "load" $ do
        it "fst" $ fst loadL `shouldBe` 3
        it "snd" $ ((==liftLoad) .  snd) loadL `shouldBe` True
    context "except" $ do
        it "fst" $ fst exceptL `shouldBe` 3
        it "snd" $ ((==liftException) . snd) exceptL `shouldBe` True

  where
    lift :: Lift
    lift  = Lift 3 LiftIdle ["B1","F0","F1","F2","F3","F4"]

    moveUpL   = runState moveSUp   lift
    moveDownL = runState moveSDown lift
    exceptL   = runState exceptS   lift
    idleL     = runState idleS     lift
    loadL     = runState loadS     lift

    liftMoveUp = lift { curFloor = 4
                      , curState = LiftMove LiftMoveUp
                      }
    liftMoveDown = lift { curFloor = 2
                        , curState = LiftMove LiftMoveDown
                        }
    liftIdle = lift {curState = LiftIdle }
    liftLoad = lift {curState = LiftLoad }
    liftException = lift {curState = LiftException }

A test/Scheduler/TaskQueueSpec.hs => test/Scheduler/TaskQueueSpec.hs +30 -0
@@ 0,0 1,30 @@
module Scheduler.TaskQueueSpec where

import Test.Hspec
import Test.Hspec.QuickCheck
import Lift
import Scheduler.TaskQueue
import Floor

spec :: Spec
spec = describe "Task Queue" $ do
    prop "sort task" $
        \x -> let m = if x `mod` taskLen == 0
                      then (abs x + 1) `mod` taskLen
                      else abs x `mod` taskLen
              in sortTask current (sorted `index` (m - 1))
              < sortTask current (sorted `index` m)
    prop "push task" $
        \x -> last (pushTask task (x `mod` count)) == x `mod` count
    it "pop task" $
        fst (popTask task current) `shouldBe` (sorted `index` 0)
  where
    current :: Lift
    current  = Lift 2 (LiftMove LiftMoveUp) ["B1", "F0", "F1", "F2", "F3"]
    task    :: TaskQueue
    task     = 4 :<| 3 :<| 5 :<| 0 :<| Empty
    taskLen  = taskCount task
    count   :: Int
    count    = floorCount $ floorNames current
    last (xs :|> x) = x
    sorted = sortOn (sortTask current) task

A test/SchedulerSpec.hs => test/SchedulerSpec.hs +55 -0
@@ 0,0 1,55 @@
module SchedulerSpec where

import Test.Hspec
import Test.Hspec.QuickCheck
import Scheduler
import Scheduler.TaskQueue
import Lift
import Floor
import Data.Function
import Data.Either

spec :: Spec
spec = describe "Scheduler" $ do
    it "on move up" $
        (==liftMoveUp) moveUpL `shouldBe` True
    it "on move down" $
        (==liftMoveDown) moveDownL `shouldBe` True
    it "on open" $
        (==liftLoad) openL `shouldBe` True
    it "on close" $
        (==liftIdle)  closeL `shouldBe` True
    it "on except" $
        (==liftException) exceptL `shouldBe` True
    prop "on floor" $
        \x -> onFloor (floorNames lift !! modX x) lift task == task :|> (modX x)
    prop "task" $ \x -> ((modX x)==) $ curFloor $
        fromLeft (lift { curFloor = -1 }) $
        (iterate ((=<<) $ uncurry doTask) (Right (modX x, lift))) !! count
  where
    lift :: Lift
    lift  = Lift 3 LiftIdle ["B1","F0","F1","F2","F3","F4"]

    count = taskCount task

    task = 4 :<| 5 :<| 3 :<| Empty

    moveUpL   = doFloorUp   lift
    moveDownL = doFloorDown lift
    exceptL   = onExcept    lift
    openL     = onOpen      lift
    closeL    = onClose     lift

    liftMoveUp = lift { curFloor = 4
                      , curState = LiftMove LiftMoveUp
                      }
    liftMoveDown = lift { curFloor = 2
                        , curState = LiftMove LiftMoveDown
                        }
    liftIdle = lift {curState = LiftIdle }
    liftLoad = lift {curState = LiftLoad }
    liftException = lift {curState = LiftException }

    modX x = if x `mod` count == 0
             then (abs x + 1) `mod` count
             else abs x `mod` count

A test/Spec.hs => test/Spec.hs +1 -0
@@ 0,0 1,1 @@
{-# OPTIONS_GHC -F -pgmF hspec-discover #-}