| Copyright | (C) 2012-2016 University of Twente |
|---|---|
| License | BSD2 (see the file LICENSE) |
| Maintainer | QBayLogic B.V. <devops@qbaylogic.com> |
| Safe Haskell | None |
| Language | Haskell2010 |
Clash.Util
Description
Assortment of utility function used in the Clash library
Synopsis
- assertPanic :: String -> Int -> a
- pprDebugAndThen :: (String -> a) -> Doc ann -> Doc ann -> a
- pprPanic :: String -> Doc ann -> a
- callStackDoc :: HasCallStack => Doc ann
- assertPprPanic :: HasCallStack => String -> Int -> Doc ann -> a
- pprTrace :: String -> Doc ann -> a -> a
- pprTraceDebug :: String -> Doc ann -> a -> a
- warnPprTrace :: HasCallStack => Bool -> String -> Int -> Doc ann -> a -> a
- class Monad m => MonadUnique (m :: Type -> Type) where
- getUniqueM :: m Unique
- curLoc :: Q Exp
- clogBase :: Integer -> Integer -> Maybe Int
- makeCached :: (MonadState s m, Hashable k, Eq k) => k -> Lens' s (HashMap k v) -> m v -> m v
- indexNote :: HasCallStack => String -> [a] -> Int -> a
- thenCompare :: Ordering -> Ordering -> Ordering
- data ClashException = ClashException SrcSpan String (Maybe String)
- reportTimeDiff :: UTCTime -> UTCTime -> String
- wantedLanguageExtensions :: [Extension]
- unwantedLanguageExtensions :: [Extension]
- makeCachedU :: (MonadState s m, Uniquable k) => k -> Lens' s (UniqMap v) -> m v -> m v
- namePat :: Name -> Q Pat
- makeCachedO :: (MonadState s m, Uniquable k) => k -> Lens' s (OMap Unique v) -> m v -> m v
- indexNote' :: HasCallStack => String -> Int -> [a] -> a
- clashLibVersion :: Version
- flogBase :: Integer -> Integer -> Maybe Int
- pkgIdFromTypeable :: Typeable a => a -> String
- orElses :: [Maybe a] -> Maybe a
- data SrcSpan
- noSrcSpan :: SrcSpan
- hoistMaybe :: forall (m :: Type -> Type) b. Applicative m => Maybe b -> MaybeT m b
Documentation
assertPanic :: String -> Int -> a Source #
pprDebugAndThen :: (String -> a) -> Doc ann -> Doc ann -> a Source #
callStackDoc :: HasCallStack => Doc ann Source #
assertPprPanic :: HasCallStack => String -> Int -> Doc ann -> a Source #
pprTraceDebug :: String -> Doc ann -> a -> a Source #
Arguments
| :: HasCallStack | |
| => Bool | Trigger warning? |
| -> String | File name |
| -> Int | Line number |
| -> Doc ann | Message |
| -> a | Pass value (like trace) |
| -> a |
class Monad m => MonadUnique (m :: Type -> Type) where Source #
A class that can generate unique numbers
Instances
| MonadUnique (RewriteMonad extra) Source # | |
Defined in Clash.Rewrite.Types Methods getUniqueM :: RewriteMonad extra Unique Source # | |
| Monad m => MonadUnique (StateT Unique m) Source # | |
Defined in Clash.Util | |
Create a TH expression that returns the a formatted string containing the
name of the module curLoc is spliced into, and the line where it was spliced.
Arguments
| :: (MonadState s m, Hashable k, Eq k) | |
| => k | The key the action is associated with |
| -> Lens' s (HashMap k v) | The Lens to the HashMap that is the cache |
| -> m v | The action to cache |
| -> m v |
Cache the result of a monadic action
Arguments
| :: HasCallStack | |
| => String | Error message to display |
| -> [a] | List to index |
| -> Int | Index n |
| -> a | Error or element n |
Unsafe indexing, return a custom error message when indexing fails
data ClashException Source #
Constructors
| ClashException SrcSpan String (Maybe String) |
Instances
| Exception ClashException Source # | |
Defined in Clash.Util Methods toException :: ClashException -> SomeException Source # fromException :: SomeException -> Maybe ClashException Source # | |
| Show ClashException Source # | |
Defined in Clash.Util | |
Arguments
| :: (MonadState s m, Uniquable k) | |
| => k | Key the action is associated with |
| -> Lens' s (UniqMap v) | Lens to the cache |
| -> m v | Action to cache |
| -> m v |
Cache the result of a monadic action using a UniqMap
namePat :: Name -> Q Pat Source #
Construct a string pattern match out of the given TemplateHaskell name
Arguments
| :: (MonadState s m, Uniquable k) | |
| => k | Key the action is associated with |
| -> Lens' s (OMap Unique v) | Lens to the cache |
| -> m v | Action to cache |
| -> m v |
Cache the result of a monadic action using a OMap
Arguments
| :: HasCallStack | |
| => String | Error message to display |
| -> Int | Index n |
| -> [a] | List to index |
| -> a | Error or element n |
Same as indexNote with last two arguments swapped
pkgIdFromTypeable :: Typeable a => a -> String Source #
Get the package id of the type of a value
>>>pkgIdFromTypeable (0 :: Unsigned 32)"clash-prelude-...
Source Span
A SrcSpan identifies either a specific portion of a text file
or a human-readable description of a location.
Instances
hoistMaybe :: forall (m :: Type -> Type) b. Applicative m => Maybe b -> MaybeT m b Source #