primitive-primvar (empty) → 0.0.0.0

raw patch · 5 files changed

+306/−0 lines, 5 filesdep +basedep +primitive

Dependencies added: base, primitive

Files

• CC0-1.0.txt +121/−0
• CHANGELOG.md +5/−0
• README.md +25/−0
• primitive-primvar.cabal +46/−0
• src/Data/Primitive/PrimVar.hs +109/−0

@@ -0,0 +1,121 @@+Creative Commons Legal Code++CC0 1.0 Universal++    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED+    HEREUNDER.++Statement of Purpose++The laws of most jurisdictions throughout the world automatically confer+exclusive Copyright and Related Rights (defined below) upon the creator+and subsequent owner(s) (each and all, an "owner") of an original work of+authorship and/or a database (each, a "Work").++Certain owners wish to permanently relinquish those rights to a Work for+the purpose of contributing to a commons of creative, cultural and+scientific works ("Commons") that the public can reliably and without fear+of later claims of infringement build upon, modify, incorporate in other+works, reuse and redistribute as freely as possible in any form whatsoever+and for any purposes, including without limitation commercial purposes.+These owners may contribute to the Commons to promote the ideal of a free+culture and the further production of creative, cultural and scientific+works, or to gain reputation or greater distribution for their Work in+part through the use and efforts of others.++For these and/or other purposes and motivations, and without any+expectation of additional consideration or compensation, the person+associating CC0 with a Work (the "Affirmer"), to the extent that he or she+is an owner of Copyright and Related Rights in the Work, voluntarily+elects to apply CC0 to the Work and publicly distribute the Work under its+terms, with knowledge of his or her Copyright and Related Rights in the+Work and the meaning and intended legal effect of CC0 on those rights.++1. Copyright and Related Rights. A Work made available under CC0 may be+protected by copyright and related or neighboring rights ("Copyright and+Related Rights"). Copyright and Related Rights include, but are not+limited to, the following:++  i. the right to reproduce, adapt, distribute, perform, display,+     communicate, and translate a Work;+ ii. moral rights retained by the original author(s) and/or performer(s);+iii. publicity and privacy rights pertaining to a person's image or+     likeness depicted in a Work;+ iv. rights protecting against unfair competition in regards to a Work,+     subject to the limitations in paragraph 4(a), below;+  v. rights protecting the extraction, dissemination, use and reuse of data+     in a Work;+ vi. database rights (such as those arising under Directive 96/9/EC of the+     European Parliament and of the Council of 11 March 1996 on the legal+     protection of databases, and under any national implementation+     thereof, including any amended or successor version of such+     directive); and+vii. other similar, equivalent or corresponding rights throughout the+     world based on applicable law or treaty, and any national+     implementations thereof.++2. Waiver. To the greatest extent permitted by, but not in contravention+of, applicable law, Affirmer hereby overtly, fully, permanently,+irrevocably and unconditionally waives, abandons, and surrenders all of+Affirmer's Copyright and Related Rights and associated claims and causes+of action, whether now known or unknown (including existing as well as+future claims and causes of action), in the Work (i) in all territories+worldwide, (ii) for the maximum duration provided by applicable law or+treaty (including future time extensions), (iii) in any current or future+medium and for any number of copies, and (iv) for any purpose whatsoever,+including without limitation commercial, advertising or promotional+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each+member of the public at large and to the detriment of Affirmer's heirs and+successors, fully intending that such Waiver shall not be subject to+revocation, rescission, cancellation, termination, or any other legal or+equitable action to disrupt the quiet enjoyment of the Work by the public+as contemplated by Affirmer's express Statement of Purpose.++3. Public License Fallback. Should any part of the Waiver for any reason+be judged legally invalid or ineffective under applicable law, then the+Waiver shall be preserved to the maximum extent permitted taking into+account Affirmer's express Statement of Purpose. In addition, to the+extent the Waiver is so judged Affirmer hereby grants to each affected+person a royalty-free, non transferable, non sublicensable, non exclusive,+irrevocable and unconditional license to exercise Affirmer's Copyright and+Related Rights in the Work (i) in all territories worldwide, (ii) for the+maximum duration provided by applicable law or treaty (including future+time extensions), (iii) in any current or future medium and for any number+of copies, and (iv) for any purpose whatsoever, including without+limitation commercial, advertising or promotional purposes (the+"License"). The License shall be deemed effective as of the date CC0 was+applied by Affirmer to the Work. Should any part of the License for any+reason be judged legally invalid or ineffective under applicable law, such+partial invalidity or ineffectiveness shall not invalidate the remainder+of the License, and in such case Affirmer hereby affirms that he or she+will not (i) exercise any of his or her remaining Copyright and Related+Rights in the Work or (ii) assert any associated claims and causes of+action with respect to the Work, in either case contrary to Affirmer's+express Statement of Purpose.++4. Limitations and Disclaimers.++ a. No trademark or patent rights held by Affirmer are waived, abandoned,+    surrendered, licensed or otherwise affected by this document.+ b. Affirmer offers the Work as-is and makes no representations or+    warranties of any kind concerning the Work, express, implied,+    statutory or otherwise, including without limitation warranties of+    title, merchantability, fitness for a particular purpose, non+    infringement, or the absence of latent or other defects, accuracy, or+    the present or absence of errors, whether or not discoverable, all to+    the greatest extent permissible under applicable law.+ c. Affirmer disclaims responsibility for clearing rights of other persons+    that may apply to the Work or any use thereof, including without+    limitation any person's Copyright and Related Rights in the Work.+    Further, Affirmer disclaims responsibility for obtaining any necessary+    consents, permissions or other rights required for any use of the+    Work.+ d. Affirmer understands and acknowledges that Creative Commons is not a+    party to this document and has no duty or obligation with respect to+    this CC0 or use of the Work.

@@ -0,0 +1,5 @@+# Revision history for primitive-primvar++## 0.0.0.0 -- 2022-09-15++* First version. Released on an unsuspecting world.

@@ -0,0 +1,25 @@+# `primitive-primvar`++Version 0.0.0.0++## Description++This package provides the type `PrimVar`, which is internally a+`PrimArray` of one element, but with a convenient `MutVar`-like API.++This project follows the [Haskell Package Versioning Policy][PVP].++[PVP]: https://pvp.haskell.org/++## Copyright++Each contributor waives their Copyright and Related Rights to+this work according to [CC0-1.0].++[CC0-1.0]: https://creativecommons.org/publicdomain/zero/1.0/++## Patent++Each contributor licenses you to do everything with this work that+would otherwise infringe any patent claims they can license or become+able to license.

@@ -0,0 +1,46 @@+cabal-version:      2.4+name:               primitive-primvar+version:            0.0.0.0+license:            CC0-1.0+license-file:       CC0-1.0.txt+author:             Russell Hernandez Ruiz+maintainer:         qrpnxz@hyperlife.xyz+stability:          stable+homepage:           https://sr.ht/~qrpnxz/primitive-primvar/+bug-reports:        https://todo.sr.ht/~qrpnxz/primitive-primvar+synopsis:           Unboxed variables for `Prim` values.+description:+  This package provides the type `PrimVar`, which is internally a+  `PrimArray` of one element, but with a convenient `MutVar`-like API.+category:           primitive+extra-source-files: README.md+extra-source-files: CHANGELOG.md++source-repository head+  type:     git+  location: https://git.sr.ht/~qrpnxz/primitive-primvar++source-repository this+  type:     git+  location: https://git.sr.ht/~qrpnxz/primitive-primvar+  tag:      0.0.0.0++library+  hs-source-dirs:   src+  exposed-modules:+      Data.Primitive.PrimVar+  build-depends:+      base >=4.13 && <4.18+    , primitive >=0.7.1 && <0.8+  default-language: Haskell2010+  ghc-options:+    -Wall+    -Wcompat+    -Widentities+    -Wincomplete-record-updates+    -Wincomplete-uni-patterns+    -Wpartial-fields+    -Wredundant-constraints+  ghc-options:+    -Wno-redundant-constraints+    -Wno-unticked-promoted-constructors

@@ -0,0 +1,109 @@+-- SPDX-License-Identifier: CC0-1.0+{-+Each contributor licenses you to do everything with this work that+would otherwise infringe any patent claims they can license or become+able to license.+-}+{-|+`PrimVar` is internally a `PrimArray` of one element,+but with a convenient `MutVar`-like API.+-}+module Data.Primitive.PrimVar+  ( -- * Types+    PrimVar(..)+    -- * Allocation+  , newPrimVar+  , newPinnedPrimVar+  , newAlignedPinnedPrimVar+    -- * Access+  , readPrimVar+  , writePrimVar+  , modifyPrimVar+    -- * Information+  , samePrimVar+  , primVarContents+  , isPrimVarPinned+  ) where++import Data.Functor ( ($>) )+import Foreign (Ptr)++import Control.Monad.Primitive ( PrimMonad(PrimState) )+import Data.Primitive+  ( MutablePrimArray+  , Prim+  , newPrimArray+  , newPinnedPrimArray+  , newAlignedPinnedPrimArray+  , readPrimArray+  , writePrimArray+  , sameMutablePrimArray+  , mutablePrimArrayContents+  , isMutablePrimArrayPinned+  )++newtype PrimVar s a = PrimVar (MutablePrimArray s a)++newPrimVar+  :: (Prim a, PrimMonad m)+  => a -> m (PrimVar (PrimState m) a)+-- ^ Create a new `PrimVar` with the specified initial value.+newPrimVar a =+  newPrimArray 1 >>= \arr ->+    writePrimArray arr 0 a $> PrimVar arr++newPinnedPrimVar+  :: (Prim a, PrimMonad m)+  => a -> m (PrimVar (PrimState m) a)+-- ^ Create a new /pinned/ `PrimVar` with the specified initial value.+-- The garbage collector is guaranteed not to move it.+newPinnedPrimVar a =+  newPinnedPrimArray 1 >>= \arr ->+    writePrimArray arr 0 a $> PrimVar arr++newAlignedPinnedPrimVar+  :: (Prim a, PrimMonad m)+  => a -> m (PrimVar (PrimState m) a)+-- ^ Create a new /pinned/ `PrimVar` with the specified initial value+-- and with the alignment given by its Prim instance.+-- The garbage collector is guaranteed not to move it.+newAlignedPinnedPrimVar a =+  newAlignedPinnedPrimArray 1 >>= \arr ->+    writePrimArray arr 0 a $> PrimVar arr++readPrimVar+  :: (Prim a, PrimMonad m)+  => PrimVar (PrimState m) a -> m a+-- ^ Read the value of a `PrimVar`.+readPrimVar (PrimVar v) = readPrimArray v 0++writePrimVar+  :: (Prim a, PrimMonad m)+  => PrimVar (PrimState m) a -> a -> m ()+-- ^ Write a new value into a `PrimVar`.+writePrimVar (PrimVar v) = writePrimArray v 0++modifyPrimVar+  :: (Prim a, PrimMonad m)+  => PrimVar (PrimState m) a -> (a -> a) -> m ()+-- ^ Mutate the contents of a `PrimVar`.+modifyPrimVar v f =+  readPrimVar v >>= \a ->+    writePrimVar v (f a)++samePrimVar :: PrimVar s a -> PrimVar s a -> Bool+-- ^ Check if two `PrimVar`s refer to the same memory block.+samePrimVar (PrimVar v0) (PrimVar v1) =+  sameMutablePrimArray v0 v1++primVarContents :: PrimVar s a -> Ptr a+-- ^ Yield a pointer to a `PrimVar`'s data.+-- This operation is only safe on pinned `PrimVar`s+-- allocated by `newPinnedPrimVar` or `newAlignedPinnedPrimVar`.+primVarContents (PrimVar v) =+  mutablePrimArrayContents v++isPrimVarPinned :: PrimVar s a -> Bool+-- ^ Check whether or not a `PrimVar` is pinned.+isPrimVarPinned (PrimVar v) =+  isMutablePrimArrayPinned v