Needs a parse tree for C files
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 30/100
- Issue-Typ
- Feature
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Bereich
- documentation, tooling
Rechercherichtung
Beginne damit, RDocs Behandlung von rb_define_class, rb_define_method und rb_define_module_function anhand der dateiübergreifenden Beispiele in globals.h, ooura_fft.c und fft.c nachzuverfolgen. Als erledigt gilt dies, wenn RDoc Klassen oder Module erkennt, die in einer C-Datei initialisiert und in einer anderen über extern-Deklarationen verwendet werden, einschließlich der dokumentierten Methoden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Ruby
- Sterne
- 930
- Forks
- 472
- Ø Merge
- 2 T. 8 Std.
- Gemergte PRs (30 T.)
- 12
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus ruby/rdoc
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationEvtl. vergeben @OskarEichler hat das vor 80 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
ruby/rdoc#1759 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
markdown html excerpt includes link partsEvtl. vergeben @anyingiit hat das vor 26 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 66/100
Maintainer antworten meist innerhalb von 1 Tag
-
Regexp generated from unescaped input in #expand_classEvtl. vergeben @jaynetics hat das vor 39 Tagen übernommen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 25/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
Pro request form loses all text when the subject is too longEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offenbug f:request-creation professional
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
mysociety/alaveteli#9733 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
needs verification
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
Maintainer antworten meist innerhalb von 13 Tagen
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
betagouv/conseillers-entreprises#4808 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100