Needs a parse tree for C files
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 30/100
- Type d'issue
- Fonctionnalité
- Clarté
- À clarifier
- Activité
- À l'abandon
- Domaine
- documentation, tooling
Piste de recherche
Commencez par suivre la gestion par RDoc de rb_define_class, rb_define_method et rb_define_module_function en vous appuyant sur les exemples inter-fichiers de globals.h, ooura_fft.c et fft.c. C’est terminé lorsque RDoc reconnaît les classes ou modules initialisés dans un fichier C et utilisés dans un autre par l’intermédiaire de déclarations extern, y compris les méthodes documentées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Ruby
- Étoiles
- 930
- Forks
- 472
- Merge moyen
- 2 j 8 h
- PR mergées (30 j)
- 12
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ruby/rdoc
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationPeut-être pris @OskarEichler l’a pris il y a 80 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
ruby/rdoc#1759 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
markdown html excerpt includes link partsPeut-être pris @anyingiit l’a pris il y a 26 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 66/100
Les mainteneurs répondent en général sous 1 jour
-
Regexp generated from unescaped input in #expand_classPeut-être pris @jaynetics l’a pris il y a 39 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 25/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
Pro request form loses all text when the subject is too longPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouvertebug f:request-creation professional
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
mysociety/alaveteli#9733 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
needs verification
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
Les mainteneurs répondent en général sous 13 jours
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
betagouv/conseillers-entreprises#4808 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100