Needs a parse tree for C files

未關閉
#1,168 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
30/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
c, ruby

研究方向

首先,參考 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 小時
30 天內合併 PR
12

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

ruby/rdoc 的其他 Issue

查看 ruby/rdoc 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。