docs for pango done

[sdlgit/SDL-Site.git] / pages / blog-0014.html-inc

diff --git a/pages/blog-0014.html-inc b/pages/blog-0014.html-inc
index 7c07be1..f5d4032 100644 (file)
--- a/pages/blog-0014.html-inc
+++ b/pages/blog-0014.html-inc
@@ -1,6 +1,26 @@
 <div class="blog">
 <h1 id="NAME">
-Newbie Friendly Perl Projects
+The beginnings of modular design for SDL Perl
 </h1>
 <div class="CONTENT">
-<div style="text-align: right;"><i>A seed needs soft soil and water to grow</i></div><div style="text-align: right;"></div>This is a reply to <a href="http://szabgab.com/blog/2009/09/1251862435.html">szabgab's</a> post on how to get newbies interested in Perl modules. Being a newbie in Perl myself I thought I should take a shot.<br /><br />I was thinking you can make projects more accessible to newbies by having a step by step plan included with where they need to look. For example for docs of SDL_perl:<br /><ol><li>Look at SDL docs [<a href="http://www.libsdl.org/cgi/docwiki.cgi/SDL_API_by_name">link</a>]</li><li>See where SDL_perl is using the same functions [<a href="http://cpansearch.perl.org/src/KTHAKORE/SDL_Perl-v2.2.2.11/src/SDL.xs">link</a>] and the docs to this file [<a href="http://cpansearch.perl.org/src/KTHAKORE/SDL_Perl-v2.2.2.11/lib/SDL.pm">link</a>]</li><li>Use the pod format to add it to the source [<a href="http://perldoc.perl.org/perlpod.html">link to using pod</a>]</li><li>{BONUS} Come up with tutorial or cookbook [<a href="http://search.cpan.org/%7Edrolsky/Moose-0.89/lib/Moose/Cookbook.pod">link to example</a>]</li><li>Submit code to github [<a href="http://github.com/guides/home">link</a>] or email them to me [<a href="mailto:kthakore@cpan.org">link</a>]<br /></li></ol><br />Basically assume nothing is known. I know this may seem demeaning but I am a newbie to Perl and sometimes I hate looking for crust (docs). I call it crust because a crust is useful for me to eat a pizza slice, but it has no flavor .<br /><br /><i>--yapgh </i><div class="blogger-post-footer"><img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/3102167581424744259-581981098917545448?l=yapgh.blogspot.com'/></div></div>
\ No newline at end of file
+<div style="text-align: right;"><i>“Do or do not... there is no try.”</i><br />
+</div><div style="text-align: right;"><i>--yoda </i><br />
+<br />
+</div><h1>The design before</h1><br />
+The bindings before were all in <a href="http://github.com/kthakore/SDL_perl/blob/master/src/SDL.xs">one huge XS file</a>. This was then exported into the SDL module. This means that the XS file has to handle with macros if any component (e.x SDL_Mixer) is not compiled. Moreover having ever binding in one XS file prevents use to treat C structs as object with only one point of free and malloc. This would be BEGIN and DESTROY in Perl. Also the monolithic design introduces a lot of bugs because we have to use free and malloc all over the place. Lastly SDL monolithic design has the constructor for all structs in both Perl and in XS. <br />
+<br />
+<h1>The design we are aiming for</h1>Simple <a href="http://github.com/kthakore/SDL_perl/blob/master/src/Rect.xs">one XS</a> per Module. This would also simplify the Build code.<br />
+<br />
+<h2>First Step </h2><br />
+We have began with SDL Rect. It is in github master branch now. We are in the progress of making it back compatible. Originally SDL::Rect took named variables as parameters for new(). Now since the constructor <a href="http://github.com/kthakore/SDL_perl/blob/master/src/Rect.xs#L16">is in XS</a> we have only unnamed parameters. <br />
+<br />
+<br />
+<h3>Before</h3><br />
+SDL::Rect-&gt;new( -x =&gt; 0, -y =&gt; 0, -width =&gt; 0, -height =&gt; 0);<br />
+<br />
+<h3>After</h3><br />
+SDL::Rect-&gt;new(0, 0, 0, 0);<br />
+<br />
+Ideally we would like both ways of constructing Rect.<div class="blogger-post-footer"><img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/3102167581424744259-6151839795039915111?l=yapgh.blogspot.com' alt='' /></div>
+<p><a href="http://feedads.g.doubleclick.net/~a/kLUEuAPtuInPChqB2WfChUn3YyI/0/da"><img src="http://feedads.g.doubleclick.net/~a/kLUEuAPtuInPChqB2WfChUn3YyI/0/di" border="0" ismap="true"></img></a><br/>
+<a href="http://feedads.g.doubleclick.net/~a/kLUEuAPtuInPChqB2WfChUn3YyI/1/da"><img src="http://feedads.g.doubleclick.net/~a/kLUEuAPtuInPChqB2WfChUn3YyI/1/di" border="0" ismap="true"></img></a></p><img src="http://feeds.feedburner.com/~r/YetAnotherPerlGameHackeryapgh/~4/uEzoBWRJEks" height="1" width="1"/></div></div>
\ No newline at end of file