Add IIJLAB presentation

doc/presentation/SIL Open Font License.txt

@@ -0,0 +1,44 @@
+Copyright (c) 2011, Vernon Adams (vern@newtypography.co.uk),
+with Reserved Font Names "Rokkitt".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting, or substituting -- in part or in whole -- any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission.
+
+5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.

doc/presentation/architecture.tex

@@ -0,0 +1,44 @@
+\documentclass{article}
+\usepackage{polyglossia}
+\usepackage{xcolor}
+\usepackage{fontspec}
+\usepackage{tikz}
+
+\begin{document}
+
+  % \begin{tikzpicture}
+  %   \draw (-1,0) -- (1,0);
+  %   \draw (0,-1) -- (0,1);
+
+  %   \draw (-0.5,-0.5) rectangle (-1,-1);
+  % \end{tikzpicture}.
+
+  \begin{tikzpicture}[every node/.style={draw}]
+    \matrix [draw=red,column sep=1cm]
+    {
+      \node {8}; & \node{1}; & \node {6}; \\
+      \node {3}; & \node{5}; & \node {7}; \\
+      \node {4}; & \node{9}; & \node {2}; \\
+    };
+  \end{tikzpicture}
+
+  \begin{tikzpicture}
+    \matrix[draw=black,nodes=draw,column sep=1mm] at (0, 0) {
+      \node {check}; &
+      \node {type}; &
+      \node {browse}; &
+      \node {find}; &
+      \node {refine}; \\
+    };
+
+    \matrix[draw=black,nodes=draw,column sep=1mm] at (0, 0) {
+      \node {check}; &
+      \node {type}; &
+      \node {browse}; &
+      \node {find}; &
+      \node {refine}; \\
+    };
+  \end{tikzpicture}
+
+
+\end{document}

doc/presentation/auto/main.el

@@ -0,0 +1,14 @@
+(TeX-add-style-hook
+ "main"
+ (lambda ()
+   (TeX-run-style-hooks
+    "latex2e"
+    "beamer"
+    "beamer10"
+    "polyglossia"
+    "xcolor"
+    "fontspec")
+   (TeX-add-symbols
+    "gm"
+    "gms")))
+

doc/presentation/main.tex

@@ -0,0 +1,204 @@
+\documentclass{beamer}
+
+\usepackage{polyglossia}
+\usepackage{xcolor}
+\usepackage{fontspec}
+
+\newfontfamily\Rokkitt{Rokkitt.otf}
+
+\newcommand\gm{{\Rokkitt ghc-mod}\ }
+\newcommand\gms{{\Rokkitt ghc-mod's}\ }
+
+\mode<presentation>
+{
+  \usetheme{Rochester}
+  \usecolortheme{default}
+}
+
+\definecolor{beamer@blendedblue}{HTML}{545488}
+\definecolor{gmgrey}{HTML}{F3F3FF}
+
+\setbeamercolor{normal text}{fg=black,bg=white}
+\setbeamercolor{alerted text}{fg=red}
+\setbeamercolor{example text}{fg=green!50!black}
+
+\setbeamercolor{structure}{fg=beamer@blendedblue}
+
+\setbeamercolor{background canvas}{parent=normal text}
+\setbeamercolor{background}{parent=background canvas}
+
+\setbeamercolor{palette primary}{fg=gmgrey,bg=beamer@blendedblue} % changed this
+\setbeamercolor{palette secondary}{use=structure,fg=structure.fg!100!green} % changed this
+\setbeamercolor{palette tertiary}{use=structure,fg=structure.fg!100!green} % changed this
+
+\title{\gm}
+\subtitle{Making Haskell development even more fun}
+
+\author{\includegraphics{logo} \\ \bigskip Daniel Gr\"ober \and Kazu Yamamoto \vspace{-1em} }
+
+\pgfdeclareimage[height=0.5cm]{logo}{logo}
+\logo{\pgfuseimage{logo}}
+
+% Delete this, if you do not want the table of contents to pop up at
+% the beginning of each subsection:
+\AtBeginSubsection[]
+{
+  \begin{frame}<beamer>{Outline}
+    \tableofcontents[currentsection,currentsubsection]
+  \end{frame}
+}
+
+\begin{document}
+
+\begin{frame}
+  \titlepage
+\end{frame}
+
+\begin{frame}{Outline}
+  \tableofcontents
+\end{frame}
+
+\section{Motivation}
+
+\subsection{What is it?}
+
+\begin{frame}{What is \gm?}
+  First some marketing blurb:
+
+  \begin{block}{}
+    \gm is a backend program for enhancing editors and other kinds of
+    development environments with support for Haskell, a library for abstracting
+    the black magic incantations required to use the API of the most popular
+    Haskell compiler in various build environments and an Emacs Lisp frontend
+    program to let users access it's features.
+  \end{block}
+\end{frame}
+
+\begin{frame}{What does it do?}
+  \begin{itemize}
+    \item \texttt{check} modules for compilation errors and warnings,
+    \item get the inferred \texttt{type} of an expression in a module,
+    \item \texttt{list} modules, compiler and \texttt{lang}uage \texttt{flag}s,
+    \item \texttt{browse} symbols defined in modules,
+    \item \texttt{find} which module a symbol was defined in,
+    \item lookup \texttt{doc}umentation for a symbol or module
+    \item and a bunch of more obscure things.
+  \end{itemize}
+\end{frame}
+
+\subsection{Why work on it?}
+
+\begin{frame}{Why?}
+  \begin{itemize}
+  \item It's actually rather popular: \vspace{1em}
+
+  \item GitHub
+    \includegraphics[width=\textwidth]{gh-stars}
+
+  \item Hackage (Haskell package repository)
+    \includegraphics[width=\textwidth]{hackage-dls}
+
+  \item Also working with compilers is fun, right?
+  \end{itemize}
+\end{frame}
+
+
+\section{Implementation details}
+
+\subsection{Current architecture}
+\begin{frame}{Current architecture}
+  \includegraphics[width=\textwidth]{current-architecture}
+\end{frame}
+
+\begin{frame}{\gm the Elisp program}
+  \begin{itemize}
+  \item Extends haskell-mode to allow access to \gms features
+  \item There really isn't much more to it than that
+  \end{itemize}
+\end{frame}
+
+\begin{frame}{\gm the program}
+  \begin{itemize}
+  \item Development environment communicates with \gm process
+  \item Exists as a one-shot and long running process version
+  \begin{itemize}
+    \item \gm simple, doesn't have to worry about caching
+    \item \gm ``interactive'' much more complex, needs to be very aware of
+      changing environment and how that affects compiler internal caches
+  \end{itemize}
+  \item interactive \gm is generally much faster than \gm at least for features
+      that require compilation though
+  \end{itemize}
+\end{frame}
+
+\begin{frame}{\gm the library}
+  \begin{itemize}
+  \item \gm frontend programs use the library to implement all functionality
+  \item Frontends are very thin wrappers around the library, all the
+    intelligence is in there
+  \item Primary entry point abstracts away environment setup and just gives the
+    underlying tool a compiler session to work with
+  \item Right now it's only of limited use for implementing new \gm like tools
+    on top of it and definitely needs a redesign (for v6.0 probably)
+  \item Alan Zimmerman's Haskell Refactorer (HaRe) uses it for example
+  \end{itemize}
+\end{frame}
+
+\begin{frame}{Problems}
+  \begin{itemize}
+  \item Extending \gm from the outside is hard to impossible
+  \item External tools end up depending on ghc-mod making it difficult for us to
+    make use of them
+  \item This all just leads to fragmentation in the already fragmented Haskell
+    Tooling Landscape
+  \item one tool, \texttt{mote}, just ended up copy-pasting part of \gms
+    environment support code straight into it's codebase \texttt{-.-}
+  \item development environments essentially need to support every tooling
+    project themselves
+  \end{itemize}
+\end{frame}
+
+\subsection{Redesigned architecture}
+\begin{frame}{Redesigned architecture}
+  \includegraphics[width=\textwidth]{planned-architecture}
+\end{frame}
+
+\begin{frame}{Redesigned architecture}
+  \begin{itemize}
+  \item Factor out commands from library into a seperate package
+  \item Refine the library so any tool can actually make use of it
+  \item Design a communication library towards the development environment which
+    provides some common ground for tools and frontend developers
+  \end{itemize}
+\end{frame}
+
+\section{The internship}
+
+\subsection{What we have done so far}
+
+\begin{frame}{Bitrot}
+  \begin{itemize}
+  \item Cabal version 1.22 completely broke \gms hack'y way of getting
+    information about the build system state
+  \item To fix this (recurring) problem once and for all we had to completely
+    re-design how we access Cabal's internal state
+  \item Next GHC version 7.10 came along and also broke \gm
+  \item Adding support for the new compiler version was easy
+  \item Cabal-1.22 support was however still blocking the release
+  \end{itemize}
+\end{frame}
+
+\subsection{What is still to be done}
+
+\begin{frame}{TODO}
+  \begin{itemize}
+  \item Essentially implement all of the architectural changes
+  \item Support for implementing REPLs on top of ghc-mod
+  \item Speed up \gm program by adding network RPC support
+  \end{itemize}
+\end{frame}
+
+\begin{frame}{Questions?}
+\end{frame}
+
+\end{document}