keera-hails-mvc-environment-gtk (empty) → 0.0.3.3

raw patch · 5 files changed

+174/−0 lines, 5 filesdep +basedep +keera-hails-mvc-model-protectedmodeldep +keera-hails-mvc-viewsetup-changed

Dependencies added: base, keera-hails-mvc-model-protectedmodel, keera-hails-mvc-view, keera-hails-mvc-view-gtk

Files

LICENSE +30/−0
Setup.hs +2/−0
keera-hails-mvc-environment-gtk.cabal +61/−0
src/Hails/MVC/DefaultGtkEnvironment.hs +18/−0
src/Hails/MVC/GenericCombinedEnvironment.hs +63/−0

+ LICENSE view

@@ -0,0 +1,30 @@+Copyright (c)2012, Ivan Perez++All rights reserved.++Redistribution and use in source and binary forms, with or without+modification, are permitted provided that the following conditions are met:++    * Redistributions of source code must retain the above copyright+      notice, this list of conditions and the following disclaimer.++    * Redistributions in binary form must reproduce the above+      copyright notice, this list of conditions and the following+      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.++THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+ Setup.hs view

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

+ keera-hails-mvc-environment-gtk.cabal view

@@ -0,0 +1,61 @@+-- 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-mvc-environment-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.0.3.3++-- A short (one-line) description of the package.+Synopsis:            Haskell on Gtk rails - Gtk-based global environment for MVC applications++-- A longer description of the package.+-- Description:         ++-- URL for the project homepage or repository.+Homepage:            http://www.keera.es/blog/community/++-- 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.es++-- A copyright notice.+-- Copyright:           ++Category:            Development++Build-type:          Simple++-- Extra files to be distributed with the package, such as examples or+-- a README.+-- Extra-source-files:  ++-- Constraint on the version of Cabal needed to build this package.+Cabal-version:       >=1.2++Library+  hs-source-dirs: src/+  +  ghc-options: -Wall -fno-warn-unused-do-bind -O2++  -- Modules exported by the library.+  Exposed-modules: Hails.MVC.GenericCombinedEnvironment+                 , Hails.MVC.DefaultGtkEnvironment+  +  -- Packages needed in order to build this package.+  Build-depends: base >= 4 && < 5+               , keera-hails-mvc-model-protectedmodel+               , keera-hails-mvc-view+               , keera-hails-mvc-view-gtk

+ src/Hails/MVC/DefaultGtkEnvironment.hs view

@@ -0,0 +1,18 @@+-- | The environment that contains both the view and the model.+--+module Hails.MVC.DefaultGtkEnvironment+   ( view+   , GEnv.model+   , GEnv.createCEnv+   , GEnv.installCondition+   , GEnv.installConditions+   )+  where++-- Internal libraries+import qualified Hails.MVC.View.GtkView               as GtkView+import qualified Hails.MVC.GenericCombinedEnvironment as GEnv+import           Hails.MVC.Model.ReactiveModel++view :: (GtkView.GtkGUI a, Event c) => GEnv.CEnv a b c -> a+view = GtkView.getGUI . GEnv.view

+ src/Hails/MVC/GenericCombinedEnvironment.hs view

@@ -0,0 +1,63 @@+-- | This module contains the necessary functions to manipulate a global+-- environment that gives access to the view and the model in a MVC-structured+-- program with a Gtk View.+--+-- It contains the necessary functions to create an environment+-- that holds a View and a Protected Reactive Model.+--+-- Although this code is stable, the design is experimental. Usage in real+-- applications should give way to better implementations.+module Hails.MVC.GenericCombinedEnvironment+   ( CEnv (view, model)+   , createCEnv+   , installConditions+   , installCondition+   )+  where++-- Internal libraries+import Hails.MVC.View+import Hails.MVC.View.GtkView+import Hails.MVC.Model.ProtectedModel+import Hails.MVC.Model.ReactiveModel (Event)++-- | Given a GUI and a Type for the events, a CEnv contains a View and a+-- Protected Model.+data (GtkGUI a, Event c) => CEnv a b c = CEnv+  { view  :: GtkView a+  , model :: ProtectedModel b c+  }++-- | To create an Environment, we just need to provide the+-- default internal model. The initialisation operations+-- for the view and the protected model are called internally.+createCEnv :: (GtkGUI a, Event c) => b -> IO (CEnv a b c)+createCEnv emptyBM = do+  m <- startProtectedModel emptyBM+  v <- createView+  return CEnv { view = v, model = m }++-- | Installs a condition in the Combined Environment.+--+-- NOTE: This is an experimental function and might be removed in the future.+installCondition :: (GtkGUI a, Event c) => CEnv a b c -> (CEnv a b c -> IO()) -> IO()+installCondition cenv cond = cond cenv++-- | Installs several conditions in the Combined Environment.+--+-- FIXME: I really don't like the syntax+--   installConditions cenv +--      [ rv1 =:= rf1+--      , ...+--      ]+--+--   I'd rather use+--   installConditions cenv $ do+--     rv1 =:= rf1+--     rv2 =:= rf2+--     ...+--   Which means that I would have to define a monad.+--+-- NOTE: This is an experimental function and might be removed in the future.+installConditions :: (GtkGUI a, Event c) => CEnv a b c -> [ CEnv a b c -> IO() ] -> IO ()+installConditions cenv conds = mapM_ (installCondition cenv) conds