Skip to content

Fix support for rb_file_const and rb_curses_define_const #1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nobu merged 1 commit into from
Dec 19, 2023
Merged

Fix support for rb_file_const and rb_curses_define_const #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions lib/rdoc/parser/c.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,17 +756,27 @@ def find_class_comment class_name, class_mod
def gen_const_table file_content
table = {}
@content.scan(%r{
((?>^\s*/\*.*?\*/\s+))
rb_define_(\w+)\((?:\s*(?:\w+),)?\s*
"(\w+)"\s*,
(?<doc>(?>^\s*/\*.*?\*/\s+))
rb_define_(?<type>\w+)\(\s*(?:\w+),\s*
"(?<name>\w+)"\s*,
.*?\)\s*;
| (?<doc>(?>^\s*/\*.*?\*/\s+))
rb_file_(?<type>const)\(\s*
"(?<name>\w+)"\s*,
.*?\)\s*;
| (?<doc>(?>^\s*/\*.*?\*/\s+))
rb_curses_define_(?<type>const)\(\s*
(?<name>\w+)
\s*\)\s*;
| Document-(?:const|global|variable):\s
((?:\w+::)*\w+)
\s*?\n((?>.*?\*/))
(?<name>(?:\w+::)*\w+)
\s*?\n(?<doc>(?>.*?\*/))
}mxi) do
case
when $1 then table[[$2, $3]] = $1
when $4 then table[$4] = "/*\n" + $5
name, doc, type = $~.values_at(:name, :doc, :type)
if type
table[[type, name]] = doc
else
table[name] = "/*\n" + doc
end
end
table
Expand Down
5 changes: 1 addition & 4 deletions test/rdoc/test_rdoc_parser_c.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,8 +583,6 @@ def test_do_constants_curses
mCurses = rb_define_module("Curses");

/*
* Document-const: Curses::COLOR_BLACK
*
* Value of the color black
*/
rb_curses_define_const(COLOR_BLACK);
Expand All @@ -609,8 +607,7 @@ def test_do_constants_curses
def test_do_constants_file
content = <<-EOF
void Init_File(void) {
/* Document-const: LOCK_SH
*
/*
* Shared lock
*/
rb_file_const("LOCK_SH", INT2FIX(LOCK_SH));
Expand Down