Created isLabel and HasLabel classes (#643)

* created isLabel and HasLabel classes

* moved newly created classes to Classes file; created new file to avoid cyclic imports

* Renamed some files as suggested

code/Language/Drasil/Classes.hs

@@ -11,6 +11,8 @@ module Language.Drasil.Classes (
   , HasSpace(typ)
   , HasUnitSymbol(usymb)
   , IsUnit
+  , HasLabel(getLabel)
+  , IsLabel
   , UnitEq(uniteq)
   , HasReference(getReferences)
   , CommonIdea(abrv)
@@ -24,6 +26,7 @@ import Language.Drasil.Chunk.Constrained.Core (Constraint)
 import Language.Drasil.Chunk.Derivation (Derivation)
 import Language.Drasil.Chunk.References (References)
 import Language.Drasil.Expr (Expr)
+import Language.Drasil.Label.Core (Label)
 import Language.Drasil.NounPhrase.Core (NP)
 import Language.Drasil.Space (Space)
 import Language.Drasil.Spec (Sentence)
@@ -94,6 +97,13 @@ class Constrained c where
 class HasReasVal c where
   reasVal     :: Lens' c (Maybe Expr)
 
+-- | For those things which "have a label"
+class HasLabel c where
+  getLabel :: Lens' c Label
+
+-- IsLabel is associated with String rendering
+class (HasLabel u, HasUID u) => IsLabel u where
+
 -----------------------------------------------------
 -- Below are for units only
 -- | Some chunks store a unit symbol

code/Language/Drasil/Label.hs

@@ -1,21 +1,9 @@
-{-# Language TemplateHaskell #-}
 module Language.Drasil.Label (Label) where
 
-import Control.Lens (makeLenses)
-import Language.Drasil.UID (UID)
+import Language.Drasil.Label.Core
 import Language.Drasil.Classes (HasUID(uid))
 import Data.Char (isAscii)
 
--- import reference address from Language.Drasil.References?
-data LblType = RefAdd String | MetaLink String | URI String
-
--- Used for referencing; has to be pure ASCII
-data Label = Lbl
-  { _uniqueID  :: UID --internal, unique
-  , lblType    :: LblType 
-  }
-makeLenses ''Label
-
 instance HasUID Label where uid = uniqueID
 
 -- multiple mkLabel constructors for label creation
@@ -29,6 +17,5 @@ mkLabelML id ref = Lbl id (MetaLink $ ensureASCII ref)
 mkLabelURI :: String -> String -> Label
 mkLabelURI id ref = Lbl id (URI $ ensureASCII ref)
 
--- helpers
 ensureASCII :: String -> String
 ensureASCII s = map (\y -> if isAscii y then y else error "Label needs to be pure ASCII.") s

code/Language/Drasil/Label/Core.hs

@@ -0,0 +1,15 @@
+{-# Language TemplateHaskell #-}
+module Language.Drasil.Label.Core where
+
+import Control.Lens (makeLenses)
+import Language.Drasil.UID (UID)
+
+-- import reference address from Language.Drasil.References?
+data LblType = RefAdd String | MetaLink String | URI String
+
+-- Used for referencing; has to be pure ASCII
+data Label = Lbl
+  { _uniqueID  :: UID --internal, unique
+  , lblType    :: LblType 
+  }
+makeLenses ''Label

code/drasil.cabal

@@ -41,6 +41,7 @@ library
     , Language.Drasil.Expr.Math
     , Language.Drasil.Expr.Precedence
     , Language.Drasil.Classes
+    , Language.Drasil.Label.Core
     , Language.Drasil.Label
     , Language.Drasil.Config
     , Language.Drasil.Document