Use commandProgramName
[darcs-mirror-ipatch.git] / src / IPatch / Help.lhs
1 %  Copyright (C) 2002-2004 David Roundy
2 %  Copyright (C) 2010 Joachim Breitner
3 %
4 %  This program is free software; you can redistribute it and/or modify
5 %  it under the terms of the GNU General Public License as published by
6 %  the Free Software Foundation; either version 2, or (at your option)
7 %  any later version.
8 %
9 %  This program is distributed in the hope that it will be useful,
10 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 %  GNU General Public License for more details.
13 %
14 %  You should have received a copy of the GNU General Public License
15 %  along with this program; see the file COPYING.  If not, write to
16 %  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 %  Boston, MA 02110-1301, USA.
18
19 \darcsCommand{help}
20 \begin{code}
21 module IPatch.Help (
22  helpCmd,
23  commandControlList, environmentHelp,          -- these are for preproc.hs
24  printVersion,
25  listAvailableCommands ) where
26
27 import Darcs.Arguments
28     ( DarcsFlag(..), environmentHelpEmail, environmentHelpSendmail )
29 import Darcs.Commands
30     ( CommandArgs(..),
31       CommandControl(..),
32       DarcsCommand(..),
33       disambiguateCommands,
34       extractCommands,
35       getCommandHelp, -- This still prints "darcs", need to revise API here.
36       nodefaults,
37       usageHelper )
38 import Darcs.External ( viewDoc )
39 import Darcs.Lock
40     ( environmentHelpTmpdir, environmentHelpKeepTmpdir )
41 import Darcs.Repository.Prefs
42     ( binariesFileHelp, environmentHelpHome )
43 import Darcs.Utils
44     ( withCurrentDirectory,
45       environmentHelpEditor,
46       environmentHelpPager )
47 import Data.Char ( isAlphaNum, toLower )
48 import Data.List ( groupBy )
49 import English ( andClauses )
50 import Printer ( text )
51 import Ssh
52     ( environmentHelpSsh, environmentHelpScp, environmentHelpSshPort )
53 import System.Exit ( ExitCode(..), exitWith )
54 import URL ( environmentHelpProxy, environmentHelpProxyPassword )
55 import Workaround ( getCurrentDirectory )
56
57 import IPatch.Version ( version )
58 import qualified IPatch.TheCommands as TheCommands ( commandControlList )
59
60 helpDescription :: String
61 helpDescription = "Display help about ipatch and ipatch commands."
62
63 helpHelp :: String
64 helpHelp =
65  "Without arguments, `ipatch help' prints a categorized list of ipatch\n" ++
66  "commands and a short description of each one.  With an extra argument,\n" ++
67  "`ipatch help foo' prints detailed help about the ipatch command foo.\n"
68
69 help :: DarcsCommand
70 help = DarcsCommand {commandProgramName = "ipatch",
71                      commandName = "help",
72                      commandHelp = helpHelp,
73                      commandDescription = helpDescription,
74                      commandExtraArgs = -1,
75                      --commandExtraArgHelp = ["[<DARCS_COMMAND> [DARCS_SUBCOMMAND]]  "],
76                      commandExtraArgHelp = ["[<IPATCH_COMMAND>]  "],
77                      commandCommand = \ x y -> helpCmd x y >> exitWith ExitSuccess,
78                      commandPrereq = \_ -> return $ Right (),
79                      commandGetArgPossibilities = return [],
80                      commandArgdefaults = nodefaults,
81                      commandAdvancedOptions = [],
82                      commandBasicOptions = []}
83
84 usage :: [CommandControl] -> String
85 usage cs = "Usage: ipatch COMMAND ...\n\nCommands:\n" ++
86            usageHelper cs ++ "\n" ++
87            "Use 'ipatch COMMAND --help' for help on a single command.\n" ++
88            "Use 'ipatch --version' to see the ipatch version number.\n"
89            -- "Use 'ipatch --exact-version' to get the exact version of this ipatch instance.\n"
90            -- "Use 'ipatch help environment' for help on environment variables.\n" ++
91            --"\n" ++
92            --"Check bug reports at http://bugs.darcs.net/\n"
93
94
95 helpCmd :: [DarcsFlag] -> [String] -> IO ()
96 helpCmd _ ["manpage"] = putStr $ unlines manpageLines
97 -- helpCmd _ ["environment"] = viewDoc $ text $ helpOnEnvironment
98 helpCmd _ [] = viewDoc $ text $ usage commandControlList
99
100 helpCmd _ (cmd:args) =
101     let disambiguated = disambiguateCommands commandControlList cmd args
102     in case disambiguated of
103          Left err -> fail err
104          Right (cmds,_) ->
105              let msg = case cmds of
106                          CommandOnly c       -> getCommandHelp Nothing  c
107                          SuperCommandOnly c  -> getCommandHelp Nothing  c
108                          SuperCommandSub c s -> getCommandHelp (Just c) s
109              in viewDoc $ text msg
110
111 listAvailableCommands :: IO ()
112 listAvailableCommands =
113     do here <- getCurrentDirectory
114        is_valid <- mapM
115                    (\c-> withCurrentDirectory here $ (commandPrereq c) [])
116                    (extractCommands commandControlList)
117        putStr $ unlines $ map (commandName . fst) $
118                 filter (isRight.snd) $
119                 zip (extractCommands commandControlList) is_valid
120        putStrLn "--help"
121        putStrLn "--version"
122        -- putStrLn "--exact-version"
123        -- putStrLn "--overview"
124     where isRight (Right _) = True
125           isRight _ = False
126
127 printVersion :: IO ()
128 printVersion = putStrLn $ "ipatch version " ++ version
129
130 -- avoiding a module import cycle between Help and TheCommands
131 commandControlList :: [CommandControl]
132 commandControlList =
133   CommandData help : TheCommands.commandControlList
134
135 -- FIXME: the "grouping" comments below should made subsections in the
136 -- manpage, as we already do for DarcsCommand groups. --twb, 2009
137
138 -- | Help on each environment variable in which Darcs is interested.
139 environmentHelp :: [([String], [String])]
140 environmentHelp = []
141 {-
142  -- General-purpose
143  environmentHelpHome,
144  environmentHelpEditor,
145  environmentHelpPager,
146  environmentHelpTmpdir,
147  environmentHelpKeepTmpdir,
148  environmentHelpEmail,
149  environmentHelpSendmail,
150  -- Remote Repositories
151  environmentHelpSsh,
152  environmentHelpScp,
153  environmentHelpSshPort,
154  environmentHelpProxy,
155  environmentHelpProxyPassword]
156 -}
157
158 -- | The rendered form of the data in 'environment_help'.
159 helpOnEnvironment :: String
160 helpOnEnvironment =
161     "Environment Variables\n" ++
162     "=====================\n\n" ++
163     unlines [andClauses ks ++ ":\n" ++
164                      (unlines $ map ("  " ++) ds)
165                      | (ks, ds) <- environmentHelp]
166
167 -- | This module is responsible for emitting a ipatch "man-page", a
168 -- reference document used widely on Unix-like systems.  Manpages are
169 -- primarily used as a quick reference, or "memory jogger", so the
170 -- output should be terser than the user manual.
171 --
172 -- Before modifying the output, please be sure to read the man(7) and
173 -- man-pages(7) manpages, as these respectively describe the relevant
174 -- syntax and conventions.
175
176 -- | The lines of the manpage to be printed.
177 manpageLines :: [String]
178 manpageLines = [
179  ".TH DARCS 1 \"" ++ version ++ "\"",
180  ".SH NAME",
181  "ipatch \\- an advanced revision control system",
182  ".SH SYNOPSIS",
183  ".B ipatch", ".I command", ".RI < arguments |[ options ]>...",
184  "",
185  "Where the", ".I commands", "and their respective", ".I arguments", "are",
186  "",
187  unlines synopsis,
188  ".SH DESCRIPTION",
189  -- FIXME: this is copy-and-pasted from ipatch.cabal, so
190  -- it'll get out of date as people forget to maintain
191  -- both in sync.
192  "ipatch is a free, open source revision control",
193  "system. It is:",
194  ".TP 3", "\\(bu",
195  "Distributed: Every user has access to the full",
196  "command set, removing boundaries between server and",
197  "client or committer and non\\(hycommitters.",
198  ".TP", "\\(bu",
199  "Interactive: ipatch is easy to learn and efficient to",
200  "use because it asks you questions in response to",
201  "simple commands, giving you choices in your work",
202  "flow. You can choose to record one change in a file,",
203  "while ignoring another. As you update from upstream,",
204  "you can review each patch name, even the full `diff'",
205  "for interesting patches.",
206  ".TP", "\\(bu",
207  "Smart: ipatch is based on a unique algebra of patches, ",
208  "Originally developed by physicist David Roundy",
209  ".SH OPTIONS",
210  "Different options are accepted by different ipatch commands.",
211  "Each command's most important options are listed in the",
212  ".B COMMANDS",
213  "section.  For a full list of all options accepted by",
214  "a particular command, run `ipatch", ".I command", "\\-\\-help'.",
215  ".SH COMMANDS",
216  unlines commands,
217  unlines environment,
218  {-
219  ".SH BUGS",
220  "At http://bugs.darcs.net/ you can find a list of known",
221  "bugs in ipatch.  Unknown bugs can be reported at that",
222  "site (after creating an account) or by emailing the",
223  "report to bugs@darcs.net.",
224  -}
225  -- ".SH EXAMPLE",
226  -- FIXME:
227  -- new project: init, rec -la;
228  -- track upstream project: get, pull -a;
229  -- contribute to project: add, rec, push/send.
230  ".SH SEE ALSO"
231  {-"A user manual is included with ipatch, in PDF and HTML",
232  "form.  It can also be found at http://darcs.net/manual/."
233  -}
234  ]
235     where
236       -- | A synopsis line for each command.  Uses 'foldl' because it is
237       -- necessary to avoid blank lines from Hidden_commands, as groff
238       -- translates them into annoying vertical padding (unlike TeX).
239       synopsis :: [String]
240       synopsis = foldl iter [] commandControlList
241           where iter :: [String] -> CommandControl -> [String]
242                 iter acc (GroupName _) = acc
243                 iter acc (HiddenCommand _) = acc
244                 iter acc (CommandData c@SuperCommand {}) =
245                     acc ++ concatMap
246                             (render (commandName c ++ " "))
247                             (extractCommands (commandSubCommands c))
248                 iter acc (CommandData c) = acc ++ render "" c
249                 render :: String -> DarcsCommand -> [String]
250                 render prefix c =
251                     [".B ipatch " ++ prefix ++ commandName c] ++
252                     (map mangle_args $ commandExtraArgHelp c) ++
253                     -- In the output, we want each command to be on its own
254                     -- line, but we don't want blank lines between them.
255                     -- AFAICT this can only be achieved with the .br
256                     -- directive, which is probably a GNUism.
257                     [".br"]
258
259       -- | As 'synopsis', but make each group a subsection (.SS), and
260       -- include the help text for each command.
261       commands :: [String]
262       commands = foldl iter [] commandControlList
263           where iter :: [String] -> CommandControl -> [String]
264                 iter acc (GroupName x) = acc ++ [".SS \"" ++ x ++ "\""]
265                 iter acc (HiddenCommand _) = acc
266                 iter acc (CommandData c@SuperCommand {}) =
267                     acc ++ concatMap
268                             (render (commandName c ++ " "))
269                             (extractCommands (commandSubCommands c))
270                 iter acc (CommandData c) = acc ++ render "" c
271                 render :: String -> DarcsCommand -> [String]
272                 render prefix c =
273                     [".B ipatch " ++ prefix ++ commandName c] ++
274                     (map mangle_args $ commandExtraArgHelp c) ++
275                     [".RS 4", escape $ commandHelp c, ".RE"]
276
277       -- | Now I'm showing off: mangle the extra arguments of Darcs commands
278       -- so as to use the ideal format for manpages, italic words and roman
279       -- punctuation.
280       mangle_args :: String -> String
281       mangle_args s =
282           ".RI " ++ (unwords $ map show (groupBy cmp $ map toLower $ gank s))
283               where cmp x y = not $ xor (isAlphaNum x) (isAlphaNum y)
284                     xor x y = (x && not y) || (y && not x)
285                     gank (' ':'o':'r':' ':xs) = '|' : gank xs
286                     gank (x:xs) = x : gank xs
287                     gank [] = []
288
289       environment :: [String]
290       environment = ".SH ENVIRONMENT" : concat
291                     [(".SS \"" ++ andClauses ks ++ "\"") : map escape ds
292                      | (ks, ds) <- environmentHelp]
293
294       -- | Copied from Preproc.escape_latex_specials.
295       escape :: String -> String
296       escape = minus . bs       -- Order is important
297         where
298           minus      = replace "-"     "\\-"
299           bs         = replace "\\"    "\\\\"
300
301           replace :: Eq a => [a] -> [a] -> [a] -> [a]
302           replace _ _ [] = []
303           replace find repl s =
304               if take (length find) s == find
305                   then repl ++ (replace find repl (drop (length find) s))
306                   else [head s] ++ replace find repl (tail s)
307
308 \end{code}