diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, 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. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies 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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +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 program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +Description +=========== +Generate package description from .cabal files in format of exheres-0 for +Exherbo Linux. + +Usage +----- +As a source you can use one of the following reference: +- ./LOCAL-FILE.cabal and /LOCAL-FILE.cabal: read from LOCAL-FILE.cabal +- PACKAGE-VERSION: fetch appropriate package from Hackage + +You can either pass sources as a list of arguments or as lines of standard +input if no arguments provided. + +Examples +-------- +``` +> exherbo-cabal mtl-2.2.1 +> exherbo-cabal mtl transformers +> echo yesod-core | exherbo-cabal +> exherbo-cabal ./exherbo-cabal.cabal +> find /tmp/index -name \*.cabal | exherbo-cabal +``` diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/exherbo-cabal.cabal b/exherbo-cabal.cabal new file mode 100644 --- /dev/null +++ b/exherbo-cabal.cabal @@ -0,0 +1,83 @@ +-- Initial exherbo-cabal.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: exherbo-cabal + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.1.0.0 + +-- A short (one-line) description of the package. +synopsis: Exheres generator for cabal packages + +-- A longer description of the package. +description: Generate package description from .cabal files in format + of exheres-0 for Exherbo Linux. + +-- The license under which the package is released. +license: GPL-2 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Mykola Orliuk + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: virkony@gmail.com + +-- A copyright notice. +-- copyright: + +category: Distribution + +build-type: Simple + +-- Extra files to be distributed with the package, such as examples or a +-- README. +extra-source-files: README.md + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/ony/exherbo-cabal + +executable exherbo-cabal + -- .hs or .lhs file containing the Main module. + main-is: Main.hs + + -- Modules included in this executable, other than Main. + other-modules: ExRender + + -- LANGUAGE extensions used by modules in this package. + other-extensions: + FlexibleInstances, + OverloadedStrings, + UnicodeSyntax, + ViewPatterns + + -- Other library packages from which modules are imported. + build-depends: + Cabal >=1.18 && <1.19, + base >=4.7 && <4.8, + bytestring >=0.10 && <0.11, + containers, + haddock-library >=1.0 && <1.3, + http-client >=0.4 && <0.5, + pcre-light <0.5, + pretty >=1.1 && <1.2 + + -- Directories containing source files. + -- hs-source-dirs: + hs-source-dirs: src + + -- Base language which the package is written in. + default-language: Haskell2010 diff --git a/src/ExRender.hs b/src/ExRender.hs new file mode 100644 --- /dev/null +++ b/src/ExRender.hs @@ -0,0 +1,277 @@ +-- Copyright © 2015 Mykola Orliuk +-- Distributed under the terms of the GNU General Public License v2 + +{-# LANGUAGE UnicodeSyntax, ViewPatterns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleInstances #-} + +module ExRender (exDisp, exDispQ, exRender) where + +import Data.Maybe +import Data.List +import Data.Function +import qualified Data.Map as M +import Text.PrettyPrint + +import Control.Arrow ((&&&)) + +import Distribution.Text +import Distribution.Package +import Distribution.Version +import Distribution.License +import Distribution.Compiler +import Distribution.System +import Distribution.PackageDescription +import Documentation.Haddock.Parser +import Documentation.Haddock.Types hiding (Version) + +exWrapWidth ∷ Int +exWrapWidth = 80 + +exGHCVersion ∷ Version +exGHCVersion = Version [7, 8, 2] [] -- TODO: solve this hard-coded GHC version assumption + +exKnownLicenses ∷ [String] +exKnownLicenses = ["CC0"] + +dquoted ∷ String → String +dquoted [] = [] +dquoted ('\\':xs) = "\\\\" ++ dquoted xs +dquoted ('"':xs) = "\\\"" ++ dquoted xs +dquoted (x:xs) = x : dquoted xs + +softWidth ∷ Int → [String] → [[String]] +softWidth width = build 0 [] where + build _ ys [] = [reverse ys] + build 0 [] (w:ws) = build (length w) [w] ws + build n ys (w:ws) | n' > width = reverse ys : build 0 [] (w:ws) + | otherwise = build n' (w : ys) ws + where + n' = length w + n + +reflow ∷ Int → String → Doc +reflow width = vcat . map (text . unwords) . softWidth width . words + +-- |Wrap doc with spaces around +spaces ∷ Doc → Doc +spaces doc | isEmpty doc = empty + | otherwise = space <> doc <> space + +-- |Wrap with brackets non-empty doc +nbrackets ∷ Doc → Doc +nbrackets doc | isEmpty doc = empty + | otherwise = brackets doc + +class ExRender a where + -- |Renders 'a' into a 'Doc' representing some part of exheres + exDisp :: a → Doc + +class ExRenderQ a where + -- |Renders 'a' into a 'Doc' to be placed within double-quotes inside of exheres + exDispQ :: a → Doc + +instance ExRenderQ String where + -- TODO: exDispQ = sep . map text . words . dquoted + exDispQ = text . dquoted + +instance ExRender Identifier where exDisp (_, s, _) = text s +instance ExRenderQ Identifier where exDispQ = exDisp + +instance ExRenderQ id => ExRenderQ (DocH mod id) where + exDispQ x = case x of + DocEmpty → empty + DocAppend a b → exDispQ a <> exDispQ b + DocString s → exDispQ s + DocParagraph a → exDispQ a + DocIdentifier s → exDispQ s + DocModule s → exDispQ s + DocWarning a → exDispQ a + DocEmphasis a → exDispQ a + DocMonospaced a → exDispQ a + DocBold a → exDispQ a + DocHyperlink (Hyperlink _ (Just s)) → exDispQ s + DocHyperlink (Hyperlink s Nothing) → exDispQ s + DocPic _ → empty -- XXX: no images in description + DocAName s → exDispQ s + DocProperty s → exDispQ s + DocExamples _ → empty -- XXX: examples are filtered out + +instance ExRender LowerBound where + exDisp (LowerBound v InclusiveBound) = ">=" <> disp v + exDisp (LowerBound v ExclusiveBound) = ">" <> disp v + +instance ExRender UpperBound where + exDisp (UpperBound v InclusiveBound) = "<=" <> disp v + exDisp (UpperBound v ExclusiveBound) = "<" <> disp v + exDisp x = error $ "Unsupported UpperBound: " ++ show x + +instance ExRender VersionInterval where + exDisp (LowerBound v InclusiveBound, + UpperBound v' InclusiveBound) | v == v' = brackets ("=" <> disp v) + exDisp (LowerBound (Version [0] []) InclusiveBound, NoUpperBound) = empty + exDisp (LowerBound (Version [0] []) InclusiveBound, ub) = brackets (exDisp ub) + exDisp (lb, NoUpperBound) = brackets (exDisp lb) + exDisp (lb, ub) = brackets (exDisp lb <> char '&' <> exDisp ub) + +instance ExRender VersionRange where + exDisp vr = case asVersionIntervals vr of + [vi] → exDisp vi + _ → error $ "Unsupported version range: " ++ display vr + +instance ExRender Dependency where + exDisp (Dependency n vr) = "dev-haskell/" <> disp n <> exDisp vr + +instance ExRender License where + exDisp (GPL Nothing) = "Unspecified-GPL" + exDisp (GPL (Just v)) = "GPL-" <> disp v + exDisp (AGPL (Just v)) = "AGPL-" <> disp v + exDisp (LGPL Nothing) = "Unspecified-LGPL" + exDisp (LGPL (Just v)) = "LGPL-" <> disp v + exDisp (Apache Nothing) = "Unspecified-Apache" + exDisp (Apache (Just v)) = "Apache-" <> disp v + exDisp BSD3 = "BSD-3" + exDisp BSD4 = "BSD-4" + exDisp MIT = "MIT" + exDisp (UnknownLicense "BSD2") = "BSD-2" + exDisp (UnknownLicense "MPL-2") = "MPL-2.0" + exDisp (UnknownLicense x) | x `elem` exKnownLicenses = text x + exDisp x = error $ "Unsupported license: " ++ display x + +instance ExRender GenericPackageDescription where + exDisp descr = exheres where + nameSelf = pkgName . package $ packageDescription descr + ignoredPkgIds = map (fromJust . simpleParse) ["base", "ghc", "ghc-prim"] + + ignoredDep (Dependency n _) | n `elem` ignoredPkgIds = True + ignoredDep _ = False + ignoredTestDep (Dependency n _) | n == nameSelf = True + ignoredTestDep d = ignoredDep d + ignoredBinDep (Dependency n _) | n == nameSelf = True + ignoredBinDep d = ignoredDep d + + exDepFn name deps = vcat [ + text ("$(" ++ name) <> " \"", + nest 4 . vcat . map exDisp . mergeSortedDeps $ sortDeps deps, + "\")"] + + exLibDeps | null libDeps = empty + | otherwise = exDepFn "haskell_lib_dependencies" libDeps + where + libDeps = filter (not . ignoredDep) (collectLibDeps descr) + + exBinDeps | null binDeps = empty + | otherwise = exDepFn "haskell_bin_dependencies" binDeps + where + binDeps = filter (not . ignoredBinDep) (collectBinDeps descr) + + exTestDeps = case condTestSuites descr of + [] → empty + _ → exDepFn "haskell_test_dependencies" testDeps where + testDeps = filter (not . ignoredTestDep) (collectTestDeps descr) + + exDependencies = vcat [ + "DEPENDENCIES=\"", + nest 4 exLibDeps, + nest 4 exTestDeps, + nest 4 exBinDeps, + "\""] + + pkgDescr = packageDescription descr + + hasLib = isJust $ condLibrary descr + hasBin = not . null $ condExecutables descr + hasMods = maybe False (not . null . exposedModules . condTreeData) . condLibrary $ descr + exRequire = "require hackage" <+> nbrackets exParams + where + exHasLib = if hasLib then empty else "has_lib=false" + exHasBin = if hasBin then "has_bin=true" else empty + exHasOptions | hasMods || not hasLib = empty + | otherwise = hsep [ + "has_haddock=false", + "has_hscolour=false", + "has_profile=false" + ] + exParams = spaces $ exHasLib <+> exHasBin <+> exHasOptions + + exheres = vcat [ + "# Copyright 2015 Mykola Orliuk ", + "# Distributed under the terms of the GNU General Public License v2", + "# Generated for " <> disp (package pkgDescr), + "", + exRequire, + "", + exField "SUMMARY" (synopsis pkgDescr), + exFieldDoc "DESCRIPTION" (exDispQ . toRegular . parseString $ description pkgDescr), + exField "HOMEPAGE" (homepage pkgDescr), + "", + exField "LICENCES" (exRender $ license pkgDescr), + exField "PLATFORMS" "~amd64", + "", + exDependencies, + "", + exField "BUGS_TO" "virkony@gmail.com", + "" + ] + +-- |Collect dependencies from all 'CondTree' nodes of +-- 'GenericPackageDescription' using provided view +collectDeps ∷ (GenericPackageDescription → [CondTree ConfVar [Dependency] a]) + → GenericPackageDescription → [Dependency] +collectDeps view descr = concatMap build (view descr) where + flags = M.fromList . map (flagName &&& id) $ genPackageFlags descr + eval (Var (Flag k)) = flagDefault . fromJust $ M.lookup k flags + eval (Var (OS Linux)) = True -- TODO: solve this hard-coded OS assumption + eval (Var (OS _)) = False + eval (Var (Arch X86_64)) = True -- TODO: support other platforms besides amd64 + eval (Var (Arch _)) = False + eval (Var (Impl GHC vr)) = exGHCVersion `withinRange` vr + eval (Var (Impl _ _)) = False -- XXX: no support for non-GHC compilers + eval (Lit f) = f + eval (CNot e) = not (eval e) + eval (COr a b) = eval a || eval b + eval (CAnd a b) = eval a || eval b + -- eval e = error $ "Unsupported expr " ++ show e + + build t = condTreeConstraints t ++ concatMap buildOptional (condTreeComponents t) + + buildOptional (eval → True, t, _) = build t + buildOptional (eval → False, _, Just t) = build t + buildOptional (eval → False, _, Nothing) = [] + +collectLibDeps, collectBinDeps, collectTestDeps ∷ GenericPackageDescription → [Dependency] +collectLibDeps = collectDeps (maybeToList . condLibrary) +collectBinDeps = collectDeps (map snd . condExecutables) +collectTestDeps = collectDeps (map snd . condTestSuites) + +-- |Render 'a' to a final part of Exheres +exRender ∷ ExRender a ⇒ a → String +exRender = render . exDisp + +-- |Render a multi-line meta-field of Exheres if non-empty value +exFieldDoc ∷ String → Doc → Doc +exFieldDoc name value | isEmpty value = empty + | otherwise = vcat [text name <> "=\"", value, char '"'] + +-- |Render a single-line with potential wrap meta-field of Exheres if non-empty value +exField ∷ String → String → Doc +exField _ "" = empty +exField name x | length singleLine < exWrapWidth = text singleLine + | otherwise = exFieldDoc name (reflow exWrapWidth (dquoted x)) + where + singleLine = name ++ "=\"" ++ dquoted x ++ "\"" + +-- |Sort dependencies according to Exherbo order +sortDeps ∷ [Dependency] → [Dependency] +sortDeps = sortBy (compare `on` display) + +-- |Merge sorted deps to through applying the most tighten ones +mergeSortedDeps ∷ [Dependency] → [Dependency] +mergeSortedDeps [] = [] +mergeSortedDeps [x] = [x] +mergeSortedDeps (x:y:z) = case (x, y) of + (Dependency n v, Dependency n' v') | n == n' → + mergeSortedDeps (Dependency n (intersectVersionRanges v v') : z) + _ → x : mergeSortedDeps (y:z) + +-- TODO: drop test deps that already in build +-- TODO: use renderStyle instead of manual wrapping diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,100 @@ +-- Copyright © 2015 Mykola Orliuk +-- Distributed under the terms of the GNU General Public License v2 + +{-# LANGUAGE ViewPatterns, UnicodeSyntax #-} + +module Main where + +import Control.Applicative +import Control.Monad +import Control.Exception +import Data.Maybe +import Data.ByteString.Lazy.Char8 (unpack) + +import System.Environment +import System.IO + +import Distribution.Text +import Distribution.Package +import Distribution.License +import Distribution.Version +import Distribution.PackageDescription +import Distribution.PackageDescription.Parse +import Distribution.Verbosity +import Network.HTTP.Client + +import qualified Text.Regex.PCRE.Light.Char8 as R + +import ExRender + +-- |Fetch content by provided URI +simpleFetch ∷ String → IO String +simpleFetch url = do + let settings = defaultManagerSettings + req ← parseUrl url + withManager settings $ liftM (unpack . responseBody) . httpLbs req + +licenseHints ∷ [(R.Regex, License)] +licenseHints = [ + (R.compile "http://creativecommons\\.org/publicdomain/zero/1\\.0/" [R.multiline], UnknownLicense "CC0"), + (R.compile "http://www\\.apache\\.org/licenses/LICENSE-2\\.0" [R.multiline], Apache (Just $ Version [2, 0] [])), + (R.compile "GNU AFFERO GENERAL PUBLIC LICENSE\\s*Version 3," [R.multiline], UnknownLicense "AGPL-3"), + (R.compile "Mozilla Public License Version 2\\.0$" [R.multiline], UnknownLicense "MPL-2") + ] + +guessLicense ∷ String → IO License +guessLicense text | isJust foundLicense = return $ fromJust foundLicense where + foundLicense = listToMaybe $ mapMaybe hint licenseHints + hint (re, answer) = const answer <$> R.match re text [] + +guessLicense _ = return OtherLicense + +hackageBaseUri ∷ String +hackageBaseUri = "http://hackage.haskell.org/package/" + +fixLicense ∷ GenericPackageDescription → IO GenericPackageDescription +fixLicense descr | license pkgDescr == OtherLicense = adjustLicense + | otherwise = return descr + where + pkgDescr = packageDescription descr + packageUri = hackageBaseUri ++ display (package pkgDescr) + adjustLicense = do + let licensePath = licenseFile pkgDescr + licenseContent ← simpleFetch (packageUri ++ "/src/" ++ licensePath) + license' ← guessLicense licenseContent + case license' of + OtherLicense → do + hPutStrLn stderr licenseContent + return descr + _ → do + let pkgDescr' = pkgDescr { license = license' } + descr' = descr { packageDescription = pkgDescr' } + return descr' + +-- |Fetch and parse cabal file for specific 'PackageIdentifier' using URL build +-- in form of http://hackage.haskell.org/package//.cabal +fetchPackageDescription ∷ PackageIdentifier → IO GenericPackageDescription +fetchPackageDescription pkgid = do + let cabalFile = display (packageName pkgid) ++ ".cabal" + packageUri = hackageBaseUri ++ display pkgid + url = packageUri ++ "/" ++ cabalFile + ParseOk _ descr ← liftM parsePackageDescription $ simpleFetch url + fixLicense descr + +main ∷ IO () +main = do + args ← getArgs + sources ← case args of + [] → liftM lines getContents + _ → return args + forM_ sources $ \source → do + descr ← case source of + ('.':_) → readPackageDescription verbose source >>= fixLicense + ('/':_) → readPackageDescription verbose source >>= fixLicense + (simpleParse → Just pkgId) -> fetchPackageDescription pkgId + _ -> error $ "Specified source " ++ show source + ++ " neither starts with '.' or '/' (local file)" + ++ " nor a valid packageIdentifier (to fetch from hackage)" + let handler ∷ SomeException → IO () + handler e = hPutStrLn stderr $ "# Failed fetch/generate for " ++ show source ++ ": " ++ show e + catch (evaluate (exRender descr) >>= putStrLn) handler