<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>RedBrain @ $HOME : ~ $ &#187; c/c++</title>
	<atom:link href="http://redbrain.co.uk/index.php/tag/cc/feed/" rel="self" type="application/rss+xml" />
	<link>http://redbrain.co.uk</link>
	<description>Frustrated Software Developer</description>
	<lastBuildDate>Wed, 16 Nov 2011 17:36:07 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.2.1</generator>
		<item>
		<title>Parsing the Doom Wad File</title>
		<link>http://redbrain.co.uk/index.php/random/parsing-the-doom-wad-file/</link>
		<comments>http://redbrain.co.uk/index.php/random/parsing-the-doom-wad-file/#comments</comments>
		<pubDate>Thu, 07 Jan 2010 01:12:31 +0000</pubDate>
		<dc:creator>redbrain</dc:creator>
				<category><![CDATA[Random]]></category>
		<category><![CDATA[Tutorials]]></category>
		<category><![CDATA[c/c++]]></category>
		<category><![CDATA[Crules]]></category>
		<category><![CDATA[doom]]></category>
		<category><![CDATA[linux]]></category>
		<category><![CDATA[Programming]]></category>

		<guid isPermaLink="false">http://redbrain.co.uk/?p=528</guid>
		<description><![CDATA[<p>So it was a fine Christmas, I was at home with family armed only with 2 seasons of xFiles and my laptop added to the factI didn&#8217;t upload my ssh key to my laptop so hacking on Crules was out the window. So it got me thinking on the main goals for my Crules Scripting [...]]]></description>
			<content:encoded><![CDATA[<p>So it was a fine Christmas, I was at home with family armed only with 2 seasons of xFiles and my laptop added to the factI didn&#8217;t upload my ssh key to my laptop so hacking on Crules was out the window. So it got me thinking on the main goals for my Crules Scripting Language, one of which ( the main one ) is that it should be embeddable into existing C/C++ applications like Lua or Python or even C# (mono) if your using its recently added reflection api!</p>
<p>So why not make a game engine using my language with crules as a scripting language so I can see what the API _SHOULD_ look like for the client. So i choose doom since i am terrible with graphics, i can use the doom.wad and concentrate on programming; So in the past i have written two separate 2D game engines one was a Java 2D <a href="http://en.wikipedia.org/wiki/Monkey_Island_%28series%29">Monkey Island</a> clone i done for university and it was terrible since Java is a terrible platform in my opinion, then my 2nd was a port  of it over to <a href="http://www.libsdl.org/">C++/SDL</a> and the code was terrible <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' />  so don&#8217;t bother asking me about it.</p>
<p>Anyway&#8217;s so the long and short i am writing doom engine from scratch, my original idea was to work with an existing game engine like <a href="http://www.crystalspace3d.org/main/Main_Page">Crystal Space</a> or <a href="http://dengine.net/">Doomsday Engine</a> though, Crystal Space i was put off since it already uses Python and i don&#8217;t really feel like trawling though lots of code and forking it essentially would be really more work than its worth. Doomsday Engine is the cream of the crop of Doom Ports at the moment, all others are practically the same in essence using the same ancient code and hacks from throughout the 90&#8242;s. And really the technology has changed somewhat since then. Though Doomsday Engine is pretty amazing and works well, it seems to need a massive cleanup and i don&#8217;t mean to be nasty on the developers or anything they have done a fantastic job!  And they have really made the code much cleaner than any other port about! Plus the lead developer has been really nice to me <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' /> . Anyway&#8217;s Games have always been a great passion to me and really doom can&#8217;t be that hard to re-implement from scratch and really it isn&#8217;t i already have a basic game engine working using OpenGL and <a href="http://www.libsdl.org/">SDL{ _ttf, _mixer }</a>. With audio, and fps counter and input bla bla. But i am just concentrating on differentiating the wad sprite formats etc while revising for exams and working on crules and many other bits and pieces. So in the end  i&#8217;ll just stick in an extract of the log of my game engine when it starts parsing the doom.wad and explain a little on how to parse the wad!</p>
<blockquote><p>debug: main.c:28 -&gt; Trying to start crldoom wad: data/doom.wad!<br />
debug: doom.c:147 -&gt; parsing wad file &lt;data/doom.wad&gt;!<br />
debug: doom.c:80 -&gt; is a wad file :: &lt;IWAD&gt;!<br />
log: doom.c:155 -&gt; wad file data/doom.wad has length 12408292!<br />
debug: doom.c:27 -&gt; debug seeking&#8230;<br />
debug: doom.c:30 -&gt; reading&#8230;.<br />
debug: doom.c:34 -&gt; parsing&#8230;<br />
log: doom.c:49 -&gt; header:: ident -&gt; 1145132873, n_lumps -&gt; 2306, infotableofs -&gt; 12371396!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 12, size -&gt; 10752, name -&gt; 1497451600, ident -&gt; PLAYPAL!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 10764, size -&gt; 8704, name -&gt; 1330401091, ident -&gt; COLORMAP!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 19468, size -&gt; 4000, name -&gt; 1329876549, ident -&gt; ENDOOM!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 23468, size -&gt; 6854, name -&gt; 1330464068, ident -&gt; DEMO1!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 30324, size -&gt; 9402, name -&gt; 1330464068, ident -&gt; DEMO2!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 39728, size -&gt; 15466, name -&gt; 1330464068, ident -&gt; DEMO3!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 55196, size -&gt; 3286, name -&gt; 1330464068, ident -&gt; DEMO4!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 58484, size -&gt; 0, name -&gt; 827142469, ident -&gt; E1M1!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 58484, size -&gt; 1430, name -&gt; 1313425492, ident -&gt; THINGS!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 59916, size -&gt; 6804, name -&gt; 1162758476, ident -&gt; LINEDEFS!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 66720, size -&gt; 19980, name -&gt; 1162103123, ident -&gt; SIDEDEFS!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 86700, size -&gt; 1880, name -&gt; 1414677846, ident -&gt; VERTEXES!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 88580, size -&gt; 8964, name -&gt; 1397179731, ident -&gt; SEGS!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 97544, size -&gt; 956, name -&gt; 1128616787, ident -&gt; SSECTORS!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 98500, size -&gt; 6664, name -&gt; 1162104654, ident -&gt; NODES!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 105164, size -&gt; 2288, name -&gt; 1413694803, ident -&gt; SECTORS!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 107452, size -&gt; 968, name -&gt; 1162495314, ident -&gt; REJECT!<br />
log: doom.c:62 -&gt; directory:: filepos -&gt; 108420, size -&gt; 6948, name -&gt; 1129270338, ident -&gt; BLOCKMAP!</p></blockquote>
<p>So this is just some of the output of the code i had written it parses out whats called the &#8216;directories&#8217; in the file and then i also have functions to parse out whats called the &#8216;lumps&#8217; from these directories the lumps are the actual data. I&#8217;ll explain more detail when i talk about how to parse this. And how to convert the music lumps to proper midi so you can play it in SDL_mixer or even in Totem if in in gnome.</p>
<p>So what do we need, if you have yourself a Doom.wad file lying about i am sure if you go through your old boxes you&#8217;ll find yourself a copy of doom, or if you cant find it you can find it on torrent sites but you didn&#8217;t read that here <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' /> . Thing is I have bought the game like 3/4 times I am sure hehe. Lets get started.</p>
<p>In the Doom wad there is whats called the &#8216;HEADER&#8217; which is of length 12 bytes which contains 3 * 4-byte integers which contain the data we care about, so lets do that lets make some code (i just wrote this code in like 10 min to illustrate the idea its ok does the job!):</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="co2">#include &lt;stdio.h&gt;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="co2">#include &lt;stdlib.h&gt;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="co2">#include &lt;string.h&gt;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li2">
<div class="de2"><span class="co2">#define WAD_HEADER_LENGTH &nbsp; &nbsp; 12</span></div>
</li>
<li class="li1">
<div class="de1"><span class="co2">#define WAD_DIRECTORY_LENGTH &nbsp;16</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1"><span class="kw4">unsigned</span> <span class="kw4">long</span> parse_int<span class="br0">&#40;</span> <span class="kw4">unsigned</span> <span class="kw4">char</span> *p <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#123;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; <span class="kw1">return</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span><span class="kw4">unsigned</span> <span class="kw4">long</span><span class="br0">&#41;</span> &nbsp; p<span class="br0">&#91;</span><span class="nu0">0</span><span class="br0">&#93;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;| <span class="br0">&#40;</span><span class="kw4">unsigned</span> <span class="kw4">long</span><span class="br0">&#41;</span> p<span class="br0">&#91;</span><span class="nu0">1</span><span class="br0">&#93;</span> &lt;&lt; <span class="nu0">8</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;| <span class="br0">&#40;</span><span class="kw4">unsigned</span> <span class="kw4">long</span><span class="br0">&#41;</span> p<span class="br0">&#91;</span><span class="nu0">2</span><span class="br0">&#93;</span> &lt;&lt; <span class="nu0">16</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;| <span class="br0">&#40;</span><span class="kw4">unsigned</span> <span class="kw4">long</span><span class="br0">&#41;</span> p<span class="br0">&#91;</span><span class="nu0">3</span><span class="br0">&#93;</span> &lt;&lt; <span class="nu0">24</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="br0">&#41;</span> ;</div>
</li>
<li class="li2">
<div class="de2"><span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1"><span class="kw4">int</span> main<span class="br0">&#40;</span> <span class="kw4">int</span> argc, <span class="kw4">char</span> *argv<span class="br0">&#91;</span><span class="br0">&#93;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">const</span> <span class="kw4">char</span>* wad_file= <span class="st0">&quot;/home/redbrain/workspace/doom-dev/crldoom/data/doom.wad&quot;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; FILE* wad_fd;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">if</span><span class="br0">&#40;</span> !<span class="br0">&#40;</span>wad_fd= fopen<span class="br0">&#40;</span>wad_file, <span class="st0">&quot;rb&quot;</span><span class="br0">&#41;</span><span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; fprintf<span class="br0">&#40;</span>stderr, <span class="st0">&quot;error opening &lt;%s&gt;!<span class="es0">\n</span>&quot;</span>, wad_file<span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="kw1">return</span> EXIT_FAILURE;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">unsigned</span> <span class="kw4">char</span> header_buffer<span class="br0">&#91;</span> WAD_HEADER_LENGTH <span class="br0">&#93;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; fread<span class="br0">&#40;</span> header_buffer, WAD_HEADER_LENGTH, <span class="nu0">1</span>, wad_fd <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; <span class="kw4">char</span>* wad_ident= <span class="br0">&#40;</span><span class="kw4">char</span>*<span class="br0">&#41;</span> header_buffer;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; wad_ident<span class="br0">&#91;</span> <span class="nu0">4</span> <span class="br0">&#93;</span>= <span class="st0">&#8216;<span class="es0">\0</span>&#8216;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">if</span><span class="br0">&#40;</span> strncmp<span class="br0">&#40;</span> wad_ident, <span class="st0">&quot;IWAD&quot;</span>, <span class="nu0">4</span> <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; fprintf<span class="br0">&#40;</span>stderr, <span class="st0">&quot;invalid wad header type &lt;%s&gt;!<span class="es0">\n</span>&quot;</span>, wad_ident <span class="br0">&#41;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; <span class="kw1">return</span> EXIT_FAILURE;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">else</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <a href="http://www.opengroup.org/onlinepubs/009695399/functions/printf.html"><span class="kw3">printf</span></a><span class="br0">&#40;</span><span class="st0">&quot;doom wad is a &lt;%s&gt;!<span class="es0">\n</span>&quot;</span>, wad_ident <span class="br0">&#41;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">unsigned</span> <span class="kw4">long</span> wad_length= <span class="nu0">0</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; fseek<span class="br0">&#40;</span> wad_fd, <span class="nu0">0</span>, SEEK_END <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; wad_length= ftell<span class="br0">&#40;</span> wad_fd <span class="br0">&#41;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">unsigned</span> <span class="kw4">long</span> directory_offset= parse_int<span class="br0">&#40;</span> header_buffer<span class="nu0">+8</span> <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">unsigned</span> <span class="kw4">long</span> number_lumps= parse_int<span class="br0">&#40;</span> header_buffer<span class="nu0">+4</span> <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <a href="http://www.opengroup.org/onlinepubs/009695399/functions/printf.html"><span class="kw3">printf</span></a><span class="br0">&#40;</span><span class="st0">&quot;wad directory offset &lt;%lu&gt; with &lt;%lu&gt; lumps!<span class="es0">\n</span>&quot;</span>,</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp;directory_offset, number_lumps <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">unsigned</span> <span class="kw4">long</span> t_ofs= directory_offset; <span class="kw4">unsigned</span> <span class="kw4">long</span> lump_count= <span class="nu0">0</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">while</span><span class="br0">&#40;</span> t_ofs &lt;= <span class="br0">&#40;</span> wad_length -- WAD_DIRECTORY_LENGTH <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#123;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; fseek<span class="br0">&#40;</span> wad_fd, t_ofs, SEEK_SET <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="kw4">unsigned</span> <span class="kw4">char</span> *directory_buffer= <span class="br0">&#40;</span><span class="kw4">unsigned</span> <span class="kw4">char</span>*<span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; malloc<span class="br0">&#40;</span> <span class="kw4">sizeof</span><span class="br0">&#40;</span><span class="kw4">char</span><span class="br0">&#41;</span> * WAD_DIRECTORY_LENGTH <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; fread<span class="br0">&#40;</span> directory_buffer, WAD_DIRECTORY_LENGTH, <span class="nu0">1</span>, wad_fd <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; <span class="kw4">unsigned</span> <span class="kw4">long</span> filepos= parse_int<span class="br0">&#40;</span> directory_buffer <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="kw4">unsigned</span> <span class="kw4">long</span> size= parse_int<span class="br0">&#40;</span> directory_buffer<span class="nu0">+4</span> <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="kw4">char</span> *directory_ident= strdup<span class="br0">&#40;</span> <span class="br0">&#40;</span><span class="kw4">char</span>*<span class="br0">&#41;</span> directory_buffer<span class="nu0">+8</span> <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; directory_ident<span class="br0">&#91;</span> strlen<span class="br0">&#40;</span>directory_ident<span class="br0">&#41;</span> <span class="br0">&#93;</span>= <span class="st0">&#8216;<span class="es0">\0</span>&#8216;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; <a href="http://www.opengroup.org/onlinepubs/009695399/functions/printf.html"><span class="kw3">printf</span></a><span class="br0">&#40;</span><span class="st0">&quot;directory name &lt;%s&gt; at offset &lt;%lu&gt; with size &lt;%lu&gt;!<span class="es0">\n</span>&quot;</span>,</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp;directory_ident, filepos, size <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; free<span class="br0">&#40;</span> directory_ident <span class="br0">&#41;</span>; free<span class="br0">&#40;</span> directory_buffer <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; t_ofs += WAD_DIRECTORY_LENGTH; lump_count++;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <a href="http://www.opengroup.org/onlinepubs/009695399/functions/printf.html"><span class="kw3">printf</span></a><span class="br0">&#40;</span><span class="st0">&quot;directorys parsed &lt;%lu&gt; total lumps &lt;%lu&gt;!<span class="es0">\n</span>&quot;</span>,</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp;lump_count, number_lumps <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; fclose<span class="br0">&#40;</span> wad_fd <span class="br0">&#41;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">return</span> <span class="nu0">0</span>;</div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#125;</span></div>
</li>
</ol>
</div>
<p>So lets compile and test this code &lt;remember to change the path to your doom wad&gt;:</p>
<blockquote><p>gcc doom_wad_test.c</p>
<p>./a.out</p></blockquote>
<p>So right what does any of this code mean i just chucked it up there, i wrote it up very quickly from scratch. So as i stated earlier there is a wad header which is a 12 bytes in length which i refer to as &#8216;WAD_HEADER_LENGTH&#8217; which contains 3 * 4-byte integers. So from the code we have fopen&#8217;d the wad_file and i use fread to read in the 12 bytes in a 12 byte &#8216;unsigned char[]&#8216; buffer. So to read out the integers in a neutral endian way i found a nice parse_int function in some of the wad documentation i found and in old doom source code which was GPL so it was like&#8230;. yoink&#8230; but its pretty easy to understand if you know your representations well enough but i wont go into detail.</p>
<p>The first integer is the IWAD or PWAD string, IWAD is what you will find mostly its the deployment version of the wad, the PWAD is a patch wad and very few of them are still around and i think it has similar structure. Anyways, you parse out the first integer like this</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="kw4">char</span>* wad_ident= <span class="br0">&#40;</span><span class="kw4">char</span>*<span class="br0">&#41;</span> header_buffer;</div>
</li>
<li class="li1">
<div class="de1">wad_ident<span class="br0">&#91;</span> <span class="nu0">4</span> <span class="br0">&#93;</span>= <span class="st0">&#8216;<span class="es0">\0</span>&#8216;</span>;</div>
</li>
</ol>
</div>
<p>Remember to add null string &#8216;\0&#8242;, so we don&#8217;t get buffer overflow! This string is always a length of 4 so no need to mess about! And then the next integer is the number of lumps in the wad the lumps are the actual binary data like music and graphics. Third int is the &#8216;directory offset&#8217; which contains pointers to where the lumps are their idents and the size of the lumps which have lengths of 16 &#8216;WAD_DIRECTORY_LENGTH&#8217; until the end of the wad file! so note i find the length of the file and do:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="kw1">while</span><span class="br0">&#40;</span> t_ofs &lt;= <span class="br0">&#40;</span> wad_length -- WAD_DIRECTORY_LENGTH <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&#8230;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
</ol>
</div>
<p>So how do we parse out these directories?  We move to the directory offset and then read the 16 bytes into a buffer, which is 4 integers this time. But still contains only 3 things means the ident strings can be longer or can be with some padding between each directory lump.</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="kw4">unsigned</span> <span class="kw4">long</span> filepos= parse_int<span class="br0">&#40;</span> directory_buffer <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1"><span class="kw4">unsigned</span> <span class="kw4">long</span> size= parse_int<span class="br0">&#40;</span> directory_buffer<span class="nu0">+4</span> <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1"><span class="kw4">char</span> *directory_ident= strdup<span class="br0">&#40;</span> <span class="br0">&#40;</span><span class="kw4">char</span>*<span class="br0">&#41;</span> directory_buffer<span class="nu0">+8</span> <span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">directory_ident<span class="br0">&#91;</span> strlen<span class="br0">&#40;</span>directory_ident<span class="br0">&#41;</span> <span class="br0">&#93;</span>= <span class="st0">&#8216;<span class="es0">\0</span>&#8216;</span>;</div>
</li>
</ol>
</div>
<p>Now we know the file offset of the lump the size of the lump and the ident of the lump and we make sure to add the null terminator again to avoid buffer overflow. And then we can parse out the lumps simply just fseek and fread <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' />  Done its so simple and seems like there would be more to it, yet when you think of it is very much common sense there really isn&#8217;t that many ways to pack data into a file like this! If your interested i&#8217;ll be talking about it soon&#8230; on how to convert the D_E1M* lumps which are music lumps to compatible midi tracks. And finally on how <a href="http://en.wikipedia.org/wiki/Binary_space_partitioning">BSP</a> works for the levels and maybe how to draw them in C/SDL/OpenGL&#8230; if you ask i prefer C over C++, yeah when it comes to building this game engine there have been times i though woo having an object would be really nice here but then i realise well no because that&#8217;s what the scripting engine is going to do&#8230; <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' />  Mainly due to the fact i dont like C++ syntax it feels messy to me and C is just nice and simple <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
<p>Finally I just want to wrap up with saying <a href="http://en.wikipedia.org/wiki/John_D._Carmack">John Carmack</a> has to be one of my biggest Hero&#8217;s in Computer Science along with <a href="http://tirania.org/blog/">Migel De Icaza</a>, <a href="http://en.wikipedia.org/wiki/Linus_Torvalds">Linus Torvalds</a>, Various GCC hackers&#8230; like Ian Lance Taylor But John Carmack in particular since he made Doom! But also he attended the <a title="University of Missouri–Kansas City" href="http://en.wikipedia.org/wiki/University_of_Missouri%E2%80%93Kansas_City">University of Missouri–Kansas City</a> for two semesters before withdrawing to work as a freelance programmer. Which i think that is brilliant! Since University does not teach students to be serious programmers or technology well very few do anyway and i think its great he had the balls to do that and so did Migel De Icaza and they have both done some of the most amazing things in computer science!</p>
<p>Anyways if your interested in Crules or CrlDoom see: <a href="http://crules.org">http://crules.org</a> code for crldoom is over @ <a href="http://code.redbrain.co.uk/cgit.cgi/crldoom">http://code.redbrain.co.uk/cgit.cgi/crldoom</a></p>
<p>This is a project i love <a href="http://www.moddb.com/mods/classic-doom-3">Classic Doom 3</a> it was Doom re-implemented ontop of the Doom3 Engine what more do you want!!!</p>
<p><!-- Smart Youtube --><span class="youtube"><object width="425" height="373"><param name="movie" value="http://www.youtube.com/v/woBAUk5hMD8&amp;rel=1&amp;color1=3a3a3a&amp;color2=999999&amp;border=1&amp;fs=1&amp;hl=en&amp;autoplay=0&amp;showinfo=0&amp;iv_load_policy=3&amp;showsearch=0" /><param name="allowFullScreen" value="true" /><embed wmode="transparent" src="http://www.youtube.com/v/woBAUk5hMD8&amp;rel=1&amp;color1=3a3a3a&amp;color2=999999&amp;border=1&amp;fs=1&amp;hl=en&amp;autoplay=0&amp;showinfo=0&amp;iv_load_policy=3&amp;showsearch=0" type="application/x-shockwave-flash" allowfullscreen="true" width="425" height="373" ></embed><param name="wmode" value="transparent" /></object></span></p>
]]></content:encoded>
			<wfw:commentRss>http://redbrain.co.uk/index.php/random/parsing-the-doom-wad-file/feed/</wfw:commentRss>
		<slash:comments>3</slash:comments>
		</item>
		<item>
		<title>Crules and Intermediate Representation</title>
		<link>http://redbrain.co.uk/index.php/quick-tips/crules-and-intermediate-representation/</link>
		<comments>http://redbrain.co.uk/index.php/quick-tips/crules-and-intermediate-representation/#comments</comments>
		<pubDate>Thu, 03 Dec 2009 02:47:00 +0000</pubDate>
		<dc:creator>redbrain</dc:creator>
				<category><![CDATA[Compilers]]></category>
		<category><![CDATA[Crules]]></category>
		<category><![CDATA[Quick Tips]]></category>
		<category><![CDATA[Tutorials]]></category>
		<category><![CDATA[Update!]]></category>
		<category><![CDATA[c/c++]]></category>
		<category><![CDATA[compiler]]></category>
		<category><![CDATA[linux]]></category>
		<category><![CDATA[Programming]]></category>
		<category><![CDATA[tutorial]]></category>

		<guid isPermaLink="false">http://redbrain.co.uk/?p=491</guid>
		<description><![CDATA[<p>If you follow my blog you may have noticed i have been quiet and thats because i&#8217;ve been working on http://crules.org Its the new homepage for my project Crules, its got some good content on it but nothing really on the language yet. Though today i spend a very long time on the HACKING article [...]]]></description>
			<content:encoded><![CDATA[<p>If you follow my blog you may have noticed i have been quiet and thats because i&#8217;ve been working on <a href="http://crules.org">http://crules.org</a> Its the new homepage for my project Crules, its got some good content on it but nothing really on the language yet. Though today i spend a very long time on the<a href="http://crules.org/doku.php?id=hacking"> HACKING</a> article And i explain a lot on how Intermediate Representation&#8217;s work and <a href="http://en.wikipedia.org/wiki/Three_address_code">3-address code</a>.</p>
<p>So lets just take an extract since i am lazy: So in compilers or interpreters how do we represent:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="br0">&#40;</span><span class="br0">&#40;</span> x + y <span class="br0">&#41;</span> -- <span class="br0">&#40;</span> <span class="br0">&#40;</span> x + y <span class="br0">&#41;</span> * <span class="br0">&#40;</span> x -- y <span class="br0">&#41;</span> <span class="br0">&#41;</span> <span class="br0">&#41;</span> + <span class="br0">&#40;</span> <span class="br0">&#40;</span> x + y <span class="br0">&#41;</span> * <span class="br0">&#40;</span> x -- y <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
</ol>
</div>
<p>Lets see it in a diagram first then in IR code:</p>
<div class="wp-caption alignleft" style="width: 281px"><a href="http://farm3.static.flickr.com/2718/4153843445_7f33be00d2.jpg"><img title="Expression DAG" src="http://farm3.static.flickr.com/2718/4153843445_7f33be00d2.jpg" alt="Expression" width="271" height="202" /></a><p class="wp-caption-text">Expression</p></div>
<p>So what is this? Well early on when i was getting into compiler construction when doing semantic analysis you will need to find a way of representing these semantics for your language, and you will find generally that there are 3 things you need to know: <strong>DESTINATION OPERAND A and OPERAND B</strong>. This is what&#8217;s called <a title="http://en.wikipedia.org/wiki/Three_address_code" rel="nofollow" href="http://en.wikipedia.org/wiki/Three_address_code">3-address code</a>. This is what sets compilers apart and can make or break them! Its what gives implementations flexibility and the ability to &#8216;<strong>control the flow</strong>&#8216; of execution! Any good compiler book will give you more detailed discussion on this topic its my main interest in compilers since this is what gives an implementation its logic. So lets give it a syntax we can write down to illustrate how mine works: it just so happens a <a title="http://en.wikipedia.org /wiki/Lisp_%28programming_language%29" rel="nofollow" href="http://en.wikipedia.org%20/wiki/Lisp_%28programming_language%29">LISP</a> &#8216;ish syntax can show this very well!</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="br0">&#40;</span> <span class="br0">&#40;</span> IDENTIFIER <span class="br0">&#40;</span> TYPE <span class="br0">&#41;</span> <span class="br0">&#41;</span> =&gt; <span class="br0">&#40;</span> OPERAND A <span class="br0">&#41;</span> =&gt; <span class="br0">&#40;</span> OPERAND B <span class="br0">&#41;</span> <span class="br0">&#41;</span><span class="co1">;</span></div>
</li>
</ol>
</div>
<p>Since the parser is precedence aware it will construct the tree as shown in a symbol language which looks like this if it was output ( outputting the IR like this is a future TODO ); It may look a little like <a title="http://gcc.gnu.org/onlinedocs/gccint/GIMPLE.html" rel="nofollow" href="http://gcc.gnu.org/onlinedocs/gccint/GIMPLE.html">GIMPLE</a> but this IR I have as I will demonstrate more examples can encompass much much more..  ( this is a 3-address code by the way )</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_ADD <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_SUBTRACT <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_ADD <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;x&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;y&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#41;</span> <span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_MULTIPLY <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_ADD <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;x&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;y&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_SUBTRACT <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;x&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;y&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_MULTIPLY <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_ADD <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;x&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;y&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> OP_SUBTRACT <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;x&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#40;</span> SYMBOL_ACCESS <span class="br0">&#41;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> &#8216;y&#8217; <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; &nbsp; =&gt; <span class="br0">&#40;</span> <span class="kw1">NIL</span> <span class="br0">&#41;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="br0">&#41;</span><span class="co1">; )</span></div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#41;</span><span class="co1">;</span></div>
</li>
</ol>
</div>
<div class="wp-caption alignright" style="width: 280px"><a href="http://icanhascheezburger.files.wordpress.com/2009/11/funny-pictures-cat-will-unroll-all-toilet-paper.jpg"><img title="Busy catz" src="http://icanhascheezburger.files.wordpress.com/2009/11/funny-pictures-cat-will-unroll-all-toilet-paper.jpg" alt="busy!" width="270" height="201" /></a><p class="wp-caption-text">busy!</p></div>
<p>Though one big note its is ok for me to leave the representation like this since in my interpreter i just evaluate this at run time but how does this affect things like code-generators like proper Compilers? Well its quite simple in a sane compiler like GCC ( although most compilers will follow this idiom i am sure) introduce another layer for IR called RTL ( <a href="http://en.wikipedia.org/wiki/Register_transfer_language">Register Transfer Language</a> ). The wikipedia article lacks and most compiler books overlook this section very much since, most books are written by the academics and generally stay away from the <a href="http://en.wikipedia.org/wiki/Compiler#Back_end">back-end of compilers</a> since that is the actual hard part since a code-gen is very specific to the instruction set your targeting and register allocation algorithms are very difficult and is a huge research project.  Its said in computer science the most difficult things to build software wise is a good JIT or any Code-Generator for that matter.  Anyways back to the problem lets take a smaller expression for sleep&#8217;s sake the expression:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="kw4">unsigned</span> <span class="kw4">int</span> retval = <span class="br0">&#40;</span> x * <span class="nu0">2</span> <span class="br0">&#41;</span> / <span class="br0">&#40;</span> <span class="nu0">7</span> + y <span class="br0">&#41;</span>;</div>
</li>
</ol>
</div>
<p>Will generate something like:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">t1 = x * <span class="nu0">2</span>;</div>
</li>
<li class="li1">
<div class="de1">t2 = <span class="nu0">7</span> + y;</div>
</li>
<li class="li1">
<div class="de1">t3 = t1 / t2;</div>
</li>
<li class="li2">
<div class="de2">retval = t3;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
</ol>
</div>
<p>Anyways you&#8217;ll notice in my the IR keywords such as SYMBOL_ACCESS or SYMBOL_ITEM or OP_ADD etc, these are what&#8217;s called OP_Codes and are generally represented by some symbolic hex values since its cheap to check against for the implementation to figure out what to do with symbol &#8216;x&#8217;; So ok thats a quick and dirty intro to Intermediate Representation&#8217;s!</p>
<p>I think this lolcat will sum up your feelings at the end of reading this blog post:</p>
<p>And i started getting out my old grunge cd&#8217;s which include my <a href="http://www.last.fm/music/Silverchair">Silverchair</a> collection and this is on of my favourite bands of all time and this is a pretty good song!</p>
<p><!-- Smart Youtube --><span class="youtube"><object width="425" height="373"><param name="movie" value="http://www.youtube.com/v/fTM5cDIESrY&amp;rel=1&amp;color1=3a3a3a&amp;color2=999999&amp;border=1&amp;fs=1&amp;hl=en&amp;autoplay=0&amp;showinfo=0&amp;iv_load_policy=3&amp;showsearch=0" /><param name="allowFullScreen" value="true" /><embed wmode="transparent" src="http://www.youtube.com/v/fTM5cDIESrY&amp;rel=1&amp;color1=3a3a3a&amp;color2=999999&amp;border=1&amp;fs=1&amp;hl=en&amp;autoplay=0&amp;showinfo=0&amp;iv_load_policy=3&amp;showsearch=0" type="application/x-shockwave-flash" allowfullscreen="true" width="425" height="373" ></embed><param name="wmode" value="transparent" /></object></span></p>
]]></content:encoded>
			<wfw:commentRss>http://redbrain.co.uk/index.php/quick-tips/crules-and-intermediate-representation/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
		<item>
		<title>Intel C++ Complilers Linux</title>
		<link>http://redbrain.co.uk/index.php/quick-tips/intel-c-complilers-linux/</link>
		<comments>http://redbrain.co.uk/index.php/quick-tips/intel-c-complilers-linux/#comments</comments>
		<pubDate>Sat, 28 Nov 2009 16:15:27 +0000</pubDate>
		<dc:creator>redbrain</dc:creator>
				<category><![CDATA[Quick Tips]]></category>
		<category><![CDATA[Random]]></category>
		<category><![CDATA[Tutorials]]></category>
		<category><![CDATA[Update!]]></category>
		<category><![CDATA[autoconf]]></category>
		<category><![CDATA[c/c++]]></category>
		<category><![CDATA[linux]]></category>
		<category><![CDATA[Programming]]></category>

		<guid isPermaLink="false">http://redbrain.co.uk/?p=485</guid>
		<description><![CDATA[<p>So if you know me you&#8217;ll know i think compilers are cool&#8230; yeah i know i am weird lol. So any-way&#8217;s this is something i never really got around to until last night. Which was setting up the Intel C/C++ compilers in my Computer which is running Debian. If  you ever look at using compilers [...]]]></description>
			<content:encoded><![CDATA[<p>So if you know me you&#8217;ll know i think compilers are cool&#8230; yeah i know i am weird lol. So any-way&#8217;s this is something i never really got around to until last night. Which was setting up the Intel C/C++ compilers in my Computer which is running Debian. If  you ever look at using compilers other than GCC such as like Sun Studio and Intel C++ you may find its very messy feeling. What i mean is they have like a nasty install.sh, and to be quite honest they fail lol. Since they generally only cared about creating RPM&#8217;s and hoping your running Red Hat since most customers who would buy these compilers would be running a Red Hat server farm. So if your project is using Autoconf and Automake you dont have to worry about a thing, once the compilers are installed it will be one quick minor change to your configure.ac. And your all set!</p>
<p>First off go and download the 750mb tarball of the Intel C compilers over at: <a href="http://software.intel.com/en-us/intel-compilers/">http://software.intel.com/en-us/intel-compilers/</a></p>
<blockquote><p>% tar zxvf l_cproc_p_11.1.059_ia32.tgz</p>
<p>% cd l_cproc_p_11.1.059_ia32</p>
<p>% ./install.sh</p>
<p># follow all the instructions it complained i didn&#8217;t have java installed but you don&#8217;t need it. Once your finished it should all be installed to /opt/intel/Compiler</p>
<p>% PATH=$PATH:/opt/intel/Compiler/11.0/069/bin/ia32</p>
<p>% LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/intel/Compiler/11.1/059/lib/ia32/:/usr/lib/</p></blockquote>
<p>You should be able to run &#8216;icc&#8217; but you will probably get the error: &#8221; /opt/intel/Compiler/11.1/059/bin/ia32/mcpcom: error while loading shared libraries: libstdc++.so.5: cannot open shared object file: No such file or directory</p>
<p>compilation aborted for test.c (code 127)&#8221;</p>
<p>So you need to install an older libstdc++ on debian it is:</p>
<blockquote><p>% aptitude install libstdc++5</p></blockquote>
<p>That should be it lets give it a test:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="kw4">int</span> main<span class="br0">&#40;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; ;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">return</span> <span class="nu0">0</span>;</div>
</li>
<li class="li2">
<div class="de2"><span class="br0">&#125;</span></div>
</li>
</ol>
</div>
<blockquote><p>% icc test.c</p></blockquote>
<p>Should work now! If your project uses a Configure.ac lets make a quick change:</p>
<blockquote><p>Change your AC_PROG_CC to:<br />
AC_PROG_CC([icc gcc cc cl])</p></blockquote>
<p>This is the order in which the configure should search for each compiler. Since you need GCC installed to use Intel C++ you need to put ICC at the top of the list! Hope this helps someone!</p>
]]></content:encoded>
			<wfw:commentRss>http://redbrain.co.uk/index.php/quick-tips/intel-c-complilers-linux/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
		<item>
		<title>Identi.ca -&gt; Curl -&gt; Update</title>
		<link>http://redbrain.co.uk/index.php/about-me/identica-curl-update/</link>
		<comments>http://redbrain.co.uk/index.php/about-me/identica-curl-update/#comments</comments>
		<pubDate>Mon, 25 May 2009 23:34:14 +0000</pubDate>
		<dc:creator>redbrain</dc:creator>
				<category><![CDATA[About Me]]></category>
		<category><![CDATA[Quick Tips]]></category>
		<category><![CDATA[Tutorials]]></category>
		<category><![CDATA[Update!]]></category>
		<category><![CDATA[BLUG]]></category>
		<category><![CDATA[c/c++]]></category>
		<category><![CDATA[linux]]></category>
		<category><![CDATA[Programming]]></category>

		<guid isPermaLink="false">http://redbrain.co.uk/?p=358</guid>
		<description><![CDATA[<p>So yeah, i told you guys in my last post i would be doing a tutorial on compiler work, i am still working at this, tbh there is so much writing i am thinking i might make like a sub-domain for it like a latex-html type thing, i have been writing a long .odt in [...]]]></description>
			<content:encoded><![CDATA[<p>So yeah, i told you guys in my last post i would be doing a tutorial on compiler work, i am still working at this, tbh there is so much writing i am thinking i might make like a sub-domain for it like a latex-html type thing, i have been writing a long .odt in openOffice, but i think if i want to put it on this blog it will be far too big. But anyways well see i updated some of my stuff here on the blog feeling much happier i think i have found a theme i can settle on!</p>
<p>Oh and i added the link for my hello-world gcc-frontend</p>
<blockquote><p>$ git clone git://github.com/redbrain/gcc-sbsh.git</p>
<p>$ ./configure</p>
<p>$ make (..sleep for 2 hours&#8230;)</p></blockquote>
<p>//what your interested in is gcc/sbsh/ * all the files in there is all the stuff you have to do to make a hello world front-end you need all those definitions etc.. i think i have broke my Make-lang.in but i&#8217;ll fix it asap. If your on a mac i posted the fix for mpfr on the gcc-help mailing list.</p>
<p>To compile on a mac:</p>
<blockquote><p>$ wget -c ftp://ftp.gmplib.org/pub/gmp-4.3.1/gmp-4.3.1.tar.gz</p>
<p>$ tar xvf gmp-4.3.1.tar.gz</p>
<p>$ ./configure</p>
<p>$ make</p>
<p>$ sudo make install</p>
<p>$ sudo port install mpfr</p>
<p>$ cd gcc-sbsh</p>
<p>$ ./configure &#8211;prefix=&lt;maby put a prefix for install here instead of sys-wide install&gt; &#8211;with-mpfr-lib=/opt/local/lib &#8211;with-mpfr-include=/opt/local/include</p></blockquote>
<p>Now it should configure properly! <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' />   <a href="http://www.nabble.com/Configuration-problem:-not-recognizing-MPFR-td23556792.html">http://www.nabble.com/Configuration-problem:-not-recognizing-MPFR-td23556792.html</a>. You may find my on gcc-help pretty often now and automake bison and autoconf. I use these apps alot now and the mailing lists are really intereasting. Linux-kernel list sucks its far far too fast to follow unless you a full time-developer drizzle i dont have enough time for either KVM i think they are all over the place</p>
<p>And here is the git-repos of my work for the hello-world interpreter its still a work in progress but i think its ok for one evenings work <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
<blockquote><p>$ git clone git://github.com/redbrain/simple-programming-language.git</p>
<p>$ apt-get install build-essential autoconf automake libtool</p>
<p>$ sh autorun.sh</p>
<p>$ ./configure</p>
<p>$ make</p>
<p>$ ./src/simple &#8211;help</p>
<p>$ ./src/simple tests/helloworld.sim</p></blockquote>
<p>Oh and i have done some massive updates to the Belfast LUG wiki in general: <a href="http://www.belfastlinux.org/wiki/Main_Page">http://www.belfastlinux.org/wiki/Main_Page</a></p>
<p><a href="http://www.belfastlinux.org/wiki/2009-04-06_mobile-monday">http://www.belfastlinux.org/wiki/2009-04-06_mobile-monday</a></p>
<p><a href="http://www.belfastlinux.org/wiki/Meetings">http://www.belfastlinux.org/wiki/Meetings</a></p>
<p>I will aim to keep the Meetings page updated with my email after the meeting with what happened at the Meet like in: <a href="http://www.belfastlinux.org/wiki/2009-03-25_pubbage">http://www.belfastlinux.org/wiki/2009-03-25_pubbage</a>. I will maby start a page in the future about going to LugRadio live 2009 but thats a good few months off yet.. <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
<p>So yeah This last week and a few days i have spent my evenings doing some writing on compilers etc&#8230; for the tutorial and playing with haskell.. I am trying to learn the curl api to make an identi.ca client written in haskell and it cant be hard because the code to do it in C is well tiny look i knocked this up in a few mins:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="co2">#include &quot;stdio.h&quot;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="co2">#include &quot;curl/curl.h&quot;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1"><span class="co2">#define IDENTICA &nbsp; &nbsp; &quot;http://identi.ca/api/statuses/update.xml&quot;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp;</div>
</li>
<li class="li1">
<div class="de1"><span class="kw4">int</span> main<span class="br0">&#40;</span> <span class="kw4">int</span> argc, <span class="kw4">char</span> *argv<span class="br0">&#91;</span><span class="br0">&#93;</span> <span class="br0">&#41;</span></div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; CURL *curl;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; CURLcode res;</div>
</li>
<li class="li2">
<div class="de2">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; curl = curl_easy_init<span class="br0">&#40;</span><span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">if</span> <span class="br0">&#40;</span> curl <span class="br0">&#41;</span> <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw4">char</span> *data=<span class="st0">&quot;status=hello world identi.ca libcurl &#8211; c&quot;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; curl_easy_setopt<span class="br0">&#40;</span>curl, CURLOPT_POSTFIELDS, data<span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="co1">//username:password&#8230; male sure to keep the &#8216;:&#8217;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; curl_easy_setopt<span class="br0">&#40;</span>curl, CURLOPT_USERPWD, <span class="st0">&quot;username:password&quot;</span><span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; curl_easy_setopt<span class="br0">&#40;</span>curl, CURLOPT_URL, IDENTICA<span class="br0">&#41;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; res = curl_easy_perform<span class="br0">&#40;</span>curl<span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <a href="http://www.opengroup.org/onlinepubs/009695399/functions/printf.html"><span class="kw3">printf</span></a><span class="br0">&#40;</span><span class="st0">&quot;result -&gt; %i<span class="es0">\n</span>&quot;</span>, res<span class="br0">&#41;</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="coMULTI">/* always cleanup */</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; curl_easy_cleanup<span class="br0">&#40;</span>curl<span class="br0">&#41;</span>;</div>
</li>
<li class="li2">
<div class="de2">&nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">return</span> <span class="nu0">0</span>;</div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#125;</span></div>
</li>
</ol>
</div>
<p>You can compile with:</p>
<blockquote><p>$ gcc -o identica main.c `curl-config &#8211;libs &#8211;cflags`</p></blockquote>
<p>So as you can see posting to identi.ca or twitter is a simple task. But haskell&#8230; well it isnt simple I do love haskell in some ways its very much the way you think of things if your doing a very long definition in Pure Math or a proof in Applied Math. Yeah i do a Math degree&#8230; i hate it <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' />  a i love it just i prefer doing programming mostly.</p>
<p>Anyways the problem i have with the language is its becoming EXTREMLY messy in my opinion, instead of people concentrating on making haskell useful to actually make apps and wrappers to useful libraries they seem to keep adding features to the language. Like the way things work in it take a long time to get your head around but to manipulate data is why i LOVE it. So its like look at this tutorial it just explains why i love haskell <a href="http://www.haskell.org/~pairwise/intro/section1.html#part4">http://www.haskell.org/~pairwise/intro/section1.html#part4</a></p>
<div class="wp-caption alignleft" style="width: 382px"><a href="http://icanhascheezburger.files.wordpress.com/2009/05/funny-pictures-cat-does-not-believe-you.jpg"><img title="lolcats" src="http://icanhascheezburger.files.wordpress.com/2009/05/funny-pictures-cat-does-not-believe-you.jpg" alt="lolcat" width="372" height="209" /></a><p class="wp-caption-text">lolcat</p></div>
<p>Thats just an awesome idea lazy evaluation, i am getting to grips with it but i think it would be better if i get a book on it rather than reading a sticking bits of what i see around the interenet together.Its just its all very well being able to make a list and do silly evaluations on them etc.. But you need to have some good networking apis or some decent file-read-write apis there are some but its just very centric around read or getch type functions. Then GHC dam its a huge and the main implemenation of haskell, but its sooo bloated. I was toying with my own idea to make a gcc-haskell front-end but i don&#8217;t know if i like the language enough to do it, i would probably prefer to make my own version of it. But then it would take a long time to persude people to move over. etc&#8230;</p>
<p>Anyways its nearly 1AM and i have work in the morning <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_sad.gif' alt=':(' class='wp-smiley' />  Remember to post comments guys! <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
]]></content:encoded>
			<wfw:commentRss>http://redbrain.co.uk/index.php/about-me/identica-curl-update/feed/</wfw:commentRss>
		<slash:comments>2</slash:comments>
		</item>
		<item>
		<title>Doxygen &#8211; Sweet :D</title>
		<link>http://redbrain.co.uk/index.php/quick-tips/doxygen-sweet-d/</link>
		<comments>http://redbrain.co.uk/index.php/quick-tips/doxygen-sweet-d/#comments</comments>
		<pubDate>Wed, 18 Mar 2009 11:26:34 +0000</pubDate>
		<dc:creator>redbrain</dc:creator>
				<category><![CDATA[Quick Tips]]></category>
		<category><![CDATA[Tutorials]]></category>
		<category><![CDATA[Update!]]></category>
		<category><![CDATA[c/c++]]></category>
		<category><![CDATA[doxygen]]></category>
		<category><![CDATA[emacs]]></category>
		<category><![CDATA[linux]]></category>
		<category><![CDATA[Programming]]></category>

		<guid isPermaLink="false">http://redbrain.co.uk/?p=333</guid>
		<description><![CDATA[<p>This is pretty amazing i think take a look at some Doxygen output:
</p>
<p>I think its really worth learning + it will save you about a week or 2&#8242;s worth of documentation:</p>
<p>What you want to do is go to your projects directory and:</p>
<p>$ sudo apt-get install doxygen</p>
<p>$ doxygen -g</p>
<p>$ emacs -nw Doxyfile</p>
<p>$ echo &#8220;Now go through [...]]]></description>
			<content:encoded><![CDATA[<p>This is pretty amazing i think take a look at some Doxygen output:<br />
</p>
<p>I think its really worth learning + it will save you about a week or 2&#8242;s worth of documentation:</p>
<p>What you want to do is go to your projects directory and:</p>
<blockquote><p>$ sudo apt-get install doxygen</p></blockquote>
<blockquote><p>$ doxygen -g</p></blockquote>
<blockquote><p>$ emacs -nw Doxyfile</p>
<p>$ echo &#8220;Now go through each of these options in the config file use CTRL-S to start searching in emacs <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' /> &#8221;</p></blockquote>
<blockquote>
<blockquote><dl> </dl>
</blockquote>
<dt><code>EXTRACT_ALL = YES</code></dt>
</blockquote>
<blockquote><dd>Extract documentation even from those elements you haven&#8217;t yet commented.</dd>
</blockquote>
<blockquote><dt><code>INLINE_SOURCE = YES</code></dt>
</blockquote>
<blockquote><dd>Extract the relevant parts of the source and associate them with your description.</dd>
</blockquote>
<blockquote><dt><code>HAVE_DOT = YES</code></dt>
</blockquote>
<blockquote><dd>Use Graphviz for class and collaboration diagrams.</dd>
</blockquote>
<blockquote><dt><code>CALL_GRAPH = YES</code></dt>
</blockquote>
<blockquote><dd>Generate a dependency graph for functions and methods.</dd>
</blockquote>
<blockquote><dt><code>GENERATE_LATEX = NO</code></dt>
</blockquote>
<blockquote><dd>Skip generating <code>LaTeX</code> sources for <code>PDF</code>.</dd>
</blockquote>
<blockquote><p>RECURSIVE              = YES</p></blockquote>
<blockquote><p>To go through each of your directorys! Probably the most important.</p></blockquote>
<blockquote><p>FILE_PATTERNS          = *.c *.h</p>
<p>The source files you want to document!</p></blockquote>
<blockquote><p>echo &#8220;Now run&#8221;</p></blockquote>
<blockquote><p>$ doxygen Doxyfile</p></blockquote>
<blockquote><p>#Hope it works <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_biggrin.gif' alt=':D' class='wp-smiley' /> </p></blockquote>
<p>Finally to do documentation you need to go to your code and do documenation like:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="coMULTI">/**</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;* Return the size of the list.</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;*</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;* \return returns the size of the list as an int</span></div>
</li>
<li class="li2">
<div class="de2"><span class="coMULTI">&nbsp;* \param list The List you want to add the item to</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;*/</span></div>
</li>
<li class="li1">
<div class="de1"><span class="kw2">extern</span> <span class="kw4">int</span> size<span class="br0">&#40;</span> LinkedList** list<span class="br0">&#41;</span> <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">int</span> counter=<span class="nu0">0</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; LinkedList *tmp=*list;</div>
</li>
<li class="li2">
<div class="de2">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">if</span><span class="br0">&#40;</span>tmp-&gt;contents != <span class="kw2">NULL</span><span class="br0">&#41;</span> <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw4">struct</span> ListNode *next= tmp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; counter++;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw1">while</span><span class="br0">&#40;</span>next-&gt;nextnode != <span class="kw2">NULL</span><span class="br0">&#41;</span><span class="br0">&#123;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; next= next-&gt;nextnode;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; counter++;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw1">return</span> counter;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; <span class="kw1">else</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw1">return</span> counter;</div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
</ol>
</div>
]]></content:encoded>
			<wfw:commentRss>http://redbrain.co.uk/index.php/quick-tips/doxygen-sweet-d/feed/</wfw:commentRss>
		<slash:comments>1</slash:comments>
		</item>
	</channel>
</rss>

