diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,5 @@ -Copyright (c)2012, Ivan Perez +Copyright (c) 2013-2020, Keera Studios Ltd +Copyright (c) 2010-2012, Ivan Perez All rights reserved. @@ -13,9 +14,9 @@ disclaimer in the documentation and/or other materials provided with the distribution. - * Neither the name of Ivan Perez nor the names of other - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. + * Neither the name of Ivan Perez, nor the name of Keera Studios, nor the + names of other contributors may be used to endorse or promote products + derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT diff --git a/keera-hails-reactive-gtk.cabal b/keera-hails-reactive-gtk.cabal --- a/keera-hails-reactive-gtk.cabal +++ b/keera-hails-reactive-gtk.cabal @@ -1,19 +1,20 @@ --- hails.cabal auto-generated by cabal init. For additional options, --- see --- http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/authors.html#pkg-descr. --- The name of the package. -Name: keera-hails-reactive-gtk - --- The package version. See the Haskell package versioning policy --- (http://www.haskell.org/haskellwiki/Package_versioning_policy) for --- standards guiding when and how versions should be incremented. -Version: 0.5 - --- A short (one-line) description of the package. -Synopsis: Haskell on Gtk rails - Reactive Fields for Gtk widgets +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : All Rights Reserved +-- Maintainer : support@keera.co.uk +-- +cabal-version: >= 1.10 +build-type: Simple --- A longer description of the package. -Description: +name: keera-hails-reactive-gtk +version: 0.6.0 +author: Ivan Perez +maintainer: support@keera.co.uk +homepage: http://www.keera.co.uk/blog/community/ +license: BSD3 +license-file: LICENSE +category: Development +synopsis: Haskell on Gtk rails - Reactive Fields for Gtk widgets +description: A layer defining RVs for GTK+ fields and actions. . Reactive Values are an abstraction for reactive programming based on setters @@ -30,119 +31,110 @@ For details, please see the paper "Bridging the GUI Gap with Reactive Values and Relations", by Ivan Perez and Henrik Nilsson at Haskell Symposium 2015. --- URL for the project homepage or repository. -Homepage: http://www.keera.co.uk/blog/community/ +source-repository head + type: git + location: git://github.com/keera-studios/keera-hails + subdir: keera-hails-reactive-gtk --- The license under which the package is released. -License: BSD3 --- The file containing the license text. -License-file: LICENSE - --- The package author(s). -Author: Ivan Perez - --- An email address to which users can send suggestions, bug reports, --- and patches. -Maintainer: ivan.perez@keera.co.uk +-- You can disable the hlint test suite with -f-test-hlint +flag test-hlint + default: False + manual: True --- A copyright notice. --- Copyright: +-- You can disable the haddock coverage test suite with -f-test-doc-coverage +flag test-doc-coverage + default: False + manual: True -Category: Development +library -Build-type: Simple + exposed-modules: + Graphics.UI.Gtk.Reactive + Graphics.UI.Gtk.Reactive.Gtk2 + Graphics.UI.Gtk.Reactive.Button + Graphics.UI.Gtk.Reactive.ColorButton + Graphics.UI.Gtk.Reactive.CheckMenuItem + Graphics.UI.Gtk.Reactive.Entry + Graphics.UI.Gtk.Reactive.Image + Graphics.UI.Gtk.Reactive.Label + Graphics.UI.Gtk.Reactive.MenuItem + Graphics.UI.Gtk.Reactive.Property + Graphics.UI.Gtk.Reactive.Scale + Graphics.UI.Gtk.Reactive.SpinButton + Graphics.UI.Gtk.Reactive.StatusIcon + Graphics.UI.Gtk.Reactive.TextView + Graphics.UI.Gtk.Reactive.ToolButton + Graphics.UI.Gtk.Reactive.ToggleButton + Graphics.UI.Gtk.Reactive.TreeView + Graphics.UI.Gtk.Reactive.Widget + Graphics.UI.Gtk.Reactive.Window --- Extra files to be distributed with the package, such as examples or --- a README. --- Extra-source-files: + build-depends: + base >= 4 && < 5 + , bytestring + , mtl + , transformers + , glib + , gtk + , gtk-helpers + , cairo --- Constraint on the version of Cabal needed to build this package. -cabal-version: >= 1.10 + , keera-hails-reactivevalues -Library default-language: Haskell2010 hs-source-dirs: src/ ghc-options: -Wall -fno-warn-unused-do-bind -O2 - -- Modules exported by the library. - Exposed-modules: Graphics.UI.Gtk.Reactive - , Graphics.UI.Gtk.Reactive.Gtk2 - , Graphics.UI.Gtk.Reactive.Button - , Graphics.UI.Gtk.Reactive.ColorButton - , Graphics.UI.Gtk.Reactive.CheckMenuItem - , Graphics.UI.Gtk.Reactive.Entry - , Graphics.UI.Gtk.Reactive.Image - , Graphics.UI.Gtk.Reactive.Label - , Graphics.UI.Gtk.Reactive.MenuItem - , Graphics.UI.Gtk.Reactive.Property - , Graphics.UI.Gtk.Reactive.Scale - , Graphics.UI.Gtk.Reactive.SpinButton - , Graphics.UI.Gtk.Reactive.StatusIcon - , Graphics.UI.Gtk.Reactive.TextView - , Graphics.UI.Gtk.Reactive.ToolButton - -- , Graphics.UI.Gtk.Reactive.TypedComboBoxUnsafe - , Graphics.UI.Gtk.Reactive.ToggleButton - , Graphics.UI.Gtk.Reactive.TreeView - , Graphics.UI.Gtk.Reactive.Widget - , Graphics.UI.Gtk.Reactive.Window - -- Packages needed in order to build this package. - Build-depends: base >= 4 && < 5 - , bytestring - , mtl - , transformers - , glib - , gtk - , gtk-helpers - , keera-hails-reactivevalues - , cairo +test-suite hlint -source-repository head - type: git - location: git://github.com/keera-studios/keera-hails - subdir: keera-hails-reactive-gtk + type: + exitcode-stdio-1.0 --- You can disable the hlint test suite with -f-test-hlint -flag test-hlint - default: False - manual: True + main-is: + HLintMain.hs --- You can disable the haddock coverage test suite with -f-test-doc-coverage -flag test-doc-coverage - default: False - manual: True + hs-source-dirs: + tests -test-suite hlint - type: exitcode-stdio-1.0 - main-is: hlint.hs - hs-source-dirs: tests if !flag(test-hlint) buildable: False else build-depends: - base, - hlint >= 1.7 + base + , hlint >= 1.7 - default-language: Haskell2010 + default-language: + Haskell2010 + -- Verify that the code is thoroughly documented test-suite haddock-coverage - type: exitcode-stdio-1.0 - main-is: HaddockCoverage.hs - ghc-options: -Wall - hs-source-dirs: tests + type: + exitcode-stdio-1.0 + + main-is: + HaddockCoverage.hs + + ghc-options: + -Wall + + hs-source-dirs: + tests + if !flag(test-doc-coverage) buildable: False else build-depends: - base >= 4 && < 5, - directory, - filepath, - process, - regex-posix + base >= 4 && < 5 + , directory + , filepath + , process + , regex-posix - default-language: Haskell2010 + default-language: + Haskell2010 diff --git a/src/Graphics/UI/Gtk/Reactive.hs b/src/Graphics/UI/Gtk/Reactive.hs --- a/src/Graphics/UI/Gtk/Reactive.hs +++ b/src/Graphics/UI/Gtk/Reactive.hs @@ -1,3 +1,8 @@ +-- | +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive (module Exported) where diff --git a/src/Graphics/UI/Gtk/Reactive/Button.hs b/src/Graphics/UI/Gtk/Reactive/Button.hs --- a/src/Graphics/UI/Gtk/Reactive/Button.hs +++ b/src/Graphics/UI/Gtk/Reactive/Button.hs @@ -1,5 +1,9 @@ {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of a menuitem +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Button where import Control.Monad diff --git a/src/Graphics/UI/Gtk/Reactive/CheckMenuItem.hs b/src/Graphics/UI/Gtk/Reactive/CheckMenuItem.hs --- a/src/Graphics/UI/Gtk/Reactive/CheckMenuItem.hs +++ b/src/Graphics/UI/Gtk/Reactive/CheckMenuItem.hs @@ -1,4 +1,8 @@ -- | Publishes the main elements of a checkmenuitem +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.CheckMenuItem where import Control.Monad diff --git a/src/Graphics/UI/Gtk/Reactive/ColorButton.hs b/src/Graphics/UI/Gtk/Reactive/ColorButton.hs --- a/src/Graphics/UI/Gtk/Reactive/ColorButton.hs +++ b/src/Graphics/UI/Gtk/Reactive/ColorButton.hs @@ -2,6 +2,10 @@ {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of an entry as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.ColorButton where import Control.Monad (void, when) diff --git a/src/Graphics/UI/Gtk/Reactive/Entry.hs b/src/Graphics/UI/Gtk/Reactive/Entry.hs --- a/src/Graphics/UI/Gtk/Reactive/Entry.hs +++ b/src/Graphics/UI/Gtk/Reactive/Entry.hs @@ -2,6 +2,10 @@ {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of an entry as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Entry where import Data.ReactiveValue diff --git a/src/Graphics/UI/Gtk/Reactive/Gtk2.hs b/src/Graphics/UI/Gtk/Reactive/Gtk2.hs --- a/src/Graphics/UI/Gtk/Reactive/Gtk2.hs +++ b/src/Graphics/UI/Gtk/Reactive/Gtk2.hs @@ -1,4 +1,9 @@ {-# LANGUAGE CPP #-} +-- | +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Gtk2 where import Control.Monad (void) diff --git a/src/Graphics/UI/Gtk/Reactive/Image.hs b/src/Graphics/UI/Gtk/Reactive/Image.hs --- a/src/Graphics/UI/Gtk/Reactive/Image.hs +++ b/src/Graphics/UI/Gtk/Reactive/Image.hs @@ -2,6 +2,10 @@ {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of an entry as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Image where import Data.ReactiveValue diff --git a/src/Graphics/UI/Gtk/Reactive/Label.hs b/src/Graphics/UI/Gtk/Reactive/Label.hs --- a/src/Graphics/UI/Gtk/Reactive/Label.hs +++ b/src/Graphics/UI/Gtk/Reactive/Label.hs @@ -2,6 +2,10 @@ {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of an label as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Label where import Data.ReactiveValue diff --git a/src/Graphics/UI/Gtk/Reactive/MenuItem.hs b/src/Graphics/UI/Gtk/Reactive/MenuItem.hs --- a/src/Graphics/UI/Gtk/Reactive/MenuItem.hs +++ b/src/Graphics/UI/Gtk/Reactive/MenuItem.hs @@ -1,5 +1,9 @@ {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of a menuitem +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.MenuItem where import Control.Monad diff --git a/src/Graphics/UI/Gtk/Reactive/Property.hs b/src/Graphics/UI/Gtk/Reactive/Property.hs --- a/src/Graphics/UI/Gtk/Reactive/Property.hs +++ b/src/Graphics/UI/Gtk/Reactive/Property.hs @@ -1,5 +1,9 @@ {-# LANGUAGE ScopedTypeVariables #-} -- | Publishes the main elements of a scale as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Property where import Control.Monad (void, when) @@ -28,7 +32,7 @@ -- | Create an RV based on a widget's attribute and signal. -- Before setting, the value is *not* checked against the current one. --- The value is thus set even if they are the same. +-- The value is thus set even if they are the same. reactivePropertyNE :: self -> Signal self (IO ()) -> Attr self b -> ReactiveFieldReadWrite IO b diff --git a/src/Graphics/UI/Gtk/Reactive/Scale.hs b/src/Graphics/UI/Gtk/Reactive/Scale.hs --- a/src/Graphics/UI/Gtk/Reactive/Scale.hs +++ b/src/Graphics/UI/Gtk/Reactive/Scale.hs @@ -1,4 +1,8 @@ -- | Publishes the main elements of a scale as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Scale where import Control.GFunctor diff --git a/src/Graphics/UI/Gtk/Reactive/SpinButton.hs b/src/Graphics/UI/Gtk/Reactive/SpinButton.hs --- a/src/Graphics/UI/Gtk/Reactive/SpinButton.hs +++ b/src/Graphics/UI/Gtk/Reactive/SpinButton.hs @@ -1,4 +1,8 @@ -- | Publishes the main elements of a toggle button +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.SpinButton where import Control.GFunctor diff --git a/src/Graphics/UI/Gtk/Reactive/StatusIcon.hs b/src/Graphics/UI/Gtk/Reactive/StatusIcon.hs --- a/src/Graphics/UI/Gtk/Reactive/StatusIcon.hs +++ b/src/Graphics/UI/Gtk/Reactive/StatusIcon.hs @@ -1,5 +1,9 @@ {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of a status icon +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.StatusIcon where import Control.Monad diff --git a/src/Graphics/UI/Gtk/Reactive/TextView.hs b/src/Graphics/UI/Gtk/Reactive/TextView.hs --- a/src/Graphics/UI/Gtk/Reactive/TextView.hs +++ b/src/Graphics/UI/Gtk/Reactive/TextView.hs @@ -1,4 +1,8 @@ -- | Publishes the main elements of a text view as reactive fields +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.TextView where import Control.Monad (void) diff --git a/src/Graphics/UI/Gtk/Reactive/ToggleButton.hs b/src/Graphics/UI/Gtk/Reactive/ToggleButton.hs --- a/src/Graphics/UI/Gtk/Reactive/ToggleButton.hs +++ b/src/Graphics/UI/Gtk/Reactive/ToggleButton.hs @@ -1,4 +1,8 @@ -- | Publishes the main elements of a toggle button +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.ToggleButton where import Control.Monad diff --git a/src/Graphics/UI/Gtk/Reactive/ToolButton.hs b/src/Graphics/UI/Gtk/Reactive/ToolButton.hs --- a/src/Graphics/UI/Gtk/Reactive/ToolButton.hs +++ b/src/Graphics/UI/Gtk/Reactive/ToolButton.hs @@ -1,5 +1,9 @@ {-# LANGUAGE MultiParamTypeClasses #-} -- | Publishes the main elements of a menuitem +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.ToolButton where import Control.Monad diff --git a/src/Graphics/UI/Gtk/Reactive/TreeView.hs b/src/Graphics/UI/Gtk/Reactive/TreeView.hs --- a/src/Graphics/UI/Gtk/Reactive/TreeView.hs +++ b/src/Graphics/UI/Gtk/Reactive/TreeView.hs @@ -1,3 +1,8 @@ +-- | +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.TreeView where import Control.Monad.IO.Class (liftIO) diff --git a/src/Graphics/UI/Gtk/Reactive/Widget.hs b/src/Graphics/UI/Gtk/Reactive/Widget.hs --- a/src/Graphics/UI/Gtk/Reactive/Widget.hs +++ b/src/Graphics/UI/Gtk/Reactive/Widget.hs @@ -1,3 +1,8 @@ +-- | +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Widget where import Control.Monad.IO.Class (liftIO) diff --git a/src/Graphics/UI/Gtk/Reactive/Window.hs b/src/Graphics/UI/Gtk/Reactive/Window.hs --- a/src/Graphics/UI/Gtk/Reactive/Window.hs +++ b/src/Graphics/UI/Gtk/Reactive/Window.hs @@ -1,3 +1,8 @@ +-- | +-- +-- Copyright : (C) Keera Studios Ltd, 2013 +-- License : BSD3 +-- Maintainer : support@keera.co.uk module Graphics.UI.Gtk.Reactive.Window where import Control.Monad (void, when) diff --git a/tests/HLintMain.hs b/tests/HLintMain.hs new file mode 100644 --- /dev/null +++ b/tests/HLintMain.hs @@ -0,0 +1,23 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Main (hlint) +-- Copyright : (C) 2013 Edward Kmett +-- License : BSD-style (see the file LICENSE) +-- Maintainer : Edward Kmett +-- Stability : provisional +-- Portability : portable +-- +-- This module runs HLint on the lens source tree. +----------------------------------------------------------------------------- +module Main where + +import Control.Monad +import Language.Haskell.HLint +import System.Environment +import System.Exit + +main :: IO () +main = do + args <- getArgs + hints <- hlint $ ["src", "--cross", "--hint=tests/HLint.hs" ] ++ args + unless (null hints) exitFailure diff --git a/tests/hlint.hs b/tests/hlint.hs deleted file mode 100644 --- a/tests/hlint.hs +++ /dev/null @@ -1,23 +0,0 @@ ------------------------------------------------------------------------------ --- | --- Module : Main (hlint) --- Copyright : (C) 2013 Edward Kmett --- License : BSD-style (see the file LICENSE) --- Maintainer : Edward Kmett --- Stability : provisional --- Portability : portable --- --- This module runs HLint on the lens source tree. ------------------------------------------------------------------------------ -module Main where - -import Control.Monad -import Language.Haskell.HLint -import System.Environment -import System.Exit - -main :: IO () -main = do - args <- getArgs - hints <- hlint $ ["src", "--cross", "--hint=tests/HLint.hs" ] ++ args - unless (null hints) exitFailure