-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Declare, construct and verify directory layout
--   
--   Language to express directory layouts
@package directory-layout
@version 0.3.0.0


-- | Wrappers around exception throwing functions and related routines
module System.Directory.Layout.Errored

-- | Information about cought exceptions in various routines
data LayoutException

-- | <a>createDirectory</a> exceptions
CD :: IOErrorType -> FilePath -> LayoutException

-- | <a>createFile</a> eceptions
CF :: IOErrorType -> FilePath -> LayoutException

-- | <a>fileExists</a> eceptions
FE :: IOErrorType -> FilePath -> LayoutException

-- | <a>directoryExists</a> eceptions
DE :: IOErrorType -> FilePath -> LayoutException

-- | <a>readFile</a> eceptions
RF :: IOErrorType -> FilePath -> Text -> LayoutException

-- | IO-exceptions-free <a>createDirectory</a>
createDirectory :: MonadIO m => FilePath -> m (Either LayoutException ())

-- | IO-exceptions-free <a>writeFile</a>
createFile :: MonadIO m => FilePath -> Maybe Text -> m (Either LayoutException ())

-- | <a>doesFileExists</a> that returns <a>Either</a> instead of
--   <a>Bool</a>
fileExists :: MonadIO m => FilePath -> m (Either LayoutException ())

-- | <a>doesDirectoryExists</a> that returns <a>Either</a> instead of
--   <a>Bool</a>
directoryExists :: MonadIO m => FilePath -> m (Either LayoutException ())

-- | IO-exceptions-free <a>readFile</a>
readFile :: MonadIO m => FilePath -> Text -> m (Either LayoutException ())

-- | Log failures
anyfail :: MonadWriter [w] m => m (Either w a) -> m ()

-- | Make paths in <a>LayoutException</a> relative to given <a>FilePath</a>
relative :: FilePath -> LayoutException -> LayoutException
instance Show LayoutException
instance Eq LayoutException


-- | Free monad based directory layouts
module System.Directory.Layout.Internal

-- | Representation of directory layouts
--   
--   Invariants:
--   
--   <ul>
--   <li><a>F</a> second argument is never <tt>D _ _ _</tt> or <tt>F _ _
--   _</tt> itself</li>
--   <li><a>F</a> third argument is never <tt>T _ _</tt></li>
--   <li><a>D</a> second argument is never <tt>T _ _</tt></li>
--   <li><a>D</a> third argument is never <tt>T _ _</tt></li>
--   </ul>
data DL a

-- | Emptyness, nothing found here
E :: !a -> DL a

-- | File contents
T :: !Text -> !a -> DL a

-- | File node
F :: !FilePath -> !Layout -> !(DL a) -> DL a

-- | Directory node
D :: !FilePath -> !Layout -> !(DL a) -> DL a

-- | Type synonym to save some acrobatics
type Layout = DL ()
instance Show a => Show (DL a)
instance Read a => Read (DL a)
instance Eq a => Eq (DL a)
instance Ord a => Ord (DL a)
instance Traversable DL
instance Foldable DL
instance Monad DL
instance Bind DL
instance Applicative DL
instance Apply DL
instance Functor DL
instance Default a => Monoid (DL a)
instance Semigroup (DL a)
instance Default a => Default (DL a)


-- | <a>Layout</a> traverses
module System.Directory.Layout.Traverse

-- | Make layout as specified
--   
--   For example, suppose you are in an empty directory
--   
--   <pre>
--   % tree
--   .
--   </pre>
--   
--   and you've written simple layout:
--   
--   <pre>
--   layout = do
--     directory "baz" $
--       file_ "twey"
--     directory "foo" $ do
--       directory "bar" $ do
--         file_ "quuz"
--         file_ "tatata"
--       file_ "quux"
--   </pre>
--   
--   then running it should result in this directory tree:
--   
--   <pre>
--   % tree
--   .
--   ├── baz
--   │   └── twey
--   └── foo
--       ├── bar
--       │   ├── quuz
--       │   └── tatata
--       └── quux
--   </pre>
make :: Layout -> FilePath -> IO [LayoutException]

-- | Check directory layout agrees with specified one
--   
--   For example, suppose there is a tree:
--   
--   <pre>
--   % tree
--   .
--   ├── baz
--   │   └── twey
--   └── foo
--       ├── bar
--       │   ├── quuz
--       │   └── tatata
--       └── quux
--   </pre>
--   
--   then you can write:
--   
--   <pre>
--   layout = do
--     directory "baz" $
--       file_ "twey"
--     directory "foo" $ do
--       directory "bar" $ do
--         file_ "quuz"
--         file_ "tatata"
--       file_ "quux"
--   </pre>
--   
--   and running <tt>check layout "."</tt> should result in <tt>[]</tt>
check :: Layout -> FilePath -> IO [LayoutException]


-- | <a>Control.Lens</a> based extractors for <a>DL</a>
module System.Directory.Layout.Lens

-- | Get <a>Text</a> out of the current <a>Layout</a> (if possible)
--   
--   <pre>
--   &gt;&gt;&gt; layout ^? text
--   Nothing
--   
--   &gt;&gt;&gt; layout ^? file "foo" . text
--   Just "not empty"
--   
--   &gt;&gt;&gt; layout ^? directory "bar" . file "quux" . text
--   Just "something"
--   </pre>
text :: Prism Layout Layout Text Text

-- | Look into the file in the current <a>Layout</a> (if possible)
--   
--   <pre>
--   &gt;&gt;&gt; layout ^? file "biz"
--   Nothing
--   
--   &gt;&gt;&gt; layout ^? file "swaks"
--   Just (E ())
--   
--   &gt;&gt;&gt; layout ^? directory "bar" . file "baz"
--   Just (E ())
--   </pre>
file :: FilePath -> IndexedTraversal' FilePath Layout Layout

-- | Go into the directory in the current <a>Layout</a> (if possible)
--   
--   <pre>
--   &gt;&gt;&gt; layout ^? directory "foo"
--   Nothing
--   
--   &gt;&gt;&gt; layout ^? directory "bar"
--   Just (F "baz" (E ()) (F "quux" (T "something" ()) (E ())))
--   </pre>
directory :: FilePath -> IndexedTraversal' FilePath Layout Layout


-- | Language to express directory layouts
module System.Directory.Layout

-- | Representation of directory layouts
--   
--   Invariants:
--   
--   <ul>
--   <li><a>F</a> second argument is never <tt>D _ _ _</tt> or <tt>F _ _
--   _</tt> itself</li>
--   <li><a>F</a> third argument is never <tt>T _ _</tt></li>
--   <li><a>D</a> second argument is never <tt>T _ _</tt></li>
--   <li><a>D</a> third argument is never <tt>T _ _</tt></li>
--   </ul>
data DL a

-- | Type synonym to save some acrobatics
type Layout = DL ()

-- | Declare file with specified contents
file :: FilePath -> Text -> Layout

-- | Declare empty file
file_ :: FilePath -> Layout

-- | Declare directory with specified listing
directory :: FilePath -> Layout -> Layout

-- | Declare empty directory
directory_ :: FilePath -> Layout

-- | Make layout as specified
--   
--   For example, suppose you are in an empty directory
--   
--   <pre>
--   % tree
--   .
--   </pre>
--   
--   and you've written simple layout:
--   
--   <pre>
--   layout = do
--     directory "baz" $
--       file_ "twey"
--     directory "foo" $ do
--       directory "bar" $ do
--         file_ "quuz"
--         file_ "tatata"
--       file_ "quux"
--   </pre>
--   
--   then running it should result in this directory tree:
--   
--   <pre>
--   % tree
--   .
--   ├── baz
--   │   └── twey
--   └── foo
--       ├── bar
--       │   ├── quuz
--       │   └── tatata
--       └── quux
--   </pre>
make :: Layout -> FilePath -> IO [LayoutException]

-- | Check directory layout agrees with specified one
--   
--   For example, suppose there is a tree:
--   
--   <pre>
--   % tree
--   .
--   ├── baz
--   │   └── twey
--   └── foo
--       ├── bar
--       │   ├── quuz
--       │   └── tatata
--       └── quux
--   </pre>
--   
--   then you can write:
--   
--   <pre>
--   layout = do
--     directory "baz" $
--       file_ "twey"
--     directory "foo" $ do
--       directory "bar" $ do
--         file_ "quuz"
--         file_ "tatata"
--       file_ "quux"
--   </pre>
--   
--   and running <tt>check layout "."</tt> should result in <tt>[]</tt>
check :: Layout -> FilePath -> IO [LayoutException]

-- | Information about cought exceptions in various routines
data LayoutException

-- | <a>createDirectory</a> exceptions
CD :: IOErrorType -> FilePath -> LayoutException

-- | <a>createFile</a> eceptions
CF :: IOErrorType -> FilePath -> LayoutException

-- | <a>fileExists</a> eceptions
FE :: IOErrorType -> FilePath -> LayoutException

-- | <a>directoryExists</a> eceptions
DE :: IOErrorType -> FilePath -> LayoutException

-- | <a>readFile</a> eceptions
RF :: IOErrorType -> FilePath -> Text -> LayoutException