Code Safari: расширение Ruby с помощью C

GitHub недавно выпустил новую библиотеку Ruby для анализа Markdown: Redcarpet . Это обертка вокруг библиотеки C Upskirt , которая заставила меня задуматься: как ты вообще пишешь расширение C для Ruby? Для тех из нас, кто привык к плюшевому комфорту земли Руби, спуск к С — пугающая перспектива. Призрак сегфоутов преследует границу, заставляя неподготовленных путешественников повернуть назад при первом взгляде на точку с запятой.

Что если это не так сложно? Возможно, немного мужества, немного сердца и мозгов мы сможем открыть для себя возможность написания расширения на Си.

Первые шаги

Мой первый следственный ход всегда один и тот же: клонировать репозиторий и запустить rake умолчанию.

 $ git clone git://github.com/tanoku/redcarpet.git $ cd redcarpet $ rake 

В хорошо сделанном геме (как этот) он запустит полный набор тестов. В этом случае мы также видим в выводе, что некоторый C-код компилируется ранее. Мы можем покопаться в Rakefile чтобы узнать больше.

 # excerpt from redcarpet/Rakefile DLEXT = Config::MAKEFILE_CONFIG['DLEXT'] RUBYDIGEST = Digest::MD5.hexdigest(`#{RUBY} --version`)   file "ext/ruby-#{RUBYDIGEST}" do |f| rm_f FileList["ext/ruby-*"] touch f.name end CLEAN.include "ext/ruby-*"   file 'ext/Makefile' => FileList['ext/*.{c,h,rb}', "ext/ruby-#{RUBYDIGEST}"] do chdir('ext') { ruby 'extconf.rb' } end CLEAN.include 'ext/Makefile', 'ext/mkmf.log'   file "ext/redcarpet.#{DLEXT}" => FileList["ext/Makefile"] do |f| sh 'cd ext && make clean && make && rm -rf conftest.dSYM' end CLEAN.include 'ext/*.{o,bundle,so,dll}'   file "lib/redcarpet.#{DLEXT}" => "ext/redcarpet.#{DLEXT}" do |f| cp f.prerequisites, "lib/", :preserve => true end   desc 'Build the redcarpet extension' task :build => "lib/redcarpet.#{DLEXT}" 

При использовании rake только для запуска задач с зависимостями легко забыть, что изначально он был задуман как версия make для Ruby. Как таковой, он предоставляет методы, отличные от task которые пригодятся для строительных проектов. file является одним из таких методов, создавая задачу, которая генерирует именованный файл.

 $ rake ext/Makefile $ ls ext/Makefile ext/Makefile # it exists! 

Следуя цепочке зависимостей в приведенном выше коде, мы можем извлечь основные шаги, необходимые для компиляции расширения C:

 cd ext ruby extconf.rb make 

make является стандартным для сборки практически любого кода на C, но extconf.rb является новым.

 # redcloth/ext/extconf.rb require 'mkmf'   dir_config('redcarpet') create_makefile('redcarpet') 

Документация для mkmf подтверждает, что мы ожидаем, что этот код будет делать:

модуль для создания Makefile для модулей расширения

Предположительно это компилирует файл с таким же именем redcarpet.c , так что давайте посмотрим на это, и у нас должны быть redcarpet.c для создания нашего собственного расширения.

 // excerpt from redcarpet/ext/redcarpet.c #include <stdio.h> #include "ruby.h" &nbsp; static VALUE rb_cRedcarpet; &nbsp; // ... &nbsp; static VALUE rb_redcarpet_toc(int argc, VALUE *argv, VALUE self) { // ... } &nbsp; static VALUE rb_redcarpet_to_html(int argc, VALUE *argv, VALUE self) { // ... } &nbsp; void Init_redcarpet() { rb_cRedcarpet = rb_define_class("Redcarpet", rb_cObject); rb_define_method(rb_cRedcarpet, "to_html", rb_redcarpet_to_html, -1); rb_define_method(rb_cRedcarpet, "toc_content", rb_redcarpet_toc, -1); } 

Это не выглядит слишком страшно. Метод Init_redcarpet устанавливает класс, а затем добавляет к нему несколько методов, которые отображаются на другие функции, определенные в файле. Мы можем сделать это. На самом деле, давайте!

Расширение нашего собственного

В духе выполнения самой простой вещи, давайте напишем расширение C, которое просто складывает числа вместе. Функционально, возможно, бесполезно, но обучение полезно ! Из нашего исследования Redcarpet мы знаем, что для создания нашего расширения требуется всего три шага:

1. Написать функцию Init в C-коде.
2. Создайте файл extconf.rb который может создать Makefile для компиляции этого C-кода.
3. Запустите Makefile, чтобы скомпилировать расширение.

Конечно, есть и скрытый четвертый шаг: проверьте, все ли работает!

Прежде всего, код C:

 // fastadd/fastadd.c #include "ruby.h"   static VALUE rb_cFastadd;   void Init_fastadd() { rb_cFastadd = rb_define_class("Fastadd", rb_cObject); } 

 # fastadd/extconf.rb require 'mkmf'   dir_config('fastadd') create_makefile('fastadd') 

 $ ruby extconf.rb Creating Makefile $ make gcc # ... $ ruby -r./fastadd -e 'puts Fastadd.new' #<Fastadd:0x0000010086dde0> 

 VALUE text = rb_funcall(self, rb_intern("text"), 0); 

 class Redcarpet # Original Markdown formatted text. attr_reader :text   def initialize(text, *extensions) @text = text extensions.each { |e| send("#{e}=", true) } end end     require 'redcarpet.so' 

 # fastadd/fastadd.rb class Fastadd attr_reader :n   def initialize(n) @n = n end end   require './fastadd.so' 

 // fastadd/fastadd.c #include "ruby.h"   static VALUE rb_cFastadd;   static VALUE rb_fastadd_add_one(int argc, VALUE *argv, VALUE self) { int n = NUM2INT(rb_funcall(self, rb_intern("n"), 0));   return INT2NUM(n + 1); }     void Init_fastadd() { rb_cFastadd = rb_define_class("Fastadd", rb_cObject); rb_define_method(rb_cFastadd, "add_one", rb_fastadd_add_one, -1); } 

 $ make # gcc output $ ruby -r./fastadd -e 'puts Fastadd.new(3).add_one' 4