@@ -1,5 +1,3 @@ -The MIT License - Copyright (c) 2008 Jason Roelofs Permission is hereby granted, free of charge, to any person obtaining a copy MIT_LICENCE @@ -1,9 +1,9 @@ --- -title: Rb++ +title: rb++ inMenu: true orderInfo: 1 --- -<h1>Rb++</h1> +<h1>rb++</h1> <h3>Synopsis</h3> @@ -11,11 +11,23 @@ Rb++ is a code generation system using <a href="rbgccxml.html">RbGCCXML</a> and <a href="http://rice.rubyforge.org" target="_blank">Rice</a> to make the creation of Ruby extensions of C++ libraries as easy as possible. +Rb++ is released under the <a href="http://github.com/jameskilton/rbplusplus/tree/master/MIT_LICENCE">MIT Licence</a> + <h3>Documentation</h3> -View the projects RDocs <a href="rbplusplus/index.html">here</a>. +View the project's README and RDocs <a href="rbplusplus/index.html">here</a>. + +<h3>Installation</h3> -<h3>Example</h3> +<div class="CodeRay"> +<div class="code"> +<pre> + gem install rbplusplus +</pre> +</div> +</div> + +<h3>Using rb++</h3> To give an idea of how easy it is to wrap C++ libraries into Ruby extensions, we'll go through the wrapping of the <a href="http://libnoise.sourceforge.net/" target="_blank"> @@ -65,7 +77,7 @@ Please note that all directories used in the script should be full paths to prev {includeFile: {filename: code/build_noise.3.rb, processOutput: false, escapeHTML: false, highlight: ruby}} <br/> -Here we have the bulk of the required setup for this wrapper to function properly. Extension#sources is the method that controls +This is the bulk of the required setup for this wrapper to function properly. Extension#sources is the method that controls configuration of what source code is to be wrapped, where such code is to be found, any extra code to be added to the extension, and how compilation works (flags, etc). We'll go through each part on it's own. @@ -123,7 +135,7 @@ The final option given to Extension#sources fits in with :include_source_files a to be included in all of the generated source files (such as custom_to_from_ruby.hpp), it must be specified with this option. As said before, this will most likely made simplier and cleaner in the next release of rb++. -With this, Rb++ is fully configured to create an extension from C++ source code. However, because C++ features and standards and Ruby features and standards don't often match up, Rb++ makes available many tools for manipulating the resulting extension to fit the Ruby-way. +With this, rb++ is fully configured to create an extension from C++ source code. However, because C++ features and standards and Ruby features and standards don't often match up, rb++ makes available many tools for manipulating the resulting extension to fit the Ruby-way. <a name="definitions"></a> <h4>Wrapping Definitions</h4> @@ -131,17 +143,17 @@ With this, Rb++ is fully configured to create an extension from C++ source code. {includeFile: {filename: code/build_noise.definitions.rb, processOutput: false, escapeHTML: false, highlight: ruby}} <br/> -The rest of the code handles defining the final Ruby extension. Rb++'s API is meant to be as simple and obvious as possible, +The rest of the code handles defining the final Ruby extension. rb++'s API is meant to be as simple and obvious as possible, though there are some nuances that need to be explained. <br/> {includeFile: {filename: code/build_noise.4.rb, processOutput: false, escapeHTML: false, highlight: ruby}} <br/> -Extensions can have any number of Modules defined in them. Here we're defining a "Noise" module as a top-level module +Extensions can have any number of Modules defined in them. This defines a "Noise" module as a top-level module in the extension. -The #namespace call seen here is the hook into Rb++ code querying and processing system. Rb++ works primarily on C++ namespaces; +The #namespace call seen here is the hook into the rb++ code querying and processing system. rb++ works primarily on C++ namespaces; code must be contained in a namespace to be wrapped into a Ruby extension. The main reason for this is to block out any system-level code that might get included (such as STL), and secondly to help organize the code. @@ -158,8 +170,7 @@ Here we're wrapping code in the C++ "noise::model" namespace into Noise::Module <br/> As was mentioned at the beginning, many times C++ does not adhere to Ruby, either in style, layout, or in Rice's ability to handle -functionality. Here we see the use of the internal querying system available via RbGCCXML and added on top of that -the ability to specify which parts of C++ do or do not actually get wrapped. +functionality. This section of the code shows off the internal querying system available via RbGCCXML and added on top of that the ability to specify which parts of C++ do or do not actually get wrapped. <br/> {includeFile: {filename: code/build_noise.6.1.rb, processOutput: false, escapeHTML: false, highlight: ruby}} @@ -172,7 +183,7 @@ the #namespace call. This node will be the RbGCCMXL Namespace node for that C++ {includeFile: {filename: code/build_noise.6.2.rb, processOutput: false, escapeHTML: false, highlight: ruby}} <br/> -Here we see both the power of the RbGCCXML query system and Rb++'s ability to mark nodes for exclusion. For this method, +Here we see both the power of the RbGCCXML query system and rb++'s ability to mark nodes for exclusion. For this method, NoiseMapBuilder::SetCallback, we need to ignore it from the wrapping because Rice does not currently know how to handle methods with function pointer arguments. @@ -188,7 +199,7 @@ be available in Ruby, so we ignore all of those we know we don't want, leaving j {includeFile: {filename: code/build_noise.7.rb, processOutput: false, escapeHTML: false, highlight: ruby}} <br/> -Here we finish up the wrapper definition, specifying one more Module to create and a few methods to ignore (again overloaded +This finishes up the wrapper definition, specifying one more Module to create and a few methods to ignore (again overloaded methods but in this case we ignore all of them). And that's the entire wrapper. Simply run this file and after a few minutes, a new Ruby extension will appear in working_dir/. @@ -200,3 +211,5 @@ For this specific extension, if you have Ogre.rb checked out, run the following * rake noise:build The resulting library will be found in lib/, and you can now run the samples found in noise/samples. + +<a href="#">Back to Top</a> website/src/index.page @@ -1,8 +1,31 @@ --- -title: RbGCCXML +title: rbgccxml inMenu: true orderInfo: 2 --- -## RbGCCXML +<h1>rbgccxml</h1> + +<h3>Synopsis</h3> + +Rbgccxml is a C++ source code querying library. It makes use of +<a href="http://www.gccxml.org">GCCXML</a> and +<a href="http://code.whytheluckystiff.net/hpricot/">Hpricot</a> to process +the C++ code (currently only headers and not body code) into easy to read XML, then +opens up a very simple but powerful query API for searching everything about the code. + +Rbgccxml is released under the <a href="http://github.com/jameskilton/rbgccxml/tree/master/MIT_LICENCE">MIT Licence</a> + +<h3>Installation</h3> + +<div class="CodeRay"> +<div class="code"> +<pre> + gem install rbgccxml +</pre> +</div> +</div> + +<h3>Documentation</h3> + +View the project's README and RDocs, including how to get started and sample queries, <a href="rbgccxml/index.html">here</a>. -<a href="rbgccxml/index.html">RDocs</a> website/src/rbgccxml.page 0cedd3326bb047660b16464af0770a908679805c Jason Roelofs jameskilton@gmail.com http://github.com/jameskilton/rbplusplus/commit/19c1cfba8fc98a94d53b613ce2e759d7d020d2f0 19c1cfba8fc98a94d53b613ce2e759d7d020d2f0 2008-07-21T14:14:44-07:00 2008-07-21T14:14:44-07:00 website is ready to go 29a657e1e76d469345c200afe5aa5266ae1ac371 Jason Roelofs jameskilton@gmail.com