-- | Even though we do not have 'Label's per se, here we define the
-- different ways of construction  ways to mark labels.
module Language.Drasil.Label.Type(
  -- * Types
    LblType(RP, Citation, URI), IRefProg(..)
  -- * Classes
  , HasRefAddress(..), Referable(..)
  -- * 'LblType' accessor
  , getAdd
  -- * 'IRefProg' constructors
  , name, (+::+), raw, defer, prepend
) where

import Drasil.Database (UID, HasUID)

-- | Applying different pieces of information for a reference.
-- An RP is a decorated internal reference.
-- Citation is a citation.
-- URI is for URLs and other external links.
data LblType =
    RP IRefProg String
  | Citation String
  | URI String

-- | Created for different forms of references. Used in 'LblType'.
data IRefProg =
    Deferred UID                -- ^ Deferred lookup; done later. Used for domains in a 'ConceptInstance'.
  | RS String                   -- ^ Lifts a 'String' into a 'RefProg'.
  | RConcat IRefProg IRefProg   -- ^ Concatenates with two subprograms.
  | Name                        -- ^ The 'Symbol' to insert the 'ShortName' directly.

-- | Members must have a reference address.
class HasRefAddress b where
  -- | Provides the ability to hold a reference address.
  getRefAdd :: b -> LblType

-- | Members of this class have the ability to be referenced.
class (HasUID s, HasRefAddress s) => Referable s where
  -- | The referencing address (what we're linking to).
  -- Only visible in the source (tex/html).
  refAdd    :: s -> String
  -- | Alternate form of reference.
  renderRef :: s -> LblType

-- | Retrieves the 'String' contained in a 'LblType'.
getAdd :: LblType -> String
getAdd :: LblType -> String
getAdd (RP IRefProg
_ String
s)     = String
s
getAdd (Citation String
s) = String
s
getAdd (URI String
s)      = String
s

-- | Constructor that gets the 'Name' of an 'IRefProg'.
name :: IRefProg
name :: IRefProg
name = IRefProg
Name

-- | Constructor that concatenates two subprograms.
(+::+) :: IRefProg -> IRefProg -> IRefProg
+::+ :: IRefProg -> IRefProg -> IRefProg
(+::+) = IRefProg -> IRefProg -> IRefProg
RConcat

-- | Constructor for a 'String' into an 'IRefProg'.
raw :: String -> IRefProg
raw :: String -> IRefProg
raw = String -> IRefProg
RS

-- | Constructor to defer a 'UID' lookup; done later.
defer :: UID -> IRefProg
defer :: UID -> IRefProg
defer = UID -> IRefProg
Deferred

-- | Prepends a 'String' to an 'IRefProg'.
prepend :: String -> IRefProg
prepend :: String -> IRefProg
prepend String
s = String -> IRefProg
RS String
s IRefProg -> IRefProg -> IRefProg
+::+ String -> IRefProg
RS String
":" IRefProg -> IRefProg -> IRefProg
+::+ IRefProg
Name