1-----------------------------------------------------------------------------
3-- Module : Language.PureScript.Names
4-- Copyright : (c) Phil Freeman 2013
7-- Maintainer : Phil Freeman <paf31@cantab.net>
8-- Stability : experimental
12-- Data types for names
14-----------------------------------------------------------------------------
16{-# LANGUAGE DeriveDataTypeable #-}
17{-# LANGUAGE DeriveFunctor #-}
18{-# LANGUAGE TemplateHaskell #-}
21module Language.PureScript.Names where
25import Data.List.Split (splitOn)
27import qualified Data.Aeson as A
28import qualified Data.Text as T
31-- Names for value identifiers
35 -- An alphanumeric identifier
39 -- A symbolic name for an infix operator
41 | Op String deriving (Show, Read, Eq, Ord, Data, Typeable)
43runIdent :: Ident -> String
47showIdent :: Ident -> String
48showIdent (Ident i) = i
49showIdent (Op op) = '(' : op ++ ")"
52-- Proper names, i.e. capitalized names for e.g. module names, type//data constructors.
54newtype ProperName = ProperName { runProperName :: String } deriving (Show, Read, Eq, Ord, Data, Typeable)
59newtype ModuleName = ModuleName [ProperName] deriving (Show, Read, Eq, Ord, Data, Typeable)
61runModuleName :: ModuleName -> String
62runModuleName (ModuleName pns) = intercalate "." (runProperName `map` pns)
64moduleNameFromString :: String -> ModuleName
65moduleNameFromString = ModuleName . splitProperNames
67 splitProperNames s = case dropWhile (== '.') s of
69 s' -> ProperName w : splitProperNames s''
70 where (w, s'') = break (== '.') s'
73-- A qualified name, i.e. a name with an optional module name
75data Qualified a = Qualified (Maybe ModuleName) a deriving (Show, Read, Eq, Ord, Data, Typeable, Functor)
77showQualified :: (a -> String) -> Qualified a -> String
78showQualified f (Qualified Nothing a) = f a
79showQualified f (Qualified (Just name) a) = runModuleName name ++ "." ++ f a
81instance (a ~ ProperName) => A.ToJSON (Qualified a) where
82 toJSON = A.toJSON . showQualified runProperName
84instance (a ~ ProperName) => A.FromJSON (Qualified a) where
86 A.withText "Qualified ProperName" $ \str ->
87 return $ case reverse (splitOn "." (T.unpack str)) of
88 [name] -> Qualified Nothing (ProperName name)
89 (name:rest) -> Qualified (Just (reconstructModuleName rest)) (ProperName name)
90 _ -> Qualified Nothing (ProperName "")
92 reconstructModuleName = moduleNameFromString . intercalate "." . reverse
95-- Provide a default module name, if a name is unqualified
97qualify :: ModuleName -> Qualified a -> (ModuleName, a)
98qualify m (Qualified Nothing a) = (m, a)
99qualify _ (Qualified (Just m) a) = (m, a)
102-- Makes a qualified value from a name and module name.
104mkQualified :: a -> ModuleName -> Qualified a
105mkQualified name mn = Qualified (Just mn) name
107-- | Remove the module name from a qualified name
108disqualify :: Qualified a -> a
109disqualify (Qualified _ a) = a
112-- Checks whether a qualified value is actually qualified with a module reference
114isUnqualified :: Qualified a -> Bool
115isUnqualified (Qualified Nothing _) = True
116isUnqualified _ = False
118$(deriveJSON (defaultOptions { sumEncoding = ObjectWithSingleField }) ''Ident)
119$(deriveJSON (defaultOptions { sumEncoding = ObjectWithSingleField }) ''ProperName)
120$(deriveJSON (defaultOptions { sumEncoding = ObjectWithSingleField }) ''ModuleName)
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list