grammar: distinguish `nd` for doc and `no` for optional eol
[nit.git] / src / parser / nit.sablecc3xx
index abccc28..1f922d6 100644 (file)
@@ -162,6 +162,9 @@ stareq = '*=';
 slasheq = '/=';
 percenteq = '%=';
 starstareq = '**=';
+pipeeq = '|=';
+careteq = '^=';
+ampeq = '&=';
 lleq = '<<=';
 ggeq = '>>=';
 dotdotdot = '...';
@@ -173,6 +176,10 @@ star = '*';
 starstar = '**';
 slash = '/';
 percent = '%';
+pipe = '|';
+caret = '^';
+amp = '&';
+tilde = '~';
 eq = '==';
 ne = '!=';
 lt = '<';
@@ -184,6 +191,7 @@ gg = '>>';
 starship = '<=>';
 bang='!';
 at='@';
+semi=';';
 
 classid = uppercase letter*;
 id = lowercase letter*;
@@ -217,11 +225,11 @@ module
        = moduledecl? [imports]:import* [extern_bodies]:extern_code_body* [classdefs]:topdef* implicit_main_class {-> New module(moduledecl, [imports.import], [extern_bodies.extern_code_block], [classdefs.classdef,implicit_main_class.classdef])};
 
 moduledecl
-       = [doc]:no redef visibility kwmodule no module_name annotation_withend [n2]:n1 {-> New moduledecl(doc.doc, redef.kwredef, visibility, kwmodule, module_name, annotation_withend.annotations)};
+       = [doc]:nd redef visibility kwmodule no module_name annotation_withend [n2]:n1 {-> New moduledecl(doc.doc, redef.kwredef, visibility, kwmodule, module_name, annotation_withend.annotations)};
 
 import
-       = {std} [doc]:no redef visibility kwimport no module_name annotation_withend [n2]:n1 {-> New import.std(visibility, kwimport, module_name, annotation_withend.annotations)}
-       | {no} [doc]:no redef visibility kwimport no kwend [n2]:n1 {-> New import.no(visibility, kwimport, kwend)}
+       = {std} [doc]:nd redef visibility kwimport no module_name annotation_withend [n2]:n1 {-> New import.std(visibility, kwimport, module_name, annotation_withend.annotations)}
+       | {no} [doc]:nd redef visibility kwimport no kwend [n2]:n1 {-> New import.no(visibility, kwimport, kwend)}
        ;
 
 topdef {-> classdef}
@@ -234,13 +242,13 @@ implicit_main_class {-> classdef?}
        | {null} n? {-> Null}
        ;
 implicit_main_meth {-> propdef}
-       = [doc]:no stmts {-> New propdef.main_meth(Null, stmts.expr)}
-       | {n} [doc]:no stmtsn {-> New propdef.main_meth(Null, stmtsn.expr)}
+       = [doc]:nd stmts {-> New propdef.main_meth(Null, stmts.expr)}
+       | {n} [doc]:nd stmtsn {-> New propdef.main_meth(Null, stmtsn.expr)}
        ;
 
 /* CLASSES *******************************************************************/
 classdef
-       = [doc]:no redef visibility classkind no qclassid formaldefs extern_code_block? propdefs kwend {-> New classdef.std(doc.doc, redef.kwredef, visibility, classkind, qclassid.classid, [formaldefs.formaldef], extern_code_block, [propdefs.propdef], kwend)};
+       = [doc]:nd redef visibility classkind no qclassid formaldefs extern_code_block? propdefs kwend {-> New classdef.std(doc.doc, redef.kwredef, visibility, classkind, qclassid.classid, [formaldefs.formaldef], extern_code_block, [propdefs.propdef], kwend)};
 redef {-> kwredef?}
        = kwredef? {-> kwredef};
 classkind
@@ -261,29 +269,29 @@ formaldef
        = classid annotations? typing_o {-> New formaldef(classid, typing_o.type, annotations)};
 
 superclass {-> propdef}
-       = {super} [doc]:no redef visibility kwsuper [n2]:no type annotation_withend {-> New propdef.super(doc.doc, redef.kwredef, visibility, kwsuper, type, annotation_withend.annotations)}
+       = {super} [doc]:nd redef visibility kwsuper [n2]:no type annotation_withend {-> New propdef.super(doc.doc, redef.kwredef, visibility, kwsuper, type, annotation_withend.annotations)}
        ;
 
 propdefs {-> propdef*}
        = propdefn+ no {-> [propdefn.propdef]}
        | {super} superclass {-> [superclass.propdef]}
-       | {empty} no {-> []}
+       | {empty} nd {-> []}
        ;
 propdefn {-> propdef}
        = propdef n1 {-> propdef.propdef}
        ;
 propdef~toplevel {-> propdef}
-       = {meth} [doc]:no redef visibility kwmeth qmethid signature annotation_noend? kwdo stmtso kwend_o {-> New propdef.meth(doc.doc, redef.kwredef, visibility, kwmeth, Null, Null, qmethid.methid, signature, annotation_noend.annotations, Null, Null, stmtso.expr)}
-       | {nobody} [doc]:no redef visibility kwmeth qmethid signature annotation_withend_nonull {-> New propdef.meth(doc.doc, redef.kwredef, visibility, kwmeth, Null, Null, qmethid.methid, signature.signature, annotation_withend_nonull.annotations, Null, Null, Null)}
-!toplevel| {intern_new} [doc]:no redef visibility kwnew qmethid? signature annotation_withend_nonull {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, Null, kwnew, qmethid.methid, signature, annotation_withend_nonull.annotations, Null, Null, Null)}
-!toplevel| {new} [doc]:no redef visibility kwnew qmethid? signature annotation_noend? kwdo stmtso kwend_o {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, Null, kwnew, qmethid.methid, signature, annotation_noend.annotations, Null, Null, stmtso.expr)}
-       | {extern_implicit} [doc]:no redef visibility kwmeth qmethid signature annotation_noend? extern_calls extern_code_block {-> New propdef.meth(doc.doc, redef.kwredef, visibility, kwmeth, Null, Null, qmethid.methid, signature.signature, annotation_noend.annotations, extern_calls, extern_code_block, Null)}
-!toplevel| {var3} [doc]:no redef visibility kwvar id typing_o annotation_withend {-> New propdef.attr(doc.doc, redef.kwredef, visibility, kwvar, id, typing_o.type, Null, annotation_withend.annotations, Null)}
-!toplevel| {var4} [doc]:no redef visibility kwvar id typing_o assign [n2]:no expr annotation_withend {-> New propdef.attr(doc.doc, redef.kwredef, visibility, kwvar, id, typing_o.type, expr.expr, annotation_withend.annotations, Null)}
-!toplevel| {var5} [doc]:no redef visibility kwvar id typing_o annotation_noend? kwdo stmtso kwend? {-> New propdef.attr(doc.doc, redef.kwredef, visibility, kwvar, id, typing_o.type, Null, annotation_noend.annotations, stmtso.expr)}
-!toplevel| {init} [doc]:no redef visibility kwinit qmethid? signature annotation_noend? kwdo stmtso kwend_o {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, kwinit, Null, qmethid.methid, signature, annotation_noend.annotations, Null, Null, stmtso.expr)}
-!toplevel| {type} [doc]:no redef visibility kwtype classid typing annotation_withend {-> New propdef.type(doc.doc, redef.kwredef, visibility, kwtype, classid, typing.type, annotation_withend.annotations)}
-!toplevel| {extern_init_implicit} [doc]:no redef visibility kwnew qmethid? signature annotation_noend? extern_calls extern_code_block {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, Null, kwnew, qmethid.methid, signature, annotation_noend.annotations, extern_calls, extern_code_block, Null)}
+       = {meth} [doc]:nd redef visibility kwmeth qmethid signature annotation_noend? kwdo stmtso kwend_o {-> New propdef.meth(doc.doc, redef.kwredef, visibility, kwmeth, Null, Null, qmethid.methid, signature, annotation_noend.annotations, Null, Null, stmtso.expr)}
+       | {nobody} [doc]:nd redef visibility kwmeth qmethid signature annotation_withend_nonull {-> New propdef.meth(doc.doc, redef.kwredef, visibility, kwmeth, Null, Null, qmethid.methid, signature.signature, annotation_withend_nonull.annotations, Null, Null, Null)}
+!toplevel| {intern_new} [doc]:nd redef visibility kwnew qmethid? signature annotation_withend_nonull {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, Null, kwnew, qmethid.methid, signature, annotation_withend_nonull.annotations, Null, Null, Null)}
+!toplevel| {new} [doc]:nd redef visibility kwnew qmethid? signature annotation_noend? kwdo stmtso kwend_o {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, Null, kwnew, qmethid.methid, signature, annotation_noend.annotations, Null, Null, stmtso.expr)}
+       | {extern_implicit} [doc]:nd redef visibility kwmeth qmethid signature annotation_noend? extern_calls extern_code_block {-> New propdef.meth(doc.doc, redef.kwredef, visibility, kwmeth, Null, Null, qmethid.methid, signature.signature, annotation_noend.annotations, extern_calls, extern_code_block, Null)}
+!toplevel| {var3} [doc]:nd redef visibility kwvar id typing_o annotation_withend {-> New propdef.attr(doc.doc, redef.kwredef, visibility, kwvar, id, typing_o.type, Null, annotation_withend.annotations, Null)}
+!toplevel| {var4} [doc]:nd redef visibility kwvar id typing_o assign [n2]:no expr annotation_withend {-> New propdef.attr(doc.doc, redef.kwredef, visibility, kwvar, id, typing_o.type, expr.expr, annotation_withend.annotations, Null)}
+!toplevel| {var5} [doc]:nd redef visibility kwvar id typing_o annotation_noend? kwdo stmtso kwend? {-> New propdef.attr(doc.doc, redef.kwredef, visibility, kwvar, id, typing_o.type, Null, annotation_noend.annotations, stmtso.expr)}
+!toplevel| {init} [doc]:nd redef visibility kwinit qmethid? signature annotation_noend? kwdo stmtso kwend_o {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, kwinit, Null, qmethid.methid, signature, annotation_noend.annotations, Null, Null, stmtso.expr)}
+!toplevel| {type} [doc]:nd redef visibility kwtype classid typing annotation_withend {-> New propdef.type(doc.doc, redef.kwredef, visibility, kwtype, classid, typing.type, annotation_withend.annotations)}
+!toplevel| {extern_init_implicit} [doc]:nd redef visibility kwnew qmethid? signature annotation_noend? extern_calls extern_code_block {-> New propdef.meth(doc.doc, redef.kwredef, visibility, Null, Null, kwnew, qmethid.methid, signature, annotation_noend.annotations, extern_calls, extern_code_block, Null)}
 !toplevel| {annot} line_annotation_forclass {-> line_annotation_forclass.propdef}
 !toplevel| {super} superclass {-> superclass.propdef}
        ;
@@ -312,6 +320,10 @@ methid~noid {-> methid}
        | {starstar} starstar {-> New methid.starstar(starstar)}
        | {slash} slash {-> New methid.slash(slash)}
        | {percent} percent {-> New methid.percent(percent)}
+       | {pipe} pipe {-> New methid.pipe(pipe)}
+       | {caret} caret {-> New methid.caret(caret)}
+       | {amp} amp {-> New methid.amp(amp)}
+       | {tilde} tilde {-> New methid.tilde(tilde)}
        | {eq} eq {-> New methid.eq(eq)}
        | {ne} ne {-> New methid.ne(ne)}
        | {le} le {-> New methid.le(le)}
@@ -453,6 +465,9 @@ assign_op
        | {slash} slasheq
        | {percent} percenteq
        | {starstar} starstareq
+       | {pipe} pipeeq
+       | {caret} careteq
+       | {amp} ampeq
        | {ll} lleq
        | {gg} ggeq
        ;
@@ -525,17 +540,36 @@ expr_not~nopar~nobra {-> expr}
        ;
 
 expr_eq~nopar~nobra {-> expr}
-       = expr_add~nopar~nobra {-> expr_add~nopar~nobra.expr}
-       | {:eq} expr_add~nopar~nobra eq :no [expr2]:expr_add~nopar~nobra
-       | {:ne} expr_add~nopar~nobra ne :no [expr2]:expr_add~nopar~nobra
-       | {:lt} expr_add~nopar~nobra lt :no [expr2]:expr_add~nopar~nobra
-       | {:le} expr_add~nopar~nobra le :no [expr2]:expr_add~nopar~nobra
-       | {:ll} expr_eq~nopar~nobra ll :no [expr2]:expr_add~nopar~nobra
-       | {:gt} expr_add~nopar~nobra gt :no [expr2]:expr_add~nopar~nobra
-       | {:ge} expr_add~nopar~nobra ge :no [expr2]:expr_add~nopar~nobra
-       | {:gg} expr_eq~nopar~nobra gg :no [expr2]:expr_add~nopar~nobra
-       | {:starship} expr_add~nopar~nobra starship :no [expr2]:expr_add~nopar~nobra
-       | {:isa} expr_add~nopar~nobra kwisa :no type~nobra
+       = expr_bitor~nopar~nobra {-> expr_bitor~nopar~nobra.expr}
+       | {:eq} expr_bitor~nopar~nobra eq :no [expr2]:expr_bitor~nopar~nobra
+       | {:ne} expr_bitor~nopar~nobra ne :no [expr2]:expr_bitor~nopar~nobra
+       | {:lt} expr_bitor~nopar~nobra lt :no [expr2]:expr_bitor~nopar~nobra
+       | {:le} expr_bitor~nopar~nobra le :no [expr2]:expr_bitor~nopar~nobra
+       | {:gt} expr_bitor~nopar~nobra gt :no [expr2]:expr_bitor~nopar~nobra
+       | {:ge} expr_bitor~nopar~nobra ge :no [expr2]:expr_bitor~nopar~nobra
+       | {:starship} expr_bitor~nopar~nobra starship :no [expr2]:expr_bitor~nopar~nobra
+       | {:isa} expr_bitor~nopar~nobra kwisa :no type~nobra
+       ;
+
+expr_bitor~nopar~nobra {-> expr}
+       = [expr]:expr_bitxor~nopar~nobra {-> expr.expr}
+       | {:pipe} expr_bitor~nopar~nobra pipe :no [expr2]:expr_bitxor~nopar~nobra
+       ;
+
+expr_bitxor~nopar~nobra {-> expr}
+       = [expr]:expr_bitand~nopar~nobra {-> expr.expr}
+       | {:caret} expr_bitxor~nopar~nobra caret :no [expr2]:expr_bitand~nopar~nobra
+       ;
+
+expr_bitand~nopar~nobra {-> expr}
+       = [expr]:expr_shift~nopar~nobra {-> expr.expr}
+       | {:amp} expr_bitand~nopar~nobra amp :no [expr2]:expr_shift~nopar~nobra
+       ;
+
+expr_shift~nopar~nobra {-> expr}
+       = [expr]:expr_add~nopar~nobra {-> expr.expr}
+       | {:ll} expr_shift~nopar~nobra ll :no [expr2]:expr_add~nopar~nobra
+       | {:gg} expr_shift~nopar~nobra gg :no [expr2]:expr_add~nopar~nobra
        ;
 
 expr_add~nopar~nobra {-> expr}
@@ -560,6 +594,7 @@ expr_minus~nopar~nobra {-> expr}
        = expr_new~nopar~nobra {-> expr_new~nopar~nobra.expr}
        | {:uminus} minus expr_minus~nobra
        | {:uplus} plus expr_minus~nobra
+       | {:utilde} tilde expr_minus~nobra
        | {:once} kwonce :no expr_minus~nobra
        ;
 
@@ -580,7 +615,12 @@ expr_atom~nopar~nobra {-> expr}
         | {as_cast} expr_atom~nopar~nobra dot no kwas [n2]:no opar [n3]:no type [n4]:no cpar {-> New expr.as_cast(expr_atom~nopar~nobra.expr, kwas, opar, type, cpar)}
         | {as_notnull} expr_atom~nopar~nobra dot no kwas [n2]:no opar [n3]:no kwnot [n4]:no kwnull [n5]:no cpar {-> New expr.as_notnull(expr_atom~nopar~nobra.expr, kwas, opar, kwnot, kwnull, cpar)}
         | {as_notnull2}expr_atom~nopar~nobra dot no kwas [n2]:no kwnot [n4]:no kwnull {-> New expr.as_notnull(expr_atom~nopar~nobra.expr, kwas, Null, kwnot, kwnull, Null)}
-       | {vararg} [expr]:expr_atom~nopar~nobra dotdotdot {-> New expr.vararg(expr.expr, dotdotdot)}
+       ;
+
+arg~nopar~nobra {-> expr}
+       = [expr]:expr~nopar~nobra {-> expr.expr}
+       | {vararg} [expr]:expr~nopar~nobra dotdotdot {-> New expr.vararg(expr.expr, dotdotdot)}
+       | {namedarg} id assign [expr]:expr~nopar~nobra  {-> New expr.namedarg(id, assign, expr.expr) }
        ;
 
 expr_single~nopar~nobra {-> expr}
@@ -687,14 +727,14 @@ line_annotations {-> annotations}
        = line_annotation+ {-> New annotations(Null, Null, [line_annotation.annotation], Null) }
        ;
 line_annotation {-> annotation}
-       = [doc]:no redef visibility atid annotations? n1 {-> New annotation(doc.doc, redef.kwredef, visibility, atid.atid, Null, [], Null, annotations)}
-       | {args} [doc]:no redef visibility atid opar no at_args cpar annotations? n1 {-> New annotation(doc.doc, redef.kwredef, visibility, atid.atid, opar, [at_args.expr], cpar, annotations)}
-       | {nopar} [doc]:no redef visibility atid at_args_nopar n1 {-> New annotation(doc.doc, redef.kwredef, visibility, atid.atid, Null, [at_args_nopar.expr], Null, Null)}
+       = [doc]:nd redef visibility atid annotations? n1 {-> New annotation(doc.doc, redef.kwredef, visibility, atid.atid, Null, [], Null, annotations)}
+       | {args} [doc]:nd redef visibility atid opar no at_args cpar annotations? n1 {-> New annotation(doc.doc, redef.kwredef, visibility, atid.atid, opar, [at_args.expr], cpar, annotations)}
+       | {nopar} [doc]:nd redef visibility atid at_args_nopar n1 {-> New annotation(doc.doc, redef.kwredef, visibility, atid.atid, Null, [at_args_nopar.expr], Null, Null)}
        ;
 line_annotation_forclass {-> propdef}
-       = [doc]:no atid_forclass annotations? {-> New propdef.annot(doc.doc, Null, Null, atid_forclass.atid, Null, [], Null, annotations)}
-       | {args} [doc]:no atid_forclass opar no at_args cpar annotations? {-> New propdef.annot(doc.doc, Null, Null, atid_forclass.atid, opar, [at_args.expr], cpar, annotations)}
-       | {nopar} [doc]:no atid_forclass at_args_nopar {-> New propdef.annot(doc.doc, Null, Null, atid_forclass.atid, Null, [at_args_nopar.expr], Null, Null)}
+       = [doc]:nd atid_forclass annotations? {-> New propdef.annot(doc.doc, Null, Null, atid_forclass.atid, Null, [], Null, annotations)}
+       | {args} [doc]:nd atid_forclass opar no at_args cpar annotations? {-> New propdef.annot(doc.doc, Null, Null, atid_forclass.atid, opar, [at_args.expr], cpar, annotations)}
+       | {nopar} [doc]:nd atid_forclass at_args_nopar {-> New propdef.annot(doc.doc, Null, Null, atid_forclass.atid, Null, [at_args_nopar.expr], Null, Null)}
        ;
 
 at_args~nopar {-> expr* }
@@ -743,12 +783,10 @@ args_nopar {-> exprs}
        ;
 braargs        {-> exprs}
        = obra no expr_list cbra {-> New exprs.bra(obra, [expr_list.expr], cbra)};
-args_list {-> exprs}
-       = expr_list {-> New exprs.list([expr_list.expr])};
 expr_list {-> expr*}
-       = expr [n2]:no expr_tail* {-> [expr, expr_tail.expr]};
+       = arg [n2]:no expr_tail* {-> [arg.expr, expr_tail.expr]};
 expr_tail {-> expr} 
-       = comma no expr [n2]:no {-> expr};
+       = comma no arg [n2]:no {-> arg.expr};
 idlist {-> id*}
        = opar no idlist_nopar [n2]:no cpar {-> [idlist_nopar.id]}
        | {nopar} idlist_nopar {-> [idlist_nopar.id]}
@@ -789,19 +827,32 @@ kwend_o {-> kwend?}
        = kwend? {-> kwend}
        ;
 
-n1     = {a} comment | {b} eol;
-n {-> doc?}
-       = {a} n2? comment+ {-> New doc([comment])}
-       | {b} n2 {-> Null}
+/* A single hard break */
+n1     = {a} comment | {b} eol | {c} semi;
+
+/* A mandatory hard break, returns the last comment */
+n~nosemi {-> doc?}
+       = {a} n2* comment+ {-> New doc([comment])}
+       | {b} n2+ {-> Null}
+!nosemi | {c} n2* comment* semi n? {-> n.doc }
        ;
-no {-> doc?}
+
+/* An optional hard break, returns the last comment.
+ * Used mainly to introduce optional documentation */
+nd {-> doc?}
        = {empty} {-> Null}
        | n {-> n.doc}
        ;
 
+/* An optional soft break.
+ * Used when a unambiguous line break or comment could be inserted/ */
+no
+       = {empty}
+       | n_nosemi
+       ;
+
 n2
-       = {a} n2? comment+ eol+
-       | {b} eol+
+       = {a} comment* eol
        ;
 
 /*****************************************************************************/
@@ -863,6 +914,10 @@ methid
        | {ll} [op]:ll
        | {gg} [op]:gg
        | {starship} [op]:starship
+       | {pipe} [op]:pipe
+       | {caret} [op]:caret
+       | {amp} [op]:amp
+       | {tilde} [op]:tilde
        | {bra} obra cbra
        | {assign} id assign
        | {braassign} obra cbra assign
@@ -915,8 +970,12 @@ expr       = {block} expr* kwend?
        | {starstar} expr [op]:starstar [expr2]:expr
        | {slash} expr [op]:slash [expr2]:expr
        | {percent} expr [op]:percent [expr2]:expr
+       | {pipe} expr [op]:pipe [expr2]:expr
+       | {caret} expr [op]:caret [expr2]:expr
+       | {amp} expr [op]:amp [expr2]:expr
        | {uminus} [op]:minus expr
        | {uplus} [op]:plus expr
+       | {utilde} [op]:tilde expr
        | {new} kwnew type id? [args]:exprs
        | {attr} expr [id]:attrid 
        | {attr_assign} expr [id]:attrid assign [value]:expr 
@@ -956,6 +1015,7 @@ expr       = {block} expr* kwend?
        | {isset_attr} kwisset expr [id]:attrid
        | {debug_type} kwdebug kwtype expr type
        | {vararg} expr dotdotdot
+       | {namedarg} id assign expr
        | {type} type
        | {methid} expr [id]:methid
        | {at} annotations
@@ -973,6 +1033,9 @@ assign_op
        | {slash} [op]:slasheq
        | {percent} [op]:percenteq
        | {starstar} [op]:starstareq
+       | {pipe} [op]:pipeeq
+       | {caret} [op]:careteq
+       | {amp} [op]:ampeq
        | {ll} [op]:lleq
        | {gg} [op]:ggeq
        ;