WEditorHyphen (empty) → 0.1.0.0
raw patch · 8 files changed
+589/−0 lines, 8 filesdep +WEditordep +WEditorHyphendep +basesetup-changed
Dependencies added: WEditor, WEditorHyphen, base, directory, hyphenation
Files
- ChangeLog.md +5/−0
- LICENSE +202/−0
- Setup.hs +2/−0
- WEditorHyphen.cabal +54/−0
- WEditorHyphen/LangHyphen.hs +117/−0
- test/Common.hs +86/−0
- test/TestLangHyphen.hs +85/−0
- test/test.hs +38/−0
+ ChangeLog.md view
@@ -0,0 +1,5 @@+# Revision history for WEditorHyphen++## 0.1.0.0 -- 2020-04-20++* First version. Released on an unsuspecting world.
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright 2020 Kevin P. Barry++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ WEditorHyphen.cabal view
@@ -0,0 +1,54 @@+name: WEditorHyphen+version: 0.1.0.0+synopsis: Language-specific hyphenation policies for WEditor.++description:+ This package provides language-specific hyphenation policies for use with+ the <https://github.com/ta0kira/wrapping-editor WEditor> and+ <https://github.com/ta0kira/wrapping-editor WEditorBrick> packages.++homepage: https://github.com/ta0kira/wrapping-editor+license: Apache-2.0+license-file: LICENSE+author: Kevin P. Barry+maintainer: Kevin P. Barry <ta0kira@gmail.com>+copyright: (c) Kevin P. Barry 2020+category: Text+build-type: Simple++cabal-version: 2.0+tested-with: GHC == 8.8.3++extra-source-files: ChangeLog.md+++library+ exposed-modules: WEditorHyphen.LangHyphen+ other-extensions: FlexibleInstances,+ MultiParamTypeClasses,+ Safe++ build-depends: base >= 4.0 && < 4.14,+ hyphenation >= 0.3 && < 0.9,+ WEditor >= 0.2 && < 0.3++ default-language: Haskell2010+++test-suite WEditorHyphen-test+ type: exitcode-stdio-1.0++ main-is: test.hs++ other-modules: Common,+ TestLangHyphen++ hs-source-dirs: test++ build-depends: base,+ directory >= 1.0,+ hyphenation,+ WEditor,+ WEditorHyphen++ default-language: Haskell2010
+ WEditorHyphen/LangHyphen.hs view
@@ -0,0 +1,117 @@+{- -----------------------------------------------------------------------------+Copyright 2020 Kevin P. Barry++Licensed under the Apache License, Version 2.0 (the "License");+you may not use this file except in compliance with the License.+You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++Unless required by applicable law or agreed to in writing, software+distributed under the License is distributed on an "AS IS" BASIS,+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+See the License for the specific language governing permissions and+limitations under the License.+----------------------------------------------------------------------------- -}++-- Author: Kevin P. Barry [ta0kira@gmail.com]++-- | Language-specific hyphenation rules.++{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE Safe #-}++module WEditorHyphen.LangHyphen (+ LangHyphen,+ langHyphen,+) where++import Data.Char+import Text.Hyphenation+import WEditor.LineWrap+++data LangHyphen = LangHyphen Language Hyphenator++-- | Hyphenates words using 'Language'-specific rules.+--+-- Example usage:+--+-- @+-- import WEditor.LineWrap+-- import WEditor.Document+-- import WEditorHyphen.LangHyphen+--+-- content = map UnparsedPara (lines "Your document content.")+--+-- doc = editDocument (breakWords (langHyphen English_US))+-- @+langHyphen :: Language -> LangHyphen+langHyphen l = LangHyphen l (languageHyphenator l)+++-- Private below here.++instance Show LangHyphen where+ show (LangHyphen l _) = show l++instance WordSplitter LangHyphen Char where+ splitWord (LangHyphen l h) k w cs+ | w < (minWidth l) || k > w = Nothing+ | k >= length cs || k < 3 = Just []+ | otherwise = Just breaks where+ (nb,cs',ne) = trimPunct l cs+ (n0:ns) = map length $ hyphenate h cs'+ breaks+ -- Move the word to the next line if it has punctuation in the middle.+ | any (noSplitChars l) cs' = []+ | null ns = []+ | otherwise = combine k (nb+n0) (init ns ++ [ne+last ns])+ combine _ _ [] = []+ combine t n (k:ks)+ -- Add a break if adding a segment would exceed the remaining space.+ | (n+k > t-(length (hyphenChar l)) && not (null ks)) || n+k > t = n:(combine w k ks)+ -- Append the next segment to the current segment.+ | otherwise = combine w (n+k) ks+ isWordChar (LangHyphen l _) = wordChars l+ isWhitespace (LangHyphen l _) = whitespaceChars l+ appendHyphen (LangHyphen l _) = (++ hyphenChar l)++minWidth :: Language -> Int+minWidth _ = 8++wordChars :: Language -> Char -> Bool+wordChars l c = generalCategory c `elem` cats l || noSplitChars l c where+ -- Add language-specific tokenizing rules here.+ cats _ = [UppercaseLetter,+ LowercaseLetter,+ TitlecaseLetter,+ ModifierLetter,+ OtherLetter,+ NonSpacingMark,+ SpacingCombiningMark,+ DashPunctuation]++noSplitChars :: Language -> Char -> Bool+noSplitChars l c = generalCategory c `elem` cats l where+ -- Add language-specific punctuation rules here.+ cats _ = [DecimalNumber,+ OtherNumber,+ ConnectorPunctuation,+ InitialQuote,+ FinalQuote,+ OtherPunctuation,+ CurrencySymbol]++whitespaceChars :: Language -> Char -> Bool+whitespaceChars _ c = isSeparator c++hyphenChar :: Language -> [Char]+hyphenChar _ = "-"++trimPunct :: Language -> [Char] -> (Int,[Char],Int)+trimPunct l cs =+ (length $ takeWhile (noSplitChars l) cs,+ dropWhile (noSplitChars l) $ reverse $ dropWhile (noSplitChars l) $ reverse cs,+ length $ takeWhile (noSplitChars l) $ reverse cs)
+ test/Common.hs view
@@ -0,0 +1,86 @@+{- -----------------------------------------------------------------------------+Copyright 2020 Kevin P. Barry++Licensed under the Apache License, Version 2.0 (the "License");+you may not use this file except in compliance with the License.+You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++Unless required by applicable law or agreed to in writing, software+distributed under the License is distributed on an "AS IS" BASIS,+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+See the License for the specific language governing permissions and+limitations under the License.+----------------------------------------------------------------------------- -}++-- Author: Kevin P. Barry [ta0kira@gmail.com]++{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE Safe #-}++module Common (+ checkCondition,+ checkConditions,+ composeActions,+ endLine,+ hyphenLine,+ innerLine,+ repeatAction,+ runTests,+ testFail,+ testPass,+) where++import Control.Applicative ((<|>))+import Control.Monad (when)+import Data.Maybe (catMaybes)+import System.IO (hPutStr,hPutStrLn,stderr)++import WEditor.Base+import WEditor.LineWrap+++endLine :: String -> VisibleLine Char LineBreak+endLine = VisibleLine lineBreakEnd++innerLine :: String -> VisibleLine Char LineBreak+innerLine = VisibleLine lineBreakSimple++hyphenLine :: String -> VisibleLine Char LineBreak+hyphenLine = VisibleLine lineBreakHyphen++composeActions :: [a -> a] -> a -> a+composeActions = foldr (flip (.)) id++repeatAction :: Int -> (a -> a) -> a -> a+repeatAction n f = composeActions (replicate n f)++checkConditions :: [(String,Bool)] -> IO (Maybe String)+checkConditions = fmap (foldr (<|>) Nothing) . sequence . map (uncurry checkCondition)++checkCondition :: String -> Bool -> IO (Maybe String)+checkCondition _ True = testPass+checkCondition m False = testFail m++testPass :: IO (Maybe String)+testPass = return Nothing++testFail :: String -> IO (Maybe String)+testFail m = return (Just m)++runTests :: String -> [(String,IO (Maybe String))] -> IO Int+runTests setName tests = do+ results <- fmap catMaybes $ sequence $ map runTest $ zip [1..] tests+ hPutStrLn stderr $ resultSummary results+ when (not $ null results) $ hPutStr stderr $ unlines results+ return (length results)+ where+ resultSummary rs = "*** " ++ setName ++ ": " +++ show (length tests - length rs) ++ " passed, " +++ show (length rs) ++ " failed ***"+ runTest (n,(name,test)) = do+ result <- test+ case result of+ Just m -> return (Just $ "Test " ++ show n ++ " (" ++ name ++ "): " ++ m)+ Nothing -> return Nothing
+ test/TestLangHyphen.hs view
@@ -0,0 +1,85 @@+{- -----------------------------------------------------------------------------+Copyright 2020 Kevin P. Barry++Licensed under the Apache License, Version 2.0 (the "License");+you may not use This file except in compliance with the License.+You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++Unless required by applicable law or agreed to in writing, software+distributed under the License is distributed on an "AS IS" BASIS,+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+See the License for the specific language governing permissions and+limitations under the License.+----------------------------------------------------------------------------- -}++-- Author: Kevin P. Barry [ta0kira@gmail.com]++{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE Safe #-}++module TestLangHyphen (+ allTests,+) where++import Text.Hyphenation+import WEditor.Base+import WEditor.LineWrap+import WEditorHyphen.LangHyphen++import Common+++allTests :: [(String,IO (Maybe String))]+allTests = tests_English_US++tests_English_US :: [(String,IO (Maybe String))]+tests_English_US = [+ ("langHyphen English_US without punctuation", checkLineBreak+ (setLineWidth (breakWords (langHyphen English_US)) 8)+ "Hyphenation testability depends on the usage of longer lexicographical objects"+ [hyphenLine "Hyphen",+ innerLine "ation ",+ hyphenLine "testa",+ innerLine "bility ",+ innerLine "depends ",+ innerLine "on the ",+ innerLine "usage of ",+ innerLine "longer ",+ hyphenLine "lexico",+ hyphenLine "graphi",+ hyphenLine "cal ob",+ endLine "jects"]),+ ("langHyphen English_US with quoted text", checkLineBreak+ (setLineWidth (breakWords (langHyphen English_US)) 8)+ "Hyphenation \"testability\" depends on the usage of longer \"lexicographical objects\""+ [hyphenLine "Hyphen",+ innerLine"ation ",+ hyphenLine "\"testa",+ innerLine "bility\" ",+ innerLine "depends ",+ innerLine "on the ",+ innerLine "usage of ",+ innerLine "longer ",+ hyphenLine "\"lexico",+ hyphenLine "graphi",+ hyphenLine "cal ob",+ endLine "jects\""]),+ ("langHyphen English_US leading quote not left hanging", checkLineBreak+ (setLineWidth (breakWords (langHyphen English_US)) 8)+ "012345 \"somethingness\""+ [innerLine "012345 ",+ hyphenLine "\"some",+ hyphenLine "thing",+ endLine "ness\""]),+ ("langHyphen English_US trailing quote and period not left hanging", checkLineBreak+ (setLineWidth (breakWords (langHyphen English_US)) 8)+ " \"The.\""+ [innerLine " ",+ endLine "\"The.\""])+ ]++checkLineBreak b x ys = do+ let breaks = breakLines b x+ checkCondition (show breaks) (breaks == ys)
+ test/test.hs view
@@ -0,0 +1,38 @@+{- -----------------------------------------------------------------------------+Copyright 2020 Kevin P. Barry++Licensed under the Apache License, Version 2.0 (the "License");+you may not use this file except in compliance with the License.+You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++Unless required by applicable law or agreed to in writing, software+distributed under the License is distributed on an "AS IS" BASIS,+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+See the License for the specific language governing permissions and+limitations under the License.+----------------------------------------------------------------------------- -}++-- Author: Kevin P. Barry [ta0kira@gmail.com]++{-# LANGUAGE Safe #-}++import Control.Monad+import System.Directory+import System.Exit+import System.IO++import Common (runTests)+import qualified TestLangHyphen as TestLangHyphen (allTests)+++main = do+ cwd <- getCurrentDirectory+ hPutStrLn stderr $ "Running from " ++ cwd+ failures <- fmap sum $ sequence [+ runTests "LangHyphen Tests" TestLangHyphen.allTests+ ]+ when (failures > 0) $ do+ hPutStrLn stderr $ "### TEST FAILURES: " ++ show failures ++ " ###"+ exitFailure