octave: libinterp/parse-tree/oct-parse.yy comparison

comparison libinterp/parse-tree/oct-parse.yy @ 28511:59dfd9ed72a3 stable

capture comments for classdef classes, properties, events, and enumerations * parse.h, oct-parse.yy: Refactor parser rules for collecting comments and docstrings for classdef parse tree elements. * pt-classdef.h, pt-classdef.cc (tree_classdef_property, tree_classdef_event, tree_classdef_enum): Store comments and docstrings and provide access to them. (tree_classdef_body): Store docstring for classdef object. (tree_classdef): Provide access to classdef docstring from classdef body object.

author	John W. Eaton <jwe@octave.org>
date	Thu, 28 May 2020 13:48:37 -0400
parents	06bc2f0bf760
children	70d155283f33 3dae50cf0bc5

comparison

equal deleted inserted replaced

-:a3ea758870dc
+:59dfd9ed72a3
 classdef        : classdef_beg stash_comment attr_list identifier opt_sep superclass_list class_body END
 {
 YYUSE ($5);
+octave::comment_list *lc = $2;
+octave::comment_list *tc = lexer.get_comment ();
 lexer.m_parsing_classdef = false;
-if (! ($$ = parser.make_classdef ($1, $3, $4, $6, $7, $8, $2)))
+if (! ($$ = parser.make_classdef ($1, $3, $4, $6, $7, $8,
+lc, tc)))
 {
-// make_classdef deleted $3, $4, $6, and $7.
+// make_classdef deleted $3, $4, $6, $7, LC, and
+// TC.
 YYABORT;
 }
 }
 ;
 $$ = $1;
 }
 ;
 properties_block
-: PROPERTIES opt_sep stash_comment attr_list property_list END
+: PROPERTIES stash_comment opt_sep attr_list property_list END
 {
-YYUSE ($2);
+YYUSE ($3);
+octave::comment_list *lc = $2;
+octave::comment_list *tc = lexer.get_comment ();
 if (! ($$ = parser.make_classdef_properties_block
-($1, $4, $5, $6, $3)))
+($1, $4, $5, $6, lc, tc)))
 {
-// make_classdef_properties_block deleted $4 and $5.
+// make_classdef_properties_block deleted $4,
+// $5, LC, and TC.
 YYABORT;
 }
 }
 ;
 { $$ = new octave::tree_classdef_property_list ($1); }
 | property_list1 sep class_property
 {
 YYUSE ($2);
+// We don't look ahead to grab end-of-line comments.
+// Instead, they are grabbed when we see the
+// identifier that becomes the next element in the
+// list.  If the element at the end of the list
+// doesn't have a doc string, see whether the
+// element we are adding is stroing an end-of-line
+// comment for us to use.
+octave::tree_classdef_property *last_elt = $1->back ();
+if (! last_elt->have_doc_string ())
+{
+octave::comment_list *cl = $3->comments ();
+if (cl)
+{
+octave::comment_elt elt = cl->front ();
+if (elt.is_end_of_line ())
+last_elt->doc_string (elt.text ());
+}
+}
 $1->append ($3);
 $$ = $1;
 }
 ;
-class_property  : identifier
+class_property  : stash_comment identifier
-{ $$ = new octave::tree_classdef_property ($1); }
+{
-| identifier '=' decl_param_init expression
+$$ = new octave::tree_classdef_property ($2, $1);
-{
+}
-YYUSE ($2);
+| stash_comment identifier '=' decl_param_init expression
+{
+YYUSE ($3);
 lexer.m_looking_at_initializer_expression = false;
-$$ = new octave::tree_classdef_property ($1, $4);
-}
+$$ = new octave::tree_classdef_property ($2, $5, $1);
-;
+}
+;
-methods_block   : METHODS opt_sep stash_comment attr_list methods_list END
-{
+methods_block   : METHODS stash_comment opt_sep attr_list methods_list END
-YYUSE ($2);
+{
+YYUSE ($3);
+octave::comment_list *lc = $2;
+octave::comment_list *tc = lexer.get_comment ();
 if (! ($$ = parser.make_classdef_methods_block
-($1, $4, $5, $6, $3)))
+($1, $4, $5, $6, lc, tc)))
 {
-// make_classdef_methods_block deleted $4 and $5.
+// make_classdef_methods_block deleted $4, $5,
+// LC, and TC.
 YYABORT;
 }
 }
 ;
 }
 method_decl1
 {
 lexer.m_defining_func--;
 lexer.m_parsed_function_name.pop ();
 $$ = parser.finish_classdef_external_method ($5, $2, $1);
 }
 ;
 method          : method_decl
 $1->append (fcn);
 $$ = $1;
 }
 ;
-events_block    : EVENTS opt_sep stash_comment attr_list events_list END
+events_block    : EVENTS stash_comment opt_sep attr_list events_list END
 {
-YYUSE ($2);
+YYUSE ($3);
+octave::comment_list *lc = $2;
+octave::comment_list *tc = lexer.get_comment ();
 if (! ($$ = parser.make_classdef_events_block
-($1, $4, $5, $6, $3)))
+($1, $4, $5, $6, lc, tc)))
 {
-// make_classdef_events_block deleted $4 and $5.
+// make_classdef_events_block deleted $4, $5,
+// LC, and TC.
 YYABORT;
 }
 }
 ;
 $1->append ($3);
 $$ = $1;
 }
 ;
-class_event     : identifier
+class_event     : stash_comment identifier
-{ $$ = new octave::tree_classdef_event ($1); }
+{ $$ = new octave::tree_classdef_event ($2, $1); }
 ;
-enum_block      : ENUMERATION opt_sep stash_comment attr_list enum_list END
+enum_block      : ENUMERATION stash_comment opt_sep attr_list enum_list END
 {
-YYUSE ($2);
+YYUSE ($3);
+octave::comment_list *lc = $2;
+octave::comment_list *tc = lexer.get_comment ();
 if (! ($$ = parser.make_classdef_enum_block
-($1, $4, $5, $6, $3)))
+($1, $4, $5, $6, lc, tc)))
 {
-// make_classdef_enum_block deleted $3 and $4.
+// make_classdef_enum_block deleted $4, $5, LC,
+// and TC.
 YYABORT;
 }
 }
 ;
 $1->append ($3);
 $$ = $1;
 }
 ;
-class_enum      : identifier '(' expression ')'
+class_enum      : stash_comment identifier '(' expression ')'
 {
-YYUSE ($2);
+YYUSE ($3);
-YYUSE ($4);
+YYUSE ($5);
-$$ = new octave::tree_classdef_enum ($1, $3);
+$$ = new octave::tree_classdef_enum ($2, $4, $1);
 }
 ;
 // =============
 // Miscellaneous
 // methods, but it is not an executable command.  Parsing the block
 // makes some changes in the symbol table (inserting the constructor
 // and methods, and adding to the list of known objects) and creates
 // a parse tree containing meta information about the class.
+// LC contains comments appearing before the classdef keyword.
+// TC contains comments appearing between the classdef elements
+// and the final end token for the classdef block.
 tree_classdef *
 base_parser::make_classdef (token *tok_val,
 tree_classdef_attribute_list *a,
 tree_identifier *id,
 tree_classdef_superclass_list *sc,
 tree_classdef_body *body, token *end_tok,
-comment_list *lc)
+comment_list *lc, comment_list *tc)
 {
 tree_classdef *retval = nullptr;
 m_lexer.m_symtab_context.pop ();
 delete a;
 delete id;
 delete sc;
 delete body;
+delete lc;
+delete tc;
 bison_error ("invalid classdef definition, the class name must match the filename", l, c);
 }
 else
 {
 if (end_token_ok (end_tok, token::classdef_end))
 {
-comment_list *tc = m_lexer.m_comment_buf.get_comment ();
 int l = tok_val->line ();
 int c = tok_val->column ();
 if (! body)
 body = new tree_classdef_body ();
 {
 delete a;
 delete id;
 delete sc;
 delete body;
+delete lc;
+delete tc;
 end_token_error (end_tok, token::switch_end);
 }
 }
 return retval;
 }
+// LC contains comments appearing before the properties keyword.
+// If this properties block appears first in the list of classdef
+// elements, this comment list will be used for the help text for the
+// classdef block.
+// TC contains comments appearing between the list of properties
+// and the final end token for the properties block and may be used to
+// find the doc string for the final property in the list.
 tree_classdef_properties_block *
 base_parser::make_classdef_properties_block (token *tok_val,
 tree_classdef_attribute_list *a,
 tree_classdef_property_list *plist,
 token *end_tok,
-comment_list *lc)
+comment_list *lc,
+comment_list *tc)
 {
 tree_classdef_properties_block *retval = nullptr;
 if (end_token_ok (end_tok, token::properties_end))
 {
-comment_list *tc = m_lexer.m_comment_buf.get_comment ();
 int l = tok_val->line ();
 int c = tok_val->column ();
-if (! plist)
+if (plist)
+{
+// If the element at the end of the list doesn't have a doc
+// string, see whether the first element of TC is an
+// end-of-line comment for us to use.
+if (tc)
+{
+tree_classdef_property *last_elt = plist->back ();
+if (! last_elt->have_doc_string ())
+{
+comment_elt first_comment_elt = tc->front ();
+if (first_comment_elt.is_end_of_line ())
+{
+std::string eol_comment = first_comment_elt.text ();
+last_elt->doc_string (eol_comment);
+}
+}
+}
+}
+else
 plist = new tree_classdef_property_list ();
 retval = new tree_classdef_properties_block (a, plist, lc, tc, l, c);
 }
 else
 {
 delete a;
 delete plist;
+delete lc;
+delete tc;
 end_token_error (end_tok, token::properties_end);
 }
 return retval;
 }
+// LC contains comments appearing before the methods keyword.
+// If this methods block appears first in the list of classdef
+// elements, this comment list will be used for the help text for the
+// classdef block.
 tree_classdef_methods_block *
 base_parser::make_classdef_methods_block (token *tok_val,
 tree_classdef_attribute_list *a,
 tree_classdef_methods_list *mlist,
-token *end_tok,
+token *end_tok, comment_list *lc,
-comment_list *lc)
+comment_list *tc)
 {
 tree_classdef_methods_block *retval = nullptr;
 if (end_token_ok (end_tok, token::methods_end))
 {
-comment_list *tc = m_lexer.m_comment_buf.get_comment ();
 int l = tok_val->line ();
 int c = tok_val->column ();
 if (! mlist)
 mlist = new tree_classdef_methods_list ();
 }
 else
 {
 delete a;
 delete mlist;
+delete lc;
+delete tc;
 end_token_error (end_tok, token::methods_end);
 }
 return retval;
 }
+// LC contains comments appearing before the events keyword.
+// If this events block appears first in the list of classdef
+// elements, this comment list will be used for the help text for the
+// classdef block.
+// TC contains comments appearing between the list of events and
+// the final end token for the events block and may be used to find
+// the doc string for the final event in the list.
 tree_classdef_events_block *
 base_parser::make_classdef_events_block (token *tok_val,
 tree_classdef_attribute_list *a,
 tree_classdef_events_list *elist,
 token *end_tok,
-comment_list *lc)
+comment_list *lc,
+comment_list *tc)
 {
 tree_classdef_events_block *retval = nullptr;
 if (end_token_ok (end_tok, token::events_end))
 {
-comment_list *tc = m_lexer.m_comment_buf.get_comment ();
 int l = tok_val->line ();
 int c = tok_val->column ();
 if (! elist)
 elist = new tree_classdef_events_list ();
 }
 else
 {
 delete a;
 delete elist;
+delete lc;
+delete tc;
 end_token_error (end_tok, token::events_end);
 }
 return retval;
 }
+// LC contains comments appearing before the enumeration keyword.
+// If this enumeration block appears first in the list of classdef
+// elements, this comment list will be used for the help text for the
+// classdef block.
+// TC contains comments appearing between the list of
+// enumerations and the final end token for the enumeration block and
+// may be used to find the doc string for the final enumeration in the
+// list.
 tree_classdef_enum_block *
 base_parser::make_classdef_enum_block (token *tok_val,
 tree_classdef_attribute_list *a,
 tree_classdef_enum_list *elist,
 token *end_tok,
-comment_list *lc)
+comment_list *lc,
+comment_list *tc)
 {
 tree_classdef_enum_block *retval = nullptr;
 if (end_token_ok (end_tok, token::enumeration_end))
 {
-comment_list *tc = m_lexer.m_comment_buf.get_comment ();
 int l = tok_val->line ();
 int c = tok_val->column ();
 if (! elist)
 elist = new tree_classdef_enum_list ();
 }
 else
 {
 delete a;
 delete elist;
+delete lc;
+delete tc;
 end_token_error (end_tok, token::enumeration_end);
 }
 return retval;

Mercurial > octave

comparison libinterp/parse-tree/oct-parse.yy @ 28511:59dfd9ed72a3 stable