1 <?xml version="1.0" encoding="iso-8859-1"?>
3 <title>Using GHCi</title>
4 <indexterm><primary>GHCi</primary></indexterm>
5 <indexterm><primary>interpreter</primary><see>GHCi</see></indexterm>
6 <indexterm><primary>interactive</primary><see>GHCi</see></indexterm>
9 <para>The ‘i’ stands for “Interactive”</para>
11 is GHC's interactive environment, in which Haskell expressions can
12 be interactively evaluated and programs can be interpreted. If
13 you're familiar with <ulink url="http://www.haskell.org/hugs/">Hugs</ulink><indexterm><primary>Hugs</primary>
14 </indexterm>, then you'll be right at home with GHCi. However, GHCi
15 also has support for interactively loading compiled code, as well as
16 supporting all<footnote><para>except <literal>foreign export</literal>, at the moment</para>
17 </footnote> the language extensions that GHC provides.</para>
18 <indexterm><primary>FFI</primary><secondary>GHCi support</secondary></indexterm>
19 <indexterm><primary>Foreign Function Interface</primary><secondary>GHCi support</secondary></indexterm>
22 <title>Introduction to GHCi</title>
24 <para>Let's start with an example GHCi session. You can fire up
25 GHCi with the command <literal>ghci</literal>:</para>
31 / /_\// /_/ / / | | GHC Interactive, version 6.6, for Haskell 98.
32 / /_\\/ __ / /___| | http://www.haskell.org/ghc/
33 \____/\/ /_/\____/|_| Type :? for help.
35 Loading package base ... linking ... done.
39 <para>There may be a short pause while GHCi loads the prelude and
40 standard libraries, after which the prompt is shown. If we follow
41 the instructions and type <literal>:?</literal> for help, we
45 Commands available from the prompt:
47 <stmt> evaluate/run <stmt>
48 :add <filename> ... add module(s) to the current target set
49 :browse [*]<module> display the names defined by <module>
50 :cd <dir> change directory to <dir>
51 :def <cmd> <expr> define a command :<cmd>
52 :help, :? display this list of commands
53 :info [<name> ...] display information about the given names
54 :load <filename> ... load module(s) and their dependents
55 :module [+/-] [*]<mod> ... set the context for expression evaluation
56 :main [<arguments> ...] run the main function with the given arguments
57 :reload reload the current module set
59 :set <option> ... set options
60 :set args <arg> ... set the arguments returned by System.getArgs
61 :set prog <progname> set the value returned by System.getProgName
62 :set prompt <prompt> set the prompt used in GHCi
64 :show modules show the currently loaded modules
65 :show bindings show the current bindings made at the prompt
67 :ctags [<file>] create tags file for Vi (default: "tags")
68 :etags [<file>] create tags file for Emacs (defauilt: "TAGS")
69 :type <expr> show the type of <expr>
70 :kind <type> show the kind of <type>
71 :undef <cmd> undefine user-defined command :<cmd>
72 :unset <option> ... unset options
74 :!<command> run the shell command <command>
76 Options for ':set' and ':unset':
78 +r revert top-level expressions after each evaluation
79 +s print timing/memory stats after each evaluation
80 +t print type after evaluation
81 -<flags> most GHC command line flags can also be set here
82 (eg. -v2, -fglasgow-exts, etc.)
85 <para>We'll explain most of these commands as we go along. For
86 Hugs users: many things work the same as in Hugs, so you should be
87 able to get going straight away.</para>
89 <para>Haskell expressions can be typed at the prompt:</para>
90 <indexterm><primary>prompt</primary><secondary>GHCi</secondary>
96 Prelude> let x = 42 in x / 9
101 <para>GHCi interprets the whole line as an expression to evaluate.
102 The expression may not span several lines - as soon as you press
103 enter, GHCi will attempt to evaluate it.</para>
107 <title>Loading source files</title>
109 <para>Suppose we have the following Haskell source code, which we
110 place in a file <filename>Main.hs</filename>:</para>
113 main = print (fac 20)
116 fac n = n * fac (n-1)
119 <para>You can save <filename>Main.hs</filename> anywhere you like,
120 but if you save it somewhere other than the current
121 directory<footnote><para>If you started up GHCi from the command
122 line then GHCi's current directory is the same as the current
123 directory of the shell from which it was started. If you started
124 GHCi from the “Start” menu in Windows, then the
125 current directory is probably something like
126 <filename>C:\Documents and Settings\<replaceable>user
127 name</replaceable></filename>.</para> </footnote> then we will
128 need to change to the right directory in GHCi:</para>
131 Prelude> :cd <replaceable>dir</replaceable>
134 <para>where <replaceable>dir</replaceable> is the directory (or
135 folder) in which you saved <filename>Main.hs</filename>.</para>
137 <para>To load a Haskell source file into GHCi, use the
138 <literal>:load</literal> command:</para>
139 <indexterm><primary><literal>:load</literal></primary></indexterm>
143 Compiling Main ( Main.hs, interpreted )
144 Ok, modules loaded: Main.
148 <para>GHCi has loaded the <literal>Main</literal> module, and the
149 prompt has changed to “<literal>*Main></literal>” to
150 indicate that the current context for expressions typed at the
151 prompt is the <literal>Main</literal> module we just loaded (we'll
152 explain what the <literal>*</literal> means later in <xref
153 linkend="ghci-scope"/>). So we can now type expressions involving
154 the functions from <filename>Main.hs</filename>:</para>
161 <para>Loading a multi-module program is just as straightforward;
162 just give the name of the “topmost” module to the
163 <literal>:load</literal> command (hint: <literal>:load</literal>
164 can be abbreviated to <literal>:l</literal>). The topmost module
165 will normally be <literal>Main</literal>, but it doesn't have to
166 be. GHCi will discover which modules are required, directly or
167 indirectly, by the topmost module, and load them all in dependency
170 <sect2 id="ghci-modules-filenames">
171 <title>Modules vs. filenames</title>
172 <indexterm><primary>modules</primary><secondary>and filenames</secondary></indexterm>
173 <indexterm><primary>filenames</primary><secondary>of modules</secondary></indexterm>
175 <para>Question: How does GHC find the filename which contains
176 module <replaceable>M</replaceable>? Answer: it looks for the
177 file <literal><replaceable>M</replaceable>.hs</literal>, or
178 <literal><replaceable>M</replaceable>.lhs</literal>. This means
179 that for most modules, the module name must match the filename.
180 If it doesn't, GHCi won't be able to find it.</para>
182 <para>There is one exception to this general rule: when you load
183 a program with <literal>:load</literal>, or specify it when you
184 invoke <literal>ghci</literal>, you can give a filename rather
185 than a module name. This filename is loaded if it exists, and
186 it may contain any module you like. This is particularly
187 convenient if you have several <literal>Main</literal> modules
188 in the same directory and you can't call them all
189 <filename>Main.hs</filename>.</para>
191 <para>The search path for finding source files is specified with
192 the <option>-i</option> option on the GHCi command line, like
194 <screen>ghci -i<replaceable>dir<subscript>1</subscript></replaceable>:...:<replaceable>dir<subscript>n</subscript></replaceable></screen>
196 <para>or it can be set using the <literal>:set</literal> command
197 from within GHCi (see <xref
198 linkend="ghci-cmd-line-options"/>)<footnote><para>Note that in
199 GHCi, and <option>––make</option> mode, the <option>-i</option>
200 option is used to specify the search path for
201 <emphasis>source</emphasis> files, whereas in standard
202 batch-compilation mode the <option>-i</option> option is used to
203 specify the search path for interface files, see <xref
204 linkend="search-path"/>.</para> </footnote></para>
206 <para>One consequence of the way that GHCi follows dependencies
207 to find modules to load is that every module must have a source
208 file. The only exception to the rule is modules that come from
209 a package, including the <literal>Prelude</literal> and standard
210 libraries such as <literal>IO</literal> and
211 <literal>Complex</literal>. If you attempt to load a module for
212 which GHCi can't find a source file, even if there are object
213 and interface files for the module, you'll get an error
218 <title>Making changes and recompilation</title>
219 <indexterm><primary><literal>:reload</literal></primary></indexterm>
221 <para>If you make some changes to the source code and want GHCi
222 to recompile the program, give the <literal>:reload</literal>
223 command. The program will be recompiled as necessary, with GHCi
224 doing its best to avoid actually recompiling modules if their
225 external dependencies haven't changed. This is the same
226 mechanism we use to avoid re-compiling modules in the batch
227 compilation setting (see <xref linkend="recomp"/>).</para>
231 <sect1 id="ghci-compiled">
232 <title>Loading compiled code</title>
233 <indexterm><primary>compiled code</primary><secondary>in GHCi</secondary></indexterm>
235 <para>When you load a Haskell source module into GHCi, it is
236 normally converted to byte-code and run using the interpreter.
237 However, interpreted code can also run alongside compiled code in
238 GHCi; indeed, normally when GHCi starts, it loads up a compiled
239 copy of the <literal>base</literal> package, which contains the
240 <literal>Prelude</literal>.</para>
242 <para>Why should we want to run compiled code? Well, compiled
243 code is roughly 10x faster than interpreted code, but takes about
244 2x longer to produce (perhaps longer if optimisation is on). So
245 it pays to compile the parts of a program that aren't changing
246 very often, and use the interpreter for the code being actively
249 <para>When loading up source files with <literal>:load</literal>,
250 GHCi looks for any corresponding compiled object files, and will
251 use one in preference to interpreting the source if possible. For
252 example, suppose we have a 4-module program consisting of modules
253 A, B, C, and D. Modules B and C both import D only,
254 and A imports both B & C:</para>
262 <para>We can compile D, then load the whole program, like this:</para>
264 Prelude> :! ghc -c D.hs
266 Skipping D ( D.hs, D.o )
267 Compiling C ( C.hs, interpreted )
268 Compiling B ( B.hs, interpreted )
269 Compiling A ( A.hs, interpreted )
270 Ok, modules loaded: A, B, C, D.
274 <para>In the messages from the compiler, we see that it skipped D,
275 and used the object file <filename>D.o</filename>. The message
276 <literal>Skipping</literal> <replaceable>module</replaceable>
277 indicates that compilation for <replaceable>module</replaceable>
278 isn't necessary, because the source and everything it depends on
279 is unchanged since the last compilation.</para>
281 <para>At any time you can use the command
282 <literal>:show modules</literal>
283 to get a list of the modules currently loaded
289 C ( C.hs, interpreted )
290 B ( B.hs, interpreted )
291 A ( A.hs, interpreted )
294 <para>If we now modify the source of D (or pretend to: using Unix
295 command <literal>touch</literal> on the source file is handy for
296 this), the compiler will no longer be able to use the object file,
297 because it might be out of date:</para>
302 Compiling D ( D.hs, interpreted )
303 Skipping C ( C.hs, interpreted )
304 Skipping B ( B.hs, interpreted )
305 Skipping A ( A.hs, interpreted )
306 Ok, modules loaded: A, B, C, D.
310 <para>Note that module D was compiled, but in this instance
311 because its source hadn't really changed, its interface remained
312 the same, and the recompilation checker determined that A, B and C
313 didn't need to be recompiled.</para>
315 <para>So let's try compiling one of the other modules:</para>
318 *Main> :! ghc -c C.hs
320 Compiling D ( D.hs, interpreted )
321 Compiling C ( C.hs, interpreted )
322 Compiling B ( B.hs, interpreted )
323 Compiling A ( A.hs, interpreted )
324 Ok, modules loaded: A, B, C, D.
327 <para>We didn't get the compiled version of C! What happened?
328 Well, in GHCi a compiled module may only depend on other compiled
329 modules, and in this case C depends on D, which doesn't have an
330 object file, so GHCi also rejected C's object file. Ok, so let's
331 also compile D:</para>
334 *Main> :! ghc -c D.hs
336 Ok, modules loaded: A, B, C, D.
339 <para>Nothing happened! Here's another lesson: newly compiled
340 modules aren't picked up by <literal>:reload</literal>, only
341 <literal>:load</literal>:</para>
345 Skipping D ( D.hs, D.o )
346 Skipping C ( C.hs, C.o )
347 Compiling B ( B.hs, interpreted )
348 Compiling A ( A.hs, interpreted )
349 Ok, modules loaded: A, B, C, D.
352 <para>HINT: since GHCi will only use a compiled object file if it
353 can be sure that the compiled version is up-to-date, a good technique
354 when working on a large program is to occasionally run
355 <literal>ghc ––make</literal> to compile the whole project (say
356 before you go for lunch :-), then continue working in the
357 interpreter. As you modify code, the new modules will be
358 interpreted, but the rest of the project will remain
364 <title>Interactive evaluation at the prompt</title>
366 <para>When you type an expression at the prompt, GHCi immediately
367 evaluates and prints the result:
369 Prelude> reverse "hello"
376 <sect2><title>I/O actions at the prompt</title>
378 <para>GHCi does more than simple expression evaluation at the prompt.
379 If you type something of type <literal>IO a</literal> for some
380 <literal>a</literal>, then GHCi <emphasis>executes</emphasis> it
381 as an IO-computation.
385 Prelude> putStrLn "hello"
388 Furthermore, GHCi will print the result of the I/O action if (and only
391 <listitem><para>The result type is an instance of <literal>Show</literal>.</para></listitem>
392 <listitem><para>The result type is not
393 <literal>()</literal>.</para></listitem>
395 For example, remembering that <literal>putStrLn :: String -> IO ()</literal>:
397 Prelude> putStrLn "hello"
399 Prelude> do { putStrLn "hello"; return "yes" }
406 <title>Using <literal>do-</literal>notation at the prompt</title>
407 <indexterm><primary>do-notation</primary><secondary>in GHCi</secondary></indexterm>
408 <indexterm><primary>statements</primary><secondary>in GHCi</secondary></indexterm>
410 <para>GHCi actually accepts <firstterm>statements</firstterm>
411 rather than just expressions at the prompt. This means you can
412 bind values and functions to names, and use them in future
413 expressions or statements.</para>
415 <para>The syntax of a statement accepted at the GHCi prompt is
416 exactly the same as the syntax of a statement in a Haskell
417 <literal>do</literal> expression. However, there's no monad
418 overloading here: statements typed at the prompt must be in the
419 <literal>IO</literal> monad.
421 Prelude> x <- return 42
427 The statement <literal>x <- return 42</literal> means
428 “execute <literal>return 42</literal> in the
429 <literal>IO</literal> monad, and bind the result to
430 <literal>x</literal>”. We can then use
431 <literal>x</literal> in future statements, for example to print
432 it as we did above.</para>
434 <para>GHCi will print the result of a statement if and only if:
437 <para>The statement is not a binding, or it is a monadic binding
438 (<literal>p <- e</literal>) that binds exactly one
442 <para>The variable's type is not polymorphic, is not
443 <literal>()</literal>, and is an instance of
444 <literal>Show</literal></para>
449 <para>Of course, you can also bind normal non-IO expressions
450 using the <literal>let</literal>-statement:</para>
457 <para>Another important difference between the two types of binding
458 is that the monadic bind (<literal>p <- e</literal>) is
459 <emphasis>strict</emphasis> (it evaluates <literal>e</literal>),
460 whereas with the <literal>let</literal> form, the expression
461 isn't evaluated immediately:</para>
463 Prelude> let x = error "help!"
469 <para>Note that <literal>let</literal> bindings do not automatically
470 print the value bound, unlike monadic bindings.</para>
472 <para>Any exceptions raised during the evaluation or execution
473 of the statement are caught and printed by the GHCi command line
474 interface (for more information on exceptions, see the module
475 <literal>Control.Exception</literal> in the libraries
476 documentation).</para>
478 <para>Every new binding shadows any existing bindings of the
479 same name, including entities that are in scope in the current
480 module context.</para>
482 <para>WARNING: temporary bindings introduced at the prompt only
483 last until the next <literal>:load</literal> or
484 <literal>:reload</literal> command, at which time they will be
485 simply lost. However, they do survive a change of context with
486 <literal>:module</literal>: the temporary bindings just move to
487 the new location.</para>
489 <para>HINT: To get a list of the bindings currently in scope, use the
490 <literal>:show bindings</literal> command:</para>
493 Prelude> :show bindings
497 <para>HINT: if you turn on the <literal>+t</literal> option,
498 GHCi will show the type of each variable bound by a statement.
500 <indexterm><primary><literal>+t</literal></primary></indexterm>
503 Prelude> let (x:xs) = [1..]
510 <sect2 id="ghci-scope">
511 <title>What's really in scope at the prompt?</title>
513 <para>When you type an expression at the prompt, what
514 identifiers and types are in scope? GHCi provides a flexible
515 way to control exactly how the context for an expression is
516 constructed. Let's start with the simple cases; when you start
517 GHCi the prompt looks like this:</para>
519 <screen>Prelude></screen>
521 <para>Which indicates that everything from the module
522 <literal>Prelude</literal> is currently in scope. If we now
523 load a file into GHCi, the prompt will change:</para>
526 Prelude> :load Main.hs
527 Compiling Main ( Main.hs, interpreted )
531 <para>The new prompt is <literal>*Main</literal>, which
532 indicates that we are typing expressions in the context of the
533 top-level of the <literal>Main</literal> module. Everything
534 that is in scope at the top-level in the module
535 <literal>Main</literal> we just loaded is also in scope at the
536 prompt (probably including <literal>Prelude</literal>, as long
537 as <literal>Main</literal> doesn't explicitly hide it).</para>
540 <literal>*<replaceable>module</replaceable></literal> indicates
541 that it is the full top-level scope of
542 <replaceable>module</replaceable> that is contributing to the
543 scope for expressions typed at the prompt. Without the
544 <literal>*</literal>, just the exports of the module are
547 <para>We're not limited to a single module: GHCi can combine
548 scopes from multiple modules, in any mixture of
549 <literal>*</literal> and non-<literal>*</literal> forms. GHCi
550 combines the scopes from all of these modules to form the scope
551 that is in effect at the prompt. For technical reasons, GHCi
552 can only support the <literal>*</literal>-form for modules which
553 are interpreted, so compiled modules and package modules can
554 only contribute their exports to the current scope.</para>
556 <para>The scope is manipulated using the
557 <literal>:module</literal> command. For example, if the current
558 scope is <literal>Prelude</literal>, then we can bring into
559 scope the exports from the module <literal>IO</literal> like
564 Prelude IO> hPutStrLn stdout "hello\n"
569 <para>(Note: <literal>:module</literal> can be shortened to
570 <literal>:m</literal>). The full syntax of the
571 <literal>:module</literal> command is:</para>
574 :module <optional>+|-</optional> <optional>*</optional><replaceable>mod<subscript>1</subscript></replaceable> ... <optional>*</optional><replaceable>mod<subscript>n</subscript></replaceable>
577 <para>Using the <literal>+</literal> form of the
578 <literal>module</literal> commands adds modules to the current
579 scope, and <literal>-</literal> removes them. Without either
580 <literal>+</literal> or <literal>-</literal>, the current scope
581 is replaced by the set of modules specified. Note that if you
582 use this form and leave out <literal>Prelude</literal>, GHCi
583 will assume that you really wanted the
584 <literal>Prelude</literal> and add it in for you (if you don't
585 want the <literal>Prelude</literal>, then ask to remove it with
586 <literal>:m -Prelude</literal>).</para>
588 <para>The scope is automatically set after a
589 <literal>:load</literal> command, to the most recently loaded
590 "target" module, in a <literal>*</literal>-form if possible.
591 For example, if you say <literal>:load foo.hs bar.hs</literal>
592 and <filename>bar.hs</filename> contains module
593 <literal>Bar</literal>, then the scope will be set to
594 <literal>*Bar</literal> if <literal>Bar</literal> is
595 interpreted, or if <literal>Bar</literal> is compiled it will be
596 set to <literal>Prelude Bar</literal> (GHCi automatically adds
597 <literal>Prelude</literal> if it isn't present and there aren't
598 any <literal>*</literal>-form modules).</para>
600 <para>With multiple modules in scope, especially multiple
601 <literal>*</literal>-form modules, it is likely that name
602 clashes will occur. Haskell specifies that name clashes are
603 only reported when an ambiguous identifier is used, and GHCi
604 behaves in the same way for expressions typed at the
608 <title>Qualified names</title>
610 <para>To make life slightly easier, the GHCi prompt also
611 behaves as if there is an implicit <literal>import
612 qualified</literal> declaration for every module in every
613 package, and every module currently loaded into GHCi.</para>
617 <title>The <literal>:main</literal> command</title>
620 When a program is compiled and executed, it can use the
621 <literal>getArgs</literal> function to access the
622 command-line arguments.
623 However, we cannot simply pass the arguments to the
624 <literal>main</literal> function while we are testing in ghci,
625 as the <literal>main</literal> function doesn't take its
630 Instead, we can use the <literal>:main</literal> command.
631 This runs whatever <literal>main</literal> is in scope, with
632 any arguments being treated the same as command-line arguments,
637 Prelude> let main = System.Environment.getArgs >>= print
638 Prelude> :main foo bar
647 <title>The <literal>it</literal> variable</title>
648 <indexterm><primary><literal>it</literal></primary>
651 <para>Whenever an expression (or a non-binding statement, to be
652 precise) is typed at the prompt, GHCi implicitly binds its value
653 to the variable <literal>it</literal>. For example:</para>
660 <para>What actually happens is that GHCi typechecks the
661 expression, and if it doesn't have an <literal>IO</literal> type,
662 then it transforms it as follows: an expression
663 <replaceable>e</replaceable> turns into
665 let it = <replaceable>e</replaceable>;
668 which is then run as an IO-action.</para>
670 <para>Hence, the original expression must have a type which is an
671 instance of the <literal>Show</literal> class, or GHCi will
677 <interactive>:1:0:
678 No instance for (Show (a -> a))
679 arising from use of `print' at <interactive>:1:0-1
680 Possible fix: add an instance declaration for (Show (a -> a))
681 In the expression: print it
682 In a 'do' expression: print it
685 <para>The error message contains some clues as to the
686 transformation happening internally.</para>
688 <para>If the expression was instead of type <literal>IO a</literal> for
689 some <literal>a</literal>, then <literal>it</literal> will be
690 bound to the result of the <literal>IO</literal> computation,
691 which is of type <literal>a</literal>. eg.:</para>
693 Prelude> Time.getClockTime
694 Wed Mar 14 12:23:13 GMT 2001
696 Wed Mar 14 12:23:13 GMT 2001
699 <para>The corresponding translation for an IO-typed
700 <replaceable>e</replaceable> is
702 it <- <replaceable>e</replaceable>
706 <para>Note that <literal>it</literal> is shadowed by the new
707 value each time you evaluate a new expression, and the old value
708 of <literal>it</literal> is lost.</para>
712 <sect2 id="extended-default-rules">
713 <title>Type defaulting in GHCi</title>
714 <indexterm><primary>Type default</primary></indexterm>
715 <indexterm><primary><literal>Show</literal> class</primary></indexterm>
717 Consider this GHCi session:
721 What should GHCi do? Strictly speaking, the program is ambiguous. <literal>show (reverse [])</literal>
722 (which is what GHCi computes here) has type <literal>Show a => a</literal> and how that displays depends
723 on the type <literal>a</literal>. For example:
725 ghci> (reverse []) :: String
727 ghci> (reverse []) :: [Int]
730 However, it is tiresome for the user to have to specify the type, so GHCi extends Haskell's type-defaulting
731 rules (Section 4.3.4 of the Haskell 98 Report (Revised)) as follows. The
732 standard rules take each group of constraints <literal>(C1 a, C2 a, ..., Cn
733 a)</literal> for each type variable <literal>a</literal>, and defaults the
736 <listitem><para> The type variable <literal>a</literal>
737 appears in no other constraints </para></listitem>
738 <listitem><para> All the classes <literal>Ci</literal> are standard.</para></listitem>
739 <listitem><para> At least one of the classes <literal>Ci</literal> is
740 numeric.</para></listitem>
742 At the GHCi prompt, the second and third rules are relaxed as follows
743 (differences italicised):
745 <listitem><para> <emphasis>All</emphasis> of the classes
746 <literal>Ci</literal> are single-parameter type classes.</para></listitem>
747 <listitem><para> At least one of the classes <literal>Ci</literal> is
748 numeric, <emphasis>or is <literal>Show</literal>,
749 <literal>Eq</literal>, or <literal>Ord</literal></emphasis>.</para></listitem>
751 The same type-default behaviour can be enabled in an ordinary Haskell
752 module, using the flag <literal>-fextended-default-rules</literal>.
757 <sect1 id="ghci-invocation">
758 <title>Invoking GHCi</title>
759 <indexterm><primary>invoking</primary><secondary>GHCi</secondary></indexterm>
760 <indexterm><primary><option>––interactive</option></primary></indexterm>
762 <para>GHCi is invoked with the command <literal>ghci</literal> or
763 <literal>ghc ––interactive</literal>. One or more modules or
764 filenames can also be specified on the command line; this
765 instructs GHCi to load the specified modules or filenames (and all
766 the modules they depend on), just as if you had said
767 <literal>:load <replaceable>modules</replaceable></literal> at the
768 GHCi prompt (see <xref linkend="ghci-commands"/>). For example, to
769 start GHCi and load the program whose topmost module is in the
770 file <literal>Main.hs</literal>, we could say:</para>
776 <para>Most of the command-line options accepted by GHC (see <xref
777 linkend="using-ghc"/>) also make sense in interactive mode. The ones
778 that don't make sense are mostly obvious; for example, GHCi
779 doesn't generate interface files, so options related to interface
780 file generation won't have any effect.</para>
783 <title>Packages</title>
784 <indexterm><primary>packages</primary><secondary>with GHCi</secondary></indexterm>
786 <para>Most packages (see <xref linkend="using-packages"/>) are
787 available without needing to specify any extra flags at all:
788 they will be automatically loaded the first time they are
791 <para>For non-auto packages, however, you need to request the
792 package be loaded by using the <literal>-package</literal> flag:</para>
795 $ ghci -package readline
798 / /_\// /_/ / / | | GHC Interactive, version 6.6, for Haskell 98.
799 / /_\\/ __ / /___| | http://www.haskell.org/ghc/
800 \____/\/ /_/\____/|_| Type :? for help.
802 Loading package base ... linking ... done.
803 Loading package readline-1.0 ... linking ... done.
807 <para>The following command works to load new packages into a
811 Prelude> :set -package <replaceable>name</replaceable>
814 <para>But note that doing this will cause all currently loaded
815 modules to be unloaded, and you'll be dumped back into the
816 <literal>Prelude</literal>.</para>
820 <title>Extra libraries</title>
821 <indexterm><primary>libraries</primary><secondary>with GHCi</secondary></indexterm>
823 <para>Extra libraries may be specified on the command line using
824 the normal <literal>-l<replaceable>lib</replaceable></literal>
825 option. (The term <emphasis>library</emphasis> here refers to
826 libraries of foreign object code; for using libraries of Haskell
827 source code, see <xref linkend="ghci-modules-filenames"/>.) For
828 example, to load the “m” library:</para>
834 <para>On systems with <literal>.so</literal>-style shared
835 libraries, the actual library loaded will the
836 <filename>lib<replaceable>lib</replaceable>.so</filename>. GHCi
837 searches the following places for libraries, in this order:</para>
841 <para>Paths specified using the
842 <literal>-L<replaceable>path</replaceable></literal>
843 command-line option,</para>
846 <para>the standard library search path for your system,
847 which on some systems may be overridden by setting the
848 <literal>LD_LIBRARY_PATH</literal> environment
853 <para>On systems with <literal>.dll</literal>-style shared
854 libraries, the actual library loaded will be
855 <filename><replaceable>lib</replaceable>.dll</filename>. Again,
856 GHCi will signal an error if it can't find the library.</para>
858 <para>GHCi can also load plain object files
859 (<literal>.o</literal> or <literal>.obj</literal> depending on
860 your platform) from the command-line. Just add the name the
861 object file to the command line.</para>
863 <para>Ordering of <option>-l</option> options matters: a library
864 should be mentioned <emphasis>before</emphasis> the libraries it
865 depends on (see <xref linkend="options-linker"/>).</para>
870 <sect1 id="ghci-commands">
871 <title>GHCi commands</title>
873 <para>GHCi commands all begin with
874 ‘<literal>:</literal>’ and consist of a single command
875 name followed by zero or more parameters. The command name may be
876 abbreviated, as long as the abbreviation is not ambiguous. All of
877 the builtin commands, with the exception of
878 <literal>:unset</literal> and <literal>:undef</literal>, may be
879 abbreviated to a single letter.</para>
884 <literal>:add</literal> <replaceable>module</replaceable> ...
885 <indexterm><primary><literal>:add</literal></primary></indexterm>
888 <para>Add <replaceable>module</replaceable>(s) to the
889 current <firstterm>target set</firstterm>, and perform a
896 <literal>:browse</literal> <optional><literal>*</literal></optional><replaceable>module</replaceable> ...
897 <indexterm><primary><literal>:browse</literal></primary></indexterm>
900 <para>Displays the identifiers defined by the module
901 <replaceable>module</replaceable>, which must be either
902 loaded into GHCi or be a member of a package. If the
903 <literal>*</literal> symbol is placed before the module
904 name, then <emphasis>all</emphasis> the identifiers defined
905 in <replaceable>module</replaceable> are shown; otherwise
906 the list is limited to the exports of
907 <replaceable>module</replaceable>. The
908 <literal>*</literal>-form is only available for modules
909 which are interpreted; for compiled modules (including
910 modules from packages) only the non-<literal>*</literal>
911 form of <literal>:browse</literal> is available.</para>
917 <literal>:cd</literal> <replaceable>dir</replaceable>
918 <indexterm><primary><literal>:cd</literal></primary></indexterm>
921 <para>Changes the current working directory to
922 <replaceable>dir</replaceable>. A
923 ‘<literal>˜</literal>’ symbol at the
924 beginning of <replaceable>dir</replaceable> will be replaced
925 by the contents of the environment variable
926 <literal>HOME</literal>.</para>
928 <para>NOTE: changing directories causes all currently loaded
929 modules to be unloaded. This is because the search path is
930 usually expressed using relative directories, and changing
931 the search path in the middle of a session is not
938 <literal>:def</literal> <replaceable>name</replaceable> <replaceable>expr</replaceable>
939 <indexterm><primary><literal>:def</literal></primary></indexterm>
942 <para>The command <literal>:def</literal>
943 <replaceable>name</replaceable>
944 <replaceable>expr</replaceable> defines a new GHCi command
945 <literal>:<replaceable>name</replaceable></literal>,
946 implemented by the Haskell expression
947 <replaceable>expr</replaceable>, which must have type
948 <literal>String -> IO String</literal>. When
949 <literal>:<replaceable>name</replaceable>
950 <replaceable>args</replaceable></literal> is typed at the
951 prompt, GHCi will run the expression
952 <literal>(<replaceable>name</replaceable>
953 <replaceable>args</replaceable>)</literal>, take the
954 resulting <literal>String</literal>, and feed it back into
955 GHCi as a new sequence of commands. Separate commands in
956 the result must be separated by
957 ‘<literal>\n</literal>’.</para>
959 <para>That's all a little confusing, so here's a few
960 examples. To start with, here's a new GHCi command which
961 doesn't take any arguments or produce any results, it just
962 outputs the current date & time:</para>
965 Prelude> let date _ = Time.getClockTime >>= print >> return ""
966 Prelude> :def date date
968 Fri Mar 23 15:16:40 GMT 2001
971 <para>Here's an example of a command that takes an argument.
972 It's a re-implementation of <literal>:cd</literal>:</para>
975 Prelude> let mycd d = Directory.setCurrentDirectory d >> return ""
976 Prelude> :def mycd mycd
980 <para>Or I could define a simple way to invoke
981 “<literal>ghc ––make Main</literal>” in the
982 current directory:</para>
985 Prelude> :def make (\_ -> return ":! ghc ––make Main")
988 <para>We can define a command that reads GHCi input from a
989 file. This might be useful for creating a set of bindings
990 that we want to repeatedly load into the GHCi session:</para>
993 Prelude> :def . readFile
994 Prelude> :. cmds.ghci
997 <para>Notice that we named the command
998 <literal>:.</literal>, by analogy with the
999 ‘<literal>.</literal>’ Unix shell command that
1000 does the same thing.</para>
1006 <literal>:help</literal>
1007 <indexterm><primary><literal>:help</literal></primary></indexterm>
1010 <literal>:?</literal>
1011 <indexterm><primary><literal>:?</literal></primary></indexterm>
1014 <para>Displays a list of the available commands.</para>
1020 <literal>:info</literal> <replaceable>name</replaceable> ...
1021 <indexterm><primary><literal>:info</literal></primary></indexterm>
1024 <para>Displays information about the given name(s). For
1025 example, if <replaceable>name</replaceable> is a class, then
1026 the class methods and their types will be printed; if
1027 <replaceable>name</replaceable> is a type constructor, then
1028 its definition will be printed; if
1029 <replaceable>name</replaceable> is a function, then its type
1030 will be printed. If <replaceable>name</replaceable> has
1031 been loaded from a source file, then GHCi will also display
1032 the location of its definition in the source.</para>
1038 <literal>:load</literal> <replaceable>module</replaceable> ...
1039 <indexterm><primary><literal>:load</literal></primary></indexterm>
1042 <para>Recursively loads the specified
1043 <replaceable>module</replaceable>s, and all the modules they
1044 depend on. Here, each <replaceable>module</replaceable>
1045 must be a module name or filename, but may not be the name
1046 of a module in a package.</para>
1048 <para>All previously loaded modules, except package modules,
1049 are forgotten. The new set of modules is known as the
1050 <firstterm>target set</firstterm>. Note that
1051 <literal>:load</literal> can be used without any arguments
1052 to unload all the currently loaded modules and
1055 <para>After a <literal>:load</literal> command, the current
1056 context is set to:</para>
1060 <para><replaceable>module</replaceable>, if it was loaded
1061 successfully, or</para>
1064 <para>the most recently successfully loaded module, if
1065 any other modules were loaded as a result of the current
1066 <literal>:load</literal>, or</para>
1069 <para><literal>Prelude</literal> otherwise.</para>
1077 <literal>:module <optional>+|-</optional> <optional>*</optional><replaceable>mod<subscript>1</subscript></replaceable> ... <optional>*</optional><replaceable>mod<subscript>n</subscript></replaceable></literal>
1078 <indexterm><primary><literal>:module</literal></primary></indexterm>
1081 <para>Sets or modifies the current context for statements
1082 typed at the prompt. See <xref linkend="ghci-scope"/> for
1083 more details.</para>
1089 <literal>:quit</literal>
1090 <indexterm><primary><literal>:quit</literal></primary></indexterm>
1093 <para>Quits GHCi. You can also quit by typing a control-D
1094 at the prompt.</para>
1100 <literal>:reload</literal>
1101 <indexterm><primary><literal>:reload</literal></primary></indexterm>
1104 <para>Attempts to reload the current target set (see
1105 <literal>:load</literal>) if any of the modules in the set,
1106 or any dependent module, has changed. Note that this may
1107 entail loading new modules, or dropping modules which are no
1108 longer indirectly required by the target.</para>
1114 <literal>:set</literal> <optional><replaceable>option</replaceable>...</optional>
1115 <indexterm><primary><literal>:set</literal></primary></indexterm>
1118 <para>Sets various options. See <xref linkend="ghci-set"/>
1119 for a list of available options. The
1120 <literal>:set</literal> command by itself shows which
1121 options are currently set.</para>
1127 <literal>:set</literal> <literal>args</literal> <replaceable>arg</replaceable> ...
1128 <indexterm><primary><literal>:set args</literal></primary></indexterm>
1131 <para>Sets the list of arguments which are returned when the
1132 program calls <literal>System.getArgs</literal><indexterm><primary>getArgs</primary>
1133 </indexterm>.</para>
1139 <literal>:set</literal> <literal>prog</literal> <replaceable>prog</replaceable>
1140 <indexterm><primary><literal>:set prog</literal></primary></indexterm>
1143 <para>Sets the string to be returned when the program calls
1144 <literal>System.getProgName</literal><indexterm><primary>getProgName</primary>
1145 </indexterm>.</para>
1151 <literal>:set</literal> <literal>prompt</literal> <replaceable>prompt</replaceable>
1154 <para>Sets the string to be used as the prompt in GHCi.
1155 Inside <replaceable>prompt</replaceable>, the sequence
1156 <literal>%s</literal> is replaced by the names of the
1157 modules currently in scope, and <literal>%%</literal> is
1158 replaced by <literal>%</literal>.</para>
1164 <literal>:show bindings</literal>
1165 <indexterm><primary><literal>:show bindings</literal></primary></indexterm>
1168 <para>Show the bindings made at the prompt and their
1175 <literal>:show modules</literal>
1176 <indexterm><primary><literal>:show modules</literal></primary></indexterm>
1179 <para>Show the list of modules currently load.</para>
1185 <literal>:ctags</literal> <optional><replaceable>filename</replaceable></optional>
1186 <literal>:etags</literal> <optional><replaceable>filename</replaceable></optional>
1187 <indexterm><primary><literal>:etags</literal></primary>
1189 <indexterm><primary><literal>:etags</literal></primary>
1193 <para>Generates a “tags” file for Vi-style editors
1194 (<literal>:ctags</literal>) or Emacs-style editors (<literal>etags</literal>). If
1195 no filename is specified, the defaulit <filename>tags</filename> or
1196 <filename>TAGS</filename> is
1197 used, respectively. Tags for all the functions, constructors and
1198 types in the currently loaded modules are created. All modules must
1199 be interpreted for these commands to work.</para>
1200 <para>See also <xref linkend="hasktags" />.</para>
1206 <literal>:type</literal> <replaceable>expression</replaceable>
1207 <indexterm><primary><literal>:type</literal></primary></indexterm>
1210 <para>Infers and prints the type of
1211 <replaceable>expression</replaceable>, including explicit
1212 forall quantifiers for polymorphic types. The monomorphism
1213 restriction is <emphasis>not</emphasis> applied to the
1214 expression during type inference.</para>
1220 <literal>:kind</literal> <replaceable>type</replaceable>
1221 <indexterm><primary><literal>:kind</literal></primary></indexterm>
1224 <para>Infers and prints the kind of
1225 <replaceable>type</replaceable>. The latter can be an arbitrary
1226 type expression, including a partial application of a type constructor,
1227 such as <literal>Either Int</literal>.</para>
1233 <literal>:undef</literal> <replaceable>name</replaceable>
1234 <indexterm><primary><literal>:undef</literal></primary></indexterm>
1237 <para>Undefines the user-defined command
1238 <replaceable>name</replaceable> (see <literal>:def</literal>
1245 <literal>:unset</literal> <replaceable>option</replaceable>...
1246 <indexterm><primary><literal>:unset</literal></primary></indexterm>
1249 <para>Unsets certain options. See <xref linkend="ghci-set"/>
1250 for a list of available options.</para>
1256 <literal>:!</literal> <replaceable>command</replaceable>...
1257 <indexterm><primary><literal>:!</literal></primary></indexterm>
1258 <indexterm><primary>shell commands</primary><secondary>in GHCi</secondary></indexterm>
1261 <para>Executes the shell command
1262 <replaceable>command</replaceable>.</para>
1269 <sect1 id="ghci-set">
1270 <title>The <literal>:set</literal> command</title>
1271 <indexterm><primary><literal>:set</literal></primary></indexterm>
1273 <para>The <literal>:set</literal> command sets two types of
1274 options: GHCi options, which begin with
1275 ‘<literal>+</literal>” and “command-line”
1276 options, which begin with ‘-’. </para>
1278 <para>NOTE: at the moment, the <literal>:set</literal> command
1279 doesn't support any kind of quoting in its arguments: quotes will
1280 not be removed and cannot be used to group words together. For
1281 example, <literal>:set -DFOO='BAR BAZ'</literal> will not do what
1285 <title>GHCi options</title>
1286 <indexterm><primary>options</primary><secondary>GHCi</secondary>
1289 <para>GHCi options may be set using <literal>:set</literal> and
1290 unset using <literal>:unset</literal>.</para>
1292 <para>The available GHCi options are:</para>
1297 <literal>+r</literal>
1298 <indexterm><primary><literal>+r</literal></primary></indexterm>
1299 <indexterm><primary>CAFs</primary><secondary>in GHCi</secondary></indexterm>
1300 <indexterm><primary>Constant Applicative Form</primary><see>CAFs</see></indexterm>
1303 <para>Normally, any evaluation of top-level expressions
1304 (otherwise known as CAFs or Constant Applicative Forms) in
1305 loaded modules is retained between evaluations. Turning
1306 on <literal>+r</literal> causes all evaluation of
1307 top-level expressions to be discarded after each
1308 evaluation (they are still retained
1309 <emphasis>during</emphasis> a single evaluation).</para>
1311 <para>This option may help if the evaluated top-level
1312 expressions are consuming large amounts of space, or if
1313 you need repeatable performance measurements.</para>
1319 <literal>+s</literal>
1320 <indexterm><primary><literal>+s</literal></primary></indexterm>
1323 <para>Display some stats after evaluating each expression,
1324 including the elapsed time and number of bytes allocated.
1325 NOTE: the allocation figure is only accurate to the size
1326 of the storage manager's allocation area, because it is
1327 calculated at every GC. Hence, you might see values of
1328 zero if no GC has occurred.</para>
1334 <literal>+t</literal>
1335 <indexterm><primary><literal>+t</literal></primary></indexterm>
1338 <para>Display the type of each variable bound after a
1339 statement is entered at the prompt. If the statement is a
1340 single expression, then the only variable binding will be
1342 ‘<literal>it</literal>’.</para>
1348 <sect2 id="ghci-cmd-line-options">
1349 <title>Setting GHC command-line options in GHCi</title>
1351 <para>Normal GHC command-line options may also be set using
1352 <literal>:set</literal>. For example, to turn on
1353 <option>-fglasgow-exts</option>, you would say:</para>
1356 Prelude> :set -fglasgow-exts
1359 <para>Any GHC command-line option that is designated as
1360 <firstterm>dynamic</firstterm> (see the table in <xref
1361 linkend="flag-reference"/>), may be set using
1362 <literal>:set</literal>. To unset an option, you can set the
1363 reverse option:</para>
1364 <indexterm><primary>dynamic</primary><secondary>options</secondary></indexterm>
1367 Prelude> :set -fno-glasgow-exts
1370 <para><xref linkend="flag-reference"/> lists the reverse for each
1371 option where applicable.</para>
1373 <para>Certain static options (<option>-package</option>,
1374 <option>-I</option>, <option>-i</option>, and
1375 <option>-l</option> in particular) will also work, but some may
1376 not take effect until the next reload.</para>
1377 <indexterm><primary>static</primary><secondary>options</secondary></indexterm>
1381 <sect1 id="ghci-dot-files">
1382 <title>The <filename>.ghci</filename> file</title>
1383 <indexterm><primary><filename>.ghci</filename></primary><secondary>file</secondary>
1385 <indexterm><primary>startup</primary><secondary>files, GHCi</secondary>
1388 <para>When it starts, GHCi always reads and executes commands from
1389 <filename>$HOME/.ghci</filename>, followed by
1390 <filename>./.ghci</filename>.</para>
1392 <para>The <filename>.ghci</filename> in your home directory is
1393 most useful for turning on favourite options (eg. <literal>:set
1394 +s</literal>), and defining useful macros. Placing a
1395 <filename>.ghci</filename> file in a directory with a Haskell
1396 project is a useful way to set certain project-wide options so you
1397 don't have to type them everytime you start GHCi: eg. if your
1398 project uses GHC extensions and CPP, and has source files in three
1399 subdirectories A B and C, you might put the following lines in
1400 <filename>.ghci</filename>:</para>
1403 :set -fglasgow-exts -cpp
1407 <para>(Note that strictly speaking the <option>-i</option> flag is
1408 a static one, but in fact it works to set it using
1409 <literal>:set</literal> like this. The changes won't take effect
1410 until the next <literal>:load</literal>, though.)</para>
1412 <para>Two command-line options control whether the
1413 <filename>.ghci</filename> files are read:</para>
1418 <option>-ignore-dot-ghci</option>
1419 <indexterm><primary><option>-ignore-dot-ghci</option></primary></indexterm>
1422 <para>Don't read either <filename>./.ghci</filename> or
1423 <filename>$HOME/.ghci</filename> when starting up.</para>
1428 <option>-read-dot-ghci</option>
1429 <indexterm><primary><option>-read-dot-ghci</option></primary></indexterm>
1432 <para>Read <filename>.ghci</filename> and
1433 <filename>$HOME/.ghci</filename>. This is normally the
1434 default, but the <option>-read-dot-ghci</option> option may
1435 be used to override a previous
1436 <option>-ignore-dot-ghci</option> option.</para>
1444 <title>FAQ and Things To Watch Out For</title>
1448 <term>The interpreter can't load modules with foreign export
1449 declarations!</term>
1451 <para>Unfortunately not. We haven't implemented it yet.
1452 Please compile any offending modules by hand before loading
1453 them into GHCi.</para>
1459 <literal>-O</literal> doesn't work with GHCi!
1460 <indexterm><primary><option>-O</option></primary></indexterm>
1463 <para>For technical reasons, the bytecode compiler doesn't
1464 interact well with one of the optimisation passes, so we
1465 have disabled optimisation when using the interpreter. This
1466 isn't a great loss: you'll get a much bigger win by
1467 compiling the bits of your code that need to go fast, rather
1468 than interpreting them with optimisation turned on.</para>
1473 <term>Unboxed tuples don't work with GHCi</term>
1475 <para>That's right. You can always compile a module that
1476 uses unboxed tuples and load it into GHCi, however.
1477 (Incidentally the previous point, namely that
1478 <literal>-O</literal> is incompatible with GHCi, is because
1479 the bytecode compiler can't deal with unboxed
1485 <term>Concurrent threads don't carry on running when GHCi is
1486 waiting for input.</term>
1488 <para>No, they don't. This is because the Haskell binding
1489 to the GNU readline library doesn't support reading from the
1490 terminal in a non-blocking way, which is required to work
1491 properly with GHC's concurrency model.</para>
1496 <term>After using <literal>getContents</literal>, I can't use
1497 <literal>stdin</literal> again until I do
1498 <literal>:load</literal> or <literal>:reload</literal>.</term>
1501 <para>This is the defined behaviour of
1502 <literal>getContents</literal>: it puts the stdin Handle in
1503 a state known as <firstterm>semi-closed</firstterm>, wherein
1504 any further I/O operations on it are forbidden. Because I/O
1505 state is retained between computations, the semi-closed
1506 state persists until the next <literal>:load</literal> or
1507 <literal>:reload</literal> command.</para>
1509 <para>You can make <literal>stdin</literal> reset itself
1510 after every evaluation by giving GHCi the command
1511 <literal>:set +r</literal>. This works because
1512 <literal>stdin</literal> is just a top-level expression that
1513 can be reverted to its unevaluated state in the same way as
1514 any other top-level expression (CAF).</para>
1524 ;;; Local Variables: ***
1526 ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter") ***