src/Pure/ProofGeneral/README
author wenzelm
Wed, 04 Apr 2007 00:11:22 +0200
changeset 22589 18735b5fef26
parent 22160 27cdecde8c2b
child 30204 8ede2f7104cf
permissions -rw-r--r--
added print_mode;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
21637
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     1
Proof General interface for Isabelle.
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     2
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     3
This includes a prover-side PGIP abstraction layer for passing
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     4
interface configuration, control commands and display messages to
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     5
Proof General.
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     6
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     7
  pgip_types.ML    -- the datatypes in PGIP and their manipulation
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     8
  pgip_input.ML	   -- commands sent to the prover
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
     9
  pgip_output.ML   -- commands the prover sends out
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    10
  pgip_markup.ML   -- markup for proof script documents
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    11
  pgip.ML	   -- union of the above
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    12
  pgip_tests.ML    -- some basic testing of the API
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    13
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    14
The code constructs some marshalling datatypes for reading and writing
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    15
XML which conforms to the PGIP schema, interfacing with SML types and
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    16
some basic types from the Isabelle platform (i.e. URLs, XML).  This
22160
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    17
portion is intended to be useful for reuse or porting elsewhere, so it
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    18
should have minimal dependency on Isabelle and be written readably.
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    19
Some languages have tools for making type-safe XML<->native datatype
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    20
translations from a schema (e.g. HaXML for Haskell) which would be
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    21
useful here.
21637
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    22
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    23
The Isabelle specific configuration is in these files:
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    24
22160
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    25
  pgip_isabelle.ML	 - configure part of PGIP supported by Isabelle + type mapping
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    26
  parsing.ML		 - parsing routines to add PGIP markup to scripts
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    27
  preferences.ML	 - user preferences
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    28
  proof_general_pgip.ML  - the main connection point with Isabelle, including
27cdecde8c2b Comments
aspinall
parents: 21867
diff changeset
    29
			   the PGIP processing loop.
21637
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    30
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    31
For the full PGIP schema and an explanation of it, see:
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    32
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    33
   http://proofgeneral.inf.ed.ac.uk/kit
21867
8750fbc28d5c Add abstraction for objtypes and documents.
aspinall
parents: 21637
diff changeset
    34
   http://proofgeneral.inf.ed.ac.uk/wiki/Main/PGIP
21637
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    35
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    36
David Aspinall, Dec. 2006.
a7b156c404e2 Revamped Proof General interface.
aspinall
parents:
diff changeset
    37
$Id$