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


-- | Simple Makefile parser
--   
--   This package provides a few <tt>Attoparser</tt> parsers and
--   convenience functions for parsing Makefiles. The datatypes used for
--   describing Makefiles are located in <a>Data.Makefile</a>. The parsers
--   and parsing functions are located in <a>Data.Makefile.Parse</a>. To
--   parse a Makefile in the current folder, simply run
--   <a>parseMakefile</a>. To parse a Makefile located at <tt>path</tt>,
--   run <a>parseAsMakefile</a> <tt>path</tt>.
@package makefile
@version 0.1.0.2


-- | This module defines the different types used when working with a
--   Makefile.
--   
--   <pre>
--   # File: Makefile
--   
--   hello = world
--   
--   foo: bar
--     baz
--   </pre>
--   
--   <pre>
--   Makefile {
--     entries =
--       [ Assignment "hello " " world"
--       , Rule (Target "foo") [Dependency "bar"] [Command "baz"] ]
--       })
--   </pre>
module Data.Makefile

-- | A Makefile object, a list of makefile entries
data Makefile
Makefile :: [Entry] -> Makefile
[entries] :: Makefile -> [Entry]

-- | A makefile entry, either a rule <tt>(target: dep1 dep1; commands)</tt>
--   or a variable assignment (<tt>hello = world</tt> or <tt>hello :=
--   world</tt>)
data Entry
Rule :: Target -> [Dependency] -> [Command] -> Entry
Assignment :: ByteString -> ByteString -> Entry

-- | Makefile target (<tt>foo</tt> in the example above)
newtype Target
Target :: ByteString -> Target

-- | Target dependency (<tt>bar</tt> in the example above)
newtype Dependency
Dependency :: ByteString -> Dependency

-- | Command (<tt>baz</tt> in the example above)
newtype Command
Command :: ByteString -> Command
instance GHC.Classes.Eq Data.Makefile.Makefile
instance GHC.Show.Show Data.Makefile.Makefile
instance GHC.Classes.Eq Data.Makefile.Entry
instance GHC.Show.Show Data.Makefile.Entry
instance Data.String.IsString Data.Makefile.Command
instance GHC.Classes.Eq Data.Makefile.Command
instance GHC.Show.Show Data.Makefile.Command
instance Data.String.IsString Data.Makefile.Dependency
instance GHC.Classes.Eq Data.Makefile.Dependency
instance GHC.Show.Show Data.Makefile.Dependency
instance Data.String.IsString Data.Makefile.Target
instance GHC.Classes.Eq Data.Makefile.Target
instance GHC.Show.Show Data.Makefile.Target

module Data.Makefile.Parse.Internal

-- | Parse makefile.
--   
--   Tries to open and parse a file name <tt>Makefile</tt> in the current
--   directory.
parseMakefile :: IO (Either String Makefile)

-- | Parse the specified file as a makefile.
parseAsMakefile :: FilePath -> IO (Either String Makefile)

-- | Parser for a makefile
makefile :: Parser Makefile

-- | Parser for a makefile entry (either a rule or a variable assignment)
entry :: Parser Entry

-- | Parser of variable assignment
assignment :: Parser Entry

-- | Parser for an entire rule
rule :: Parser Entry

-- | Parser for a command
command :: Parser Command

-- | Parser for a (rule) target
target :: Parser Target

-- | Parser for a (rule) dependency
dependency :: Parser Dependency

-- | Parser for variable name in declaration (lazy set, <tt>var = x</tt>)
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly lazyVar "CFLAGS=-c -Wall"
--   Right "CFLAGS"
--   </pre>
lazyVar :: Parser ByteString

-- | Parser for variable name in declaration (immediate set, <tt>var :=
--   x</tt>)
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly immVar "CFLAGS:=-c -Wall"
--   Right "CFLAGS"
--   </pre>
immVar :: Parser ByteString

-- | Parser for a comment (the comment starts with the hashtag)
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly comment "# I AM A COMMENT"
--   Right " I AM A COMMENT"
--   </pre>
comment :: Parser ByteString

-- | Consume a newline character (<tt>'\n'</tt>)
nextLine :: Parser ()

-- | Consume an empty line (potentially containing spaces and/or tabs).
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly emptyLine "\t\t   \t   \t\n"
--   Right ()
--   </pre>
emptyLine :: Parser ()
isSpaceChar :: Char -> Bool
toLineEnd1 :: Parser ByteString

module Data.Makefile.Parse

-- | Parse makefile.
--   
--   Tries to open and parse a file name <tt>Makefile</tt> in the current
--   directory.
parseMakefile :: IO (Either String Makefile)

-- | Parse the specified file as a makefile.
parseAsMakefile :: FilePath -> IO (Either String Makefile)

-- | Parser for a makefile
makefile :: Parser Makefile

-- | Parser for a makefile entry (either a rule or a variable assignment)
entry :: Parser Entry

-- | Parser of variable assignment
assignment :: Parser Entry

-- | Parser for an entire rule
rule :: Parser Entry

-- | Parser for a command
command :: Parser Command

-- | Parser for a (rule) target
target :: Parser Target

-- | Parser for a (rule) dependency
dependency :: Parser Dependency

-- | Parser for variable name in declaration (lazy set, <tt>var = x</tt>)
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly lazyVar "CFLAGS=-c -Wall"
--   Right "CFLAGS"
--   </pre>
lazyVar :: Parser ByteString

-- | Parser for variable name in declaration (immediate set, <tt>var :=
--   x</tt>)
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly immVar "CFLAGS:=-c -Wall"
--   Right "CFLAGS"
--   </pre>
immVar :: Parser ByteString

-- | Parser for a comment (the comment starts with the hashtag)
--   
--   <pre>
--   &gt;&gt;&gt; Atto.parseOnly comment "# I AM A COMMENT"
--   Right " I AM A COMMENT"
--   </pre>
comment :: Parser ByteString