test/rdoc/test_rdoc_c_parser.rb

   1 require 'stringio'
   2 require 'tempfile'
   3 require 'test/unit'
   4 require 'rdoc/parsers/parse_c'
   5
   6 class RDoc::C_Parser
   7   attr_accessor :classes
   8
   9   public :do_classes, :do_constants
  10 end
  11
  12 class TestRdocC_Parser < Test::Unit::TestCase
  13
  14   def setup
  15     @tempfile = Tempfile.new self.class.name
  16     filename = @tempfile.path
  17
  18     @top_level = RDoc::TopLevel.new filename
  19     @fn = filename
  20     @options = RDoc::Options.new Hash.new
  21     @stats = RDoc::Stats.new
  22
  23     @progress = StringIO.new
  24   end
  25
  26   def teardown
  27     @tempfile.unlink
  28   end
  29
  30   def test_do_classes_boot_class
  31     content = <<-EOF
  32 /* Document-class: Foo
  33  * this is the Foo boot class
  34  */
  35 VALUE cFoo = boot_defclass("Foo", 0);
  36     EOF
  37
  38     klass = util_get_class content, 'cFoo'
  39     assert_equal "   this is the Foo boot class\n   ", klass.comment
  40   end
  41
  42   def test_do_classes_class
  43     content = <<-EOF
  44 /* Document-class: Foo
  45  * this is the Foo class
  46  */
  47 VALUE cFoo = rb_define_class("Foo", rb_cObject);
  48     EOF
  49
  50     klass = util_get_class content, 'cFoo'
  51     assert_equal "   this is the Foo class\n   ", klass.comment
  52   end
  53
  54   def test_do_classes_class_under
  55     content = <<-EOF
  56 /* Document-class: Kernel::Foo
  57  * this is the Foo class under Kernel
  58  */
  59 VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_cObject);
  60     EOF
  61
  62     klass = util_get_class content, 'cFoo'
  63     assert_equal "   this is the Foo class under Kernel\n   ", klass.comment
  64   end
  65
  66   def test_do_classes_module
  67     content = <<-EOF
  68 /* Document-module: Foo
  69  * this is the Foo module
  70  */
  71 VALUE mFoo = rb_define_module("Foo");
  72     EOF
  73
  74     klass = util_get_class content, 'mFoo'
  75     assert_equal "   this is the Foo module\n   ", klass.comment
  76   end
  77
  78   def test_do_classes_module_under
  79     content = <<-EOF
  80 /* Document-module: Kernel::Foo
  81  * this is the Foo module under Kernel
  82  */
  83 VALUE mFoo = rb_define_module_under(rb_mKernel, "Foo");
  84     EOF
  85
  86     klass = util_get_class content, 'mFoo'
  87     assert_equal "   this is the Foo module under Kernel\n   ", klass.comment
  88   end
  89
  90   def test_do_constants
  91     content = <<-EOF
  92 #include <ruby.h>
  93
  94 void Init_foo(){
  95    VALUE cFoo = rb_define_class("Foo", rb_cObject);
  96
  97    /* 300: The highest possible score in bowling */
  98    rb_define_const(cFoo, "PERFECT", INT2FIX(300));
  99
 100    /* Huzzah!: What you cheer when you roll a perfect game */
 101    rb_define_const(cFoo, "CHEER", rb_str_new2("Huzzah!"));
 102
 103    /* TEST\:TEST: Checking to see if escaped semicolon works */
 104    rb_define_const(cFoo, "TEST", rb_str_new2("TEST:TEST"));
 105
 106    /* \\: The file separator on MS Windows */
 107    rb_define_const(cFoo, "MSEPARATOR", rb_str_new2("\\"));
 108
 109    /* /: The file separator on Unix */
 110    rb_define_const(cFoo, "SEPARATOR", rb_str_new2("/"));
 111
 112    /* C:\\Program Files\\Stuff: A directory on MS Windows */
 113    rb_define_const(cFoo, "STUFF", rb_str_new2("C:\\Program Files\\Stuff"));
 114
 115    /* Default definition */
 116    rb_define_const(cFoo, "NOSEMI", INT2FIX(99));
 117
 118    rb_define_const(cFoo, "NOCOMMENT", rb_str_new2("No comment"));
 119
 120    /*
 121     * Multiline comment goes here because this comment spans multiple lines.
 122     * Multiline comment goes here because this comment spans multiple lines.
 123     */
 124    rb_define_const(cFoo, "MULTILINE", INT2FIX(1));
 125
 126    /*
 127     * 1: Multiline comment goes here because this comment spans multiple lines.
 128     * Multiline comment goes here because this comment spans multiple lines.
 129     */
 130    rb_define_const(cFoo, "MULTILINE_VALUE", INT2FIX(1));
 131
 132    /* Multiline comment goes here because this comment spans multiple lines.
 133     * Multiline comment goes here because this comment spans multiple lines.
 134     */
 135    rb_define_const(cFoo, "MULTILINE_NOT_EMPTY", INT2FIX(1));
 136
 137 }
 138     EOF
 139
 140     parser = util_parser content
 141
 142     parser.do_classes
 143     parser.do_constants
 144
 145     klass = parser.classes['cFoo']
 146     assert klass
 147
 148     constants = klass.constants
 149     assert !klass.constants.empty?
 150
 151     constants = constants.map { |c| [c.name, c.value, c.comment] }
 152
 153     assert_equal ['PERFECT', '300',
 154                   "\n      The highest possible score in bowling   \n   "],
 155                  constants.shift
 156     assert_equal ['CHEER', 'Huzzah!',
 157                   "\n      What you cheer when you roll a perfect game   \n   "],
 158                  constants.shift
 159     assert_equal ['TEST', 'TEST:TEST',
 160                   "\n      Checking to see if escaped semicolon works   \n   "],
 161                  constants.shift
 162     assert_equal ['MSEPARATOR', '\\',
 163                   "\n      The file separator on MS Windows   \n   "],
 164                  constants.shift
 165     assert_equal ['SEPARATOR', '/',
 166                   "\n      The file separator on Unix   \n   "],
 167                  constants.shift
 168     assert_equal ['STUFF', 'C:\\Program Files\\Stuff',
 169                   "\n      A directory on MS Windows   \n   "],
 170                  constants.shift
 171     assert_equal ['NOSEMI', 'INT2FIX(99)',
 172                   "\n      Default definition   \n   "],
 173                  constants.shift
 174     assert_equal ['NOCOMMENT', 'rb_str_new2("No comment")', nil],
 175                  constants.shift
 176
 177     comment = <<-EOF.chomp
 178
 179
 180       Multiline comment goes here because this comment spans multiple lines.
 181       Multiline comment goes here because this comment spans multiple lines.
 182
 183
 184     EOF
 185     assert_equal ['MULTILINE', 'INT2FIX(1)', comment], constants.shift
 186     assert_equal ['MULTILINE_VALUE', '1', comment], constants.shift
 187
 188     comment = <<-EOF.chomp
 189
 190       Multiline comment goes here because this comment spans multiple lines.
 191       Multiline comment goes here because this comment spans multiple lines.
 192
 193
 194     EOF
 195     assert_equal ['MULTILINE_NOT_EMPTY', 'INT2FIX(1)', comment], constants.shift
 196
 197     assert constants.empty?, constants.inspect
 198   end
 199
 200   def test_find_class_comment_init
 201     content = <<-EOF
 202 /*
 203  * a comment for class Foo
 204  */
 205 void
 206 Init_Foo(void) {
 207   VALUE foo = rb_define_class("Foo", rb_cObject);
 208 }
 209     EOF
 210
 211     klass = util_get_class content, 'foo'
 212
 213     assert_equal "  \n   a comment for class Foo\n   \n", klass.comment
 214   end
 215
 216   def test_find_class_comment_define_class
 217     content = <<-EOF
 218 /*
 219  * a comment for class Foo
 220  */
 221 VALUE foo = rb_define_class("Foo", rb_cObject);
 222     EOF
 223
 224     klass = util_get_class content, 'foo'
 225
 226     assert_equal "  \n   a comment for class Foo\n   ", klass.comment
 227   end
 228
 229   def test_find_class_comment_define_class_Init_Foo
 230     content = <<-EOF
 231 /*
 232  * a comment for class Foo on Init
 233  */
 234 void
 235 Init_Foo(void) {
 236     /*
 237      * a comment for class Foo on rb_define_class
 238      */
 239     VALUE foo = rb_define_class("Foo", rb_cObject);
 240 }
 241     EOF
 242
 243     klass = util_get_class content, 'foo'
 244
 245     assert_equal "  \n   a comment for class Foo on Init\n   \n", klass.comment
 246   end
 247
 248   def util_get_class(content, name)
 249     parser = util_parser content
 250     parser.do_classes
 251     parser.classes[name]
 252   end
 253
 254   def util_parser(content)
 255     parser = RDoc::C_Parser.new @top_level, @fn, content, @options, @stats
 256     parser.progress = @progress
 257     parser
 258   end
 259
 260 end
 261