Needs a parse tree for C files
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 領域
- documentation, tooling
調査の方向性
まず、globals.h、ooura_fft.c、fft.c にあるファイル間の例を使って、RDoc による rb_define_class、rb_define_method、rb_define_module_function の扱いを追跡します。完了の条件は、RDoc が、ある C ファイルで初期化され、別のファイルで extern 宣言を通じて使用されるクラスまたはモジュールを、ドキュメント化されたメソッドも含めて認識することです。
索引モデルが issue の本文から書いたものです。
説明
In the current version of RDoc, when searching for class definition APIs such as rb_define_class and rb_define_method in a C file, if a match is found in that file, it seems to only accept the class and method definitions in that file.
This means that no matter how the method is defined in other C files, it will be ignored.
A mechanism will needed that to first gather elements from the C file and determine whether they are properly defined as classes. In this case, the parse tree would be desirable.
rb_xYYY variables used as object entities are basically the global variables, so they must be declared as extern when defining classes at the C level. However, this way does not work in outer method definitions (#pack/#unpack, etc.) because these "global variables" are not defined as classes.
In C, global variables must be initialized. A popular solution is to do the initialization in a single C file.
// global.h
#ifdef GLOBAL_VARIABLE_DEFINE
#define GLOBAL
#define GLOBAL_VAL(v) = (v)
#else
#define GLOBAL extern
#define GLOBAL_VAL(v)
#endif
This allows you to initialize variables as needed.
#define GLOBAL_VARIABLE_DEFINE // without extern
#include "global.h"
In Ruby, C's global variables are definitions, which means they have a different meaning than initialization.
Now below, definition in single file, RDoc is well parse here:
/*
* call-seq:
* bar -> nil
*
* It is a test.
*/
static VALUE
foo_bar(VALUE self)
{
return Qnil;
}
void
Init_foo()
{
rb_cFoo = rb_define_class("Foo", rb_cObject);
rb_define_method(rb_cFoo, "bar", foo_bar, 0);
}
However, a library that could become a small framework (such as image processing) is unlikely to be a single C file.
That is, it needs to be improved.
Below is a typical way I write it, and it is an example of an extension library that uses Professor Oura's FFT in Ruby.
The compiler passes it, but RDoc doesn't.
// ---(ruby/ext_extern.h)
#ifndef RUBY_EXT_EXTERN_H_INCLUDED
#define RUBY_EXT_EXTERN_H_INCLUDED
#if defined(__cplusplus)
extern "C" {
#endif
#ifdef USE_GLOBAL_VARIABLE
# define RUBY_EXT_EXTERN
#else
# define RUBY_EXT_EXTERN extern
#endif
#if defined(__cplusplus)
}
#endif
#endif /* RUBY_EXT_EXTERN_H_INCLUDED */
// ---
// ---(ruby/ooura_fft/globals.h)
#ifndef RUBY_OOURAFFT_GLOBALS_H_INCLUDED
#define RUBY_OOURAFFT_GLOBALS_H_INCLUDED
#include <ruby/internal/value.h> // VALUE
#include "ruby/ext_extern.h"
RUBY_EXT_EXTERN VALUE rb_mOouraFFT;
#endif /* RUBY_OOURAFFT_GLOBALS_H_INCLUDED */
// ---
// --- (ooura_fft.c)
#include <ruby.h>
#define USE_GLOBAL_VARIABLE
#include "ruby/ooura_fft/globals.h"
void
Init_ooura_fft(void)
{
rb_mOouraFFT = rb_define_module("OouraFFT");
InitVM(FFT);
}
// ---
// --- (fft.c)
#include <ruby.h>
#include "ruby/ooura_fft/globals.h"
// :
// :
static void InitVM_FFTMain(void);
void
InitVM_FFT(void)
{
InitVM(FFTMain);
}
// :
// :
static void
InitVM_FFTMain(void)
{
rb_define_module_function(rb_mOouraFFT, "cdft", fft_cdft, -1);
rb_define_module_function(rb_mOouraFFT, "rdft", fft_rdft, -1);
rb_define_module_function(rb_mOouraFFT, "ddct", fft_ddct, -1);
rb_define_module_function(rb_mOouraFFT, "ddst", fft_ddst, -1);
rb_define_module_function(rb_mOouraFFT, "dfct", fft_dfct, -1);
rb_define_module_function(rb_mOouraFFT, "dfst", fft_dfst, -1);
rb_define_const(rb_mOouraFFT, "USING_THREAD", rb_str_new_cstr((const char *)USING_THREAD));
}
// ---
It is expected that more extension libraries with this syntax will be available in the future. You may want to reconsider RDoc as well.
- 主要言語
- Ruby
- スター
- 930
- フォーク
- 472
- 平均マージ
- 2日 8時間
- マージ済み PR(30日)
- 12
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ruby/rdoc のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation対応中かも @OskarEichler が 80 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
markdown html excerpt includes link parts対応中かも @anyingiit が 26 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
Regexp generated from unescaped input in #expand_class対応中かも @jaynetics が 39 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
bug f:request-creation professional
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
mysociety/alaveteli#9733 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
needs verification
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
メンテナーはふだん 13 日以内に返信
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
betagouv/conseillers-entreprises#4808 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100