Plumb module doc comments through to reflection

Summary: Adds a field to ReflectionModule to get the doc comment for the module, and plumbs that back through to HackC.

Reviewed By: oulgen

Differential Revision: D40104245

fbshipit-source-id: 3d3230544a6815cfc4431a5460a7e8ad750b9908

Author: Paul Vick

hphp/hack/src/hackc/bytecode_printer/print.rs

@@ -616,6 +616,7 @@ fn print_module_def<'arena>(
     print_span(w, &module_def.span)?;
     w.write_all(b" {")?;
     newline(w)?;
+    print_doc_comment(ctx, w, module_def.doc_comment.as_ref())?;
     w.write_all(b"}")?;
     newline(w)
 }

hphp/hack/src/hackc/emitter/emit_module.rs

@@ -22,10 +22,12 @@ pub fn emit_module<'a, 'arena, 'decl>(
     let attributes = emit_attribute::from_asts(emitter, &ast_module.user_attributes)?;
     let name = ClassName::from_ast_name_and_mangle(alloc, &ast_module.name.1);
     let span = Span::from_pos(&ast_module.span);
+    let doc_comment = ast_module.doc_comment.clone();
     Ok(Module {
         attributes: Slice::fill_iter(alloc, attributes.into_iter()),
         name,
         span,
+        doc_comment: Maybe::from(doc_comment.map(|c| Str::new_str(alloc, &(c.0).1))),
     })
 }
 

hphp/hack/src/hackc/hackc/assemble.rs

@@ -266,11 +266,13 @@ fn assemble_module<'arena>(
     let name = assemble_class_name(alloc, token_iter)?;
     let span = assemble_span(token_iter)?;
     token_iter.expect(Token::into_open_curly)?;
+    let doc_comment = assemble_doc_comment(alloc, token_iter)?;
     token_iter.expect(Token::into_close_curly)?;
     Ok(hhbc::Module {
         attributes,
         name,
         span,
+        doc_comment,
     })
 }
 

hphp/hack/src/hackc/hackc/cmp_unit.rs

@@ -792,16 +792,19 @@ fn cmp_module(a: &Module<'_>, b: &Module<'_>) -> Result<()> {
         attributes: a_attributes,
         name: a_name,
         span: a_span,
+        doc_comment: a_doc_comment,
     } = a;
     let Module {
         attributes: b_attributes,
         name: b_name,
         span: b_span,
+        doc_comment: b_doc_comment,
     } = b;
 
     cmp_eq(a_name, b_name).qualified("name")?;
     cmp_attributes(a_attributes, b_attributes).qualified("attributes")?;
     cmp_eq(a_span, b_span).qualified("span")?;
+    cmp_eq(a_doc_comment, b_doc_comment).qualified("doc_comment")?;
     Ok(())
 }
 

hphp/hack/src/hackc/hhbc/module.rs

@@ -3,7 +3,9 @@
 // This source code is licensed under the MIT license found in the
 // LICENSE file in the "hack" directory of this source tree.
 
+use ffi::Maybe;
 use ffi::Slice;
+use ffi::Str;
 use serde::Serialize;
 
 use crate::Attribute;
@@ -16,4 +18,5 @@ pub struct Module<'arena> {
     pub attributes: Slice<'arena, Attribute<'arena>>,
     pub name: ClassName<'arena>,
     pub span: Span,
+    pub doc_comment: Maybe<Str<'arena>>,
 }

hphp/hack/src/hackc/ir/conversions/bc_to_ir/convert.rs

@@ -43,6 +43,7 @@ pub fn bc_to_ir<'a>(unit: &'_ Unit<'a>, filename: &Path) -> ir::Unit<'a> {
             attributes: module.attributes.iter().map(convert_attribute).collect(),
             name: ir::ClassId::from_hhbc(module.name, &mut strings),
             src_loc: ir::SrcLoc::from_span(filename, &module.span),
+            doc_comment: module.doc_comment.into(),
         })
         .collect();
 

hphp/hack/src/hackc/ir/conversions/ir_to_bc/convert.rs

@@ -54,6 +54,7 @@ pub fn ir_to_bc<'a>(alloc: &'a bumpalo::Bump, ir_unit: ir::Unit<'a>) -> hhbc::Un
             attributes: convert_attributes(alloc, module.attributes),
             name: strings.lookup_class_name(module.name),
             span: module.src_loc.to_span(),
+            doc_comment: module.doc_comment.into(),
         }),
     );
     unit.module_use = ir_unit.module_use.into();

hphp/hack/src/hackc/ir/ir_core/module.rs

@@ -3,6 +3,8 @@
 // This source code is licensed under the MIT license found in the
 // LICENSE file in the "hack" directory of this source tree.
 
+use ffi::Str;
+
 use crate::Attribute;
 use crate::ClassId;
 use crate::SrcLoc;
@@ -11,4 +13,5 @@ pub struct Module<'a> {
     pub attributes: Vec<Attribute<'a>>,
     pub name: ClassId,
     pub src_loc: SrcLoc,
+    pub doc_comment: Option<Str<'a>>,
 }

hphp/hack/src/hackc/sem_diff/sem_diff.rs

@@ -491,16 +491,19 @@ fn sem_diff_module<'arena>(
         attributes: a_attributes,
         name: a_name,
         span: a_span,
+        doc_comment: a_doc_comment,
     } = a;
     let Module {
         attributes: b_attributes,
         name: b_name,
         span: b_span,
+        doc_comment: b_doc_comment,
     } = b;
 
     sem_diff_eq(&path.qualified("name"), a_name, b_name)?;
     sem_diff_attributes(&path.qualified("attributes"), a_attributes, b_attributes)?;
     sem_diff_eq(&path.qualified("span"), a_span, b_span)?;
+    sem_diff_eq(&path.qualified("doc_comment"), a_doc_comment, b_doc_comment)?;
     Ok(())
 }
 

hphp/hack/test/tast/module_doccomment.php

@@ -0,0 +1,7 @@
+<?hh
+
+<<file:__EnableUnstableFeatures('modules')>>
+
+/** this is a doc comment */
+new module a.b {
+}