HSH-2.1.2/0000755000175000017500000000000012423711613013666 5ustar00jgoerzenjgoerzen00000000000000HSH-2.1.2/COPYING0000644000175000017500000006363712423711613014740 0ustar00jgoerzenjgoerzen00000000000000 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. Copyright (C) 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. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! HSH-2.1.2/HSH.cabal0000644000175000017500000000326312423711613015300 0ustar00jgoerzenjgoerzen00000000000000Name: HSH Version: 2.1.2 License: LGPL Maintainer: John Goerzen Author: John Goerzen Stability: Beta Copyright: Copyright (c) 2006-2014 John Goerzen Category: system 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 and from other shell commands and arbitrary Haskell functions at will. Category: System Cabal-Version: >=1.2.3 Build-type: Simple flag buildtests description: Build the executable to run unit tests default: False library Exposed-Modules: HSH, HSH.Command, HSH.ShellEquivs, HSH.Channel Extensions: ExistentialQuantification, OverlappingInstances, UndecidableInstances, FlexibleContexts, CPP Build-Depends: base >= 4 && < 5, mtl, process, regex-compat, MissingH>=1.0.0, hslogger, filepath, regex-base, regex-posix, directory, bytestring if !os(windows) Build-Depends: unix GHC-Options: -O2 -threaded -Wall Executable runtests if flag(buildtests) Buildable: True Build-Depends: base >= 4 && < 5, mtl, process, regex-compat, MissingH>=1.0.0, hslogger, filepath, regex-base, regex-posix, directory, bytestring, HUnit, testpack if !os(windows) Build-Depends: unix else Buildable: False Main-Is: runtests.hs HS-Source-Dirs: testsrc, . Extensions: ExistentialQuantification, OverlappingInstances, UndecidableInstances, FlexibleContexts, CPP GHC-Options: -O2 -threaded HSH-2.1.2/testsrc/0000755000175000017500000000000012423711613015355 5ustar00jgoerzenjgoerzen00000000000000HSH-2.1.2/testsrc/runtests.hs0000644000175000017500000000223012423711613017575 0ustar00jgoerzenjgoerzen00000000000000{- Copyright (C) 2004-2007 John Goerzen Please see the COPYRIGHT file -} module Main where import Test.HUnit import Tests import TestUtils import System.IO import Text.Printf -- main = do runTestTT tests main = do hSetBuffering stdout LineBuffering hSetBuffering stderr LineBuffering (c, _) <- performTest reportStart reportError reportFailure () tests printf "\n TESTS COMPLETE\n" printf "Cases: %d, Tried: %d, Errors: %d, Failures: %d\n" (cases c) (tried c) (errors c) (failures c) reportStart :: ReportStart () reportStart st () = do printf "[%-4d/%-4d] START %s\n" (tried . counts $ st) (cases . counts $ st) (showPath . path $ st) hFlush stdout return () reportError :: ReportProblem () reportError = problem "ERROR " reportFailure :: ReportProblem () reportFailure = problem "FAILURE" problem :: String -> ReportProblem () problem ptype ptext st () = do printf "[%-4d/%-4d] %s\n %s\n" (tried . counts $ st) (cases . counts $ st) (showPath . path $ st) ptext hFlush stdout return () HSH-2.1.2/HSH.hs0000644000175000017500000000713112423711613014646 0ustar00jgoerzenjgoerzen00000000000000{- HSH -- The Haskell Shell Copyright (C) 2004-2007 John Goerzen Please see the COPYRIGHT file -} {- | Module : HSH Copyright : Copyright (C) 2006 John Goerzen License : GNU LGPL, version 2.1 or above Maintainer : John Goerzen Stability : provisional Portability: portable Copyright (c) 2006 John Goerzen, jgoerzen\@complete.org Welcome to HSH, the Haskell Shell infrastructure. 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-" > >runIO $ "ls -l" -|- "wc -l" > -> 12 > >runIO $ "ls -l" -|- wcL > -> 12 > >runIO $ ("ls", ["-l", "file with spaces.txt"]) >glob "~jgoerzen" >>= cd . head 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)@, plus many more involving ByteStrings and functions that take no input. See 'HSH.Command.ShellCommand' for more. 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: -} module HSH ( module HSH.Command, module HSH.ShellEquivs ) where import HSH.Command import HSH.ShellEquivsHSH-2.1.2/HSH/0000755000175000017500000000000012423711613014310 5ustar00jgoerzenjgoerzen00000000000000HSH-2.1.2/HSH/Command.hs0000644000175000017500000005666712423711613016246 0ustar00jgoerzenjgoerzen00000000000000{-# OPTIONS_GHC -XFlexibleInstances -XTypeSynonymInstances -XStandaloneDeriving #-} {- Commands for HSH Copyright (C) 2004-2008 John Goerzen Please see the COPYRIGHT file -} {- | Module : HSH.Command Copyright : Copyright (C) 2006-2009 John Goerzen License : GNU LGPL, version 2.1 or above Maintainer : John Goerzen Stability : provisional Portability: portable Copyright (c) 2006-2009 John Goerzen, jgoerzen\@complete.org -} module HSH.Command (Environment, ShellCommand(..), PipeCommand(..), (-|-), RunResult, run, runIO, runSL, InvokeResult, checkResults, tryEC, catchEC, setenv, unsetenv ) where -- import System.IO.HVIO -- import System.IO.Utils import Prelude hiding (catch) import System.IO import System.Exit import System.Log.Logger import System.IO.Error (isUserError, ioeGetErrorString) import Data.Maybe.Utils import Data.Maybe import Data.List.Utils(uniq) import Control.Exception(try, evaluate, SomeException, catch) import Text.Regex.Posix import Control.Monad(when) import Data.String.Utils(rstrip) import Control.Concurrent import System.Process import System.Environment(getEnvironment) import qualified Data.ByteString.Lazy as BSL import qualified Data.ByteString as BS import HSH.Channel d, dr :: String -> IO () d = debugM "HSH.Command" dr = debugM "HSH.Command.Run" em = errorM "HSH.Command" {- | Result type for shell commands. The String is the text description of the command, not its output. -} type InvokeResult = (String, IO ExitCode) {- | Type for the environment. -} type Environment = Maybe [(String, String)] {- | 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'. Some pre-defined instances include: * A simple bare string, which 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 @Handle -> Handle -> IO ()@ function, which reads from the first handle and write to the second. * Various functions. These functions will accept input representing its standard input and output will go to standard output. Some pre-defined instance functions include: * @(String -> String)@, @(String -> IO String)@, plus the same definitions for ByteStrings. * @([String] -> [String])@, @([String] -> IO [String])@, where each @String@ in the list represents a single line * @(() -> String)@, @(() -> IO String)@, for commands that explicitly read no input. Useful with closures. Useful when you want to avoid reading stdin because something else already is. These have the unit as part of the function because otherwise we would have conflicts with things such as bare Strings, which represent a command name. -} class (Show a) => ShellCommand a where {- | Invoke a command. -} fdInvoke :: a -- ^ The command -> Environment -- ^ The environment -> Channel -- ^ Where to read input from -> IO (Channel, [InvokeResult]) -- ^ Returns an action that, when evaluated, waits for the process to finish and returns an exit code. instance Show (Handle -> Handle -> IO ()) where show _ = "(Handle -> Handle -> IO ())" instance Show (Channel -> IO Channel) where show _ = "(Channel -> IO Channel)" instance Show (String -> String) where show _ = "(String -> String)" instance Show (() -> String) where show _ = "(() -> String)" instance Show (String -> IO String) where show _ = "(String -> IO String)" instance Show (() -> IO String) where show _ = "(() -> IO String)" instance Show (BSL.ByteString -> BSL.ByteString) where show _ = "(Data.ByteString.Lazy.ByteString -> Data.ByteString.Lazy.ByteString)" instance Show (() -> BSL.ByteString) where show _ = "(() -> Data.ByteString.Lazy.ByteString)" instance Show (BSL.ByteString -> IO BSL.ByteString) where show _ = "(Data.ByteString.Lazy.ByteString -> IO Data.ByteString.Lazy.ByteString)" instance Show (() -> IO BSL.ByteString) where show _ = "(() -> IO BSL.ByteString)" instance Show (BS.ByteString -> BS.ByteString) where show _ = "(Data.ByteString.ByteString -> Data.ByteString.ByteString)" instance Show (() -> BS.ByteString) where show _ = "(() -> Data.ByteString.ByteString)" instance Show (BS.ByteString -> IO BS.ByteString) where show _ = "(Data.ByteString.ByteString -> IO Data.ByteString.ByteString)" instance Show (() -> IO BS.ByteString) where show _ = "(() -> IO Data.ByteString.ByteString)" instance ShellCommand (String -> IO String) where fdInvoke = genericStringlikeIO chanAsString {- | A user function that takes no input, and generates output. We will deal with it using hPutStr to send the output on. -} instance ShellCommand (() -> IO String) where fdInvoke = genericStringlikeO instance ShellCommand (BSL.ByteString -> IO BSL.ByteString) where fdInvoke = genericStringlikeIO chanAsBSL instance ShellCommand (() -> IO BSL.ByteString) where fdInvoke = genericStringlikeO instance ShellCommand (BS.ByteString -> IO BS.ByteString) where fdInvoke = genericStringlikeIO chanAsBS instance ShellCommand (() -> IO BS.ByteString) where fdInvoke = genericStringlikeO {- | 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 = fdInvoke iofunc where iofunc :: String -> IO String iofunc = return . func instance ShellCommand (() -> String) where fdInvoke func = fdInvoke iofunc where iofunc :: () -> IO String iofunc = return . func instance ShellCommand (BSL.ByteString -> BSL.ByteString) where fdInvoke func = fdInvoke iofunc where iofunc :: BSL.ByteString -> IO BSL.ByteString iofunc = return . func instance ShellCommand (() -> BSL.ByteString) where fdInvoke func = fdInvoke iofunc where iofunc :: () -> IO BSL.ByteString iofunc = return . func instance ShellCommand (BS.ByteString -> BS.ByteString) where fdInvoke func = fdInvoke iofunc where iofunc :: BS.ByteString -> IO BS.ByteString iofunc = return . func instance ShellCommand (() -> BS.ByteString) where fdInvoke func = fdInvoke iofunc where iofunc :: () -> IO BS.ByteString iofunc = return . func instance ShellCommand (Channel -> IO Channel) where fdInvoke func _ cstdin = runInHandler (show func) (func cstdin) {- instance ShellCommand (Handle -> Handle -> IO ()) where fdInvoke func cstdin cstdout = runInHandler (show func) (func hstdin hstdout) -} genericStringlikeIO :: (Show (a -> IO a), Channelizable a) => (Channel -> IO a) -> (a -> IO a) -> Environment -> Channel -> IO (Channel, [InvokeResult]) genericStringlikeIO dechanfunc userfunc _ cstdin = do contents <- dechanfunc cstdin runInHandler (show userfunc) (realfunc contents) where realfunc contents = do r <- userfunc contents return (toChannel r) genericStringlikeO :: (Show (() -> IO a), Channelizable a) => (() -> IO a) -> Environment -> Channel -> IO (Channel, [InvokeResult]) genericStringlikeO userfunc _ _ = runInHandler (show userfunc) realfunc where realfunc :: IO Channel realfunc = do r <- userfunc () return (toChannel r) instance Show ([String] -> [String]) where show _ = "([String] -> [String])" instance Show (() -> [String]) where show _ = "(() -> [String])" instance Show ([String] -> IO [String]) where show _ = "([String] -> IO [String])" instance Show (() -> IO [String]) where show _ = "(() -> 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) instance ShellCommand (() -> [String]) where fdInvoke func = fdInvoke (unlines . func) {- | 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) instance ShellCommand (() -> IO [String]) where fdInvoke func = fdInvoke iofunc where iofunc :: (() -> IO String) iofunc () = do r <- func () 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 (fp, args) = genericCommand (RawCommand fp args) {- | 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 cmd = genericCommand (ShellCommand cmd) {- | How to we handle and external command. -} genericCommand :: CmdSpec -> Environment -> Channel -> IO (Channel, [InvokeResult]) -- Handling external command when stdin channel is a Handle genericCommand c environ (ChanHandle ih) = let cp = CreateProcess {cmdspec = c, cwd = Nothing, env = environ, std_in = UseHandle ih, std_out = CreatePipe, std_err = Inherit, close_fds = True #if MIN_VERSION_process(1,1,0) -- Or use GHC version as a proxy: __GLASGOW_HASKELL__ >= 720 -- Added field in process 1.1.0.0: , create_group = False #endif #if MIN_VERSION_process(1,2,0) , delegate_ctlc = False #endif } in do (_, oh', _, ph) <- createProcess cp let oh = fromJust oh' return (ChanHandle oh, [(printCmdSpec c, waitForProcess ph)]) genericCommand cspec environ ichan = let cp = CreateProcess {cmdspec = cspec, cwd = Nothing, env = environ, std_in = CreatePipe, std_out = CreatePipe, std_err = Inherit, close_fds = True #if MIN_VERSION_process(1,1,0) -- Added field in process 1.1.0.0: , create_group = False #endif #if MIN_VERSION_process(1,2,0) , delegate_ctlc = False #endif } in do (ih', oh', _, ph) <- createProcess cp let ih = fromJust ih' let oh = fromJust oh' chanToHandle True ichan ih return (ChanHandle oh, [(printCmdSpec cspec, waitForProcess ph)]) printCmdSpec :: CmdSpec -> String printCmdSpec (ShellCommand s) = s printCmdSpec (RawCommand fp args) = show (fp, args) ------------------------------------------------------------ -- Pipes ------------------------------------------------------------ data PipeCommand a b = (ShellCommand a, ShellCommand b) => PipeCommand a b deriving instance Show (PipeCommand a b) {- | An instance of 'ShellCommand' represeting a pipeline. -} instance (ShellCommand a, ShellCommand b) => ShellCommand (PipeCommand a b) where fdInvoke (PipeCommand cmd1 cmd2) env ichan = do (chan1, res1) <- fdInvoke cmd1 env ichan (chan2, res2) <- fdInvoke cmd2 env chan1 return (chan2, 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 {- | 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. Note: This output is not lazy. * IO [String] is same as IO String, but returns the results as lines. Note: this output is not lazy. * IO ExitCode runs and returns an ExitCode with the exit information. stdout is sent to stdout. Exceptions are not thrown. * IO (String, ExitCode) is like IO ExitCode, 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 ByteString and are similar to their String counterparts. * IO (String, IO (String, ExitCode)) returns a String read lazily and an IO action that, when evaluated, finishes up the process and results in its exit status. This command returns immediately. * IO (IO (String, ExitCode)) sends stdout to stdout but returns immediately. It forks off the child but does not wait for it to finish. You can use 'checkResults' to wait for the finish. * 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. To address insufficient laziness, you can process anything that needs to be processed lazily within the pipeline itself. -} 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, ExitCode)) where run cmd = do (ochan, r) <- fdInvoke cmd Nothing (ChanHandle stdin) chanToHandle False ochan stdout processResults r instance RunResult (IO ExitCode) where run cmd = ((run cmd)::IO (String, ExitCode)) >>= return . snd instance RunResult (IO Int) where run cmd = do rc <- run cmd case rc of ExitSuccess -> return 0 ExitFailure x -> return 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 = genericStringlikeResult chanAsString (\c -> evaluate (length c)) cmd instance RunResult (IO BSL.ByteString) where run cmd = genericStringlikeResult chanAsBSL (\c -> evaluate (BSL.length c)) cmd instance RunResult (IO BS.ByteString) where run cmd = genericStringlikeResult chanAsBS (\c -> evaluate (BS.length c)) cmd instance RunResult (IO (String, IO (String, ExitCode))) where run cmd = intermediateStringlikeResult chanAsString cmd instance RunResult (IO (BSL.ByteString, IO (String, ExitCode))) where run cmd = intermediateStringlikeResult chanAsBSL cmd instance RunResult (IO (BS.ByteString, IO (String, ExitCode))) where run cmd = intermediateStringlikeResult chanAsBS cmd instance RunResult (IO (IO (String, ExitCode))) where run cmd = do (ochan, r) <- fdInvoke cmd Nothing (ChanHandle stdin) chanToHandle False ochan stdout return (processResults r) intermediateStringlikeResult :: ShellCommand b => (Channel -> IO a) -> b -> IO (a, IO (String, ExitCode)) intermediateStringlikeResult chanfunc cmd = do (ochan, r) <- fdInvoke cmd Nothing (ChanHandle stdin) c <- chanfunc ochan return (c, processResults r) genericStringlikeResult :: ShellCommand b => (Channel -> IO a) -> (a -> IO c) -> b -> IO a genericStringlikeResult chanfunc evalfunc cmd = do (c, r) <- intermediateStringlikeResult chanfunc cmd evalfunc c --evaluate (length c) -- d "runS 6" -- d "runS 7" r >>= checkResults -- d "runS 8" return c {- | Evaluates the result codes and returns an overall status -} processResults :: [InvokeResult] -> IO (String, ExitCode) processResults r = do rc <- mapM procresult r case catMaybes rc of [] -> return (fst (last r), ExitSuccess) x -> return (last x) where procresult :: InvokeResult -> IO (Maybe (String, ExitCode)) procresult (cmd, action) = do rc <- action return $ case rc of ExitSuccess -> Nothing x -> Just (cmd, x) {- | Evaluates result codes and raises an error for any bad ones it finds. -} checkResults :: (String, ExitCode) -> IO () checkResults (cmd, ps) = case ps of ExitSuccess -> return () ExitFailure x -> fail $ cmd ++ ": exited with code " ++ show x {- FIXME: generate these again 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 ExitCode a) tryEC action = do r <- Control.Exception.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 . procit $ 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]+" procit :: String -> ExitCode procit e | e =~ "^: 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 -> (ExitCode -> 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) {- | Convenience function to wrap a child thread. Kicks off the thread, handles running the code, traps execptions, the works. Note that if func is lazy, such as a getContents sort of thing, the exception may go uncaught here. NOTE: expects func to be lazy! -} runInHandler :: String -- ^ Description of this function -> (IO Channel) -- ^ The action to run in the thread -> IO (Channel, [InvokeResult]) runInHandler descrip func = catch (realfunc) (exchandler) where realfunc = do r <- func return (r, [(descrip, return ExitSuccess)]) exchandler :: SomeException -> IO (Channel, [InvokeResult]) exchandler e = do em $ "runInHandler/" ++ descrip ++ ": " ++ show e return (ChanString "", [(descrip, return (ExitFailure 1))]) ------------------------------------------------------------ -- Environment ------------------------------------------------------------ {- | An environment variable filter function. This is a low-level interface; see 'setenv' and 'unsetenv' for more convenient interfaces. -} type EnvironFilter = [(String, String)] -> [(String, String)] instance Show EnvironFilter where show _ = "EnvironFilter" {- | A command that carries environment variable information with it. This is a low-level interface; see 'setenv' and 'unsetenv' for more convenient interfaces. -} data EnvironCommand a = (ShellCommand a) => EnvironCommand EnvironFilter a deriving instance Show (EnvironCommand a) instance (ShellCommand a) => ShellCommand (EnvironCommand a) where fdInvoke (EnvironCommand efilter cmd) Nothing ichan = do -- No incoming environment; initialize from system default. e <- getEnvironment fdInvoke cmd (Just (efilter e)) ichan fdInvoke (EnvironCommand efilter cmd) (Just ienv) ichan = fdInvoke cmd (Just (efilter ienv)) ichan {- | Sets an environment variable, replacing an existing one if it exists. Here's a sample ghci session to illustrate. First, let's see the defaults for some variables: > Prelude HSH> runIO $ "echo $TERM, $LANG" > xterm, en_US.UTF-8 Now, let's set one: > Prelude HSH> runIO $ setenv [("TERM", "foo")] $ "echo $TERM, $LANG" > foo, en_US.UTF-8 Or two: > Prelude HSH> runIO $ setenv [("TERM", "foo")] $ setenv [("LANG", "de_DE.UTF-8")] $ "echo $TERM, $LANG" > foo, de_DE.UTF-8 We could also do it easier, like this: > Prelude HSH> runIO $ setenv [("TERM", "foo"), ("LANG", "de_DE.UTF-8")] $ "echo $TERM, $LANG" > foo, de_DE.UTF-8 It can be combined with unsetenv: > Prelude HSH> runIO $ setenv [("TERM", "foo")] $ unsetenv ["LANG"] $ "echo $TERM, $LANG" > foo, And used with pipes: > Prelude HSH> runIO $ setenv [("TERM", "foo")] $ "echo $TERM, $LANG" -|- "tr a-z A-Z" > FOO, EN_US.UTF-8 See also 'unsetenv'. -} setenv :: (ShellCommand cmd) => [(String, String)] -> cmd -> EnvironCommand cmd setenv items cmd = EnvironCommand efilter cmd where efilter ienv = foldr efilter' ienv items efilter' (key, val) ienv = (key, val) : (filter (\(k, _) -> k /= key) ienv) {- | Removes an environment variable if it exists; does nothing otherwise. See also 'setenv', which has a more extensive example. -} unsetenv :: (ShellCommand cmd) => [String] -> cmd -> EnvironCommand cmd unsetenv keys cmd = EnvironCommand efilter cmd where efilter ienv = foldr efilter' ienv keys efilter' key = filter (\(k, _) -> k /= key) HSH-2.1.2/HSH/ShellEquivs.hs0000644000175000017500000004023612423711613017115 0ustar00jgoerzenjgoerzen00000000000000{-# LANGUAGE ScopedTypeVariables #-} {- Shell Equivalents Copyright (C) 2004-2009 John Goerzen Please see the COPYRIGHT file -} {- | Module : HSH.ShellEquivs Copyright : Copyright (C) 2009 John Goerzen License : GNU LGPL, version 2.1 or above Maintainer : John Goerzen Stability : provisional Portability: portable Copyright (c) 2006-2009 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. -} {-# LANGUAGE ScopedTypeVariables #-} #if !(defined(mingw32_HOST_OS) || defined(mingw32_TARGET_OS) || defined(__MINGW32__)) #define __HSH_POSIX__ #else #define __HSH_WINDOWS__ #endif module HSH.ShellEquivs( abspath, appendTo, basename, bracketCD, catFrom, catBytes, catBytesFrom, catTo, #ifdef __HSH_POSIX__ catToFIFO, #endif cd, cut, cutR, dirname, discard, echo, exit, glob, grep, grepV, egrep, egrepV, joinLines, lower, upper, mkdir, numberLines, pwd, #ifdef __HSH_POSIX__ readlink, readlinkabs, #endif rev, revW, HSH.Command.setenv, space, unspace, tac, tee, #ifdef __HSH_POSIX__ teeFIFO, #endif tr, trd, wcW, wcL, HSH.Command.unsetenv, uniq, ) where import Data.List (genericLength, intersperse, isInfixOf, nub) import Data.Char (toLower, toUpper) import Text.Regex (matchRegex, mkRegex) import Text.Printf (printf) import Control.Monad (foldM) import System.Directory hiding (createDirectory) import qualified Control.Exception as E -- import System.FilePath (splitPath) #ifdef __HSH_POSIX__ import System.Posix.Files (getFileStatus, isSymbolicLink, readSymbolicLink) import System.Posix.User (getEffectiveUserName, getUserEntryForName, homeDirectory) import System.Posix.Directory (createDirectory) import System.Posix.Types (FileMode()) import System.Posix.IO import System.Posix.Error #endif import System.Path (absNormPath, bracketCWD) import System.Exit import System.IO import System.Process import qualified System.Directory as SD import qualified System.Path.Glob as Glob (glob) import qualified Data.ByteString.Lazy as BSL import qualified Data.ByteString as BS import System.IO.Unsafe(unsafeInterleaveIO) import HSH.Channel import HSH.Command(setenv, unsetenv) {- | Return the absolute path of the arg. Raises an error if the computation is impossible. This is a thin wrapper around System.Path.absNormPath. Unix/Linux users note: System.Path.absNormPath is known to produce odd results when a tilde expansion is requested; you might prefer 'glob' to this function if you know your input is free of wildcards. See https://github.com/jgoerzen/hsh/issues/7 for details. -} 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 {- | The filename part of a path -} basename :: FilePath -> FilePath basename = snd . splitpath {- | The directory part of a path -} dirname :: FilePath -> FilePath dirname = fst . splitpath {- | Changes the current working directory to the given path, executes the given I\/O action, then changes back to the original directory, even if the I\/O action raised an exception. This is an alias for the MissingH function System.Path.bracketCWD. -} bracketCD :: FilePath -> IO a -> IO a bracketCD = bracketCWD {- | 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 processed at all. @-@ may be given a maximum of one time. See also 'catBytes' . -} catFrom :: [FilePath] -> Channel -> IO Channel catFrom fplist ichan = do r <- foldM foldfunc BSL.empty fplist return (toChannel r) where foldfunc accum fp = case fp of "-" -> do c <- chanAsBSL ichan return (BSL.append accum c) fn -> do c <- BSL.readFile fn return (BSL.append accum c) {- | Copy data from input to output, optionally with a fixed maximum size, in bytes. Processes data using ByteStrings internally, so be aware of any possible UTF-8 conversions. You may wish to use @hSetBuffering h (BlockBuffering Nothing)@ prior to calling this function for optimal performance. See also 'catFrom', 'catBytesFrom' -} catBytes :: (Maybe Integer) -- ^ Maximum amount of data to transfer -> Channel -- ^ Handle for input -> IO Channel catBytes count hr = catBytesFrom hr count hr {- | Generic version of 'catBytes'; reads data from specified Channel, and ignores stdin. -} catBytesFrom :: Channel -- ^ Handle to read from -> (Maybe Integer) -- ^ Maximum amount of data to transfer -> Channel -- ^ Handle for input (ignored) -> IO Channel catBytesFrom (ChanHandle hr) count cignore = case count of Nothing -> return (ChanHandle hr) Just m -> do c <- BSL.hGet hr (fromIntegral m) return (ChanBSL c) catBytesFrom cinput count cignore = case count of Nothing -> return cinput Just m -> do r <- chanAsBSL cinput return (ChanBSL (BSL.take (fromIntegral m) r)) {- | Takes input, writes it to the specified file, and does not pass it on. The return value is the empty string. See also 'catToBS', 'catToFIFO' -} catTo :: FilePath -> Channel -> IO Channel catTo fp ichan = do ofile <- openFile fp WriteMode chanToHandle True ichan ofile return (ChanString "") #ifdef __HSH_POSIX__ {- | Like 'catTo', but opens the destination in ReadWriteMode instead of ReadOnlyMode. Due to an oddity of the Haskell IO system, this is required when writing to a named pipe (FIFO) even if you will never read from it. This call will BLOCK all threads on open until a reader connects. This is provided in addition to 'catTo' because you may want to cat to something that you do not have permission to read from. This function is only available on POSIX platforms. See also 'catTo' -} catToFIFO :: FilePath -> Channel -> IO Channel catToFIFO fp ichan = do h <- fifoOpen fp chanToHandle True ichan h return (ChanString "") fifoOpen :: FilePath -> IO Handle fifoOpen fp = do fd <- throwErrnoPathIf (< 0) "HSH fifoOpen" fp $ openFd fp WriteOnly Nothing defaultFileFlags fdToHandle fd #endif {- | Like 'catTo', but appends to the file. -} appendTo :: FilePath -> String -> IO String appendTo fp inp = do appendFile fp inp return "" {- | An alias for System.Directory.setCurrentDirectory. Want to change to a user\'s home directory? Try this: > glob "~jgoerzen" >>= cd . head See also 'bracketCD'. -} cd :: FilePath -> IO () cd = setCurrentDirectory {- | Split a list by a given character and select the nth list. > cut ' ' 2 "foo bar baz quux" -> "bar" -} cut :: Integer -> Char -> String -> String cut pos = cutR [pos] {- | Read all input and produce no output. Discards input completely. -} discard :: Channel -> IO Channel discard inh = do c <- chanAsBSL inh E.evaluate (BSL.length c) return (ChanString "") {- | Split a list by a given character and select ranges of the resultant lists. > cutR [2..4] ' ' "foo bar baz quux foobar" -> "baz quux foobar" > cutR [1..1000] ' ' "foo bar baz quux foobar" -> "bar baz quux foobar" > cutR [-1000..1000] ' ' "foo bar baz quux foobar" -> "foo bar baz quux foobar" Note that too large and too small indices are essentially ignored. -} cutR :: [Integer] -> Char -> String -> String cutR nums delim z = drop 1 $ concat [delim:x | (x, y) <- zip string [0..], elem y nums] where string = split delim z {- | Takes a string and sends it on as standard output. The input to this function is never read. You can pass this thing a String, a ByteString, or even a Handle. See also 'echoBS'. -} echo :: Channelizable a => a -> Channel -> IO Channel echo inp _ = return . toChannel $ inp {- | 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 {- | Exits with the specified error code. 0 indicates no error. -} exit :: Int -> IO a exit code | code == 0 = exitWith ExitSuccess | otherwise = exitWith (ExitFailure code) {- | Takes a pattern. Returns a list of names that match that pattern. Handles: >~username at beginning of file to expand to user's home dir >? matches exactly one character >* matches zero or more characters >[list] matches any character in list >[!list] matches any character not in list The result of a tilde expansion on a nonexistant username is to do no tilde expansion. The tilde with no username equates to the current user. Non-tilde expansion is done by the MissingH module System.Path.Glob. -} glob :: FilePath -> IO [FilePath] glob inp@('~':remainder) = E.catch expanduser (\(e::E.SomeException) -> Glob.glob rest) where (username, rest) = span (/= '/') remainder #ifdef __HSH_POSIX__ expanduser = do lookupuser <- if username /= "" then return username else getEffectiveUserName ue <- getUserEntryForName lookupuser Glob.glob (homeDirectory ue ++ rest) #else expanduser = fail "non-posix; will be caught above" #endif glob x = Glob.glob x {- | Search for the string in the lines. Return those that match. Same as: > grep needle = filter (isInfixOf needle) -} grep :: String -> [String] -> [String] grep = filter . isInfixOf {- | Search for the string in the lines. Return those that do NOT match. -} grepV :: String -> [String] -> [String] grepV needle = filter (not . isInfixOf needle) -- | Join lines of a file joinLines :: [String] -> [String] joinLines = return . concat #ifdef __HSH_POSIX__ {- | Creates the given directory. A value of 0o755 for mode would be typical. An alias for System.Posix.Directory.createDirectory. The second argument will be ignored on non-POSIX systems. -} mkdir :: FilePath -> FileMode -> IO () mkdir = createDirectory #else mkdir :: FilePath -> a -> IO () mkdir fp _ = SD.createDirectory fp #endif {- | Number each line of a file -} numberLines :: [String] -> [String] numberLines = zipWith (printf "%3d %s") [(1::Int)..] {- | An alias for System.Directory.getCurrentDirectory. -} pwd :: IO FilePath pwd = getCurrentDirectory #ifdef __HSH_POSIX__ {- | Return the destination that the given symlink points to. An alias for System.Posix.Files.readSymbolicLink This function is only available on POSIX platforms. -} 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. This function is only available on POSIX platforms. -} readlinkabs :: FilePath -> IO FilePath readlinkabs inp = 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 #endif {- | Reverse characters on each line (rev) -} rev, revW :: [String] -> [String] rev = map reverse {- | Reverse words on each line -} revW = map (unwords . reverse . words) {- | Reverse lines in a String (like Unix tac). Implemented as: > tac = reverse See 'uniq'. -} tac :: [String] -> [String] tac = reverse {- | Takes input, writes it to all the specified files, and passes it on. This function does /NOT/ buffer input. See also 'catFrom'. -} tee :: [FilePath] -> Channel -> IO Channel tee fplist inp = teeBSGeneric (\fp -> openFile fp WriteMode) fplist inp #ifdef __HSH_POSIX__ {- | FIFO-safe version of 'tee'. This call will BLOCK all threads on open until a reader connects. This function is only available on POSIX platforms. -} teeFIFO :: [FilePath] -> Channel -> IO Channel teeFIFO fplist inp = teeBSGeneric fifoOpen fplist inp #endif teeBSGeneric :: (FilePath -> IO Handle) -> [FilePath] -> Channel -> IO Channel teeBSGeneric openfunc fplist ichan = do handles <- mapM openfunc fplist inp <- chanAsBSL ichan resultChunks <- hProcChunks handles (BSL.toChunks inp) return (ChanBSL $ BSL.fromChunks resultChunks) where hProcChunks :: [Handle] -> [BS.ByteString] -> IO [BS.ByteString] hProcChunks handles chunks = unsafeInterleaveIO $ case chunks of [] -> do mapM_ hClose handles return [BS.empty] (x:xs) -> do mapM_ (\h -> BS.hPutStr h x) handles remainder <- hProcChunks handles xs return (x : remainder) {- | Translate a character x to y, like: >tr 'e' 'f' Or, in sed, >y// -} tr :: Char -> Char -> String -> String tr a b = map (\x -> if x == a then b else x) {- | Delete specified character in a string. -} trd :: Char -> String -> String trd = filter . (/=) {- | Remove duplicate lines from a file (like Unix uniq). Takes a String representing a file or output and plugs it through lines and then nub to uniqify on a line basis. -} uniq :: String -> String uniq = unlines . nub . lines {- | Double space a file; add an empty line between each line. -} space :: [String] -> [String] space = intersperse "" {- | Inverse of double 'space'; drop all empty lines. -} unspace :: [String] -> [String] unspace = filter (not . null) {- | Convert a string to all lower case -} lower :: String -> String lower = map toLower {- | Convert a string to all upper case -} upper :: String -> String upper = map toUpper {- | Count number of lines. Like wc -l -} wcL :: [String] -> [String] wcL inp = [show (genericLength inp :: Integer)] {- | Count number of words in a file (like wc -w) -} wcW :: [String] -> [String] wcW inp = [show ((genericLength $ words $ unlines inp) :: Integer)] {- Utility function. > split ' ' "foo bar baz" -> ["foo","bar","baz"] -} split :: Char -> String -> [String] split c s = case rest of [] -> [chunk] _:rst -> chunk : split c rst where (chunk, rest) = break (==c) s -- TODO: Perhaps simplify to make use of split splitpath :: String -> (String, String) 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)) HSH-2.1.2/HSH/Channel.hs0000644000175000017500000000514712423711613016223 0ustar00jgoerzenjgoerzen00000000000000{-# OPTIONS_GHC -XFlexibleInstances -XTypeSynonymInstances #-} {- Channel basics for HSH Copyright (C) 2004-2008 John Goerzen Please see the COPYRIGHT file -} {- | Module : HSH.Channel Copyright : Copyright (C) 2006-2009 John Goerzen License : GNU LGPL, version 2.1 or above Maintainer : John Goerzen Stability : provisional Portability: portable Copyright (c) 2006-2009 John Goerzen, jgoerzen\@complete.org -} module HSH.Channel (Channel(..), chanAsString, chanAsBSL, chanAsBS, chanToHandle, Channelizable(..) ) where import qualified Data.ByteString.Lazy as BSL import qualified Data.ByteString as BS import qualified Data.ByteString.Lazy.Char8 as BSLC import System.IO import Control.Concurrent {- | The main type for communicating between commands. All are expected to be lazy. -} data Channel = ChanString String | ChanBSL BSL.ByteString | ChanHandle Handle chanAsString :: Channel -> IO String chanAsString (ChanString s) = return s chanAsString (ChanBSL s) = return . bsl2str $ s chanAsString (ChanHandle h) = hGetContents h chanAsBSL :: Channel -> IO BSL.ByteString chanAsBSL (ChanString s) = return . str2bsl $ s chanAsBSL (ChanBSL s) = return s chanAsBSL (ChanHandle h) = BSL.hGetContents h chanAsBS :: Channel -> IO BS.ByteString chanAsBS c = do r <- chanAsBSL c let contents = BSL.toChunks r return . BS.concat $ contents {- | Writes the Channel to the given Handle. If the first parameter is True, do this in a separate thread and close the handle afterwards. -} chanToHandle :: Bool -> Channel -> Handle -> IO () chanToHandle close c h = if close then forkIO (dumpChanToHandle c h >> hClose h) >> return () else dumpChanToHandle c h where dumpChanToHandle (ChanString s) h = hPutStr h s dumpChanToHandle (ChanBSL s) h = BSL.hPut h s dumpChanToHandle (ChanHandle srchdl) desthdl = BSL.hGetContents srchdl >>= BSL.hPut desthdl class Channelizable a where toChannel :: a -> Channel instance Channelizable String where toChannel = ChanString instance Channelizable BSL.ByteString where toChannel = ChanBSL instance Channelizable Handle where toChannel = ChanHandle instance Channelizable BS.ByteString where toChannel bs = ChanBSL . BSL.fromChunks $ [bs] str2bsl :: String -> BSL.ByteString str2bsl = BSLC.pack bsl2str :: BSL.ByteString -> String bsl2str = BSLC.unpack HSH-2.1.2/COPYRIGHT0000644000175000017500000000151512423711613015163 0ustar00jgoerzenjgoerzen00000000000000Copyright (C) 2004 - 2007 John Goerzen 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-2.1.2/Setup.lhs0000644000175000017500000000011712423711613015475 0ustar00jgoerzenjgoerzen00000000000000#!/usr/bin/env runhaskell > import Distribution.Simple > main = defaultMain