diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -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 [yyyy] [name of copyright owner] + + 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. 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/betacode.cabal b/betacode.cabal new file mode 100644 --- /dev/null +++ b/betacode.cabal @@ -0,0 +1,50 @@ +-- Initial betacode.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: betacode +version: 0.1.0.0 +synopsis: A codec for beta code (http://en.wikipedia.org/wiki/Beta_Code). +category: Text +description: A codec for beta code (http://en.wikipedia.org/wiki/Beta_Code). +license: Apache-2.0 +license-file: LICENSE +author: Eric Rochester +maintainer: erochest@gmail.com +-- copyright: +-- category: +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +library + exposed-modules: Text.BetaCode + -- other-modules: + -- other-extensions: + build-depends: base >=4.7 && <4.8 + , errors >=1.4 && <1.5 + , attoparsec >=0.12 && <0.13 + , hashable >=1.2 && <1.3 + , text >=1.2 && <1.3 + , text-icu >=0.7 && <0.8 + hs-source-dirs: src + default-language: Haskell2010 + +test-suite betacode-specs + type: exitcode-stdio-1.0 + ghc-options: -threaded -rtsopts + hs-source-dirs: specs + main-is: Specs.hs + build-depends: base == 4.7.* + , QuickCheck + , smallcheck + , hspec + -- , tasty + -- , tasty-quickcheck + -- , tasty-smallcheck + default-language: Haskell2010 + + +source-repository this + type: git + tag: 0.1.0.0 + location: git://github.com/erochest/betacode.git diff --git a/specs/Specs.hs b/specs/Specs.hs new file mode 100644 --- /dev/null +++ b/specs/Specs.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/src/Text/BetaCode.hs b/src/Text/BetaCode.hs new file mode 100644 --- /dev/null +++ b/src/Text/BetaCode.hs @@ -0,0 +1,199 @@ +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} + + +module Text.BetaCode + ( betaCode + , fromBeta + , fromBetaIgnore + , normalizeChars + , betanorm + , clean + , BetaCode + , unBeta + , toBeta + ) where + + +import Control.Applicative +import Control.Error +import Control.Monad +import Data.Attoparsec.Text +import Data.Char +import Data.Hashable +import Data.Monoid +import Data.String +import qualified Data.Text as T +import Data.Text.ICU.Normalize +import Data.Text.Lazy (toStrict) +import Data.Text.Lazy.Builder +import qualified Data.Text.Lazy.Builder as B +import GHC.Generics (Generic) + + +-- BetaCode conversion + +diacritic :: Parser Char +diacritic = choice [ char' ')' '\x0313' -- ̓ ) Smooth breathing ἐν E)N + , char' '(' '\x0314' -- ̔ ( Rough breathing ὁ, οἱ O(, OI( + , char' '/' '\x0301' -- ́ / Acute accent πρός PRO/S + , char' '=' '\x0342' -- ͂ = Circumflex accent τῶν TW=N + , char' '\\' '\x0300' -- ̀ \ Grave accent πρὸς PRO\S + , char' '+' '\x0308' -- ̈ + Diaeresis προϊέναι PROI+E/NAI + , char' '|' '\x0345' -- ͅ | Iota subscript τῷ TW=| + , char' '&' '\x0304' -- ̄ & Macron μαχαίρᾱς MAXAI/RA&S + -- , char' '\'' '\x0306' -- ̆ ' Breve μάχαιρᾰ MA/XAIRA' + , char' '?' '\x0323' -- combining dot below + ] + +punct :: Parser Char +punct = choice [ char '.' -- . . Period + , char ',' -- , , Comma + -- , char' ':' '\x00b7' -- · : Colon (Ano Stigme) + , char ':' -- · : Colon (Ano Stigme) + , char ';' -- ; ; Question Mark + , char' '\'' '\x1fbd' -- ’ ' Apostrophe + , char' '-' '\x2010' -- ‐ - Hyphen + , char' '_' '\x2014' -- — _ Dash + ] + +lowercase :: Parser Char +lowercase = choice [ beta 'A' 'a' '\x03b1' -- Α *A Alpha α A + , beta 'B' 'b' '\x03b2' -- Β *B Beta β B + , beta 'G' 'g' '\x03b3' -- Γ *G Gamma γ G + , beta 'D' 'd' '\x03b4' -- Δ *D Delta δ D + , beta 'E' 'e' '\x03b5' -- Ε *E Epsilon ε E + , beta 'V' 'v' '\x03dd' -- Ϝ *V Digamma ϝ V + , beta 'Z' 'z' '\x03b6' -- Ζ *Z Zeta ζ Z + , beta 'H' 'h' '\x03b7' -- Η *H Eta η H + , beta 'Q' 'q' '\x03b8' -- Θ *Q Theta θ Q + , beta 'I' 'i' '\x03b9' -- Ι *I Iota ι I + , beta 'K' 'k' '\x03ba' -- Κ *K Kappa κ K + , beta 'L' 'l' '\x03bb' -- Λ *L Lambda λ L + , beta 'M' 'm' '\x03bc' -- Μ *M Mu μ M + , beta 'N' 'n' '\x03bd' -- Ν *N Nu ν N + , beta 'C' 'c' '\x03be' -- Ξ *C Xi ξ C + , beta 'O' 'o' '\x03bf' -- Ο *O Omicron ο O + , beta 'P' 'p' '\x03c0' -- Π *P Pi π P + , beta 'R' 'r' '\x03c1' -- Ρ *R Rho ρ R + , beta' "S1" "s1" '\x03c3' -- Σ *S Medial Sigma σ S, S1 + , beta' "S2" "s2" '\x03c2' -- Σ *S Final Sigma ς S, S2, J + , beta' "S3" "s3" '\x03f2' -- Ϲ *S (*S3) Lunate Sigma ϲ S (S3) + , beta 'J' 'j' '\x03c2' -- Σ *S Final Sigma ς S, S2, J + , sigma + -- , beta 'S' 's' '\x03c3' -- Σ *S Medial Sigma σ S, S1 + -- , beta 'S' 's' '\x03c2' -- Σ *S Final Sigma ς S, S2, J + -- , beta 'S' 's' '\x03f2' -- Ϲ *S (*S3) Lunate Sigma ϲ S (S3) + , beta 'T' 't' '\x03c4' -- Τ *T Tau τ T + , beta 'U' 'u' '\x03c5' -- Υ *U Upsilon υ U + , beta 'F' 'f' '\x03c6' -- Φ *F Phi φ F + , beta 'X' 'x' '\x03c7' -- Χ *X Chi χ X + , beta 'Y' 'y' '\x03c8' -- Ψ *Y Psi ψ Y + , beta 'W' 'w' '\x03c9' -- Ω *W Omega ω W + ] + +char' :: Char -> Char -> Parser Char +char' c d = char c *> pure d + +beta :: Char -> Char -> Char -> Parser Char +beta c d e = (char c <|> char d) *> pure e + +beta' :: T.Text -> T.Text -> Char -> Parser Char +beta' c d e = (string c <|> string d) *> pure e + +sigma :: Parser Char +sigma = do + void $ char 'S' <|> char 's' + eow <- endOfWord + pure $ if eow + then '\x03c2' + else '\x03c3' + +diacritics :: Parser Builder +diacritics = B.fromString <$> many' diacritic + +upperseq :: Parser Builder +upperseq = char '*' *> ((<>) <$> (flip (<>) <$> diacritics + <*> (singleton . toUpper <$> lowercase)) + <*> diacritics) + +lowerseq :: Parser Builder +lowerseq = (<>) <$> (singleton <$> lowercase) <*> diacritics + +endOfWord :: Parser Bool +endOfWord = eow . fromMaybe ' ' <$> peekChar + where eow '.' = True + eow ',' = True + eow ':' = True + eow ';' = True + eow '\'' = True + eow '-' = True + eow '_' = True + eow x = isSpace x + +remove :: Parser Builder +remove = (char '<' <|> char '>') *> pure mempty + +betaCode :: Parser T.Text +betaCode = toStrict . toLazyText . mconcat + <$> (many' (space' <|> digit' <|> upperseq <|> lowerseq <|> punct' <|> remove) <* endOfInput) + where space' = singleton <$> space + punct' = singleton <$> punct + digit' = singleton <$> digit + +fromBeta :: T.Text -> Either T.Text T.Text +fromBeta t = fmapL (const errMsg) $ parseOnly betaCode t + where errMsg = "ERROR " <> t + +fromBetaIgnore :: T.Text -> T.Text +fromBetaIgnore = either id id . fromBeta + +normalizeChars :: T.Text -> T.Text +normalizeChars = normalize NFC + +betanorm :: T.Text -> T.Text +betanorm = normalizeChars . fromBetaIgnore + +clean :: T.Text -> T.Text +clean = T.filter (\c -> isAscii c && isAlphaNum c) . T.map cchar + +cchar :: Char -> Char +cchar '\x03b1' = 'a' +cchar '\x03b2' = 'b' +cchar '\x03b3' = 'g' +cchar '\x03b4' = 'd' +cchar '\x03b5' = 'e' +cchar '\x03b6' = 'z' +cchar '\x03b7' = 'h' +cchar '\x03b8' = 'q' +cchar '\x03b9' = 'i' +cchar '\x03ba' = 'k' +cchar '\x03bb' = 'l' +cchar '\x03bc' = 'm' +cchar '\x03bd' = 'n' +cchar '\x03be' = 'c' +cchar '\x03bf' = 'o' +cchar '\x03c0' = 'p' +cchar '\x03c1' = 'r' +cchar '\x03c2' = 's' +cchar '\x03c3' = 's' +cchar '\x03c4' = 't' +cchar '\x03c5' = 'u' +cchar '\x03c6' = 'f' +cchar '\x03c7' = 'x' +cchar '\x03c8' = 'y' +cchar '\x03c9' = 'w' +cchar '\x03dd' = 'v' +cchar '\x03f2' = 's' +cchar c = c + +newtype BetaCode = BC { unBeta :: T.Text } + deriving (Eq, Show, Generic) + +instance Hashable BetaCode + +toBeta :: T.Text -> BetaCode +toBeta = BC . clean . normalizeChars + +instance IsString BetaCode where + fromString = toBeta . T.pack