ten-lens (empty) → 0.1.0.0

raw patch · 4 files changed

+382/−0 lines, 4 filesdep +basedep +lensdep +profunctors

Dependencies added: base, lens, profunctors, some, ten

Files

• CHANGELOG.md +3/−0
• LICENSE +202/−0
• src/Data/Ten/Lens.hs +133/−0
• ten-lens.cabal +44/−0

@@ -0,0 +1,3 @@+# 0.1.0.0++Initial version.

@@ -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.

@@ -0,0 +1,133 @@+-- Copyright 2018-2021 Google LLC+--+-- 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.++-- | Provides lenses and related functionality for the "ten" package.++{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE GADTs #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications #-}+{-# LANGUAGE TypeOperators #-}++module Data.Ten.Lens+         ( rep10, field10, ixRep10, ap10, comp+         , _Field10, _Field10', (!=), (!=?), fragmented+         ) where++import Data.Functor.Contravariant (contramap)+import Data.Type.Equality ((:~:)(..))++import Control.Lens (Getting, Prism', Iso, iso, view)+import Control.Lens.Setter ((%~), Setter, ASetter, setting)+import Data.GADT.Compare (GEq(..))+import Data.Profunctor (dimap, right')++import Data.Ten.Ap (Ap10(..))+import Data.Ten.Sigma ((:**)(..), OpCostar, lmapFragment)+import Data.Ten.Representable (Representable10(..), rep10', field10')+import Data.Ten.Update (ixRep10)+import Data.Ten ((:.:)(..))++-- | Turn a record field lens into a 'Rep10'.+--+-- Since 'tabulate10' can give us a record of 'Rep10's, all we have to do to+-- convert a lens into a 'Rep10' is use 'view' to extract the desired 'Rep10'.+rep10+  :: Representable10 f+  => Getting (Rep10 f a) (f (Rep10 f)) (Rep10 f a) -> Rep10 f a+rep10 l = rep10' (view l)++-- | Convert a lens targeting Ap10 to a Rep10.+field10+  :: Representable10 rec+  => Getting (Ap10 a (Rep10 rec)) (rec (Rep10 rec)) (Ap10 a (Rep10 rec))+  -> Rep10 rec a+field10 l = field10' (view l)++-- | An 'Iso' between an @Ap10 a m@ wrapper and its contained @m a@.+ap10 :: Iso (Ap10 s fs) (Ap10 t ft) (fs s) (ft t)+ap10 = iso unAp10 Ap10++-- | An 'Iso' between a @(m :.: n) a@ wrapper and its contained @m (n a)@.+comp :: Iso ((m :.: n) a) ((k :.: l) b) (m (n a)) (k (l b))+comp = iso unComp1 Comp1++-- | A 'Control.Lens.Prism' from a ':**" to a particular field.+--+--     _Field10 k f (k := m) === (k :=) <$> f m+--     _Field10 k' f (k := m) === k := m | k' /= k+--     _Field10 k # m === k := m+_Field10+  :: GEq k+  => k a -> Prism' (k :** m) (m a)+_Field10 k = dimap toE fromE . right'+ where+  toE frag@(k' :** m) = case geq k k' of+    Just Refl -> Right m+    Nothing -> Left frag++  fromE = either pure (fmap (k :**))++-- | '_Field10' taking the field lens rather than the 'Rep10'.+_Field10'+  :: forall rec a m+   . (GEq (Rep10 rec), Representable10 rec)+  => (forall n. Getting (Ap10 a n) (rec n) (Ap10 a n))+  -> Prism' (Rep10 rec :** m) (m a)+_Field10' l = _Field10 @(Rep10 rec) (field10 l)++infixr 5 !=+-- | Shortcut to construct a (':**') from a 'Control.Lens.Getter'.+--+-- Note that this assumes the fields are ultimately wrapped in 'Ap10'.  If a+-- particular field doesn't have 'Ap10' (which can only arise from a+-- manually-written 'Representable10' instance), just pretend it does by adding+-- @from ap10@ to the lens.+(!=)+  :: Representable10 rec+  => (forall m. Getting (Ap10 a m) (rec m) (Ap10 a m))+  -> f a -> Rep10 rec :** f+l != x = field10 l :** x++infixr 5 !=?+-- | Shortcut to construct a (':**') using 'pure' for the value.+(!=?)+  :: (Representable10 rec, Applicative f)+  => (forall m. Getting (Ap10 a m) (rec m) (Ap10 a m))+  -> a -> Rep10 rec :** f+l !=? x = l != pure x++-- | Lifts a 'Setter' to work underneath (':**').+--+-- This means if you know how to change the type of a whole record, you can use+-- this to change the type of a (':**').+--+-- Example usage:+--+--     data MyRecord a m = MyRecord { _mrA :: Ap10 a m, _mrInt :: Ap10 Int m }+--     mrA :: Lens' (MyRecord a m) (MyRecord b m) (Ap10 m a) (Ap10 m b)+--+--     example+--       :: Rep10 (MyRecord Int) :** Identity+--       -> Rep10 (MyRecord String) :** Identity+--     example = fragmented (mrA.ap10) %~ show+fragmented+  :: ( Functor m, Representable10 recA, Representable10 recB+     , f ~ OpCostar m (Rep10 recB :** m)+     )+  => ASetter (recB f) (recA f) (f b) (f a)+  -> Setter (Rep10 recA :** m) (Rep10 recB :** m) a b+fragmented l = setting $ \f -> lmapFragment (l %~ contramap f)

@@ -0,0 +1,44 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.33.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: e2344930ad9083c232a788c6d18fb775971206770c51ed1d1bd15038c40740e8++name:           ten-lens+version:        0.1.0.0+synopsis:       Lenses for the types in the "ten" package.+description:    This provides lenses and related functionality for "ten".  It's in a separate+                package to reduce the dependency weight of "ten" itself.+category:       Data+homepage:       https://github.com/google/hs-ten#readme+bug-reports:    https://github.com/google/hs-ten/issues+author:         Andrew Pritchard <awpr@google.com>+maintainer:     Andrew Pritchard <awpr@google.com>+copyright:      2018-2021 Google LLC+license:        Apache-2.0+license-file:   LICENSE+build-type:     Simple+extra-source-files:+    CHANGELOG.md++source-repository head+  type: git+  location: https://github.com/google/hs-ten+  subdir: ten-lens++library+  exposed-modules:+      Data.Ten.Lens+  other-modules:+      Paths_ten_lens+  hs-source-dirs:+      src+  build-depends:+      base >=4.12 && <4.16+    , lens >=1.5 && <5.1+    , profunctors >=0.1 && <5.7+    , some >=1.0 && <1.1+    , ten >=0.1 && <0.2+  default-language: Haskell2010