Requirements.hs

{-
	Copyright (C) 2013 Dr. Alistair Ward

	This file is part of WeekDaze.

	WeekDaze is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	WeekDaze is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with WeekDaze.  If not, see <http://www.gnu.org/licenses/>.
-}
{- |
 [@AUTHOR@]	Dr. Alistair Ward

 [@DESCRIPTION@]	Partitions a set of arbitrary requirements, into those which are required & those which are merely desired.
-}

module WeekDaze.Data.Requirements(
-- * Types
-- ** Type-synonyms
	Requirements,
-- * Constants
	coreTag,
	optionalTag,
-- * Functions
-- ** Accessors
	getCore,
	getOptional
) where

-- | Used to qualify XML.
coreTag :: String
coreTag		= "core"

-- | Used to qualify XML.
optionalTag :: String
optionalTag	= "optional"

-- | The /core/ & /optional/ requirements, of some unspecified type.
type Requirements a	= (a, a)

-- | Accessor.
getCore :: Requirements a -> a
getCore		= fst

-- | Accessor.
getOptional :: Requirements a -> a
getOptional	= snd