\documentclass{article}

\usepackage{a4}

\usepackage{times}

\usepackage{latexsym}

\bibliographystyle{alpha}

\usepackage{graphicx}

\def\isac{${\cal I}\mkern-2mu{\cal S}\mkern-5mu{\cal AC}$}

\def\sisac{{\footnotesize${\cal I}\mkern-2mu{\cal S}\mkern-5mu{\cal AC}$}}

\def\Problem{ {\tt Problem }}

\title{Userinterfaces for Computer Theorem Provers.\\

	Contributions to Isabelle

}

\author{G. Schafhauser, A. Schulhofer, M. Steger\\

Knowledge Management Institute (KMI)\\

TU Graz}

\begin{document}

\maketitle

\abstract{

TODO}

\section{Introduction}\label{intro} (WN)

 Computer theorem proving (CTP)\footnote{The term CTP is used to address two different things in this paper: (1) the academic discipline comprising respective theories as well as (2) the products developed within this discipline, the provers and the respective technology.}, 

graphical user interfaces (GUI)

%Georg

\section{State of the art in CTP Interfaces}

\subsection{A European technology: Coq and Isabelle}\label{ctp-techn}

%     http://en.wikipedia.org/wiki/Coq\\

%     http://coq.inria.fr/

%

%     http://en.wikipedia.org/wiki/Isabelle\_(theorem\_prover)\\

%     http://isabelle.in.tum.de/index.html

%

%why math -- functional: some of the languages have been specifically designed for constructing software for symbolic computation (SC). 

%%+ required for \ref{ml-users}

%

%SC http://en.wikipedia.org/wiki/Symbolic\_computation

%% mainly does not compute numerical values, but terms containing variables like functions (symbols)

%

%The LCF project

%http://hopl.murdoch.edu.au/showlanguage.prx?exp=8177

%specifically designed a 'meta language' (ML)

%http://en.wikipedia.org/wiki/ML\_(programming\_language)

%\cite{pl:milner97}

%for developing CTP

\subsubsection{Standard ML}

Standard ML is a general-purpose, modular, functional programming language. \cite{pl:milner97}

Programs written in Standard ML consist of expressions to be evaluated, as opposed to statements or commands. 

Functional programming languages constitude a ???? very differnt of object orientated languages, see Sect. \ref{ml-users}. ML originated from the LCF-project(Logic for Computable Functions)\cite{meta-Ml}, where it had been developed as a meta language. Since ML has been standardised this family of language is called Standard ML. Important for the logical foundation of SML is the $\lambda$-calculus.

%http://en.wikipedia.org/wiki/Standard_M 

\subsubsection{Coq}

Coq is an interactive theorem prover, developed in France.

It is programmed in Objective Caml, an ML based programming language.

It has the ability to express  mathematical  assertions and check proof of mathematical assertions. 

Furthermore Coq includes automatic theorem proving tactics and decision procedures.

Properties, programs and proofs are written a functional programming language called the Calculus of Inductive Constructions (CIC).

Proof development in Coq is done through a language of tactics that allows a user-guided proof process.\cite{coq1999}

Another feature of Coq is “that it can automatically extract executable programs from specifications, as either Objective Caml 

or Haskell source code.“

There are many easy-to-read introductions to Coq \footnote{http://coq.inria.fr/a-short-introduction-to-coq} on the internet.

\subsubsection{Isabelle}

Isabelle is an interactive theorem proving framework for high-level natural deduction proofs \cite{Paulson:Isa94}, written in Standard ML. 

Isabelle is developed at University of Cambridge (Larry Paulson), Technische Universit\"at M\"unchen

and Université Paris-Sud. Isabelle is called a framework, because it implements serveral object logics.

The most widespread logic of Isabelle is Isabelle/HOL, short for higher-order logic.

Isabelle/HOL includes several  specification tools, e.g. for datatypes, inductive definitions and functions with complex pattern matching.

Proofs are written in the structured proof language Isar.\cite{wenzel:isar} Isabelle implements several tools, e.g. a reasoner, a simplifier and powerful automatic provers(Slegehammer), increase the user's productivity in theorem proving. 

Isabelle provides notational support: new notations can be introduced, using normal mathematical symbols.

Definitions and proofs may include LaTeX source, from which Isabelle can automatically generate typeset documents.

Isabelle/HOL allows to turn executable specifications directly into code in SML, OCaml, and Haskell.\cite{Haftmann-Nipkow:2010:code}

(http://www.cl.cam.ac.uk/research/hvg/Isabelle/overview.html)

\subsection{Userinterfaces for CTP: Coq and Isabelle}\label{gui-coq-isa}

%     CoqIDE, ..

%         http://coq.inria.fr/what-is-coq?q=node/57\\

%         earlier than Isabelle/jEdit

%

%     ProofGeneral for Isabelle

%         http://proofgeneral.inf.ed.ac.uk/\\

%         emacs stone age ?

\subsubsection{Coq Integrated Development Environment}

CoqIde is a graphical interface for Coq. It is written in Ocaml. (http://coq.inria.fr/cocorico/CoqIde)

Its main purpose is to allow the user to navigate forward and backward into a Coq vernacular file, 

executing corresponding commands or undoing them respectively. 

There are several  buffers for helping to write proof scripts.

Among all these buffers, there is always one which is the current running buffer, whose name is displayed on a green background,

which is the one where Coq commands are currently executed. 

Buffers may be edited as in any text editor, and classical basic editing commands (Copy/Paste, ...) are available.  

CoqIde provides also a feedback system for the user. 

Therefore the background is green when a command succeeds, otherwise an errormessage is displayed in the message window and the error location is underlined red.

CoqIDE offers only basic editing commands, therefore it is possible to launch another more sophisticated text editor. 

Furthermore CoqIde provides a proof wizard “for automatically trying to solve the current goal using simple tactics.”

Another features of this IDE are the customization options, which can be accessed by the Edit menu. 

This allows the user to change the apeareance of the IDE.

\begin{figure}[htbp]

\centering

%\includegraphics[bb=0 0 10 10]{coqide.png}

\includegraphics[scale=0.25]{fig/coqide}

\caption{CoqIDE main screen}

\end{figure}

(http://coq.inria.fr/V8.1/refman/Reference-Manual016.html)

\subsubsection{Proof General for Isabelle}

Proof General is a generic front-end for proof assistants, based on the customizable text editor Emacs.

It has been developed at  the University of Edinburgh with contributions from other sites.

Proof General comes ready-to-go for these proof assistants: Isabelle, Coq, PhoX, LEGO.

Proof General is used to write proof scripts. A Proof Script is a sequence of commands sent to theorem prover. 

The communication between the user and the theorem prover takes place via two or  more Emacs text widgets. 

Therefore the user sees only the output from the latest proof step.(proofgeneral.ps.gz)

Isabelle/Isar Proof General has full support for multiple file scripting, with dependencies between theories communicated between Isabelle and Proof General. 

There is full support for Unicode Tokens, using the Isabelle print mode for X Symbol tokens. Many Isabelle theories have X Symbol syntax already defined 

and it's easy to add to your own theories. 

(http://proofgeneral.inf.ed.ac.uk/fileshow.php?file=releases%2FProofGeneral%2Fisar%2FREADME)

\begin{figure}[htbp]

\centering

\includegraphics[scale=0.5]{fig/pgisabelle}

\caption{Proof General for Isabelle}%

\end{figure}

\subsubsection{Isabelle/Jedit}

jEdit is a text editor for programmers, written in Java.

Compared to fully-featured IDEs, such as Eclipse or Netbeans, jEdit is much 

smaller and better focused on its primary task of text editing.

The general look of the Isabelle/jEdit plugin is similar to existing Java IDEs.

The main Isabelle/jEdit plugin consists of ten small Scala files  that augment some key jEdit components in order to provide a metaphor of asynchronous 

proof document editing. 

Isabelle/jEdit integrates the jEdit 4.3.2 framework  and some further  jEdit plugins. 

It also implements custom-made IsabelleText Unicode font that actually contains the usual Isabelle symbols that users expect from long 

years of Proof General X-Symbol support. 

The editor provides useful feedback, via semantic information from the processed document in the background. 

This achieves continuous proof checking based on 

asynchronous prover toplevel. A lot of information can be directly attached 

to the source text, via coloring, tooltips, popups etc.

\subsection{Upcoming requirements for userinterfaces in CTP}\label{gui-requir}

%     @ interaction close to tty (Telegraph)\\

%       BUT: separate parts in {\em one} proof could be processed in parallel

%

%     @ http://www.informatik.uni-bremen.de/uitp/

%

%     @ ... see\\

%       http://www4.in.tum.de/~wenzelm/papers/async-isabelle-scala.pdf,\\

%       http://www4.in.tum.de/~wenzelm/papers/parallel-isabelle.pdf

After several decades, most proof assistants are still centered around TTY-based(Fußnote)  interaction in a

tight read-eval-print loop. All Emacs-based GUI's for CTPs follow this synchronous

model based on single commands with immediate response, meaning that the editor waits for the

prover after each command. As to multicore politics of leading semiconductor chip manufacturer,  parallelism in software technology has become very popular. 

Therefore the support of parallelism in CTP technology could improve the performance and the multiuser support. 

So it is necessary to use proof documents instead of proof scripts.  

Proof scripts are  sequences of commands however proof documents are  structured texts. 

So the proof document idea seems to guarantee the perfect support for parallelism in the CTP technology. 

(MW async-isabelle-scala.pdf)

\newpage

%Andreas

\section{Isabelle's plans for new user-interfaces}\label{gui-plans}

%       http://www4.in.tum.de/~wenzelm/papers/async-isabelle-scala.pdf,\\

%       http://www4.in.tum.de/~wenzelm/papers/parallel-isabelle.pdf

%

%theorem proving will be integrated into software development

%

%hundreds of proof obligations are generated during a software verification process 

%

%so the final goald of Isabelle's planning is integration with other software development tools in an integrated development environment (IDE).

%

%still many principal issues need to be clarified with respect to integration of CTP and other development tools. So engaging into details makes no sense at the present, and Isabelle will approach the final goal via experimental intermediate steps of integration.

\begin{itemize}

\item theorem proving will be integrated into software development

\item hundreds of proof obligations are generated during a software verification process

\item so the final goal of Isabelle's planning is integration with other software development tolls in an integrated development environment (IDE)

\item still many principal issues need to be clarified with respect to integration of CTP and other development tools. So engaging into details makes no sense at the present, and Isabelle will approach the final goal via experimental intermediate steps of integration

\item favorite IDE is the jEdit, because it is clearer than Eclipse or NetBeans. The reason behind this choice follows in section 4.2

\end{itemize}

\subsection{Connect ML-world to the users' world via JVM}\label{ml-users}

In Sect.\ref{ctp-techn} reasons have been given, why mathematics software at the state-of-the-art cannot be written in Java or the like. On the other side, Sect.\ref{gui-requir} stated requirements for mathematical user interfaces, which cannot be accomplished by ML-like languages. These requirements can be best accomplished by languages like Java, which have powerful libraries available for convenient assembly of GUIs.

\paragraph{Example: a functional mathematics engine} as the experimental one in the \sisac-project is given by the following signature:

{\it

\begin{tabbing}

\=xx\=xxxxxxxxxxxxxxxxxxxxxxxxx\=\kill

\>signature INTERPRETER =\\

\>sig\\

\>\>type calcstate\\

\>\>type step = formula * position * tactic\\

\>\> \\

\>\>val do\_next : program $\rightarrow$ calcstate $\rightarrow$ (calcstate * step)\\

\>\>val apply\_tactic : program $\rightarrow$ calcstate $\rightarrow$ position $\rightarrow$ tactic $\rightarrow$ (calcstate * step list)\\

\>\>val apply\_formula : program $\rightarrow$ calcstate $\rightarrow$ position $\rightarrow$ formula $\rightarrow$ (calcstate * step list)\\

%\\

%\>\>val get\_next : program $\rightarrow$ calcstate $\rightarrow$ step\\

%\>\>val get\_applicable\_tactics : program $\rightarrow$ calcstate $\rightarrow$ tactic list\\

%\>\>val get\_intermediate : program $\rightarrow$ calcstate $\rightarrow$ position * position $\rightarrow$ step list\\

\>end

\end{tabbing}}

The three essential functions are \textit{do\_next}, which reads a \textit{program} for determining the next \textit{step} in a calculation, the function \textit{apply\_tactic}, which applies a \textit{tactic} input by the user to the current \textit{position} in a calculation and thus may produce a list of \textit{step}s and the function \textit{apply\_formula}, which applies an input \textit{formula} accordingly.

Now, the point with functional programming is, that the functions do {\em not} cause persistent updates in some memory, rather: all three functions above take the current state of the calculation, \textit{calcstate}, as an argument and after they have done they work return the updated \textit{calcstate}.

There are several advantages of this kind of programming: more straight forward verification, which is not discussed here, and other features. For instance, given the three functions above, it is easy to undo steps of calculations, or go back to an earlier step of calculations: one just needs to store the \textit{calcstate}s (in a list), even without knowing the details of the \textit{calcstate}, which thus can be encapsulated for internal access only.

%

%\paragraph{Example: an object-oriented wrapper} as required for embedding the above mathematics engine into an object-oriented system. Such a wrapper looks like this:

%

%TODO

\subsection{Scala as a mediator between ML and JVM}\label{scala-medi}

{\em new} %language --- what for, ideas ...

Scala is a hybrid multi-paradigm programming language. It combines object-oriented programming and functional programming. Scala runs on the Java Virtual Machine and is byte-code compatible with existing Java programs. The compilation model of Scala is nearly the same as the Java's model. So existing tools, libraries and applications can be used with Scala. The Syntax of Scala is similar to Java and ML. A number of keywords plus the block syntax is adopted from Java and from ML the syntax for type annotation and declaration. The source-code is typically reduced, concisely and more compact compared to equivalent Java code.\\

Scala is pure object-oriented, this means every value is an object. The same is true for primitive data types, because compiler-generated byte code is using primitive data types. Known design patterns from OOP can be used with Scala as well. Data types and behaviors of objects are described by classes and traits [wiki]. Traits not only consist of definitions, they also can contain implementations of methods. To avoid the problems of multiple inheritance, classes are able to extend various traits, this is a flexible mixin-based mechanism. The keyword Object is used to implement a Singleton-Class. \\

In Scala every function is a value, hence Scala is also a functional language. Functions in Scala are first-class objects, this means it is possible to pass a function as a parameter, return a function from a subroutine, or assign to a variable. Scala also supports case classes, which are used for pattern matching. Case classes are regular classes which export their constructor parameters[wiki-11-1s]. Furthermore Scala supports higher-order functions, currying and allows functions to be nested. \\

Scala is more statically typed than Java, but is able to infer types by usage. So most static type declarations are optional. This static type system ensures a safe and coherent use of abstraction. Scala supports:

\\

\begin{itemize}

\item generic classes

\item variance annotations

\item upper and lower type bounds

\item classes and abstract types as object members

\item compound types

\item explicitly typed self references

\item views

\item polymorphic methods

\end{itemize}

Static types need no explicit declaration but can be given to give the code some clarity.\\\\

Scala supports threads, but the Scala library contains an actor model inspired from Erlang. Concurrency and Scala actors follow in the next section.\\

%quellen

%%http://de.wikipedia.org/wiki/Scala_%28Programmiersprache%29

%%http://en.wikipedia.org/wiki/Scala_%28programming_language%29

%%http://creativekarma.com/ee.php/weblog/comments/why_scala_instead_of_java/

%%http://www.scalasolutions.com/scala

\subsection{Support for parallel processing}\label{actors}

%actors copied from erlang

Concurrency has lately become more and more attention, because multicore processors make concurrency very important for efficient program execution, by running multiple threads parallel and so concurrent programming gets indispensable and distributed computing,web services and mobile environments are naturally concurrent. \\

A very attractive model, because of the fact that it might addresses multicore processors and several techniques which are basically concurrent, is message-based concurrency. Most of the message passing systems, which are used in practice, are based on the actor model. \\

An actor is a concurrent process that executes a function. The state of an actor gets never shared, so it doesn't need to compete for locks of shared data. Actors own a mailbox where incoming messages are stored in. A mailbox is mainly a queue with several producers and one consumer, which are other actors. Actors share data by sending Messages which are sent asynchronously. Messages are unchangeable, so they don't require a lock and are used for communication between actors. By creating new actors, by sending messages to known actors, or changing its behavior, an actor is able to reply to a message. The actor-based process is combined with pattern matching for messages.\\

The Erlang programming language is a functional programming language and a very popular implementation of message-based concurrency, which operates with actors. It was developed for real-time control systems. Such systems are telephone exchanges, network simulators and distributed resource controllers [IoC]. These systems use a very lightweight implementation and a large number of concurrent processes, which can active simultaneously.\\

Operating system threads and threads of virtual machines, are too heavyweight for the implementation of such processes. The standard concurrency for mainstream platforms where shared-memory threads with locks. Such a platform is the Java Virtual Machine (JVM), which suffers from high memory consumption and context-switching overhead.

The main reasons are:

\begin{enumerate}

\item quick exhaustion of virtual address space

\item locking mechanisms often lack suitable contention managers

\end{enumerate}

%[IoC]

For that reasons Erlang uses lightweight concurrent processes by its own run time system and not by the underlying operating system [IoC] and the computations on these platforms are often modeled in an event-driven style, which is complicated and error-prone.

\paragraph{Two different strategies for concurrency} are being used for implementation. This two strategies often follow different programming models, the benefit of thread-based models is that they are easier to use, but they still suffer from the memory consumption and the context-switching. The event-based models are just the opposite of the thread-based, they are more efficient, but in massive designs they are very difficult.

\subparagraph{Thread-based implementation:} The behavior of a concurrent process is defined by implementing a thread-specific method. The execution state is maintained by an associated thread stack [2.P].

Supports blocking operations and can be executed on multicore processors in parallel.

\subparagraph{Event-based implementation:} The behavior is defined by a number of (non-nested) event-handlers which are called from inside an event loop. The execution state of a concurrent process is maintained by an associated record or object [2.P]. Targets to a large number of actor which can be active simultaneously, because they are more lightweight.

\paragraph{Actors in Scala} are based on actors in Erlang. Scala uses the basic thread model of Erlang, but on the other hand all higher-level functions got implemented in the Scala library as classes or methods. The Scala-actors are a unification of the concurrent process implementation models, mentioned above and they are compatible with normal Virtual Machine thread. Normal VM threads can use the same communication and monitoring capabilities, because they are treated like an actor. A message-based concurrency seems to be more secure than shared-memory with locks, because accessing an actor's mailbox is race-free. The advantage of a implementation in a library is that it can be flexibly extended and adapted to new needs. The library makes use of Scala abstraction opportunities, like partial functions and pattern matching.

The main idea of this model is that an actor is able to wait for a message by using two different operations, which try to remove a message from the current actor's mailbox. To do so, a partial function must be given to the operation, that specifies a set of message patterns. These operations are receive and react. An actor can suspend with a full thread stack (receive) or it can suspend with just a continuation closure (react) [2.P]. The first operation of an actor to wait for an message is equal to thread-based programming and the second operation to event-based programming.

receive:         def receive[R](f: PartialFunction[Any, R]): R

The current actor's mailbox get scanned and if there is one message which matches one of the patterns declared in the partial function, the message is removed from the mailbox and the partial function is applied to the message, the result is returned. Otherwise the current thread blocks. Thus the receiving actor has the ability to execute normally when receiving a message which matches.  Note that receive retains the complete call stack of the receiving actor; the actor’s behavior is therefore a sequential program which corresponds to thread-based programming [2.P]. \\

react:          

$$\mathit{def}\;\mathit{react}(f: \mathit{PartialFunction}[Any, Unit]): \mathit{Nothing}$$

The action which is specified in the partial function is the last code that the current actor executes, if the message is matching. The partial function gets registered by the current actor and the underlying thread gets released. React has the return type Nothing, this means that the method never returns normally. When the actor receives a matching message, the earlier registered partial function gets called and the actor's execution gets continued. The partial function f which corresponds to a set of event handlers [2.P]. \\

For this implementation multiple acotrs are executed by multiple threads and therefore a thread pool is used. Whenever it is necessary the pool can be re sized, to support the operations of the thread-based and event-based model. If only operations of the event-based model are executed then the thread pool could be fixed. To avoid system-included deadlocks, if some actors use thread-based operations, the thread pool has to grow, because if there are outstanding tasks and every worker thread is occupied by a blocked actor, new threads are necessary. \\

Since the communication between actors takes place through asynchronous message passing, asynchronous operations get executed, tasks have to be created and submitted to a thread pool for execution. A new task is created, when an actor spawns a new actor or a message, which enables an actor to continue, is send to an actor which is suspended in a react operation or by calling react, where a message can be immediately removed from the mailbox.\\

Event-Based Programming without Inversion of Control - Philipp Haller, Martin Odersky  [IoC]\\

Scala actors: Unifying thread-based and event-based programming - Philipp Haller, Martin Odersky [2.P]\\

% Marco

\section{Planned contributions at TU Graz}

\subsection{Make Isabelle process structured derivations}\label{struct-der}

Structured Derivations (SD) is a format for calculational reasoning, which has been established by \cite{back-grundy-wright-98}. This is an example calculation:

{\it\begin{tabbing}

123\=123\=123\=123\=123\=123\=123\=123\=123\=123\=123\=123\=\kill

\> $\bullet$\> \Problem [ maximum\_by, calculus ]\\

\>\> $\vdash$\> $A = 2\cdot u\cdot v - u^2$\\

\>\> $\bullet$\> \Problem [make, diffable, funtion]\\

\>\> \dots\> $\overline{A}(\alpha) = 8\cdot r^2\cdot\sin\alpha\cdot\cos\alpha - 4\cdot r^2\cdot(\sin\alpha)^2$\\

\>\> $\bullet$\> \Problem [on\_interval, for\_maximum, differentiate, function]\\

\>\>\> $\vdash$\> $\overline{A}(\alpha) = 8\cdot r^2\cdot\sin\alpha\cdot\cos\alpha - 4\cdot r^2\cdot(\sin\alpha)^2$\\

\>\>\> $\bullet$\> \Problem [differentiate, funtion]\\

\>\>\> \dots\> $\overline{A}^\prime(\alpha) = 8\cdot r^2\cdot(-(\sin\alpha)^2+(\cos\alpha)^2 - 2\cdot\sin\alpha\cdot\cos\alpha)$\\

\>\>\> $\bullet$\> \Problem [on\_interval, goniometric, equation]\\

\>\>\> \dots\> $\alpha = \tan^{-1}(-1+\sqrt{2})$\\

\>\> \dots\> $\alpha = \tan^{-1}(-1+\sqrt{2})$\\

\>\> $\bullet$\> \Problem [tool, find\_values]\\

\>\> \dots\> [ $u=0.23\cdot r, \:v=0.76\cdot r$ ]\\

\> \dots\> [ $u=0.23\cdot r, \:v=0.76\cdot r$ ] %TODO calculate !

\end{tabbing}}

The plan is to use the machinery provided Isabelle/Isar as a 'logical operating system' ~\cite{isar-impl} and adapt the machinery such that is accepts SC in parallel to the Isar proof language~\cite{wenzel:isar}.

This plan involves the following details.

\subsection{Add a plug-in to jEdit}\label{plugin}

    % file structure, copied from example project ...

%Die von jEdit verfolgte Strategie im Bezug auf Plugin-Management und natürlich generell die totale Offenlegegung des Codes ist für ein Projekt wie Isabelle und auch für das Isac-Project an der TU ideal. Plugins lassen sich sehr einfach anfügen und durch die riesige Vielfalt von bereits bestehenden Plugins ist auch die Adaption von Plugins möglich bzw. zu empfehlen, denn warum sollte nicht bereits funktionierender Code verwendet werden?\\

The importance of connecting the ML-world with the world of user interfaces has been is discussed in Sect.\ref{ml-users}. jEdit follows these lines, it is an open-source, Java-based text editor that works on Windows, Mac OS X, and Linux. A big advantage of jEdit is, that there is a very good and also simple way to use and write a Plugin. There are a lot of useful and powerful Plugins available in the net and it is also possible to use a existing Plugin as part of a new one. Because of this facts, jEdit is very suitable for a project like Isabelle and also for the Isac-project at TU-Graz. \\\\

Each jEdit-Plugin basically consists of source files, written in Java or Scala, XML-files and property files. The XML-Files are important for the administration of a Plugin and provides information like the name, author, ... of the Plugin. They are also containing small pieces of BeanShell code which is executed upon a user request. (Like pressing the 'start plugin' button.) So the XML-files provide the “glue” between user input and specific Plugin routines located in the source files. As you see, this files are used as interface between the Plugin and the jEdit engine itself.\\

Based on the jEdit API, you are allowed to design your code quit freely and don't have to use a prescribed way to implement your ideas.    

To get more information about the jEdit infrastructure see: http://jedit.org/users-guide/plugin-intro

\\\\

%isabell plugin beschreiben!!!!!!!!

The Isabelle-team also follow use this Plugin-structure. In the next paragraph the involved files will be described. The jEdit-Isabelle-Plugin consists of:

\begin{itemize}

\item 14 Scala-source-files

\item three XML-files

\item one property file

\end{itemize}

%Das vom Isabelle-Team erstellte jEdit-Plugin folgt natürlich auch dem oben erklärten Muster. Es wird nun genauer auf dieses Plugin eingegangen. The plugin consits of 14 scala-source-files, three xml-files and one property-file. 

The property-file \textit{Isabelle.props} contains general informations about the Isabelle-Plugin and the needed dependencies between Isabelle and the other used Plugins like sidekick. \\

The XML-file \textit{dockables.xml} is used to create the needed dock-able windows which are important to set up the GUI of the Plugin.\\

In the file \textit{actions.xml}, the dockable windows are added to the window-manager \textit{wm} and there is also some Beanshell-code to activate the Isabelle-GUI.\\

The last XML-file is \textit{services.xml} and is used to create instances of needed jEdit-Plugins.\\

This four files are located in the folder \textit{plugin}.\\\\

The more interesting files, the scala-files of the Plugin, can be found in the 'src/jedit'-directory. In this directory you can find the file \textit{Dummy.java} which is a dummy class and is simply used to make javadoc work. Just forget about this file. Also there is a folder/package \textit{jedit} which contains all Scala-source-files. Now it is time to take a closer look on the source-files: \\

The file \textit{plugin.scala} is the main-file of the Isabelle-Plugin and there are two important parts. First the \textit{Isabelle object}. This object contains data like name and path and also few basic functions. The second part is the \textit{class Plugin} which is derived from EBPlugin. Here the basic methods \textit{handleMessage}, \textit{start} and \textit{stop} are implemented. Each jEdit-Plugin should have this methods because they are very important for the handling of the Plugin! \\

jEdit and also the Isabelle Plugin work with dock-able windows. This means that you can move around each single window and dock it somewhere on the screen. So it is possible to individualize the jEdit-GUI. To support this, the file \textit{dockable.scala} is needed. The file \textit{output-dockable.scala} is derived from \textit{dockable.scala} and is used to print the result/output in a dock-able window. The same thing with \textit{protocol-dockable.scala} and \textit{raw-output-dockable.scala}.\\

The next interesting file is \textit{scala-console.scala} with the main-class Scala-Console. This class is used to expand the Console-Plugin in a way, that it is possible to interpret Scala-code with a Shell inside of jEdit.\\ 

The file \textit{isabelle-sidekick.scala} is related to the file \textit{scala-console.scala} because it is also used to adapt the Plugin Sidekick for Isabelle.\\

The files \textit{document-model.scala} and \textit{document-view.scala1} are used to connect the jEdit-buffer/the text-area to Isabelle. Both classes offer, upon others, methods to activate and deactivate this features.\\

There also some other source-files but they aren’t discussed here, because the main goal of this paragraph is to give a basic idea how a jEdit-Plugin should be set up and the remaining files are not as important for the Isabelle-Plugin-structure:

\begin{itemize}

\item $html_panel.scala$

\item $isabelle_encoding.scala$

\item $isabelle_hyperlinks.scala$

\item $isabelle_options.scala$

\item $isabelle_token_maker.scala$

\item $isabelle_hyperlinks.scala$

\end{itemize}

%  Like each other jEdit-Plugin also this 

%Das Konzept des frei wählbaren Designs ist am Beginn villeicht etwas schwierig umzusetzten, da es leichter ist, sich irgendwo anzulehnen bzw. ein bereits bestehendes sowie funktionierendes Konzept zu übernehmen. So wurden auch die ersten Schritte an der TU gemacht. Zu diesem Zweck wurde das von den Entwicklern von jEdit zur Verfügung gestellte plugin 'QuickNotepad' übernommen und in Scala übersetzt. Obwohl Scala eng mit Java verknüpft ist, war doch einiges an 'rewritting' notwendig bis das Scala-plugin lauffähig wurde. Die benötigten XML-files konnten dazu nahezu unberührt gelassen werden.\\

\subsection{Details of NetBeans projects}\label{netbeans}

%     Scala + Java: html project files

As described in the last paragraph, jEdit is a open-source-project. The jEdit-developers use a NetBeans-project to produce the source-code and so it is beneficial to use a NetBeans project too, because there is a quite good documentation about setting up a NetBeans-project with the jEdit-source. See http://wiki.netbeans.org/NetbeansedJEdit for further information.\\\\

If you want to set up a new jEdit-Plugin-project you have to attend that you have to create some source-files and that there must be a connection to the jEdit-source because you will need to exchange data with the jEdit engine. This could probably look like: \textit{jEdit.getProperty("options.isabelle.isabelle")}\\

As shown above, the jEdit-source is needed to compile and build your Plugin. There are two ways to organize your project:

\begin{itemize}

\item with jEdit source code - two projects in one

\item with jedit.jar library

\end{itemize}

\subsubsection{Plugin with jEdit-source}

It is a good way to download the jEdit source as Netbeans project because then it is possible to add another subproject to the existing jEdit-NetBeans-project. As you see it is also possible to mix Scala and Java. A big advantage is, that debugging will now work really fine. If you want to set up a project like this, you should complete the following steps.

\begin{enumerate}

\item {Create a new NetBeans-project for your Plugin like \textit{example-plugin}. This will probably be a Scala-Project.}

\item Download (and try out) the \textit{jEdit-NetBeans-project}

\item at project \textit{example-plugin}: \textit{Project-browser} $\rightarrow$ Right-click at \textit{Libraries} $\rightarrow$ \textit{add Project...} and then choose the \textit{jEdit-NetBeans-project}.

\item at project \textit{example-plugin}: \textit{Project-browser} $\rightarrow$ Right-click at project-name-label $\rightarrow$ \textit{Properties} $\rightarrow$ \textit{Run} $\rightarrow$ \textit{Main Class:} org.gjt.sp.jedit.jEdit

\item compile and run

\end{enumerate}

\subsubsection{Plugin with jedit.jar}

It is also possible to use the \textit{jedit.jar} file. This file is already included in \$ISABELLE-HOME/contrib/jedit-4.3.2. Now you just have to follow this steps:

\begin{enumerate}

\item {Create a new NetBeans-project for your Plugin like \textit{example-plugin}. This will probably be a Scala-Project.}

\item at project \textit{example-plugin}: \textit{Project-browser} $\rightarrow$ Right-click at \textit{Libraries} $\rightarrow$ \textit{add JAR/Folder...} and then choose the \textit{jedit.jar} file.

\item at project \textit{example-plugin}: \textit{Project-browser} $\rightarrow$ Right-click at project-name-label $\rightarrow$ \textit{Properties} $\rightarrow$ \textit{Run} $\rightarrow$ \textit{Main Class:} org.gjt.sp.jedit.jEdit

\item compile and run

\end{enumerate}

This are two different ways to get started. It is difficult to say what is better because both versions have advantages. Now it is time to start coding your own Plugin but there are still a few things to think about. Remember, that a Plugin consists of source-, XML- and property-files. On default, NetBeans will just pack the source-files in the \textit{example-plugin.jar}-package. So you have to add a copy/move-routine in the \textit{build.xml} file of your NetBeans-project to get a complemented package.

\begin{itemize}

\item $\langle target name="-pre-jar"\rangle$

\item $	\langle copy $file="plugin/services.xml" todir="\${build.classes.dir}" $/\rangle$

\item $	\langle copy $file="plugin/dockables.xml" todir="\${build.classes.dir}" $/\rangle$

\item $	\langle copy $file="plugin/actions.xml" todir="\${build.classes.dir}" $/\rangle$	

\item $	\langle copy $file="plugin/Isabelle.props" todir="\${build.classes.dir}" $/\rangle$

\item $	\langle /target\rangle$

\end{itemize}

%* kurze aufzählung der xml-netbeans-files + erklärung\\

\subsubsection{NetBeans project files}

As you see in the paragraph above, it is also important to have basic knowledge about NetBeans, the project structure and how to change the operational sequences. A typical NetBeans-project consist of the source- and library-files and administrative XML- and property-files. In this paragraph the administrative part of the project is of note. The most important file is \textit{build.xml}. This file can be found in the project directory. There is also a folder \textit{nbproject} which contains the remaining XML- and property-files and also a folder \textit{private}, where individual user informations about the project is stored. The files in this \textit{private} folder are not important to describe (and they should not be pushed on the repository!).\\

A build-file like \textit{build.xml} contains one project and at least one (default) target. Targets contain task elements. Each task element of the build-file can have an id attribute and can later be referred to by the value supplied to this. So the id has to be unique. Such targets can be "run", "debug", "build", ... and can have dependencies to other targets. Tasks define what should happen, if a target is executed. So like in the example above, the target is \textit{pre-jar}, that means that this things will happen before the jar-package is packed. The tasks of this target are copying some files into the package.\\

The files inside the \textit{nbproject}-folder are not so important because some of it are generated from \textit{build.xml} and changes in this files are useless. Just the file project.properties is really interesting because this file gives a nice and tight overview about the project settings.

\subsection{Use interfaces between Java and Scala}\label{java-scala}

%     how are data exchanged between Scala and Java ...

jEdit is completely written in Java and the required plugin(s) for Isac will be coded in Scala - so there must be ways to exchange data between Java and Scala. One way is to connect this two worlds with the in 4.2 described XML-files. Here you need to use a third type of code to get an interface between Java and Scala code. But there is also a way to get a direct connection.\\

This link should be shown on the graphic-library \textit{Swing}. In both languages it is possible to use Swing which provides a lot of different shapes and useful functionality. So there is a Java-Swing and also a Scala-Swing-library. Now it is interesting to examine the connection between this two libraries.\\

In Scala a direct use of Java-Libs (like Java-Swing) is possible. So if you are Java-Programmer and want to use Java-Swing in Scala, you can simply type \textit{import javax.swing.JButton} to work with a Java-button. But you can also use the Scala-equivalent \textit{scala.swing.Button}. This two button-types will provide nearly the same functionality.\\So what is the idea of creating a nearly similar library a second time? Why have the Scala-developers done such extra work? The answer is, that they have tried to improve and simplify the usage of the Swing-library(and many other libs too!). So big parts of this Scala-Libraries are just Wrapper-objects, Wrapper-Classes and Wrapper-Methods of already existing parts in Java-Libraries. Needless to say that they also added new useful shapes and functionality.\\

But there is one important question left: Is it possible to mix Scala- and Java-objects? And yes, it is possible. There is a really easy way to convert a Scala-object to the Java-equivalent:

\begin{enumerate}

\item \textit{import javax.swing.JButton}

\item \textit{import scala.swing.Button}

\item \textit{var b: scala.swing.Button}

\item \textit{var jb: javax.swing.JButton}

\item \textit{jb = b.peer}

\end{enumerate}

As the example above illustrates, a conversion of Scala- to Java-objects is possible. It looks easy but also a little bit useless. Why should you need this? Just imagine that there is a Plugin written in Scala and one coded in Java. With this connection between Scala and Java, it would be easy to connect this two Plugins! 

%Diesen direkten Zusammenhang zwischen Java und Scala soll anhand der Grafik-Bibliotheken Swing. Beide Sprachen stellen diese Grafik-Bibliotheken zur Verfügung (und darin auch eigene Shapes und Funktionalität). Es ist jedoch möglich, Java-Bibliotheken, wie eben auch Java-Swing in Scala zu verwenden. Ein JButton kann zum Beispiel mittels \textit{import javax.swing.JButton} eingebunden und damit sofort auch verwendet werden. Auch Scala stellt in seiner Swing-Bibliothek zur Verfügung: \textit{scala.swing.Button}. Es wird nahezu die selbe Funktionalität angeboten und teilweise die Erzeugung bzw. Verwendung vereinfacht(???). Man kann sich nun fragen, warum sich die Scala-Entwickler einerseit die Mühe gemacht haben die Verwendung Java-Swing, wie in Java selbst, möglich zu machen und andererseits mit Scala-Swing eine nahezu idente Alternative geschaffen haben. Die Antwort darauf zeigt wie der objektorientierte Teil von Scala in vielen Bereichen aufgebaut wurden. Es wurde kein neues Konzept für diese Grafikklassen entworfen sondern Wrapper-Objekte/Methoden/Klassen erstellt, die das Arbeiten mit diesen Grafikkomponenten erleichtern soll. Ein Letztes Problem bleibt noch: Es ist zwar sehr einfach ein Java-Swing-Objekt an einen Scala-Swing-Container (zb. Frame) anzubinden, da eine Konvertierung von Java-Komponente in ein Scala-Äquivalent ist problemlos möglich. ...

http://www.scala-lang.org/api/current/scala/swing/Button.html\\

http://download.oracle.com/javase/1.4.2/docs/api/javax/swing/JButton.html

\section{Conclusion and future work}

\bibliography{CTP-userinterfaces}

%\bibliography{bib/math-eng,bib/bk,bib/RISC_2,bib/isac,bib/pl,bib/math,bib/pl}

\end{document}