From: Ulya Trofimovich Date: Mon, 28 Sep 2015 14:30:20 +0000 (+0100) Subject: Docs: updated descriptions of some inplace configurations. X-Git-Tag: 0.15~38 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=18e388490d97995da5ef1ebb5c1786d472001cc2;p=re2c Docs: updated descriptions of some inplace configurations. --- diff --git a/re2c/bootstrap/doc/manual.html b/re2c/bootstrap/doc/manual.html index f462cbe7..c74e2fd6 100644 --- a/re2c/bootstrap/doc/manual.html +++ b/re2c/bootstrap/doc/manual.html @@ -1786,16 +1786,44 @@ This can be set 0 to suppress output of the pre condition using YYCURSOR

+re2c:define:YYFILL = “YYFILL”; +
+
+

+Substitution for YYFILL. +Note that by default re2c generates argument in braces and semicolon after YYFILL. +If you need to make YYFILL an arbitrary statement rather than a call, +set re2c:define:YYFILL:naked to non-zero and use re2c:define:YYFILL@len to denote +formal parameter inside of YYFILL body. +

+
+
+re2c:define:YYFILL@len = “@@”; +
+
+

+Any occurence of this text inside of YYFILL will be replaced with the actual argument. +

+
+
re2c:yyfill:parameter = 1;

-Allows to suppress parameter passing to YYFILL calls. If set to zero -then no parameter is passed to YYFILL. However define:YYFILL@LEN -allows to specify a replacement string for the actual length value. If set to -a non zero value then YYFILL usage will be followed by the number of -requested characters in braces unless re2c:define:YYFILL:naked is set. -Also look at re2c:define:YYFILL:naked and re2c:define:YYFILL@LEN. +Controls argument in braces after YYFILL. +If zero, agrument is omitted. +If non-zero, argument is generated unless re2c:define:YYFILL:naked is set to non-zero. +

+
+
+re2c:define:YYFILL:naked = 0; +
+
+

+Controls argument in braces and semicolon after YYFILL. +If zero, both agrument and semicolon are omitted. +If non-zero, argument is generated unless re2c:yyfill:parameter is set to zero +and semicolon is generated unconditionally.

@@ -1915,124 +1943,121 @@ value to the actual code needed.

-re2c:define:YYFILL = YYFILL; +re2c:define:YYGETCONDITION = “YYGETCONDITION”;

-Allows to overwrite the define YYFILL and thus avoiding it by setting the -value to the actual code needed. +Substitution for YYGETCONDITION. +Note that by default re2c generates braces after YYGETCONDITION. +Set re2c:define:YYGETCONDITION:naked to non-zero to omit braces.

-re2c:define:YYFILL:naked = 0; +re2c:define:YYGETCONDITION:naked = 0;

-When set to 1 neither braces, parameter nor semicolon gets emitted. +Controls braces after YYGETCONDITION. +If zero, braces are omitted. +If non-zero, braces are generated.

-re2c:define:YYFILL@len = @@; +re2c:define:YYSETCONDITION = “YYSETCONDITION”;

-When using re2c:define:YYFILL and re2c:yyfill:parameter is 0 then -any occurence of this text inside YYFILL will be replaced with the actual -length value. +Substitution for YYSETCONDITION. +Note that by default re2c generates argument in braces and semicolon after YYSETCONDITION. +If you need to make YYSETCONDITION an arbitrary statement rather than a call, +set re2c:define:YYSETCONDITION:naked to non-zero and use re2c:define:YYSETCONDITION@cond to denote +formal parameter inside of YYSETCONDITION body.

-re2c:define:YYGETCONDITION = YYGETCONDITION; +re2c:define:YYSETCONDITION@cond = “@@”;

-Allows to overwrite the define YYGETCONDITION. +Any occurence of this text inside of YYSETCONDITION will be replaced with the actual argument.

-re2c:define:YYGETCONDITION:naked = 0; +re2c:define:YYSETCONDITION:naked = 0;

-When set to 1 neither braces, parameter nor semicolon gets emitted. +Controls argument in braces and semicolon after YYSETCONDITION. +If zero, both agrument and semicolon are omitted. +If non-zero, both argument and semicolon are generated.

-re2c:define:YYGETSTATE = YYGETSTATE; +re2c:define:YYGETSTATE = “YYGETSTATE”;

-Allows to overwrite the define YYGETSTATE and thus avoiding it by setting the -value to the actual code needed. +Substitution for YYGETSTATE. +Note that by default re2c generates braces after YYGETSTATE. +Set re2c:define:YYGETSTATE:naked to non-zero to omit braces.

-re2c:define:YYGETSTATE:naked = 0; +re2c:define:YYGETSTATE:naked = 0;

-When set to 1 neither braces, parameter nor semicolon gets emitted. +Controls braces after YYGETSTATE. +If zero, braces are omitted. +If non-zero, braces are generated.

-re2c:define:YYLIMIT = YYLIMIT; +re2c:define:YYSETSTATE = “YYSETSTATE”;

-Allows to overwrite the define YYLIMIT and thus avoiding it by setting the -value to the actual code needed. +Substitution for YYSETSTATE. +Note that by default re2c generates argument in braces and semicolon after YYSETSTATE. +If you need to make YYSETSTATE an arbitrary statement rather than a call, +set re2c:define:YYSETSTATE:naked to non-zero and use re2c:define:YYSETSTATE@cond to denote +formal parameter inside of YYSETSTATE body.

-re2c:define:YYMARKER = YYMARKER; +re2c:define:YYSETSTATE@state = “@@”;

-Allows to overwrite the define YYMARKER and thus avoiding it by setting the -value to the actual code needed. +Any occurence of this text inside of YYSETSTATE will be replaced with the actual argument.

-re2c:define:YYSETCONDITION = YYSETCONDITION; -
-
-

-Allows to overwrite the define YYSETCONDITION. -

-
-
-re2c:define:YYSETCONDITION@cond = @@; +re2c:define:YYSETSTATE:naked = 0;

-When using re2c:define:YYSETCONDITION then any occurence of this text -inside YYSETCONDITION will be replaced with the actual new condition value. +Controls argument in braces and semicolon after YYSETSTATE. +If zero, both agrument and semicolon are omitted. +If non-zero, both argument and semicolon are generated.

-re2c:define:YYSETSTATE = YYSETSTATE; +re2c:define:YYLIMIT = YYLIMIT;

-Allows to overwrite the define YYSETSTATE and thus avoiding it by setting the +Allows to overwrite the define YYLIMIT and thus avoiding it by setting the value to the actual code needed.

-re2c:define:YYSETSTATE:naked = 0; -
-
-

-When set to 1 neither braces, parameter nor semicolon gets emitted. -

-
-
-re2c:define:YYSETSTATE@state = @@; +re2c:define:YYMARKER = YYMARKER;

-When using re2c:define:YYSETSTATE then any occurence of this text -inside YYSETSTATE will be replaced with the actual new state value. +Allows to overwrite the define YYMARKER and thus avoiding it by setting the +value to the actual code needed.

@@ -2434,14 +2459,14 @@ Ulya Trofimovich skvadrik@gmail.com

VERSION INFORMATION

-

This manpage describes re2c, version 0.14.1.dev, package date 17 Sep 2015.

+

This manpage describes re2c, version 0.14.1.dev, package date 28 Sep 2015.

diff --git a/re2c/bootstrap/doc/re2c.1 b/re2c/bootstrap/doc/re2c.1 index a41c3308..f00638fc 100644 --- a/re2c/bootstrap/doc/re2c.1 +++ b/re2c/bootstrap/doc/re2c.1 @@ -2,12 +2,12 @@ .\" Title: re2c .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 09/17/2015 +.\" Date: 09/28/2015 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "RE2C" "1" "09/17/2015" "\ \&" "\ \&" +.TH "RE2C" "1" "09/28/2015" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -914,21 +914,44 @@ which becomes usefull when is always accessible\&. .RE .PP -\fBre2c:yyfill:parameter\fR = 1; +\fBre2c:define:YYFILL\fR = \(lqYYFILL\(rq; .RS 4 -Allows to suppress parameter passing to -\fBYYFILL\fR -calls\&. If set to zero then no parameter is passed to -\fBYYFILL\fR\&. However -\fBdefine:YYFILL@LEN\fR -allows to specify a replacement string for the actual length value\&. If set to a non zero value then +Substitution for +\fBYYFILL\fR\&. Note that by default +\fBre2c\fR +generates argument in braces and semicolon after +\fBYYFILL\fR\&. If you need to make \fBYYFILL\fR -usage will be followed by the number of requested characters in braces unless +an arbitrary statement rather than a call, set \fBre2c:define:YYFILL:naked\fR -is set\&. Also look at +to non\-zero and use +\fBre2c:define:YYFILL@len\fR +to denote formal parameter inside of +\fBYYFILL\fR +body\&. +.RE +.PP +\fBre2c:define:YYFILL@len\fR = \(lq@@\(rq; +.RS 4 +Any occurence of this text inside of +\fBYYFILL\fR +will be replaced with the actual argument\&. +.RE +.PP +\fBre2c:yyfill:parameter\fR = 1; +.RS 4 +Controls argument in braces after +\fBYYFILL\fR\&. If zero, agrument is omitted\&. If non\-zero, argument is generated unless \fBre2c:define:YYFILL:naked\fR -and -\fBre2c:define:YYFILL@LEN\fR\&. +is set to non\-zero\&. +.RE +.PP +\fBre2c:define:YYFILL:naked\fR = 0; +.RS 4 +Controls argument in braces and semicolon after +\fBYYFILL\fR\&. If zero, both agrument and semicolon are omitted\&. If non\-zero, argument is generated unless +\fBre2c:yyfill:parameter\fR +is set to zero and semicolon is generated unconditionally\&. .RE .PP \fBre2c:startlabel\fR = 0; @@ -1040,100 +1063,112 @@ Allows to overwrite the define and thus avoiding it by setting the value to the actual code needed\&. .RE .PP -\fBre2c:define:YYFILL\fR = \fBYYFILL\fR; -.RS 4 -Allows to overwrite the define -\fBYYFILL\fR -and thus avoiding it by setting the value to the actual code needed\&. -.RE -.PP -\fBre2c:define:YYFILL:naked\fR = \fB0\fR; +\fBre2c:define:YYGETCONDITION\fR = \(lqYYGETCONDITION\(rq; .RS 4 -When set to 1 neither braces, parameter nor semicolon gets emitted\&. +Substitution for +\fBYYGETCONDITION\fR\&. Note that by default +\fBre2c\fR +generates braces after +\fBYYGETCONDITION\fR\&. Set +\fBre2c:define:YYGETCONDITION:naked\fR +to non\-zero to omit braces\&. .RE .PP -\fBre2c:define:YYFILL@len\fR = @@; +\fBre2c:define:YYGETCONDITION:naked\fR = 0; .RS 4 -When using -\fBre2c:define:YYFILL\fR -and -\fBre2c:yyfill:parameter\fR -is 0 then any occurence of this text inside -\fBYYFILL\fR -will be replaced with the actual length value\&. +Controls braces after +\fBYYGETCONDITION\fR\&. If zero, braces are omitted\&. If non\-zero, braces are generated\&. .RE .PP -\fBre2c:define:YYGETCONDITION\fR = \fBYYGETCONDITION\fR; +\fBre2c:define:YYSETCONDITION\fR = \(lqYYSETCONDITION\(rq; .RS 4 -Allows to overwrite the define -\fBYYGETCONDITION\fR\&. +Substitution for +\fBYYSETCONDITION\fR\&. Note that by default +\fBre2c\fR +generates argument in braces and semicolon after +\fBYYSETCONDITION\fR\&. If you need to make +\fBYYSETCONDITION\fR +an arbitrary statement rather than a call, set +\fBre2c:define:YYSETCONDITION:naked\fR +to non\-zero and use +\fBre2c:define:YYSETCONDITION@cond\fR +to denote formal parameter inside of +\fBYYSETCONDITION\fR +body\&. .RE .PP -\fBre2c:define:YYGETCONDITION:naked\fR = \fB0\fR; +\fBre2c:define:YYSETCONDITION@cond\fR = \(lq@@\(rq; .RS 4 -When set to 1 neither braces, parameter nor semicolon gets emitted\&. +Any occurence of this text inside of +\fBYYSETCONDITION\fR +will be replaced with the actual argument\&. .RE .PP -\fBre2c:define:YYGETSTATE\fR = \fBYYGETSTATE\fR; +\fBre2c:define:YYSETCONDITION:naked\fR = 0; .RS 4 -Allows to overwrite the define -\fBYYGETSTATE\fR -and thus avoiding it by setting the value to the actual code needed\&. +Controls argument in braces and semicolon after +\fBYYSETCONDITION\fR\&. If zero, both agrument and semicolon are omitted\&. If non\-zero, both argument and semicolon are generated\&. .RE .PP -\fBre2c:define:YYGETSTATE:naked\fR = \fB0\fR; +\fBre2c:define:YYGETSTATE\fR = \(lqYYGETSTATE\(rq; .RS 4 -When set to 1 neither braces, parameter nor semicolon gets emitted\&. +Substitution for +\fBYYGETSTATE\fR\&. Note that by default +\fBre2c\fR +generates braces after +\fBYYGETSTATE\fR\&. Set +\fBre2c:define:YYGETSTATE:naked\fR +to non\-zero to omit braces\&. .RE .PP -\fBre2c:define:YYLIMIT\fR = \fBYYLIMIT\fR; +\fBre2c:define:YYGETSTATE:naked\fR = 0; .RS 4 -Allows to overwrite the define -\fBYYLIMIT\fR -and thus avoiding it by setting the value to the actual code needed\&. +Controls braces after +\fBYYGETSTATE\fR\&. If zero, braces are omitted\&. If non\-zero, braces are generated\&. .RE .PP -\fBre2c:define:YYMARKER\fR = \fBYYMARKER\fR; +\fBre2c:define:YYSETSTATE\fR = \(lqYYSETSTATE\(rq; .RS 4 -Allows to overwrite the define -\fBYYMARKER\fR -and thus avoiding it by setting the value to the actual code needed\&. +Substitution for +\fBYYSETSTATE\fR\&. Note that by default +\fBre2c\fR +generates argument in braces and semicolon after +\fBYYSETSTATE\fR\&. If you need to make +\fBYYSETSTATE\fR +an arbitrary statement rather than a call, set +\fBre2c:define:YYSETSTATE:naked\fR +to non\-zero and use +\fBre2c:define:YYSETSTATE@cond\fR +to denote formal parameter inside of +\fBYYSETSTATE\fR +body\&. .RE .PP -\fBre2c:define:YYSETCONDITION\fR = \fBYYSETCONDITION\fR; +\fBre2c:define:YYSETSTATE@state\fR = \(lq@@\(rq; .RS 4 -Allows to overwrite the define -\fBYYSETCONDITION\fR\&. +Any occurence of this text inside of +\fBYYSETSTATE\fR +will be replaced with the actual argument\&. .RE .PP -\fBre2c:define:YYSETCONDITION@cond\fR = @@; +\fBre2c:define:YYSETSTATE:naked\fR = \fB0\fR; .RS 4 -When using -\fBre2c:define:YYSETCONDITION\fR -then any occurence of this text inside -\fBYYSETCONDITION\fR -will be replaced with the actual new condition value\&. +Controls argument in braces and semicolon after +\fBYYSETSTATE\fR\&. If zero, both agrument and semicolon are omitted\&. If non\-zero, both argument and semicolon are generated\&. .RE .PP -\fBre2c:define:YYSETSTATE\fR = \fBYYSETSTATE\fR; +\fBre2c:define:YYLIMIT\fR = \fBYYLIMIT\fR; .RS 4 Allows to overwrite the define -\fBYYSETSTATE\fR +\fBYYLIMIT\fR and thus avoiding it by setting the value to the actual code needed\&. .RE .PP -\fBre2c:define:YYSETSTATE:naked\fR = \fB0\fR; -.RS 4 -When set to 1 neither braces, parameter nor semicolon gets emitted\&. -.RE -.PP -\fBre2c:define:YYSETSTATE@state\fR = @@; +\fBre2c:define:YYMARKER\fR = \fBYYMARKER\fR; .RS 4 -When using -\fBre2c:define:YYSETSTATE\fR -then any occurence of this text inside -\fBYYSETSTATE\fR -will be replaced with the actual new state value\&. +Allows to overwrite the define +\fBYYMARKER\fR +and thus avoiding it by setting the value to the actual code needed\&. .RE .PP \fBre2c:label:yyFillLabel\fR = \fByyFillLabel\fR; @@ -1613,4 +1648,4 @@ skvadrik@gmail\&.com .RE .SH "VERSION INFORMATION" .sp -This manpage describes \fBre2c\fR, version 0\&.14\&.1\&.dev, package date 17 Sep 2015\&. +This manpage describes \fBre2c\fR, version 0\&.14\&.1\&.dev, package date 28 Sep 2015\&. diff --git a/re2c/doc/re2c.ad.in b/re2c/doc/re2c.ad.in index 9823a428..39bfb9c5 100644 --- a/re2c/doc/re2c.ad.in +++ b/re2c/doc/re2c.ad.in @@ -632,13 +632,26 @@ this behavior might introduce sever security issues to you programs. This can be set 0 to suppress output of the pre condition using *YYCURSOR* and *YYLIMIT* which becomes usefull when *$$YYLIMIT + max (YYFILL)$$* is always accessible. +*re2c:define:YYFILL* = ``YYFILL''; :: +Substitution for *YYFILL*. +Note that by default *re2c* generates argument in braces and semicolon after *YYFILL*. +If you need to make *YYFILL* an arbitrary statement rather than a call, +set *re2c:define:YYFILL:naked* to non-zero and use *re2c:define:YYFILL@len* to denote +formal parameter inside of *YYFILL* body. + +*re2c:define:YYFILL@len* = ``@@''; :: +Any occurence of this text inside of *YYFILL* will be replaced with the actual argument. + *re2c:yyfill:parameter* = 1; :: -Allows to suppress parameter passing to *YYFILL* calls. If set to zero -then no parameter is passed to *YYFILL*. However *define:YYFILL@LEN* -allows to specify a replacement string for the actual length value. If set to -a non zero value then *YYFILL* usage will be followed by the number of -requested characters in braces unless *re2c:define:YYFILL:naked* is set. -Also look at *re2c:define:YYFILL:naked* and *re2c:define:YYFILL@LEN*. +Controls argument in braces after *YYFILL*. +If zero, agrument is omitted. +If non-zero, argument is generated unless *re2c:define:YYFILL:naked* is set to non-zero. + +*re2c:define:YYFILL:naked* = 0; :: +Controls argument in braces and semicolon after *YYFILL*. +If zero, both agrument and semicolon are omitted. +If non-zero, argument is generated unless *re2c:yyfill:parameter* is set to zero +and semicolon is generated unconditionally. *re2c:startlabel* = 0; :: If set to a non zero integer then the start label of the next scanner blocks @@ -701,30 +714,55 @@ value to the actual code needed. Allows to overwrite the define *YYDEBUG* and thus avoiding it by setting the value to the actual code needed. -*re2c:define:YYFILL* = *YYFILL*; :: -Allows to overwrite the define *YYFILL* and thus avoiding it by setting the -value to the actual code needed. - -*re2c:define:YYFILL:naked* = *0*; :: -When set to 1 neither braces, parameter nor semicolon gets emitted. - -*re2c:define:YYFILL@len* = @@; :: -When using *re2c:define:YYFILL* and *re2c:yyfill:parameter* is 0 then -any occurence of this text inside *YYFILL* will be replaced with the actual -length value. - -*re2c:define:YYGETCONDITION* = *YYGETCONDITION*; :: -Allows to overwrite the define *YYGETCONDITION*. - -*re2c:define:YYGETCONDITION:naked* = *0*; :: -When set to 1 neither braces, parameter nor semicolon gets emitted. - -*re2c:define:YYGETSTATE* = *YYGETSTATE*; :: -Allows to overwrite the define *YYGETSTATE* and thus avoiding it by setting the -value to the actual code needed. +*re2c:define:YYGETCONDITION* = ``YYGETCONDITION''; :: +Substitution for *YYGETCONDITION*. +Note that by default *re2c* generates braces after *YYGETCONDITION*. +Set *re2c:define:YYGETCONDITION:naked* to non-zero to omit braces. + +*re2c:define:YYGETCONDITION:naked* = 0; :: +Controls braces after *YYGETCONDITION*. +If zero, braces are omitted. +If non-zero, braces are generated. + +*re2c:define:YYSETCONDITION* = ``YYSETCONDITION''; :: +Substitution for *YYSETCONDITION*. +Note that by default *re2c* generates argument in braces and semicolon after *YYSETCONDITION*. +If you need to make *YYSETCONDITION* an arbitrary statement rather than a call, +set *re2c:define:YYSETCONDITION:naked* to non-zero and use *re2c:define:YYSETCONDITION@cond* to denote +formal parameter inside of *YYSETCONDITION* body. + +*re2c:define:YYSETCONDITION@cond* = ``@@''; :: +Any occurence of this text inside of *YYSETCONDITION* will be replaced with the actual argument. + +*re2c:define:YYSETCONDITION:naked* = 0; :: +Controls argument in braces and semicolon after *YYSETCONDITION*. +If zero, both agrument and semicolon are omitted. +If non-zero, both argument and semicolon are generated. + +*re2c:define:YYGETSTATE* = ``YYGETSTATE''; :: +Substitution for *YYGETSTATE*. +Note that by default *re2c* generates braces after *YYGETSTATE*. +Set *re2c:define:YYGETSTATE:naked* to non-zero to omit braces. + +*re2c:define:YYGETSTATE:naked* = 0; :: +Controls braces after *YYGETSTATE*. +If zero, braces are omitted. +If non-zero, braces are generated. + +*re2c:define:YYSETSTATE* = ``YYSETSTATE''; :: +Substitution for *YYSETSTATE*. +Note that by default *re2c* generates argument in braces and semicolon after *YYSETSTATE*. +If you need to make *YYSETSTATE* an arbitrary statement rather than a call, +set *re2c:define:YYSETSTATE:naked* to non-zero and use *re2c:define:YYSETSTATE@cond* to denote +formal parameter inside of *YYSETSTATE* body. + +*re2c:define:YYSETSTATE@state* = ``@@''; :: +Any occurence of this text inside of *YYSETSTATE* will be replaced with the actual argument. -*re2c:define:YYGETSTATE:naked* = *0*; :: -When set to 1 neither braces, parameter nor semicolon gets emitted. +*re2c:define:YYSETSTATE:naked* = *0*; :: +Controls argument in braces and semicolon after *YYSETSTATE*. +If zero, both agrument and semicolon are omitted. +If non-zero, both argument and semicolon are generated. *re2c:define:YYLIMIT* = *YYLIMIT*; :: Allows to overwrite the define *YYLIMIT* and thus avoiding it by setting the @@ -734,24 +772,6 @@ value to the actual code needed. Allows to overwrite the define *YYMARKER* and thus avoiding it by setting the value to the actual code needed. -*re2c:define:YYSETCONDITION* = *YYSETCONDITION*; :: -Allows to overwrite the define *YYSETCONDITION*. - -*re2c:define:YYSETCONDITION@cond* = @@; :: -When using *re2c:define:YYSETCONDITION* then any occurence of this text -inside *YYSETCONDITION* will be replaced with the actual new condition value. - -*re2c:define:YYSETSTATE* = *YYSETSTATE*; :: -Allows to overwrite the define *YYSETSTATE* and thus avoiding it by setting the -value to the actual code needed. - -*re2c:define:YYSETSTATE:naked* = *0*; :: -When set to 1 neither braces, parameter nor semicolon gets emitted. - -*re2c:define:YYSETSTATE@state* = @@; :: -When using *re2c:define:YYSETSTATE* then any occurence of this text -inside *YYSETSTATE* will be replaced with the actual new state value. - *re2c:label:yyFillLabel* = *yyFillLabel*; :: Allows to overwrite the name of the label *yyFillLabel*.