reordered some functions, commented functionality

Author: Zoybean

theory/Quine.hs

@@ -1,13 +1,18 @@
+-- Print the string copy of the source code
 main :: IO ()
 main = do
-    putStr $ unlines $ file
-    putStr $ unlines $ dent <$> (wrap $ escape <$> file)
+    putStr $ unlines $ file -- the program body
+    putStr $ unlines $ dent <$> (wrap $ escape <$> file) -- the string copy
 
+-- Indent a line with 4 spaces
 dent :: String -> String
 dent = ("    " ++)
 
+-- Make a list of strings resemble the lines of a list of strings in haskell syntax
 wrap :: [String] -> [String]
-wrap ss = (pre ("[" ++) $ fil ("," ++) $ ss) ++ ["]"]
+wrap ss = (pre ("[" ++) -- prepend a '[' to the first line
+          $ fil ("," ++) $ ss) -- prepend a ',' to all but the first line
+          ++ ["]"] -- append a line which contains a ']'
     where
         pre :: ([a] -> [a]) -> [[a]] -> [[a]]
         pre f []     = [f []]
@@ -16,6 +21,7 @@ wrap ss = (pre ("[" ++) $ fil ("," ++) $ ss) ++ ["]"]
         fil _ []     = []
         fil f (x:xs) = [x] ++ (f <$> xs)
 
+-- Escape a string
 escape :: String -> String
 escape s = [qot] ++ (s >>= escChar) ++ [qot]
     where
@@ -27,18 +33,24 @@ escape s = [qot] ++ (s >>= escChar) ++ [qot]
             | chr == qot = [esc, qot]
             | otherwise  = [chr]
 
+-- The internal representation of the program's own source code
 file :: [String]
 file =
-    ["main :: IO ()"
+    ["-- Print the string copy of the source code"
+    ,"main :: IO ()"
     ,"main = do"
-    ,"    putStr $ unlines $ file"
-    ,"    putStr $ unlines $ dent <$> (wrap $ escape <$> file)"
+    ,"    putStr $ unlines $ file -- the program body"
+    ,"    putStr $ unlines $ dent <$> (wrap $ escape <$> file) -- the string copy"
     ,""
+    ,"-- Indent a line with 4 spaces"
     ,"dent :: String -> String"
     ,"dent = (\"    \" ++)"
     ,""
+    ,"-- Make a list of strings resemble the lines of a list of strings in haskell syntax"
     ,"wrap :: [String] -> [String]"
-    ,"wrap ss = (pre (\"[\" ++) $ fil (\",\" ++) $ ss) ++ [\"]\"]"
+    ,"wrap ss = (pre (\"[\" ++) -- prepend a '[' to the first line"
+    ,"          $ fil (\",\" ++) $ ss) -- prepend a ',' to all but the first line"
+    ,"          ++ [\"]\"] -- append a line which contains a ']'"
     ,"    where"
     ,"        pre :: ([a] -> [a]) -> [[a]] -> [[a]]"
     ,"        pre f []     = [f []]"
@@ -47,6 +59,7 @@ file =
     ,"        fil _ []     = []"
     ,"        fil f (x:xs) = [x] ++ (f <$> xs)"
     ,""
+    ,"-- Escape a string"
     ,"escape :: String -> String"
     ,"escape s = [qot] ++ (s >>= escChar) ++ [qot]"
     ,"    where"
@@ -58,6 +71,7 @@ file =
     ,"            | chr == qot = [esc, qot]"
     ,"            | otherwise  = [chr]"
     ,""
+    ,"-- The internal representation of the program's own source code"
     ,"file :: [String]"
     ,"file ="
     ]

theory/QuineMid.hs

@@ -1,43 +1,58 @@
+-- Print the source code
 main :: IO ()
 main = do
-    putStr $ unlines $ file !! 0
-    putStr $ unlines $ dent <$> (rewrap $ wrap . (escape <$>) <$> file)
-    putStr $ unlines $ file !! 1
+    putStr $ unlines $ file !! 0 -- the leading half
+    putStr $ unlines $ dent <$> (rewrap $ wrap . (escape <$>) <$> file) -- the string copy
+    putStr $ unlines $ file !! 1 -- and the trailing half
 
+-- The internal representation of the program's own source code
 file :: [[String]]
 file =
-    [["main :: IO ()"
+    [["-- Print the source code"
+    ,"main :: IO ()"
     ,"main = do"
-    ,"    putStr $ unlines $ file !! 0"
-    ,"    putStr $ unlines $ dent <$> (rewrap $ wrap . (escape <$>) <$> file)"
-    ,"    putStr $ unlines $ file !! 1"
+    ,"    putStr $ unlines $ file !! 0 -- the leading half"
+    ,"    putStr $ unlines $ dent <$> (rewrap $ wrap . (escape <$>) <$> file) -- the string copy"
+    ,"    putStr $ unlines $ file !! 1 -- and the trailing half"
     ,""
+    ,"-- The internal representation of the program's own source code"
     ,"file :: [[String]]"
     ,"file ="
     ]
     ,[""
+    ,"-- Indent a line with 4 spaces"
     ,"dent :: String -> String"
     ,"dent = (\"    \" ++)"
     ,""
-    ,"rewrap :: [[String]] -> [String]"
-    ,"rewrap = concat . pre (pre (\"[\" ++)) . fil (pre (\",\" ++)) . app (app (++ \"]\"))"
-    ,""
+    ,"-- Perform some operation to the first list"
     ,"pre :: ([a] -> [a]) -> [[a]] -> [[a]]"
     ,"pre f []     = [f []]"
     ,"pre f (x:xs) = [f x] ++ xs"
     ,""
+    ,"-- Perform some operation to all but the first list"
     ,"fil :: ([a] -> [a]) -> [[a]] -> [[a]]"
     ,"fil _ []     = []"
     ,"fil f (x:xs) = [x] ++ (f <$> xs)"
     ,""
+    ,"-- Perform some operation to the last list"
     ,"app :: ([a] -> [a]) -> [[a]] -> [[a]]"
     ,"app f []     = [f []]"
     ,"app f [x]    = [f x]"
     ,"app f (x:xs) = [x] ++ app f xs"
     ,""
-    ,"wrap :: [String] -> [String]"
-    ,"wrap ss = (pre (\"[\" ++) $ fil (\",\" ++) $ ss) ++ [\"]\"]"
+    ,"-- Make a list of strings resemble the lines of a list of strings in haskell syntax"
+    ,"wrap ss = (pre (\"[\" ++) -- prepend a '[' to the first line"
+    ,"          $ fil (\",\" ++) $ ss) -- prepend a ',' to all but the first line"
+    ,"          ++ [\"]\"] -- append a line which contains a ']'"
+    ,""
+    ,"-- Make a list of lists of strings resemble the lines of a list of lists of strings in haskell syntax"
+    ,"rewrap :: [[String]] -> [String]"
+    ,"rewrap = concat -- Concatenate the lists"
+    ,"         . pre (pre (\"[\" ++)) -- Prepend a '[' to the first line of the first list"
+    ,"         . fil (pre (\",\" ++)) -- Prepend a ',' to the first line of all but the first list"
+    ,"         . app (app (++ \"]\")) -- Append a ']' to the last line of the last list"
     ,""
+    ,"-- Escape a string"
     ,"escape :: String -> String"
     ,"escape s = [qot] ++ (s >>= escChar) ++ [qot]"
     ,"    where"
@@ -50,28 +65,39 @@ file =
     ,"            | otherwise  = [chr]"
     ]]
 
+-- Indent a line with 4 spaces
 dent :: String -> String
 dent = ("    " ++)
 
-rewrap :: [[String]] -> [String]
-rewrap = concat . pre (pre ("[" ++)) . fil (pre ("," ++)) . app (app (++ "]"))
-
+-- Perform some operation to the first list
 pre :: ([a] -> [a]) -> [[a]] -> [[a]]
 pre f []     = [f []]
 pre f (x:xs) = [f x] ++ xs
 
+-- Perform some operation to all but the first list
 fil :: ([a] -> [a]) -> [[a]] -> [[a]]
 fil _ []     = []
 fil f (x:xs) = [x] ++ (f <$> xs)
 
+-- Perform some operation to the last list
 app :: ([a] -> [a]) -> [[a]] -> [[a]]
 app f []     = [f []]
 app f [x]    = [f x]
 app f (x:xs) = [x] ++ app f xs
 
-wrap :: [String] -> [String]
-wrap ss = (pre ("[" ++) $ fil ("," ++) $ ss) ++ ["]"]
+-- Make a list of strings resemble the lines of a list of strings in haskell syntax
+wrap ss = (pre ("[" ++) -- prepend a '[' to the first line
+          $ fil ("," ++) $ ss) -- prepend a ',' to all but the first line
+          ++ ["]"] -- append a line which contains a ']'
+
+-- Make a list of lists of strings resemble the lines of a list of lists of strings in haskell syntax
+rewrap :: [[String]] -> [String]
+rewrap = concat -- Concatenate the lists
+         . pre (pre ("[" ++)) -- Prepend a '[' to the first line of the first list
+         . fil (pre ("," ++)) -- Prepend a ',' to the first line of all but the first list
+         . app (app (++ "]")) -- Append a ']' to the last line of the last list
 
+-- Escape a string
 escape :: String -> String
 escape s = [qot] ++ (s >>= escChar) ++ [qot]
     where