source: trunk/Documentation/Developer/PluginHowTo/part1.tex @ 1156

Last change on this file since 1156 was 1156, checked in by Arno Wacker, 12 years ago

PluginHowTo:

  • Adapted title page with even larger title, move authors more down, added P. Vacek to the author list and increased version to 0.5
  • Updated part 1 (Developer Guidelines) with information from wiki about committing an building setup
  • Included list of figures
File size: 10.0 KB
Line 
1\chapter{Developer Guidelines}
2\label{DeveloperGuidelines}
3
4CrypTool 2.0 uses state-of-the-art technologies like .NET 3.5 and WPF. In order to make your first steps towards developing something in the context of this project, a few things need to be considered. First of all, please follow the instructions in this document so that you do not get stuck. If you encouter a problem or error that is not described here, please let us know so we can add the appropriate information to this guide.
5
6In the following sections we will describe all steps necessary in order to compile CrypTool 2.0 on your own. This is always the first thing you need to do before you can begin developing your own plugins and extensions. The basic steps are:
7\begin{itemize}
8        \item Getting all prerequisites and installing them
9        \item Accessing and downloading the source code with SVN
10        \item Compiling the source code for the first time
11\end{itemize}
12
13\section{Prerequisites}
14\label{Prerequisites}
15
16Since CrypTool 2.0 is based on Microsoft .NET 3.5, you will need a Microsoft Windows environment. (Currently no plans exist for porting this project to mono or to other platforms.) We have successfully tested with \textbf{Windows XP}, \textbf{Windows Vista} and \textbf{Windows 7}.
17
18Since you are reading the developer guidlines, you probably want to develop something. Hence, you will need a development environment. In order to compile our sources you need \textbf{Microsoft Visual Studio 2008 Professional}. Please always install the latest service packs for Visual Studio. Unfortunately, our sources do not work (smoothly) with the freely available Visual Studio Express (C\#) versions. This is due to the fact that CrypWin uses a commercial component and is therefore distributed only as binary. However, the C\# Express version cannot handle a binary as a start project, and thus debugging becomes cumbersome.
19
20Usually the installation of Visual Studio also installs the .NET framework. In order to run or compile our source code you will need (at the time of writing) at least \textbf{Microsoft .NET 3.5 with Service Pack 1 (SP1)}. You can get this for free from Microsoft's \href{http://download.microsoft.com/download/2/0/e/20e90413-712f-438c-988e-fdaa79a8ac3d/dotnetfx35.exe}{webpage}.
21
22After the last step, your development environment should be ready for our source code. Now you will need a way of accessing and downloading the entire sources. In the CrypTool 2.0 project we use Subversion (SVN) for version control, and hence you need an \textbf{SVN client}, e.g. \textbf{TortoiseSVN} or the \textbf{svn commandline from cygwin}. It does not matter which one you use, but if you have never worked with SVN before, we suggest using \href{http://www.tortoisesvn.net/}{TortoiseSVN}, since it offers a nice Windows Explorer integration of SVN.
23
24\section{Accessing Subversion (SVN)}
25\label{AccessingSubversion}
26
27This section describes how to access our SVN repository and how to configure the basic settings.
28
29\subsection*{The CrypTool2 SVN URL}
30\label{TheCrypTool2SVNURL}
31
32Our code repository is accessable at the following URL:
33
34\url{https://www.cryptool.org/svn/CrypTool2/}
35
36To access the repository, you must provide a username and password. If you are a guest and just want to download our source code, you can use ``anonymous" as the username and an empty password. If you are a registered developer, just use your provided username and password (which is the same as for the wiki).
37
38\subsection*{Accessing the repository with TortoiseSVN}
39\label{AccessingTheRepositoryWithTortoiseSVN}
40
41As mentioned above, in order to access the SVN repository one of the best options is \href{http://www.tortoisesvn.net/}{TortoiseSVN}. We will describe here how to use the basics of the program, although you should be able to use any SVN client in a similar fashion.
42
43First install TortoiseSVN (which unfortunately requires you to reboot your computer) and then create a directory (for instance ``CrypTool2") for storing the local working files somewhere on your computer. Right-click on this directory and select ``SVN Checkout" from the context menu. A window will appear in which you will be asked for the URL of the repository as given above. The ``Checkout directory" should already be filled in correctly with your new folder. Then just hit ok, accept the certificate (if necessary), and enter your login information as described above. Mark the checkbox for saving your credentials if you don't want to enter them every time you work with the repository. Then hit ok, and now the whole CrypTool2 repository should be checked out into your chosen directory.
44
45Later on, if changes have been made in the repository and you want to update your working copy, you can do this by right-clicking on any directory within the working files and choosing ``SVN Update" from the context menu. If you are a registered developer, have changed a file, and want your changes to be reflected in the repository, you should choose ``SVN Commit" from the context menu to upload your changes. Please always provide \textit{meaningful descriptions} of your updates. You should commit your sources to our SVN repository as often as you can. This will ensure your interoperability with the rest of the project for further development.
46
47A TortoiseSVN tutorial can be found \href{http://www.mind.ilstu.edu/research/robots/iris4/developers/svntutorial}{here}.
48
49\subsection*{Ignore patterns}
50\label{IgnorePatterns}
51
52Please only check in clean code by using the following \textbf{ignore patterns}:
53
54\begin{center}
55\textit{obj bin debug release *.pdb *.suo *.exe *.dll}
56\end{center}
57
58This basically means that you should never check in compiled and user-generated files. For example, please do not check in the entire \textit{bin/} and \textit{obj/} directories that Visual Studio generates. Note that the server will reject your commits if you try to do so. If you want to submit a component (binary file) despite the ignore patterns you can still add \textit{*.dll} files by using the context menu and add that file explicitly - but please be absolutely sure, that you know what you are doing. Additionally you need to explicitly provide a list of file names respectively directory names which shall override the ignore pattern. Example, you want to check in a file named someLib.dll, you must write a comment which looks like this:
59
60\begin{center}
61\fbox{\parbox{15cm}
62{\tt
63The lib is required by all developers, so I'm adding it explicitly to the repository.
64
65override-bad-extension: someLib.dll
66}}
67\end{center}
68
69Please note that any text after the colon and the whitespace will be treated as the file name. Please do not use quotes and do not write any text after the name.
70
71
72\subsection*{Committing your changes}
73\label{CommitingChanges}
74
75If you have an SVN account (not anonymous access), you can commit your file changes to the public CrypTool2 repository. Choose ''SVN Commit'' from the context menu in order to upload your changes. Please always provide meaningful descriptions of your updates.
76
77You can use command words in the SVN comment to link your changes to a particular ticket. The command syntax is as follows:
78
79\begin{center}
80\fbox{\parbox{15cm}
81{\tt
82command \#1\newline
83command \#1, \#2\newline
84command \#1 \& \#2\newline
85command \#1 and \#2
86}}
87\end{center}
88
89
90You can have more than one command in a message. The following commands are supported. There is more than one spelling for each command, to make this as user-friendly as possible.
91
92\begin{center}
93\fbox{\parbox{15cm}
94{\tt
95closes, fixes:\newline
96  The specified issue numbers are closed with the contents of this
97  commit message being added to it.
98
99references, refs, addresses, re:\newline
100  The specified issue numbers are left in their current status, but
101  the contents of this commit message are added to their notes.
102}}
103\end{center}
104
105A fairly complicated example of what you can do is with a commit message of:
106
107\begin{center}
108\fbox{\parbox{15cm}
109{\tt
110Changed blah and foo to do this or that. Fixes \#10 and \#12, and refs \#12.
111}}
112\end{center}
113
114
115This will close \#10 and \#12, and add a note to \#12.
116
117
118
119\section{Compiling the sources}
120\label{CompilingTheSources}
121
122By this point you should have checked out a copy of the entire CrypTool repository. Compiling is pretty easy; just go to the \textit{trunk/} directory and open the \textbf{\textit{CrypTool 2.0.sln}} Visual Studio solution. The Visual Studio IDE should open with all the working plugins components nicely arranged. In case you are now starting Visual Studio for the first time, you will have to choose your settings. Just select either ``most common" or ``C\#" --- you can change this at any time later. On the right side is the project explorer, where you can see all the subprojects included in the solution. Look for the project \textbf{\textit{CrypWin.exe}} there. Once you have found it, right-click on it and select ``Set as StartUp-Project" from the context menu. Next, go to the menu bar and select ``Build" $\rightarrow$ ``Build Solution". Then go to ``Debug" and select ``Start Debugging" --- now CrypTool 2.0 should start for the first time with your own compiled code. Presumably you have not changed anything yet, but you now have your own build of all the components (with the exception of CrypWin and AnotherEditor, since they are available only as binaries). If the program does not compile or start correctly, please consult our \href{https://www.cryptool.org/trac/CrypTool2/wiki/FAQ}{FAQ} and let us know if you found a bug.
123
124If you are a core developer, hence somebody who can also compile CryWin and AnotherEditor, you should use the \textbf{\textit{CrypTool 2.0.sln}} solution from the \textit{trunk/CoreDeveloper/} directory (which will \textit{not} be visible to you if you are not a core developer). As a core developer, be aware that when you compile, you \textbf{change the \textit{CryWin.exe}} which is visible to everybody else. Thus, when doing a check-in, please make sure you \textit{really} want to check in a new binary. As core developer you can also build a new setup and publish it as beta release on the website. This process is explained in the wiki: \url{https://www.cryptool.org/trac/CrypTool2/wiki/BuildSetup}.
Note: See TracBrowser for help on using the repository browser.