yard 0.9.21 → 0.9.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (250) hide show
  1. checksums.yaml +4 -4
  2. data/.dockerignore +0 -0
  3. data/.gitattributes +4 -0
  4. data/.github/FUNDING.yml +3 -0
  5. data/.github/ISSUE_TEMPLATE.md +6 -6
  6. data/.github/PULL_REQUEST_TEMPLATE.md +5 -5
  7. data/.github/workflows/ci.yml +42 -0
  8. data/.github/workflows/gem.yml +27 -0
  9. data/.gitignore +0 -0
  10. data/.rspec +0 -0
  11. data/.rubocop.yml +37 -24
  12. data/.travis.yml +0 -3
  13. data/.yardopts +0 -0
  14. data/.yardopts_guide +0 -0
  15. data/.yardopts_i18n +0 -0
  16. data/CHANGELOG.md +47 -4
  17. data/CONTRIBUTING.md +2 -2
  18. data/Gemfile +4 -3
  19. data/README.md +97 -102
  20. data/Rakefile +2 -0
  21. data/lib/yard/cli/diff.rb +4 -1
  22. data/lib/yard/cli/server.rb +22 -13
  23. data/lib/yard/code_objects/method_object.rb +1 -1
  24. data/lib/yard/code_objects/namespace_mapper.rb +30 -3
  25. data/lib/yard/code_objects/proxy.rb +2 -1
  26. data/lib/yard/globals.rb +1 -1
  27. data/lib/yard/handlers/c/base.rb +35 -0
  28. data/lib/yard/handlers/ruby/mixin_handler.rb +4 -1
  29. data/lib/yard/parser/ruby/legacy/irb/slex.rb +1 -1
  30. data/lib/yard/parser/ruby/ruby_parser.rb +6 -4
  31. data/lib/yard/parser/ruby/token_resolver.rb +3 -1
  32. data/lib/yard/parser/source_parser.rb +1 -1
  33. data/lib/yard/registry_resolver.rb +10 -24
  34. data/lib/yard/registry_store.rb +1 -1
  35. data/lib/yard/serializers/yardoc_serializer.rb +1 -1
  36. data/lib/yard/server/commands/base.rb +2 -2
  37. data/lib/yard/templates/helpers/html_helper.rb +10 -3
  38. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +1 -1
  39. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +5 -4
  40. data/lib/yard/templates/section.rb +1 -3
  41. data/lib/yard/version.rb +1 -1
  42. data/samus.json +15 -46
  43. data/tasks/update_error_map.rake +53 -0
  44. data/templates/default/fulldoc/html/css/style.css +1 -0
  45. data/templates/default/fulldoc/html/js/jquery.js +4 -2
  46. data/yard.gemspec +1 -2
  47. metadata +9 -206
  48. data/spec/cli/command_parser_spec.rb +0 -43
  49. data/spec/cli/command_spec.rb +0 -36
  50. data/spec/cli/config_spec.rb +0 -148
  51. data/spec/cli/diff_spec.rb +0 -254
  52. data/spec/cli/display_spec.rb +0 -30
  53. data/spec/cli/gems_spec.rb +0 -81
  54. data/spec/cli/graph_spec.rb +0 -18
  55. data/spec/cli/help_spec.rb +0 -22
  56. data/spec/cli/i18n_spec.rb +0 -107
  57. data/spec/cli/list_spec.rb +0 -8
  58. data/spec/cli/markup_types_spec.rb +0 -22
  59. data/spec/cli/server_spec.rb +0 -324
  60. data/spec/cli/stats_spec.rb +0 -96
  61. data/spec/cli/yard_on_yard_spec.rb +0 -38
  62. data/spec/cli/yardoc_spec.rb +0 -896
  63. data/spec/cli/yri_spec.rb +0 -101
  64. data/spec/code_objects/base_spec.rb +0 -485
  65. data/spec/code_objects/class_object_spec.rb +0 -226
  66. data/spec/code_objects/code_object_list_spec.rb +0 -36
  67. data/spec/code_objects/constants_spec.rb +0 -116
  68. data/spec/code_objects/extra_file_object_spec.rb +0 -161
  69. data/spec/code_objects/macro_object_spec.rb +0 -150
  70. data/spec/code_objects/method_object_spec.rb +0 -184
  71. data/spec/code_objects/module_object_spec.rb +0 -142
  72. data/spec/code_objects/namespace_object_spec.rb +0 -171
  73. data/spec/code_objects/proxy_spec.rb +0 -147
  74. data/spec/code_objects/spec_helper.rb +0 -3
  75. data/spec/config_spec.rb +0 -171
  76. data/spec/core_ext/array_spec.rb +0 -13
  77. data/spec/core_ext/file_spec.rb +0 -72
  78. data/spec/core_ext/hash_spec.rb +0 -14
  79. data/spec/core_ext/insertion_spec.rb +0 -37
  80. data/spec/core_ext/module_spec.rb +0 -9
  81. data/spec/core_ext/string_spec.rb +0 -42
  82. data/spec/core_ext/symbol_hash_spec.rb +0 -89
  83. data/spec/docstring_parser_spec.rb +0 -280
  84. data/spec/docstring_spec.rb +0 -373
  85. data/spec/handlers/alias_handler_spec.rb +0 -82
  86. data/spec/handlers/attribute_handler_spec.rb +0 -96
  87. data/spec/handlers/base_spec.rb +0 -216
  88. data/spec/handlers/c/alias_handler_spec.rb +0 -34
  89. data/spec/handlers/c/attribute_handler_spec.rb +0 -41
  90. data/spec/handlers/c/class_handler_spec.rb +0 -78
  91. data/spec/handlers/c/constant_handler_spec.rb +0 -71
  92. data/spec/handlers/c/init_handler_spec.rb +0 -48
  93. data/spec/handlers/c/method_handler_spec.rb +0 -327
  94. data/spec/handlers/c/mixin_handler_spec.rb +0 -44
  95. data/spec/handlers/c/module_handler_spec.rb +0 -71
  96. data/spec/handlers/c/override_comment_handler_spec.rb +0 -47
  97. data/spec/handlers/c/path_handler_spec.rb +0 -36
  98. data/spec/handlers/c/spec_helper.rb +0 -23
  99. data/spec/handlers/c/struct_handler_spec.rb +0 -16
  100. data/spec/handlers/class_condition_handler_spec.rb +0 -87
  101. data/spec/handlers/class_handler_spec.rb +0 -247
  102. data/spec/handlers/class_method_handler_shared_examples.rb +0 -133
  103. data/spec/handlers/class_variable_handler_spec.rb +0 -12
  104. data/spec/handlers/constant_handler_spec.rb +0 -112
  105. data/spec/handlers/decorator_handler_methods_spec.rb +0 -393
  106. data/spec/handlers/dsl_handler_spec.rb +0 -226
  107. data/spec/handlers/examples/alias_handler_001.rb.txt +0 -46
  108. data/spec/handlers/examples/attribute_handler_001.rb.txt +0 -32
  109. data/spec/handlers/examples/class_condition_handler_001.rb.txt +0 -69
  110. data/spec/handlers/examples/class_handler_001.rb.txt +0 -120
  111. data/spec/handlers/examples/class_variable_handler_001.rb.txt +0 -10
  112. data/spec/handlers/examples/constant_handler_001.rb.txt +0 -35
  113. data/spec/handlers/examples/dsl_handler_001.rb.txt +0 -156
  114. data/spec/handlers/examples/exception_handler_001.rb.txt +0 -59
  115. data/spec/handlers/examples/extend_handler_001.rb.txt +0 -19
  116. data/spec/handlers/examples/method_condition_handler_001.rb.txt +0 -10
  117. data/spec/handlers/examples/method_handler_001.rb.txt +0 -128
  118. data/spec/handlers/examples/mixin_handler_001.rb.txt +0 -40
  119. data/spec/handlers/examples/module_handler_001.rb.txt +0 -29
  120. data/spec/handlers/examples/private_constant_handler_001.rb.txt +0 -8
  121. data/spec/handlers/examples/process_handler_001.rb.txt +0 -11
  122. data/spec/handlers/examples/visibility_handler_001.rb.txt +0 -36
  123. data/spec/handlers/examples/yield_handler_001.rb.txt +0 -54
  124. data/spec/handlers/exception_handler_spec.rb +0 -49
  125. data/spec/handlers/extend_handler_spec.rb +0 -28
  126. data/spec/handlers/legacy_base_spec.rb +0 -128
  127. data/spec/handlers/method_condition_handler_spec.rb +0 -15
  128. data/spec/handlers/method_handler_spec.rb +0 -214
  129. data/spec/handlers/mixin_handler_spec.rb +0 -60
  130. data/spec/handlers/module_function_handler_spec.rb +0 -106
  131. data/spec/handlers/module_handler_spec.rb +0 -35
  132. data/spec/handlers/private_class_method_handler_spec.rb +0 -11
  133. data/spec/handlers/private_constant_handler_spec.rb +0 -25
  134. data/spec/handlers/processor_spec.rb +0 -35
  135. data/spec/handlers/public_class_method_handler_spec.rb +0 -11
  136. data/spec/handlers/ruby/base_spec.rb +0 -95
  137. data/spec/handlers/ruby/legacy/base_spec.rb +0 -84
  138. data/spec/handlers/spec_helper.rb +0 -33
  139. data/spec/handlers/visibility_handler_spec.rb +0 -44
  140. data/spec/handlers/yield_handler_spec.rb +0 -52
  141. data/spec/i18n/locale_spec.rb +0 -81
  142. data/spec/i18n/message_spec.rb +0 -52
  143. data/spec/i18n/messages_spec.rb +0 -67
  144. data/spec/i18n/pot_generator_spec.rb +0 -295
  145. data/spec/i18n/text_spec.rb +0 -184
  146. data/spec/logging_spec.rb +0 -44
  147. data/spec/options_spec.rb +0 -171
  148. data/spec/parser/base_spec.rb +0 -24
  149. data/spec/parser/c_parser_spec.rb +0 -236
  150. data/spec/parser/examples/array.c.txt +0 -6267
  151. data/spec/parser/examples/example1.rb.txt +0 -8
  152. data/spec/parser/examples/extrafile.c.txt +0 -8
  153. data/spec/parser/examples/file.c.txt +0 -28
  154. data/spec/parser/examples/multifile.c.txt +0 -22
  155. data/spec/parser/examples/namespace.cpp.txt +0 -68
  156. data/spec/parser/examples/override.c.txt +0 -424
  157. data/spec/parser/examples/parse_in_order_001.rb.txt +0 -2
  158. data/spec/parser/examples/parse_in_order_002.rb.txt +0 -2
  159. data/spec/parser/examples/tag_handler_001.rb.txt +0 -8
  160. data/spec/parser/ruby/ast_node_spec.rb +0 -33
  161. data/spec/parser/ruby/legacy/statement_list_spec.rb +0 -299
  162. data/spec/parser/ruby/legacy/token_list_spec.rb +0 -79
  163. data/spec/parser/ruby/ruby_parser_spec.rb +0 -508
  164. data/spec/parser/ruby/token_resolver_spec.rb +0 -165
  165. data/spec/parser/source_parser_spec.rb +0 -727
  166. data/spec/parser/tag_parsing_spec.rb +0 -17
  167. data/spec/rake/yardoc_task_spec.rb +0 -118
  168. data/spec/registry_spec.rb +0 -463
  169. data/spec/registry_store_spec.rb +0 -327
  170. data/spec/rubygems/doc_manager_spec.rb +0 -112
  171. data/spec/serializers/data/serialized_yardoc/checksums +0 -1
  172. data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
  173. data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
  174. data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
  175. data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
  176. data/spec/serializers/data/serialized_yardoc/proxy_types +0 -2
  177. data/spec/serializers/file_system_serializer_spec.rb +0 -145
  178. data/spec/serializers/spec_helper.rb +0 -2
  179. data/spec/serializers/yardoc_serializer_spec.rb +0 -78
  180. data/spec/server/adapter_spec.rb +0 -39
  181. data/spec/server/commands/base_spec.rb +0 -91
  182. data/spec/server/commands/library_command_spec.rb +0 -39
  183. data/spec/server/doc_server_helper_spec.rb +0 -72
  184. data/spec/server/doc_server_serializer_spec.rb +0 -60
  185. data/spec/server/rack_adapter_spec.rb +0 -21
  186. data/spec/server/router_spec.rb +0 -123
  187. data/spec/server/spec_helper.rb +0 -22
  188. data/spec/server/static_caching_spec.rb +0 -47
  189. data/spec/server/webrick_servlet_spec.rb +0 -20
  190. data/spec/server_spec.rb +0 -19
  191. data/spec/spec_helper.rb +0 -212
  192. data/spec/tags/default_factory_spec.rb +0 -168
  193. data/spec/tags/default_tag_spec.rb +0 -11
  194. data/spec/tags/directives_spec.rb +0 -463
  195. data/spec/tags/library_spec.rb +0 -48
  196. data/spec/tags/overload_tag_spec.rb +0 -53
  197. data/spec/tags/ref_tag_list_spec.rb +0 -53
  198. data/spec/tags/types_explainer_spec.rb +0 -203
  199. data/spec/templates/class_spec.rb +0 -45
  200. data/spec/templates/constant_spec.rb +0 -41
  201. data/spec/templates/engine_spec.rb +0 -131
  202. data/spec/templates/examples/class001.html +0 -308
  203. data/spec/templates/examples/class001.txt +0 -36
  204. data/spec/templates/examples/class002.html +0 -39
  205. data/spec/templates/examples/constant001.txt +0 -25
  206. data/spec/templates/examples/constant002.txt +0 -7
  207. data/spec/templates/examples/constant003.txt +0 -11
  208. data/spec/templates/examples/method001.html +0 -137
  209. data/spec/templates/examples/method001.txt +0 -35
  210. data/spec/templates/examples/method002.html +0 -91
  211. data/spec/templates/examples/method002.txt +0 -20
  212. data/spec/templates/examples/method003.html +0 -165
  213. data/spec/templates/examples/method003.txt +0 -45
  214. data/spec/templates/examples/method004.html +0 -48
  215. data/spec/templates/examples/method004.txt +0 -10
  216. data/spec/templates/examples/method005.html +0 -105
  217. data/spec/templates/examples/method005.txt +0 -33
  218. data/spec/templates/examples/method006.html +0 -108
  219. data/spec/templates/examples/method006.txt +0 -20
  220. data/spec/templates/examples/module001.dot +0 -33
  221. data/spec/templates/examples/module001.html +0 -833
  222. data/spec/templates/examples/module001.txt +0 -33
  223. data/spec/templates/examples/module002.html +0 -341
  224. data/spec/templates/examples/module003.html +0 -202
  225. data/spec/templates/examples/module004.html +0 -394
  226. data/spec/templates/examples/module005.html +0 -82
  227. data/spec/templates/examples/tag001.txt +0 -82
  228. data/spec/templates/helpers/base_helper_spec.rb +0 -171
  229. data/spec/templates/helpers/html_helper_spec.rb +0 -687
  230. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +0 -65
  231. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +0 -84
  232. data/spec/templates/helpers/markup_helper_spec.rb +0 -136
  233. data/spec/templates/helpers/method_helper_spec.rb +0 -107
  234. data/spec/templates/helpers/module_helper_spec.rb +0 -35
  235. data/spec/templates/helpers/shared_signature_examples.rb +0 -126
  236. data/spec/templates/helpers/text_helper_spec.rb +0 -65
  237. data/spec/templates/markup_processor_integrations/asciidoctor_spec.rb +0 -60
  238. data/spec/templates/markup_processor_integrations/integration_spec_helper.rb +0 -46
  239. data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb +0 -59
  240. data/spec/templates/markup_processor_integrations/rdoc_spec.rb +0 -39
  241. data/spec/templates/markup_processor_integrations/redcarpet_spec.rb +0 -59
  242. data/spec/templates/markup_processor_integrations/redcloth_spec.rb +0 -48
  243. data/spec/templates/method_spec.rb +0 -118
  244. data/spec/templates/module_spec.rb +0 -203
  245. data/spec/templates/onefile_spec.rb +0 -66
  246. data/spec/templates/section_spec.rb +0 -144
  247. data/spec/templates/spec_helper.rb +0 -76
  248. data/spec/templates/tag_spec.rb +0 -52
  249. data/spec/templates/template_spec.rb +0 -410
  250. data/spec/verifier_spec.rb +0 -106
@@ -1,8 +0,0 @@
1
- module Hello
2
- class Hi
3
- # Docstring
4
- def me
5
- "Value"
6
- end
7
- end
8
- end
@@ -1,8 +0,0 @@
1
- /*
2
- * foo
3
- */
4
- VALUE
5
- rb_extra(VALUE obj, VALUE n)
6
- {
7
- return Qtrue;
8
- }
@@ -1,28 +0,0 @@
1
- VALUE rb_cFile;
2
-
3
- /*
4
- * call-seq:
5
- * File.exist?(file_name) -> true or false
6
- *
7
- * Return <code>true</code> if the named file exists.
8
- *
9
- * _file_name_ can be an IO object.
10
- *
11
- * "file exists" means that stat() or fstat() system call is successful.
12
- */
13
-
14
- static VALUE
15
- rb_file_exist_p(VALUE obj, VALUE fname)
16
- {
17
- struct stat st;
18
-
19
- if (rb_stat(fname, &st) < 0) return Qfalse;
20
- return Qtrue;
21
- }
22
-
23
- void
24
- Init_File(void)
25
- {
26
- rb_cFile = rb_define_class("File", rb_cIO);
27
- define_filetest_function("exist?", rb_file_exist_p, 1);
28
- }
@@ -1,22 +0,0 @@
1
- struct hoge *
2
- rb_fuga(VALUE obj)
3
- {
4
- return Qtrue;
5
- }
6
-
7
- /*
8
- * Hello Mars
9
- */
10
- VALUE
11
- rb_hello_mars(VALUE obj, VALUE n)
12
- {
13
- return Qtrue;
14
- }
15
-
16
- void
17
- Init_Multifile(void)
18
- {
19
- rb_cMultifile = rb_define_class("Multifile", rb_cObject);
20
- rb_define_method(rb_cMultifile, "extra", rb_extra, 1); /* in extra.c */
21
- rb_define_method(rb_cMultifile, "hello_mars", rb_hello_mars, 1);
22
- }
@@ -1,68 +0,0 @@
1
- VALUE rb_cWXRect;
2
-
3
- namespace RubyWX {
4
- namespace Rect {
5
-
6
- VALUE _alloc(VALUE self)
7
- {
8
- return wrap(new wxRect());
9
- }
10
-
11
- /*
12
- * call-seq:
13
- * inspect -> String
14
- *
15
- * Human-readable description.
16
- * ===Return value
17
- * String
18
- */
19
- VALUE _inspect(VALUE self)
20
- {
21
- return rb_sprintf( "%s(%d, %d, %d, %d)",
22
- rb_obj_classname( self ),
23
- FIX2INT(_getX(self)),
24
- FIX2INT(_getY(self)),
25
- FIX2INT(_getWidth(self)),
26
- FIX2INT(_getHeight(self)));
27
- }
28
-
29
- } // namespace Rect
30
- } // namespace RubyWX
31
-
32
-
33
- /*
34
- * call-seq:
35
- * hello_world -> String
36
- *
37
- * Human-readable description.
38
- * ===Return value
39
- * String
40
- */
41
- VALUE _hello_world(VALUE self)
42
- {
43
- return rb_sprintf( "%s(%d, %d, %d, %d)",
44
- rb_obj_classname( self ),
45
- FIX2INT(_getX(self)),
46
- FIX2INT(_getY(self)),
47
- FIX2INT(_getWidth(self)),
48
- FIX2INT(_getHeight(self)));
49
- }
50
-
51
- /* Arrays are ordered, integer-indexed collections of any object.
52
- * Array indexing starts at 0, as in C or Java. A negative index is
53
- * assumed to be relative to the end of the array---that is, an index of -1
54
- * indicates the last element of the array, -2 is the next to last
55
- * element in the array, and so on.
56
- */
57
-
58
- void Init_Rect()
59
- {
60
- using namespace RubyWX::Rect;
61
- rb_cWXRect = rb_define_class("Rect",rb_cObject);
62
-
63
- rb_define_alloc_func(rb_cWXRect,_alloc);
64
-
65
- rb_define_method(rb_cWXRect,"inspect",RUBY_METHOD_FUNC(_inspect),0);
66
- rb_define_method(rb_cWXRect,"hello_world",RUBY_METHOD_FUNC(_hello_world),0);
67
-
68
- }
@@ -1,424 +0,0 @@
1
- #include <gmpz.h>
2
- #include <gmpq.h>
3
- #include <gmpf.h>
4
-
5
- /*
6
- * Document-class: GMP::Z
7
- *
8
- * GMP Multiple Precision Integer.
9
- *
10
- * Instances of this class can store variables of the type mpz_t. This class
11
- * also contains many methods that act as the functions for mpz_t variables,
12
- * as well as a few methods that attempt to make this library more Ruby-ish.
13
- */
14
-
15
- /**********************************************************************
16
- * Macros *
17
- **********************************************************************/
18
-
19
- /*
20
- * DEFUN_INT2INT defines two functions. The first takes a GMP::Z as
21
- * self, calls mpz_fname on the contained mpz_t, whose arguments are
22
- * exactly (0) the return argument and (1) self. The second is the same
23
- * destructive method.
24
- */
25
- #define DEFUN_INT2INT(fname,mpz_fname) \
26
- static VALUE r_gmpz_##fname(VALUE self) \
27
- { \
28
- MP_INT *self_val, *res_val; \
29
- VALUE res; \
30
- mpz_get_struct(self, self_val); \
31
- mpz_make_struct_init(res, res_val); \
32
- mpz_fname(res_val, self_val); \
33
- return res; \
34
- } \
35
- \
36
- static VALUE r_gmpz_##fname##_self(VALUE self) \
37
- { \
38
- MP_INT *self_val; \
39
- mpz_get_struct(self, self_val); \
40
- mpz_fname(self_val, self_val); \
41
- return self; \
42
- }
43
-
44
-
45
- /**********************************************************************
46
- * Integer Arithmetic *
47
- **********************************************************************/
48
-
49
- /*
50
- * call-seq:
51
- * a + b
52
- *
53
- * Adds _a_ to _b_. _b_ must be an instance of one of:
54
- * * GMP::Z
55
- * * Fixnum
56
- * * GMP::Q
57
- * * GMP::F
58
- * * Bignum
59
- */
60
- VALUE r_gmpz_add(VALUE self, VALUE arg)
61
- {
62
- MP_INT *self_val, *arg_val, *res_val;
63
- VALUE res;
64
-
65
- mpz_get_struct(self,self_val);
66
-
67
- if (GMPZ_P(arg)) {
68
- mpz_get_struct(arg,arg_val);
69
- mpz_make_struct_init(res, res_val);
70
- mpz_add(res_val, self_val, arg_val);
71
- } else if (FIXNUM_P(arg)) {
72
- mpz_make_struct_init(res, res_val);
73
- if (FIX2NUM(arg) > 0)
74
- mpz_add_ui(res_val, self_val, FIX2NUM(arg));
75
- else
76
- mpz_sub_ui(res_val, self_val, -FIX2NUM(arg));
77
- } else if (GMPQ_P(arg)) {
78
- return r_gmpq_add(arg, self);
79
- } else if (GMPF_P(arg)) {
80
- #ifndef MPFR
81
- return r_gmpf_add(arg, self);
82
- #else
83
- return rb_funcall(arg, rb_intern("+"), 1, self);
84
- #endif
85
- } else if (BIGNUM_P(arg)) {
86
- mpz_make_struct_init(res, res_val);
87
- mpz_init(res_val);
88
- mpz_set_bignum(res_val, arg);
89
- mpz_add(res_val, res_val, self_val);
90
- } else {
91
- typeerror(ZQFXB);
92
- }
93
- return res;
94
- }
95
-
96
- /*
97
- * call-seq:
98
- * a.add!(_b_)
99
- *
100
- * Adds _a_ to _b_ in-place, setting _a_ to the sum. _b_ must be an instance of one of:
101
- * * GMP::Z
102
- * * Fixnum
103
- * * GMP::Q
104
- * * GMP::F
105
- * * Bignum
106
- */
107
- VALUE r_gmpz_add_self(VALUE self, VALUE arg)
108
- {
109
- MP_INT *self_val, *arg_val;
110
-
111
- mpz_get_struct(self,self_val);
112
-
113
- if (GMPZ_P(arg)) {
114
- mpz_get_struct(arg,arg_val);
115
- mpz_add(self_val, self_val, arg_val);
116
- } else if (FIXNUM_P(arg)) {
117
- if (FIX2NUM(arg) > 0)
118
- mpz_add_ui(self_val, self_val, FIX2NUM(arg));
119
- else
120
- mpz_sub_ui(self_val, self_val, -FIX2NUM(arg));
121
- } else if (BIGNUM_P(arg)) {
122
- mpz_temp_from_bignum(arg_val, arg);
123
- mpz_add(self_val, self_val, arg_val);
124
- mpz_temp_free(arg_val);
125
- } else {
126
- typeerror(ZXB);
127
- }
128
- return Qnil;
129
- }
130
-
131
- /*
132
- * call-seq:
133
- * a - b
134
- *
135
- * Subtracts _b_ from _a_. _b_ must be an instance of one of:
136
- * * GMP::Z
137
- * * Fixnum
138
- * * GMP::Q
139
- * * GMP::F
140
- * * Bignum
141
- */
142
- VALUE r_gmpz_sub(VALUE self, VALUE arg)
143
- {
144
- MP_RAT *res_val_q, *arg_val_q;
145
- MP_INT *self_val, *arg_val, *res_val;
146
- MP_FLOAT *arg_val_f, *res_val_f;
147
- VALUE res;
148
- unsigned long prec;
149
-
150
- mpz_get_struct(self,self_val);
151
-
152
- if (GMPZ_P(arg)) {
153
- mpz_make_struct_init(res, res_val);
154
- mpz_get_struct(arg,arg_val);
155
- mpz_sub (res_val, self_val, arg_val);
156
- } else if (FIXNUM_P(arg)) {
157
- mpz_make_struct_init(res, res_val);
158
- if (FIX2NUM(arg) > 0)
159
- mpz_sub_ui (res_val, self_val, FIX2NUM(arg));
160
- else
161
- mpz_add_ui (res_val, self_val, -FIX2NUM(arg));
162
- } else if (GMPQ_P(arg)) {
163
- mpq_make_struct_init(res, res_val_q);
164
- mpq_get_struct(arg,arg_val_q);
165
- mpz_set (mpq_denref(res_val_q), mpq_denref(arg_val_q));
166
- mpz_mul (mpq_numref(res_val_q), mpq_denref(arg_val_q), self_val);
167
- mpz_sub (mpq_numref(res_val_q), mpq_numref(res_val_q), mpq_numref(arg_val_q));
168
- } else if (GMPF_P(arg)) {
169
- mpf_get_struct_prec (arg, arg_val_f, prec);
170
- mpf_make_struct_init(res, res_val_f, prec);
171
- mpf_set_z (res_val_f, self_val);
172
- mpf_sub (res_val_f, res_val_f, arg_val_f);
173
- } else if (BIGNUM_P(arg)) {
174
- mpz_make_struct_init(res, res_val);
175
- mpz_set_bignum (res_val, arg);
176
- mpz_sub (res_val, self_val, res_val);
177
- } else {
178
- typeerror (ZQFXB);
179
- }
180
- return res;
181
- }
182
-
183
- /*
184
- * call-seq:
185
- * a.sub!(b)
186
- *
187
- * Subtracts _b_ from _a_ in-place, setting _a_ to the difference. _b_ must be an
188
- * instance of one of:
189
- * * GMP::Z
190
- * * Fixnum
191
- * * GMP::Q
192
- * * GMP::F
193
- * * Bignum
194
- */
195
- VALUE r_gmpz_sub_self(VALUE self, VALUE arg)
196
- {
197
- MP_INT *self_val, *arg_val;
198
-
199
- mpz_get_struct(self,self_val);
200
-
201
- if (GMPZ_P(arg)) {
202
- mpz_get_struct(arg, arg_val);
203
- mpz_sub (self_val, self_val, arg_val);
204
- } else if (FIXNUM_P(arg)) {
205
- if (FIX2NUM(arg) > 0)
206
- mpz_sub_ui (self_val, self_val, FIX2NUM(arg));
207
- else
208
- mpz_add_ui (self_val, self_val, -FIX2NUM(arg));
209
- } else if (BIGNUM_P(arg)) {
210
- mpz_temp_from_bignum(arg_val, arg);
211
- mpz_sub (self_val, self_val, arg_val);
212
- mpz_temp_free (arg_val);
213
- } else {
214
- typeerror (ZXB);
215
- }
216
- return Qnil;
217
- }
218
-
219
- /*
220
- * call-seq:
221
- * a * b
222
- *
223
- * Multiplies _a_ with _b_. _a_ must be an instance of one of
224
- * * GMP::Z
225
- * * Fixnum
226
- * * GMP::Q
227
- * * GMP::F
228
- * * Bignum
229
- */
230
- VALUE r_gmpz_mul(VALUE self, VALUE arg)
231
- {
232
- MP_INT *self_val, *arg_val, *res_val;
233
- VALUE res;
234
-
235
- mpz_get_struct(self,self_val);
236
-
237
- if (GMPZ_P(arg)) {
238
- mpz_make_struct_init(res, res_val);
239
- mpz_get_struct(arg,arg_val);
240
- mpz_mul(res_val, self_val, arg_val);
241
- } else if (FIXNUM_P(arg)) {
242
- mpz_make_struct_init(res, res_val);
243
- mpz_mul_si(res_val, self_val, FIX2NUM(arg));
244
- } else if (GMPQ_P(arg)) {
245
- return r_gmpq_mul(arg, self);
246
- } else if (GMPF_P(arg)) {
247
- #ifndef MPFR
248
- return r_gmpf_mul(arg, self);
249
- #else
250
- return rb_funcall(arg, rb_intern("*"), 1, self);
251
- #endif
252
- } else if (BIGNUM_P(arg)) {
253
- mpz_make_struct_init(res, res_val);
254
- mpz_set_bignum(res_val, arg);
255
- mpz_mul(res_val, res_val, self_val);
256
- } else {
257
- typeerror(ZQFXB);
258
- }
259
- return res;
260
- }
261
-
262
- /*
263
- * call-seq:
264
- * a.addmul!(b, c)
265
- *
266
- * @since 0.4.17
267
- *
268
- * Sets _a_ to _a_ plus _b_ times _c_. _b_ and _c_ must each be an instance of one of
269
- * * GMP::Z
270
- * * Fixnum
271
- * * Bignum
272
- */
273
- VALUE r_gmpz_addmul_self(VALUE self, VALUE b, VALUE c)
274
- {
275
- MP_INT *self_val, *b_val, *c_val;
276
- int free_b_val = 0;
277
-
278
- if (GMPZ_P(b)) {
279
- mpz_get_struct(b, b_val);
280
- } else if (FIXNUM_P(b)) {
281
- mpz_temp_alloc(b_val);
282
- mpz_init_set_si(b_val, FIX2NUM(b));
283
- free_b_val = 1;
284
- } else if (BIGNUM_P(b)) {
285
- mpz_temp_from_bignum(b_val, b);
286
- free_b_val = 1;
287
- } else {
288
- typeerror_as(ZXB, "addend");
289
- }
290
- mpz_get_struct(self, self_val);
291
-
292
- if (GMPZ_P(c)) {
293
- mpz_get_struct(c, c_val);
294
- mpz_addmul(self_val, b_val, c_val);
295
- } else if (FIXNUM_P(c)) {
296
- if (FIX2NUM(c) < 0)
297
- {
298
- if (free_b_val) { mpz_temp_free(b_val); }
299
- rb_raise(rb_eRangeError, "multiplicand (Fixnum) must be nonnegative");
300
- }
301
- mpz_addmul_ui(self_val, b_val, FIX2NUM(c));
302
- } else if (BIGNUM_P(c)) {
303
- mpz_temp_from_bignum(c_val, c);
304
- mpz_addmul(self_val, b_val, c_val);
305
- mpz_temp_free(c_val);
306
- } else {
307
- if (free_b_val)
308
- mpz_temp_free(b_val);
309
- typeerror_as(ZXB, "multiplicand");
310
- }
311
- if (free_b_val)
312
- mpz_temp_free(b_val);
313
- return self;
314
- }
315
-
316
- /*
317
- * Document-method: neg
318
- *
319
- * call-seq:
320
- * a.neg
321
- * -a
322
- *
323
- * Returns -_a_.
324
- */
325
- /*
326
- * Document-method: neg!
327
- *
328
- * call-seq:
329
- * a.neg!
330
- *
331
- * Sets _a_ to -_a_.
332
- */
333
- DEFUN_INT2INT(neg, mpz_neg)
334
- /*
335
- * Document-method: abs
336
- *
337
- * call-seq:
338
- * a.abs
339
- *
340
- * Returns the absolute value of _a_.
341
- */
342
- /*
343
- * Document-method: abs!
344
- *
345
- * call-seq:
346
- * a.abs!
347
- *
348
- * Sets _a_ to its absolute value.
349
- */
350
- DEFUN_INT2INT(abs, mpz_abs)
351
-
352
-
353
- /**********************************************************************
354
- * Integer Roots *
355
- **********************************************************************/
356
-
357
- /*
358
- * Document-method: sqrt
359
- *
360
- * call-seq:
361
- * a.sqrt
362
- *
363
- * Returns the truncated integer part of the square root of _a_.
364
- */
365
- /*
366
- * Document-method: sqrt!
367
- *
368
- * call-seq:
369
- * a.sqrt!
370
- *
371
- * Sets _a_ to the truncated integer part of its square root.
372
- */
373
- DEFUN_INT2INT(sqrt, mpz_sqrt)
374
-
375
- /*
376
- * call-seq:
377
- * a.sqrtrem #=> s, r
378
- *
379
- * Returns the truncated integer part of the square root of _a_ as _s_ and the remainder
380
- * <i>a - s * s</i> as _r_, which will be zero if _a_ is a perfect square.
381
- */
382
- static VALUE r_gmpz_sqrtrem(VALUE self)
383
- {
384
- MP_INT *self_val, *sqrt_val, *rem_val;
385
- VALUE sqrt, rem;
386
-
387
- mpz_get_struct(self, self_val);
388
- mpz_make_struct_init(sqrt, sqrt_val);
389
- mpz_make_struct_init(rem, rem_val);
390
- mpz_sqrtrem(sqrt_val, rem_val, self_val);
391
- return rb_assoc_new(sqrt, rem);
392
- }
393
-
394
-
395
- /**********************************************************************
396
- * Init function *
397
- **********************************************************************/
398
-
399
- void init_gmpz()
400
- {
401
- mGMP = rb_define_module("GMP");
402
- rb_define_module_function(mGMP, "Z", r_gmpmod_z, -1);
403
-
404
- cGMP_Z = rb_define_class_under(mGMP, "Z", rb_cInteger);
405
-
406
- // Integer Arithmetic
407
- rb_define_method(cGMP_Z, "+", r_gmpz_add, 1);
408
- rb_define_method(cGMP_Z, "add!", r_gmpz_add_self, 1);
409
- rb_define_method(cGMP_Z, "-", r_gmpz_sub, 1);
410
- rb_define_method(cGMP_Z, "sub!", r_gmpz_sub_self, 1);
411
- rb_define_method(cGMP_Z, "*", r_gmpz_mul, 1);
412
- rb_define_method(cGMP_Z, "addmul!", r_gmpz_addmul_self, 2);
413
- rb_define_method(cGMP_Z, "neg", r_gmpz_neg, 0);
414
- rb_define_method(cGMP_Z, "neg!", r_gmpz_neg_self, 0);
415
- rb_define_method(cGMP_Z, "-@", r_gmpz_neg, 0);
416
- rb_define_method(cGMP_Z, "abs", r_gmpz_abs, 0);
417
- rb_define_method(cGMP_Z, "abs!", r_gmpz_abs_self, 0);
418
-
419
- // Integer Roots
420
- rb_define_method(cGMP_Z, "root", r_gmpz_root, 1);
421
- rb_define_method(cGMP_Z, "sqrt", r_gmpz_sqrt, 0);
422
- rb_define_method(cGMP_Z, "sqrt!", r_gmpz_sqrt_self, 0);
423
- rb_define_method(cGMP_Z, "sqrtrem", r_gmpz_sqrtrem, 0);
424
- }