HSH (empty) → 1.2.0
raw patch · 8 files changed
+1254/−0 lines, 8 filesdep +FilePathdep +MissingHdep +basebuild-type:Customsetup-changed
Dependencies added: FilePath, MissingH, base, hslogger, mtl, regex-base, regex-compat, regex-posix, unix
Files
- COPYING +510/−0
- COPYRIGHT +17/−0
- HSH.cabal +28/−0
- HSH.hs +108/−0
- HSH/Command.hs +380/−0
- HSH/ShellEquivs.hs +192/−0
- Setup.lhs +6/−0
- testsrc/runtests.hs +13/−0
+ COPYING view
@@ -0,0 +1,510 @@++ GNU LESSER GENERAL PUBLIC LICENSE+ Version 2.1, February 1999++ Copyright (C) 1991, 1999 Free Software Foundation, Inc.+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++[This is the first released version of the Lesser GPL. It also counts+ as the successor of the GNU Library Public License, version 2, hence+ the version number 2.1.]++ Preamble++ The licenses for most software are designed to take away your+freedom to share and change it. By contrast, the GNU General Public+Licenses are intended to guarantee your freedom to share and change+free software--to make sure the software is free for all its users.++ This license, the Lesser General Public License, applies to some+specially designated software packages--typically libraries--of the+Free Software Foundation and other authors who decide to use it. You+can use it too, but we suggest you first think carefully about whether+this license or the ordinary General Public License is the better+strategy to use in any particular case, based on the explanations+below.++ When we speak of free software, we are referring to freedom of use,+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 this service if you wish); that you receive source code or can get+it if you want it; that you can change the software and use pieces of+it in new free programs; and that you are informed that you can do+these things.++ To protect your rights, we need to make restrictions that forbid+distributors to deny you these rights or to ask you to surrender these+rights. These restrictions translate to certain responsibilities for+you if you distribute copies of the library or if you modify it.++ For example, if you distribute copies of the library, whether gratis+or for a fee, you must give the recipients all the rights that we gave+you. You must make sure that they, too, receive or can get the source+code. If you link other code with the library, you must provide+complete object files to the recipients, so that they can relink them+with the library after making changes to the library and recompiling+it. And you must show them these terms so they know their rights.++ We protect your rights with a two-step method: (1) we copyright the+library, and (2) we offer you this license, which gives you legal+permission to copy, distribute and/or modify the library.++ To protect each distributor, we want to make it very clear that+there is no warranty for the free library. Also, if the library is+modified by someone else and passed on, the recipients should know+that what they have is not the original version, so that the original+author's reputation will not be affected by problems that might be+introduced by others.++ Finally, software patents pose a constant threat to the existence of+any free program. We wish to make sure that a company cannot+effectively restrict the users of a free program by obtaining a+restrictive license from a patent holder. Therefore, we insist that+any patent license obtained for a version of the library must be+consistent with the full freedom of use specified in this license.++ Most GNU software, including some libraries, is covered by the+ordinary GNU General Public License. This license, the GNU Lesser+General Public License, applies to certain designated libraries, and+is quite different from the ordinary General Public License. We use+this license for certain libraries in order to permit linking those+libraries into non-free programs.++ When a program is linked with a library, whether statically or using+a shared library, the combination of the two is legally speaking a+combined work, a derivative of the original library. The ordinary+General Public License therefore permits such linking only if the+entire combination fits its criteria of freedom. The Lesser General+Public License permits more lax criteria for linking other code with+the library.++ We call this license the "Lesser" General Public License because it+does Less to protect the user's freedom than the ordinary General+Public License. It also provides other free software developers Less+of an advantage over competing non-free programs. These disadvantages+are the reason we use the ordinary General Public License for many+libraries. However, the Lesser license provides advantages in certain+special circumstances.++ For example, on rare occasions, there may be a special need to+encourage the widest possible use of a certain library, so that it+becomes a de-facto standard. To achieve this, non-free programs must+be allowed to use the library. A more frequent case is that a free+library does the same job as widely used non-free libraries. In this+case, there is little to gain by limiting the free library to free+software only, so we use the Lesser General Public License.++ In other cases, permission to use a particular library in non-free+programs enables a greater number of people to use a large body of+free software. For example, permission to use the GNU C Library in+non-free programs enables many more people to use the whole GNU+operating system, as well as its variant, the GNU/Linux operating+system.++ Although the Lesser General Public License is Less protective of the+users' freedom, it does ensure that the user of a program that is+linked with the Library has the freedom and the wherewithal to run+that program using a modified version of the Library.++ The precise terms and conditions for copying, distribution and+modification follow. Pay close attention to the difference between a+"work based on the library" and a "work that uses the library". The+former contains code derived from the library, whereas the latter must+be combined with the library in order to run.++ GNU LESSER GENERAL PUBLIC LICENSE+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION++ 0. This License Agreement applies to any software library or other+program which contains a notice placed by the copyright holder or+other authorized party saying it may be distributed under the terms of+this Lesser General Public License (also called "this License").+Each licensee is addressed as "you".++ A "library" means a collection of software functions and/or data+prepared so as to be conveniently linked with application programs+(which use some of those functions and data) to form executables.++ The "Library", below, refers to any such software library or work+which has been distributed under these terms. A "work based on the+Library" means either the Library or any derivative work under+copyright law: that is to say, a work containing the Library or a+portion of it, either verbatim or with modifications and/or translated+straightforwardly into another language. (Hereinafter, translation is+included without limitation in the term "modification".)++ "Source code" for a work means the preferred form of the work for+making modifications to it. For a library, complete source code means+all the source code for all modules it contains, plus any associated+interface definition files, plus the scripts used to control+compilation and installation of the library.++ Activities other than copying, distribution and modification are not+covered by this License; they are outside its scope. The act of+running a program using the Library is not restricted, and output from+such a program is covered only if its contents constitute a work based+on the Library (independent of the use of the Library in a tool for+writing it). Whether that is true depends on what the Library does+and what the program that uses the Library does.++ 1. You may copy and distribute verbatim copies of the Library's+complete source code as you receive it, in any medium, provided that+you conspicuously and appropriately publish on each copy an+appropriate copyright notice and disclaimer of warranty; keep intact+all the notices that refer to this License and to the absence of any+warranty; and distribute a copy of this License along with the+Library.++ You may charge a fee for the physical act of transferring a copy,+and you may at your option offer warranty protection in exchange for a+fee.++ 2. You may modify your copy or copies of the Library or any portion+of it, thus forming a work based on the Library, and copy and+distribute such modifications or work under the terms of Section 1+above, provided that you also meet all of these conditions:++ a) The modified work must itself be a software library.++ b) You must cause the files modified to carry prominent notices+ stating that you changed the files and the date of any change.++ c) You must cause the whole of the work to be licensed at no+ charge to all third parties under the terms of this License.++ d) If a facility in the modified Library refers to a function or a+ table of data to be supplied by an application program that uses+ the facility, other than as an argument passed when the facility+ is invoked, then you must make a good faith effort to ensure that,+ in the event an application does not supply such function or+ table, the facility still operates, and performs whatever part of+ its purpose remains meaningful.++ (For example, a function in a library to compute square roots has+ a purpose that is entirely well-defined independent of the+ application. Therefore, Subsection 2d requires that any+ application-supplied function or table used by this function must+ be optional: if the application does not supply it, the square+ root function must still compute square roots.)++These requirements apply to the modified work as a whole. If+identifiable sections of that work are not derived from the Library,+and can be reasonably considered independent and separate works in+themselves, then this License, and its terms, do not apply to those+sections when you distribute them as separate works. But when you+distribute the same sections as part of a whole which is a work based+on the Library, the distribution of the whole must be on the terms of+this License, whose permissions for other licensees extend to the+entire whole, and thus to each and every part regardless of who wrote+it.++Thus, it is not the intent of this section to claim rights or contest+your rights to work written entirely by you; rather, the intent is to+exercise the right to control the distribution of derivative or+collective works based on the Library.++In addition, mere aggregation of another work not based on the Library+with the Library (or with a work based on the Library) on a volume of+a storage or distribution medium does not bring the other work under+the scope of this License.++ 3. You may opt to apply the terms of the ordinary GNU General Public+License instead of this License to a given copy of the Library. To do+this, you must alter all the notices that refer to this License, so+that they refer to the ordinary GNU General Public License, version 2,+instead of to this License. (If a newer version than version 2 of the+ordinary GNU General Public License has appeared, then you can specify+that version instead if you wish.) Do not make any other change in+these notices.++ Once this change is made in a given copy, it is irreversible for+that copy, so the ordinary GNU General Public License applies to all+subsequent copies and derivative works made from that copy.++ This option is useful when you wish to copy part of the code of+the Library into a program that is not a library.++ 4. You may copy and distribute the Library (or a portion or+derivative of it, under Section 2) in object code or executable form+under the terms of Sections 1 and 2 above provided that you accompany+it with the complete corresponding machine-readable source code, which+must be distributed under the terms of Sections 1 and 2 above on a+medium customarily used for software interchange.++ If distribution of object code is made by offering access to copy+from a designated place, then offering equivalent access to copy the+source code from the same place satisfies the requirement to+distribute the source code, even though third parties are not+compelled to copy the source along with the object code.++ 5. A program that contains no derivative of any portion of the+Library, but is designed to work with the Library by being compiled or+linked with it, is called a "work that uses the Library". Such a+work, in isolation, is not a derivative work of the Library, and+therefore falls outside the scope of this License.++ However, linking a "work that uses the Library" with the Library+creates an executable that is a derivative of the Library (because it+contains portions of the Library), rather than a "work that uses the+library". The executable is therefore covered by this License.+Section 6 states terms for distribution of such executables.++ When a "work that uses the Library" uses material from a header file+that is part of the Library, the object code for the work may be a+derivative work of the Library even though the source code is not.+Whether this is true is especially significant if the work can be+linked without the Library, or if the work is itself a library. The+threshold for this to be true is not precisely defined by law.++ If such an object file uses only numerical parameters, data+structure layouts and accessors, and small macros and small inline+functions (ten lines or less in length), then the use of the object+file is unrestricted, regardless of whether it is legally a derivative+work. (Executables containing this object code plus portions of the+Library will still fall under Section 6.)++ Otherwise, if the work is a derivative of the Library, you may+distribute the object code for the work under the terms of Section 6.+Any executables containing that work also fall under Section 6,+whether or not they are linked directly with the Library itself.++ 6. As an exception to the Sections above, you may also combine or+link a "work that uses the Library" with the Library to produce a+work containing portions of the Library, and distribute that work+under terms of your choice, provided that the terms permit+modification of the work for the customer's own use and reverse+engineering for debugging such modifications.++ You must give prominent notice with each copy of the work that the+Library is used in it and that the Library and its use are covered by+this License. You must supply a copy of this License. If the work+during execution displays copyright notices, you must include the+copyright notice for the Library among them, as well as a reference+directing the user to the copy of this License. Also, you must do one+of these things:++ a) Accompany the work with the complete corresponding+ machine-readable source code for the Library including whatever+ changes were used in the work (which must be distributed under+ Sections 1 and 2 above); and, if the work is an executable linked+ with the Library, with the complete machine-readable "work that+ uses the Library", as object code and/or source code, so that the+ user can modify the Library and then relink to produce a modified+ executable containing the modified Library. (It is understood+ that the user who changes the contents of definitions files in the+ Library will not necessarily be able to recompile the application+ to use the modified definitions.)++ b) Use a suitable shared library mechanism for linking with the+ Library. A suitable mechanism is one that (1) uses at run time a+ copy of the library already present on the user's computer system,+ rather than copying library functions into the executable, and (2)+ will operate properly with a modified version of the library, if+ the user installs one, as long as the modified version is+ interface-compatible with the version that the work was made with.++ c) Accompany the work with a written offer, valid for at least+ three years, to give the same user the materials specified in+ Subsection 6a, above, for a charge no more than the cost of+ performing this distribution.++ d) If distribution of the work is made by offering access to copy+ from a designated place, offer equivalent access to copy the above+ specified materials from the same place.++ e) Verify that the user has already received a copy of these+ materials or that you have already sent this user a copy.++ For an executable, the required form of the "work that uses the+Library" must include any data and utility programs needed for+reproducing the executable from it. However, as a special exception,+the materials to be distributed need not include anything that is+normally distributed (in either source or binary form) with the major+components (compiler, kernel, and so on) of the operating system on+which the executable runs, unless that component itself accompanies+the executable.++ It may happen that this requirement contradicts the license+restrictions of other proprietary libraries that do not normally+accompany the operating system. Such a contradiction means you cannot+use both them and the Library together in an executable that you+distribute.++ 7. You may place library facilities that are a work based on the+Library side-by-side in a single library together with other library+facilities not covered by this License, and distribute such a combined+library, provided that the separate distribution of the work based on+the Library and of the other library facilities is otherwise+permitted, and provided that you do these two things:++ a) Accompany the combined library with a copy of the same work+ based on the Library, uncombined with any other library+ facilities. This must be distributed under the terms of the+ Sections above.++ b) Give prominent notice with the combined library of the fact+ that part of it is a work based on the Library, and explaining+ where to find the accompanying uncombined form of the same work.++ 8. You may not copy, modify, sublicense, link with, or distribute+the Library except as expressly provided under this License. Any+attempt otherwise to copy, modify, sublicense, link with, or+distribute the Library is void, and will automatically terminate your+rights under this License. However, parties who have received copies,+or rights, from you under this License will not have their licenses+terminated so long as such parties remain in full compliance.++ 9. You are not required to accept this License, since you have not+signed it. However, nothing else grants you permission to modify or+distribute the Library or its derivative works. These actions are+prohibited by law if you do not accept this License. Therefore, by+modifying or distributing the Library (or any work based on the+Library), you indicate your acceptance of this License to do so, and+all its terms and conditions for copying, distributing or modifying+the Library or works based on it.++ 10. Each time you redistribute the Library (or any work based on the+Library), the recipient automatically receives a license from the+original licensor to copy, distribute, link with or modify the Library+subject to these terms and conditions. You may not impose any further+restrictions on the recipients' exercise of the rights granted herein.+You are not responsible for enforcing compliance by third parties with+this License.++ 11. If, as a consequence of a court judgment or allegation of patent+infringement or for any other reason (not limited to patent issues),+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+distribute so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you+may not distribute the Library at all. For example, if a patent+license would not permit royalty-free redistribution of the Library by+all those who receive copies directly or indirectly through you, then+the only way you could satisfy both it and this License would be to+refrain entirely from distribution of the Library.++If any portion of this section is held invalid or unenforceable under+any particular circumstance, the balance of the section is intended to+apply, and the section as a whole is intended to apply in other+circumstances.++It is not the purpose of this section to induce you to infringe any+patents or other property right claims or to contest validity of any+such claims; this section has the sole purpose of protecting the+integrity of the free software distribution system which is+implemented by public license practices. Many people have made+generous contributions to the wide range of software distributed+through that system in reliance on consistent application of that+system; it is up to the author/donor to decide if he or she is willing+to distribute software through any other system and a licensee cannot+impose that choice.++This section is intended to make thoroughly clear what is believed to+be a consequence of the rest of this License.++ 12. If the distribution and/or use of the Library is restricted in+certain countries either by patents or by copyrighted interfaces, the+original copyright holder who places the Library under this License+may add an explicit geographical distribution limitation excluding those+countries, so that distribution is permitted only in or among+countries not thus excluded. In such case, this License incorporates+the limitation as if written in the body of this License.++ 13. The Free Software Foundation may publish revised and/or new+versions of the Lesser 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 Library+specifies a version number of this License which applies to it and+"any later version", you have the option of following the terms and+conditions either of that version or of any later version published by+the Free Software Foundation. If the Library does not specify a+license version number, you may choose any version ever published by+the Free Software Foundation.++ 14. If you wish to incorporate parts of the Library into other free+programs whose distribution conditions are incompatible with these,+write to the author to ask for permission. For software which is+copyrighted by the Free Software Foundation, write to the Free+Software Foundation; we sometimes make exceptions for this. Our+decision will be guided by the two goals of preserving the free status+of all derivatives of our free software and of promoting the sharing+and reuse of software generally.++ NO WARRANTY++ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR+OTHER PARTIES PROVIDE THE LIBRARY "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+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY+AND/OR REDISTRIBUTE THE LIBRARY 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+LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH+DAMAGES.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Libraries++ If you develop a new library, and you want it to be of the greatest+possible use to the public, we recommend making it free software that+everyone can redistribute and change. You can do so by permitting+redistribution under these terms (or, alternatively, under the terms+of the ordinary General Public License).++ To apply these terms, attach the following notices to the library.+It is safest to attach them to the start of each source file to most+effectively convey 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 library's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This library is free software; you can redistribute it and/or+ modify it under the terms of the GNU Lesser General Public+ License as published by the Free Software Foundation; either+ version 2.1 of the License, or (at your option) any later version.++ This library 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+ Lesser General Public License for more details.++ You should have received a copy of the GNU Lesser General Public+ License along with this library; if not, write to the Free Software+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA++Also add information on how to contact you by electronic and paper mail.++You should also get your employer (if you work as a programmer) or+your school, if any, to sign a "copyright disclaimer" for the library,+if necessary. Here is a sample; alter the names:++ Yoyodyne, Inc., hereby disclaims all copyright interest in the+ library `Frob' (a library for tweaking knobs) written by James+ Random Hacker.++ <signature of Ty Coon>, 1 April 1990+ Ty Coon, President of Vice++That's all there is to it!++
+ COPYRIGHT view
@@ -0,0 +1,17 @@+Copyright (C) 2004 - 2007 John Goerzen <jgoerzen@complete.org>++ This library is free software; you can redistribute it and/or+ modify it under the terms of the GNU Lesser General Public+ License as published by the Free Software Foundation; either+ version 2.1 of the License, or (at your option) any later version.++ This library 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+ Lesser General Public License for more details.++ You should have received a copy of the GNU Lesser General Public+ License along with this library; if not, write to the Free Software+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA++Please see COPYING for the license.
+ HSH.cabal view
@@ -0,0 +1,28 @@+Name: HSH+Version: 1.2.0+License: LGPL+Maintainer: John Goerzen <jgoerzen@complete.org>+Author: John Goerzen+Stability: Beta+Copyright: Copyright (c) 2006-2007 John Goerzen+license-file: COPYRIGHT+extra-source-files: COPYING+homepage: http://software.complete.org/hsh+Synopsis: Library to mix shell scripting with Haskell programs+Description: HSH is designed to let you mix and match shell expressions with+ Haskell programs. With HSH, it is possible to easily run shell+ commands, capture their output or provide their input, and pipe them+ to/from other shell commands and arbitrary Haskell functions at will.+Exposed-Modules: HSH, HSH.Command, HSH.ShellEquivs+Extensions: ExistentialQuantification, OverlappingInstances,+ UndecidableInstances+Build-Depends: base, unix, mtl, regex-compat, MissingH>=0.18.0, hslogger, FilePath, regex-base, regex-posix+GHC-Options: -O2+Category: System++Executable: runtests+Buildable: False +Main-Is: runtests.hs+HS-Source-Dir: testsrc+Extensions: ExistentialQuantification, OverlappingInstances,+ UndecidableInstances
+ HSH.hs view
@@ -0,0 +1,108 @@+{- HSH -- The Haskell Shell+Copyright (C) 2004-2007 John Goerzen <jgoerzen@complete.org>+Please see the COPYRIGHT file+-}++{- |+ Module : HSH+ Copyright : Copyright (C) 2006 John Goerzen+ License : GNU LGPL, version 2.1 or above++ Maintainer : John Goerzen <jgoerzen@complete.org> + Stability : provisional+ Portability: portable++Copyright (c) 2006 John Goerzen, jgoerzen\@complete.org++Welcome to HSH, the Haskell Shell infrastructure.++<http://software.complete.org/hsh>++HSH is designed to let you mix and match shell expressions with Haskell+programs.++Here are a few examples to get you started:++>run $ "echo /etc/pass*" :: IO String+> -> "/etc/passwd /etc/passwd-"+>+>run $ "ls -l" -|- "wc -l" :: IO ()+> -> 12+>+>run $ "ls -l" -|- wcL :: IO ()+> -> 12++wcL is a pure Haskell function defined in "HSH.ShellEquivs.wcL" as:++>wcL :: [String] -> [String]+>wcL inp = [show $ genericLength inp]++Here's another example:++> let countLines = (zipWith (\i line -> printf "%-5d %s" i line) +> [(1::Int)..])::([String] -> [String])+>+> runIO $ ("ls", ["-l"]) -|- countLines -|- filter (isSuffixOf "hs")+> 6 -rw-r--r-- 1 jgoerzen jgoerzen 1285 Jun 6 09:43 HSH.hs+> 11 -rw-r--r-- 1 jgoerzen jgoerzen 565 Jun 6 09:43 test.hs++To use HSH, you\'ll just want to import the HSH module. To learn more,+please see the information in "HSH.Command" and "HSH.ShellEquivs".++You can run a command with HSH in several ways:++ * By using 'run' in a context that expects IO (), which will leave+ the final standard output going+ to the normal standard output of the program++ * By using 'run' in a context that expects a String, which will+ capture standard output into a buffer and present it as a String++ * Any of the numerous other methods documented in 'RunResult'.++ * The shortcut functions 'runIO' and 'runSL'. 'runIO' lets you run + a command and force the context IO (), which is a frequently-useful+ shortcut when you don't care about the result. 'runSL' grabs the+ first line of output in the result.++You can then specify a command, which could be a single command or a command+joined together with pipes.++There are many different items that make valid types; see the list of +instances of 'ShellCommand' for a full list. Here are a few:++ * A simple bare string is passed to the shell for execution. The shell+ will then typically expand wildcards, parse parameters, etc.++ * A @(String, [String])@ tuple. The first item in the tuple gives+ the name of a program to run, and the second gives its arguments.+ The shell is never involved. This is ideal for passing filenames,+ since there is no security risk involving special shell characters.++ * A Haskell function. This function will accept input representing+ its standard input and generate output to go to stdout. Function+ types that are supported natively include @(String -> String)@,+ @(String -> IO String)@, @([String] -> [String])@, + @([String] -> IO [String])@. Those that accept a @[String]@ type will+ have each string in the list representing a single line.++Pipes can be constructed by using the -|- operator, as illustrated above.+It is quite possible to pipe data between Haskell functions and+shell commands at will.++In addition, "HSH.ShellEquivs" provides a number of useful pure-Haskell+equivalents of regular shell commands.++For more information, please consult the other modules in HSH as well as+the HSH wiki at:++<http://software.complete.org/hsh>+-}++module HSH (+ module HSH.Command,+ module HSH.ShellEquivs+ )+where+import HSH.Command+import HSH.ShellEquivs
+ HSH/Command.hs view
@@ -0,0 +1,380 @@+{- Commands for HSH+Copyright (C) 2004-2007 John Goerzen <jgoerzen@complete.org>+Please see the COPYRIGHT file+-}++{- |+ Module : HSH.Command+ Copyright : Copyright (C) 2006-2007 John Goerzen+ License : GNU LGPL, version 2.1 or above++ Maintainer : John Goerzen <jgoerzen@complete.org> + Stability : provisional+ Portability: portable++Copyright (c) 2006-2007 John Goerzen, jgoerzen\@complete.org+-}++module HSH.Command (ShellCommand(..),+ PipeCommand(..),+ (-|-),+ RunResult,+ run,+ runIO,+ runSL,+ InvokeResult,+ tryEC,+ catchEC,+ ) where++import System.Cmd.Utils hiding (pipeBoth)+import System.IO.HVIO+import System.IO.Utils+import System.IO+import System.Exit+import System.Posix.Types+import System.Posix.IO+import System.Posix.Process+import System.Log.Logger+import System.IO.Error+import Data.Maybe.Utils+import Data.Maybe+import Data.List.Utils(uniq)+import Control.Exception(evaluate)+import System.Posix.Env+import Text.Regex.Posix+import Control.Monad(when)+import Data.String(rstrip)++d = debugM "HSH.Command"+dr = debugM "HSH.Command.Run"++{- | Result type for shell commands -}+type InvokeResult = (String, IO ProcessStatus)++{- | A shell command is something we can invoke, pipe to, pipe from,+or pipe in both directions. All commands that can be run as shell+commands must define these methods. ++Minimum implementation is 'fdInvoke'.+-}+class (Show a) => ShellCommand a where+ {- | Invoke a command. -}+ fdInvoke :: a -- ^ The command+ -> Fd -- ^ fd to pass to it as stdin+ -> Fd -- ^ fd to pass to it as stdout+ -> [Fd] -- ^ Fds to close in the child. Will not harm Fds this child needs for stdin and stdout.+ -> (IO ()) -- ^ Action to run post-fork in child (or in main process if it doesn't fork)+ -> IO [InvokeResult] -- ^ Returns an action that, when evaluated, waits for the process to finish and returns an exit code.++instance Show (String -> String) where+ show _ = "(String -> String)"+instance Show (String -> IO String) where+ show _ = "(String -> IO String)"+ +instance ShellCommand (String -> IO String) where+ fdInvoke func fstdin fstdout childclosefds childfunc =+ do -- d $ "SIOSF: Before fork"+ p <- try (forkProcess childstuff)+ pid <- case p of+ Right x -> return x+ Left x -> fail $ "Error in fork for func: " ++ show x+ -- d $ "SIOSFP: New func pid " ++ show pid+ return $ seq pid pid+ return [(show func,+ getProcessStatus True False pid >>=+ (return . forceMaybe))]+ where childstuff = do closefds childclosefds [fstdin, fstdout]+ d $ "SIOSFC Input is on " ++ show fstdin+ hr <- fdToHandle fstdin+ d $ "SIOSFC Output is on " ++ show fstdout+ hw <- fdToHandle fstdout+ hSetBuffering hw LineBuffering+ d $ "SIOSFC Running child func"+ childfunc+ d $ "SIOSFC Running func in child"+ contents <- hGetContents hr+ d $ "SIOSFC Contents read"+ result <- func contents+ d $ "SIOSFC Func applied"+ hPutStr hw result+ d $ "SIOSFC Func done, closing handles."+ hClose hr+ hClose hw+ d $ "SIOSFC Child exiting."+ -- It hung here without the exitImmediately+ --exitImmediately ExitSuccess++{- | An instance of 'ShellCommand' for a pure Haskell function mapping+String to String. Implement in terms of (String -> IO String) for+simplicity. -}+instance ShellCommand (String -> String) where+ fdInvoke func fstdin fstdout childclosefds childfunc =+ fdInvoke iofunc fstdin fstdout childclosefds childfunc+ where iofunc :: String -> IO String+ iofunc = return . func++instance Show ([String] -> [String]) where+ show _ = "([String] -> [String])"+instance Show ([String] -> IO [String]) where+ show _ = "([String] -> IO [String])"++{- | An instance of 'ShellCommand' for a pure Haskell function mapping+[String] to [String].++A [String] is generated from a Handle via the 'lines' function, and the+reverse occurs via 'unlines'.++So, this function is intended to operate upon lines of input and produce+lines of output. -}+instance ShellCommand ([String] -> [String]) where+ fdInvoke func = fdInvoke (unlines . func . lines)++{- | The same for an IO function -}+instance ShellCommand ([String] -> IO [String]) where+ fdInvoke func = fdInvoke iofunc+ where iofunc input = do r <- func (lines input)+ return (unlines r)+++{- | An instance of 'ShellCommand' for an external command. The+first String is the command to run, and the list of Strings represents the+arguments to the program, if any. -}+instance ShellCommand (String, [String]) where+ fdInvoke pc@(cmd, args) fstdin fstdout childclosefds childfunc = + do d $ "S Before fork for " ++ show pc+ p <- try (forkProcess childstuff)+ pid <- case p of+ Right x -> return x+ Left x -> fail $ "Error in fork: " ++ show x+ d $ "SP New pid " ++ show pid ++ " for " ++ show pc+ return $ seq pid pid+ return [(show (cmd, args), + getProcessStatus True False pid >>=+ (return . forceMaybe))]+ + where + childstuff = do d $ "SC preparing to redir"+ d $ "SC input is on " ++ show fstdin+ d $ "SC output is on " ++ show fstdout+ redir fstdin stdInput+ redir fstdout stdOutput+ closefds childclosefds [fstdin, fstdout, 0, 1]+ childfunc+ dr ("RUN: " ++ cmd ++ " " ++ (show args))+ executeFile cmd True args Nothing++{- | An instance of 'ShellCommand' for an external command. The+String is split using words to the command to run, and the arguments, if any. -}+instance ShellCommand String where+ fdInvoke cmdline ifd ofd closefd forkfunc = + do esh <- getEnv "SHELL"+ let sh = case esh of+ Nothing -> "/bin/sh"+ Just x -> x+ fdInvoke (sh, ["-c", cmdline]) ifd ofd closefd forkfunc++redir fromfd tofd + | fromfd == tofd = do d $ "ignoring identical redir " ++ show fromfd+ return ()+ | otherwise = do d $ "running dupTo " ++ show (fromfd, tofd)+ dupTo fromfd tofd+ closeFd fromfd++closefds :: [Fd] -- ^ List of Fds to possibly close+ -> [Fd] -- ^ List of Fds to not touch, ever+ -> IO ()+closefds inpclosefds noclosefds =+ do d $ "closefds " ++ show closefds ++ " " ++ show noclosefds+ mapM_ closeit . filter (\x -> not (x `elem` noclosefds)) $ closefds+ where closeit fd = do d $ "Closing fd " ++ show fd+ closeFd fd+ closefds = uniq inpclosefds++data (ShellCommand a, ShellCommand b) => PipeCommand a b = PipeCommand a b+ deriving Show++{- | An instance of 'ShellCommand' represeting a pipeline. -}+instance (ShellCommand a, ShellCommand b) => ShellCommand (PipeCommand a b) where+ fdInvoke pc@(PipeCommand cmd1 cmd2) fstdin fstdout childclosefds forkfunc = + do d $ "*** Handling pipe: " ++ show pc+ (reader, writer) <- createPipe+ let allfdstoclose = reader : writer : fstdin : fstdout : childclosefds+ d $ "pipd fdInvoke: New pipe endpoints: " ++ show (reader, writer)+ res1 <- fdInvoke cmd1 fstdin writer allfdstoclose forkfunc+ res2 <- fdInvoke cmd2 reader fstdout allfdstoclose forkfunc+ d $ "pipe fdInvoke: Parent closing " ++ show [reader, writer]+ mapM_ closeFd [reader, writer]+ + d $ "*** Done handling pipe " ++ show pc+ return $ res1 ++ res2++{- | Pipe the output of the first command into the input of the second. -}+(-|-) :: (ShellCommand a, ShellCommand b) => a -> b -> PipeCommand a b+(-|-) = PipeCommand ++{- | Function to use when there is nothing for the parent to do -}+nullParentFunc :: IO ()+nullParentFunc = return ()++{- | Function to use when there is nothing for the child to do -}+nullChildFunc :: IO ()+nullChildFunc = return ()++{- | Different ways to get data from 'run'. ++ * IO () runs, throws an exception on error, and sends stdout to stdout ++ * IO String runs, throws an exception on error, reads stdout into+ a buffer, and returns it as a string.++ * IO [String] is same as IO String, but returns the results as lines++ * IO ProcessStatus runs and returns a ProcessStatus with the exit+ information. stdout is sent to stdout. Exceptions are not thrown. ++ * IO (String, ProcessStatus) is like IO ProcessStatus, but also+ includes a description of the last command in the pipe to have+ an error (or the last command, if there was no error)++ * IO Int returns the exit code from a program directly. If a signal+ caused the command to be reaped, returns 128 + SIGNUM.++ * IO Bool returns True if the program exited normally (exit code 0, + not stopped by a signal) and False otherwise.++-}+class RunResult a where+ {- | Runs a command (or pipe of commands), with results presented+ in any number of different ways. -}+ run :: (ShellCommand b) => b -> a++instance RunResult (IO ()) where+ run cmd = run cmd >>= checkResults++instance RunResult (IO (String, ProcessStatus)) where+ run cmd =+ do r <- fdInvoke cmd stdInput stdOutput [] nullChildFunc+ processResults r++instance RunResult (IO ProcessStatus) where+ run cmd = ((run cmd)::IO (String, ProcessStatus)) >>= return . snd++instance RunResult (IO Int) where+ run cmd = do rc <- run cmd+ case rc of+ Exited (ExitSuccess) -> return 0+ Exited (ExitFailure x) -> return x+ Terminated x -> return (128 + (fromIntegral x))+ Stopped x -> return (128 + (fromIntegral x))+ +instance RunResult (IO Bool) where+ run cmd = do rc <- run cmd+ return ((rc::Int) == 0)++instance RunResult (IO [String]) where+ run cmd = do r <- run cmd+ return (lines r)++instance RunResult (IO String) where+ run cmd =+ do (pread, pwrite) <- createPipe+ -- d $ "runS: new pipe endpoints: " ++ show [pread, pwrite]+ -- d "runS 1"+ r <- fdInvoke cmd stdInput pwrite [pread, pwrite] nullChildFunc+ -- d $ "runS 2 closing " ++ show pwrite+ closeFd pwrite+ -- d "runS 3"+ hread <- fdToHandle pread+ -- d "runS 4"+ c <- hGetContents hread+ -- d "runS 5"+ evaluate (length c)+ -- d "runS 6"+ hClose hread+ -- d "runS 7"+ processResults r >>= checkResults+ -- d "runS 8"+ return c++{- | Evaluates the result codes and returns an overall status -}+processResults :: [InvokeResult] -> IO (String, ProcessStatus)+processResults r = + do rc <- mapM procresult r+ case catMaybes rc of+ [] -> return (fst (last r), Exited (ExitSuccess))+ x -> return (last x)+ where procresult :: InvokeResult -> IO (Maybe (String, ProcessStatus))+ procresult (cmd, action) = + do rc <- action+ return $ case rc of+ Exited (ExitSuccess) -> Nothing+ x -> Just (cmd, x)++{- | Evaluates result codes and raises an error for any bad ones it finds. -}+checkResults :: (String, ProcessStatus) -> IO ()+checkResults (cmd, ps) =+ case ps of+ Exited (ExitSuccess) -> return ()+ Exited (ExitFailure x) -> + fail $ cmd ++ ": exited with code " ++ show x+ Terminated sig -> + fail $ cmd ++ ": terminated by signal " ++ show sig+ Stopped sig ->+ fail $ cmd ++ ": stopped by signal " ++ show sig+ +{- | Handle an exception derived from a program exiting abnormally -}+tryEC :: IO a -> IO (Either ProcessStatus a)+tryEC action =+ do r <- try action+ case r of+ Left ioe ->+ if isUserError ioe then+ case (ioeGetErrorString ioe =~~ pat) of+ Nothing -> ioError ioe -- not ours; re-raise it+ Just e -> return . Left . proc $ e+ else ioError ioe -- not ours; re-raise it+ Right result -> return (Right result)+ where pat = ": exited with code [0-9]+$|: terminated by signal ([0-9]+)$|: stopped by signal [0-9]+"+ proc :: String -> ProcessStatus+ proc e + | e =~ "^: exited" = Exited (ExitFailure (str2ec e))+ | e =~ "^: terminated by signal" = Terminated (str2ec e)+ | e =~ "^: stopped by signal" = Stopped (str2ec e)+ | otherwise = error "Internal error in tryEC"+ str2ec e =+ read (e =~ "[0-9]+$")++{- | Catch an exception derived from a program exiting abnormally -}+catchEC :: IO a -> (ProcessStatus -> IO a) -> IO a+catchEC action handler =+ do r <- tryEC action+ case r of+ Left ec -> handler ec+ Right result -> return result++{- | A convenience function. Refers only to the version of 'run'+that returns @IO ()@. This prevents you from having to cast to it+all the time when you do not care about the result of 'run'. ++The implementation is simply:++>runIO :: (ShellCommand a) => a -> IO ()+>runIO = run+-}+runIO :: (ShellCommand a) => a -> IO ()+runIO = run++{- | Another convenience function. This returns the first line of the output,+with any trailing newlines or whitespace stripped off. No leading whitespace+is stripped. This function will raise an exception if there is not at least+one line of output. Mnemonic: runSL means \"run single line\". ++This command exists separately from 'run' because there is already a+'run' instance that returns a String, though that instance returns the+entirety of the output in that String. -}+runSL :: (ShellCommand a) => a -> IO String+runSL cmd =+ do r <- run cmd+ when (r == []) $ fail $ "runSL: no output received from " ++ show cmd+ return (rstrip . head $ r)
+ HSH/ShellEquivs.hs view
@@ -0,0 +1,192 @@+{- Shell Equivalents+Copyright (C) 2004-2007 John Goerzen <jgoerzen@complete.org>+Please see the COPYRIGHT file+-}++{- |+ Module : HSH.ShellEquivs+ Copyright : Copyright (C) 2007 John Goerzen+ License : GNU LGPL, version 2.1 or above++ Maintainer : John Goerzen <jgoerzen@complete.org> + Stability : provisional+ Portability: portable++Copyright (c) 2006-2007 John Goerzen, jgoerzen\@complete.org++This module provides shell-like commands. Most, but not all, are designed+to be used directly as part of a HSH pipeline. All may be used outside+HSH entirely as well.++-}++module HSH.ShellEquivs(+ abspath,+ appendTo,+ basename,+ dirname,+ catFrom,+ catTo,+ cd,+ echo,+ exit,+ grep,+ grepV,+ egrep,+ egrepV,+ pwd,+ readlink,+ readlinkabs,+ tee,+ wcL,+ ) where++import HSH.Command+import Data.List+import Text.Regex+import Control.Monad+import Control.Exception(evaluate)+import System.Directory+import System.Posix.Files+import System.Path+import System.Exit++{- | Load the specified files and display them, one at a time. ++The special file @-@ means to display the input.++If it is not given, no input is read.++Unlike the shell cat, @-@ may be given twice. However, if it is, you+will be forcing Haskell to buffer the input. ++Note: buffering behavior here is untested. +-}+catFrom :: [FilePath] -> String -> IO String+catFrom fplist inp =+ do r <- foldM foldfunc "" fplist+ return r+ where foldfunc accum fp =+ case fp of+ "-" -> return (accum ++ inp)+ fn -> do c <- readFile fn+ return (accum ++ c)++{- | Takes input, writes it to the specified file, and does not pass it on. + See also 'tee'. -}+catTo :: FilePath -> String -> IO String+catTo fp inp =+ do writeFile fp inp+ return ""++{- | Like 'catTo', but appends to the file. -}+appendTo :: FilePath -> String -> IO String+appendTo fp inp =+ do appendFile fp inp+ return ""++{- | Takes a string and sends it on as standard output.++The input to this function is never read. -}+echo :: String -> String -> String+echo inp _ = inp++{- | Takes input, writes it to all the specified files, and passes it on.++This function buffers the input. ++See also 'catFrom'. -}+tee :: [FilePath] -> String -> IO String+tee [] inp = return inp+tee (x:xs) inp = do writeFile x inp+ tee xs inp++{- | Search for the string in the lines. Return those that match. -}+grep :: String -> [String] -> [String]+grep needle = filter (isInfixOf needle)++{- | Search for the string in the lines. Return those that do NOT match. -}+grepV :: String -> [String] -> [String]+grepV needle = filter (not . isInfixOf needle)++{- | Search for the regexp in the lines. Return those that match. -}+egrep :: String -> [String] -> [String]+egrep pat = filter (ismatch regex)+ where regex = mkRegex pat+ ismatch r inp = case matchRegex r inp of+ Nothing -> False+ Just _ -> True++{- | Search for the regexp in the lines. Return those that do NOT match. -}+egrepV :: String -> [String] -> [String]+egrepV pat = filter (not . ismatch regex)+ where regex = mkRegex pat+ ismatch r inp = case matchRegex r inp of+ Nothing -> False+ Just _ -> True++{- | Count number of lines. wc -l -}+wcL :: [String] -> [String]+wcL inp = [show $ genericLength inp]++{- | An alias for System.Directory.getCurrentDirectory -}+pwd :: IO FilePath+pwd = getCurrentDirectory++{- | An alias for System.Directory.setCurrentDirectory -}+cd :: FilePath -> IO ()+cd = setCurrentDirectory++{- | Return the absolute path of the arg. Raises an error if the+computation is impossible. -}+abspath :: FilePath -> IO FilePath+abspath inp =+ do p <- pwd+ case absNormPath p inp of+ Nothing -> fail $ "Cannot make " ++ show inp ++ " absolute within " +++ show p+ Just x -> return x++{- | Return the destination that the given symlink points to.+An alias for System.Posix.Files.readSymbolicLink -}+readlink :: FilePath -> IO FilePath+readlink fp = + do issym <- (getFileStatus fp >>= return . isSymbolicLink)+ if issym+ then readSymbolicLink fp+ else return fp++{- | As 'readlink', but turns the result into an absolute path. -}+readlinkabs :: FilePath -> IO FilePath+readlinkabs inp = + do do issym <- (getFileStatus inp >>= return . isSymbolicLink)+ if issym + then do rl <- readlink inp+ case absNormPath (dirname inp) rl of+ Nothing -> fail $ "Cannot make " ++ show rl ++ " absolute within " +++ show (dirname inp)+ Just x -> return x+ else abspath inp++splitpath "" = (".", ".")+splitpath "/" = ("/", "/")+splitpath p + | last p == '/' = splitpath (init p)+ | not ('/' `elem` p) = (".", p)+ | head p == '/' && length (filter (== '/') p) == 1 = ("/", tail p)+ | otherwise = (\(base, dir) -> (reverse (tail dir), reverse base))+ (break (== '/') (reverse p))++{- | The filename part of a path -}+basename :: FilePath -> FilePath+basename = snd . splitpath++{- | The directory part of a path -}+dirname :: FilePath -> FilePath+dirname = fst . splitpath++{- | Exits with the specified error code. 0 indicates no error. -}+exit :: Int -> IO a+exit code + | code == 0 = exitWith ExitSuccess+ | otherwise = exitWith (ExitFailure code)
+ Setup.lhs view
@@ -0,0 +1,6 @@+#!/usr/bin/env runhaskell++> import Distribution.Simple++> main = defaultMain+
+ testsrc/runtests.hs view
@@ -0,0 +1,13 @@+{- +Copyright (C) 2004-2007 John Goerzen <jgoerzen@complete.org>+Please see the COPYRIGHT file+-}++module Main where ++import Test.HUnit+import Tests+import TestUtils++main = runTestTT tests+