Merge pull request #5183 from IntersectMBO/coot/dmq-node-to-node

DMQ: node-to-node application

Author: coot

acts-generic/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for acts-generic
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

acts-generic/LICENSE

@@ -0,0 +1,177 @@
+
+                                 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

acts-generic/NOTICE

@@ -0,0 +1,14 @@
+Copyright 2025 Intersect
+
+   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.
+

acts-generic/acts-generic.cabal

@@ -0,0 +1,40 @@
+cabal-version: 3.4
+name: acts-generic
+version: 0.1.0.0
+synopsis: Generic instances for `Act` type class.
+license: Apache-2.0
+license-files:
+  LICENSE
+  NOTICE
+
+author: Marcin Szamotulski
+maintainer: [email protected]
+copyright: 2025 Intersect
+category: Data
+build-type: Simple
+extra-doc-files: CHANGELOG.md
+
+common ghc-options
+  ghc-options:
+    -Wall
+    -Wno-unticked-promoted-constructors
+    -Wcompat
+    -Wincomplete-uni-patterns
+    -Wincomplete-record-updates
+    -Wpartial-fields
+    -Widentities
+    -Wredundant-constraints
+    -Wunused-packages
+
+library
+  import: ghc-options
+  exposed-modules: Data.Act.Generic
+  -- other-modules:
+  -- other-extensions:
+  build-depends:
+    acts,
+    base >=4.14 && <4.22,
+
+  hs-source-dirs: src
+  default-language: Haskell2010
+  default-extensions: ImportQualifiedPost

acts-generic/src/Data/Act/Generic.hs

@@ -0,0 +1,99 @@
+{-# LANGUAGE FlexibleContexts      #-}
+{-# LANGUAGE FlexibleInstances     #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE TypeOperators         #-}
+{-# LANGUAGE UndecidableInstances  #-}
+
+-- | Provide generic `Act` instances, in two cases
+--
+--   data Product a b = Product a b
+--
+--   instance Act (Last a) a where
+--     act (Last Nothing)  a = a
+--     act (Last (Just a)) _ = a
+--
+--   instance Act (Last a) (Product a) where
+--     act = gact
+--
+-- or where two product are matched piecewise (e.g. field by field)
+--
+--   instance Act (Last a) (Identity a) where
+--     act (Last Nothing)  a = a
+--     act (Last (Just a)) _ = Identity a
+--
+--   data Product' f = Product' (f a) (f b)
+--     derive Generic
+--
+--   instance Act (Product' Last) (Product' Identity) where
+--     act = gpact
+--   
+module Data.Act.Generic
+  ( gact
+  , GenericAct (..)
+  , gpact
+  ) where
+
+import Data.Act
+import GHC.Generics
+
+-- | Action of `s` on `a` via `Rep a`.
+--
+gact :: (Generic a, GAct s (Rep a))
+     => s -> a -> a
+gact s a = to (s `gact'` from a)
+
+class GAct s g where
+  gact' :: s -> g p -> g p
+
+instance GAct s U1 where
+  gact' _ _ = U1
+  
+instance GAct s V1 where
+  gact' s a = s `seq` a `seq` error "GAct.V1: gact'"
+
+instance Act s a => GAct s (K1 i a) where
+  gact' s (K1 a) = K1 (s `act` a)
+
+instance GAct s f => GAct s (M1 i' c' f) where
+  gact' s (M1 a) = M1 (s `gact'` a)
+
+instance (GAct s f, GAct s g) => GAct s (f :*: g) where
+  gact' s (a0 :*: a1) = s `gact'` a0 :*: s `gact'` a1
+
+instance (GAct s f, GAct s g) => GAct s (f :+: g) where
+  gact' s (L1 a) = L1 (s `gact'` a)
+  gact' s (R1 a) = R1 (s `gact'` a)
+
+-- | A newtype wrapper for deriving via.
+--
+newtype GenericAct s a = GenericAct { getGenericAct :: a }
+
+instance (Generic s, Generic a, GAct s (Rep a), Semigroup s) => Act s (GenericAct s a) where
+  act s (GenericAct a) = GenericAct (s `gact` a)
+
+
+-- | Action of `s` on `a` via action of `Rep s` on `Rep a`.
+--
+gpact :: (Generic s, Generic a, GPAct (Rep s) (Rep a))
+     => s -> a -> a
+gpact s a = to (from s `gpact'` from a)
+
+class GPAct f g where
+  gpact' :: f p -> g p -> g p
+
+instance GPAct s U1 where
+  gpact' _ _ = U1
+  
+instance GPAct s V1 where
+  gpact' s a = s `seq` a `seq` error "GPAct.V1: gact'"
+
+instance Act s a => GPAct (K1 i' s) (K1 i a) where
+  gpact' (K1 s) (K1 a) = K1 (s `act` a)
+
+instance GPAct s f => GPAct (M1 i' c' s) (M1 i' c' f) where
+  gpact' (M1 s) (M1 a) = M1 (s `gpact'` a)
+
+instance (GPAct s f, GPAct s' f') => GPAct (s :*: s') (f :*: f') where
+  gpact' (s0 :*: s1) (a0 :*: a1) = s0 `gpact'` a0 :*: s1 `gpact'` a1
+
+-- we don't provide `GPAct` for `:+:`

acts-generic/src/MyLib.hs

@@ -0,0 +1,4 @@
+module MyLib (someFunc) where
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"

cabal.project

@@ -32,6 +32,7 @@ packages: ./cardano-ping
           ./ntp-client
           ./cardano-client
           ./decentralized-message-queue
+          ./acts-generic
 
 tests: True
 benchmarks: True
@@ -54,4 +55,7 @@ package network-mux
 package ouroboros-network
   flags: +asserts +cddl
 
+package acts
+  flags: -finitary
+
 allow-newer: quickcheck-instances:QuickCheck