src/scriptvm/scanner.l

/*
 * Copyright (c) 2014-2016 Christian Schoenebeck and Andreas Persson
 *
 * http://www.linuxsampler.org
 *
 * This file is part of LinuxSampler and released under the same terms.
 * See README file for details.
 */

/* Token scanner for NKSP real-time instrument script language. */

%{

#include "parser_shared.h"
#include <math.h>
// reentrant scanner data context
#define YY_EXTRA_TYPE ParserContext*
// set line number each time a token is recognized
#define YY_USER_ACTION                  \
{                                       \
    yylloc->first_line = yylineno;      \
    yylloc->last_line  = yylineno;      \
    yylloc->first_column = yycolumn;    \
    yycolumn += yyleng;                 \
    yylloc->last_column = yycolumn - 1; \
    /*printf("lex: line '%s'\n", yytext);*/  \
}
// custom (f)lex input for reading from std::istream object
#define YY_INPUT(buf,result,max_size)   \
{                                       \
    char c = yyextra->is->get();        \
    if (yyextra->is->eof())             \
        result = YY_NULL;               \
    else {                              \
        buf[0] = c;                     \
        result = 1;                     \
    }                                   \
}

static void scanner_error(YYLTYPE* locp, LinuxSampler::ParserContext* context, const char* err) {
    context->addErr(locp->first_line, locp->last_line, locp->first_column, locp->last_column, err);
}

static void scanner_warning(YYLTYPE* locp, LinuxSampler::ParserContext* context, const char* txt) {
    context->addWrn(locp->first_line, locp->last_line, locp->first_column, locp->last_column, txt);
}

#define SCANNER_ERR(txt)  scanner_error(yylloc, yyextra, txt)
#define SCANNER_WRN(txt)  scanner_warning(yylloc, yyextra, txt)

using namespace LinuxSampler;

static int countNewLineChars(const char* txt) {
    int n = 0;
    for (int i = 0; txt[i]; ++i)
        if (txt[i] == '\n') ++n;
    return n;
}

static int countCharsPastLastNewLine(const char* txt) {
    const int n = strlen(txt);
    for (int i = n - 1; i >= 0; --i)
        if (txt[i] == '\n')
            return n - i - 1;
    return n;
}

#define processLocation() { \
    const int nl = countNewLineChars(yytext); \
    yylineno += nl; \
    if (nl) yycolumn = countCharsPastLastNewLine(yytext); \
}

%}

/* use Flex's built-in support for line numbers
   (disabled, because it seems to be unreliable, so we are using our own
   tracking code in the respective scanner rules below) */
/*%option yylineno*/
/* generate a reentrant safe scanner */
%option reentrant
/* avoid symbol collision with other (i.e. future) scanner symbols */
%option prefix="InstrScript_"
/* bison-bridge adds an argument yylval to yylex, and bison-locations adds an
   argument code yylloc for location tracking. */
%option bison-bridge
%option bison-locations
/* yywrap() would be called at EOF, we don't need it */
%option noyywrap
/* enable functions yy_push_state(), yy_pop_state(), yy_top_state() */
%option stack

/* inclusive scanner conditions */
%s PREPROC_BODY_USE
/* exclusive scanner conditions */
%x PREPROC_SET_COND PREPROC_RESET_COND PREPROC_IF PREPROC_IF_NOT PREPROC_BODY_EAT PREPROC_PRE_BODY_USE PREPROC_PRE_BODY_EAT

DIGIT    [0-9]
ID       [a-zA-Z0-9_]+

%%

\"[^"]*\" {
    yylval->sValue = strdup(yytext + 1);
    yylval->sValue[strlen(yylval->sValue) - 1] = '\0';
    return STRING;
}

{DIGIT}+ {
    yylval->iValue = atoi(yytext);
    return INTEGER;
}

 /* there is currently no support for floating point numbers in NKSP yet */
 /*{DIGIT}+"."{DIGIT}* {
    printf("A float: %s (%g)\n", yytext, atof(yytext));
 }*/


 /* Preprocessor statement:  SET_CONDITION(name) */

<*>"SET_CONDITION"[ \t]*"(" {
    //printf("SET_CONDITION\n");
    yy_push_state(PREPROC_SET_COND, yyscanner);
}
<PREPROC_SET_COND>{ID} {
    //printf("preproc set condition '%s'\n", yytext);
    bool success = yyextra->setPreprocessorCondition(yytext);
    if (!success) {
        SCANNER_WRN((String("Preprocessor: Condition '") +
                    yytext + "' is already set.").c_str());
    }
}
<PREPROC_SET_COND>[ \t]*")" {
    //printf("End of PREPROC_SET_COND\n");
    yy_pop_state(yyscanner);
}


 /* Preprocessor statement:  RESET_CONDITION(name) */

<*>"RESET_CONDITION"[ \t]*"(" {
    //printf("RESET_CONDITION\n");
    yy_push_state(PREPROC_RESET_COND, yyscanner);
}
<PREPROC_RESET_COND>{ID} {
    //printf("preproc reset condition '%s'\n", yytext);
    bool success = yyextra->resetPreprocessorCondition(yytext);
    if (!success) {
        SCANNER_ERR((String("Preprocessor: could not reset condition '") +
                    yytext + "' (either not set or a built-in condition).").c_str());
    }
}
<PREPROC_RESET_COND>[ \t]*")" {
    //printf("End of RESET_CONDITION\n");
    yy_pop_state(yyscanner);
}


 /* Preprocessor conditional statements:

    USE_CODE_IF(name)
      ...
    END_USE_CODE

    and:

    USE_CODE_IF_NOT(name)
      ...
    END_USE_CODE    
 */

<*>"USE_CODE_IF"[ \t]*"(" {
    //printf("USE_CODE_IF\n");
    yy_push_state(PREPROC_IF, yyscanner);
}
<*>"USE_CODE_IF_NOT"[ \t]*"(" {
    //printf("USE_CODE_IF_NOT\n");
    yy_push_state(PREPROC_IF_NOT, yyscanner);
}
<PREPROC_IF>{ID} {
    //printf("preproc use code if '%s'\n", yytext);
    yy_pop_state(yyscanner);
    if (yyextra->isPreprocessorConditionSet(yytext))
        yy_push_state(PREPROC_PRE_BODY_USE, yyscanner);
    else
        yy_push_state(PREPROC_PRE_BODY_EAT, yyscanner);
}
<PREPROC_IF_NOT>{ID} {
    //printf("preproc use code if not '%s'\n", yytext);
    yy_pop_state(yyscanner);
    if (!yyextra->isPreprocessorConditionSet(yytext))
        yy_push_state(PREPROC_PRE_BODY_USE, yyscanner);
    else
        yy_push_state(PREPROC_PRE_BODY_EAT, yyscanner);
}
<PREPROC_PRE_BODY_USE>[ \t]*")" {
    yy_pop_state(yyscanner);
    yy_push_state(PREPROC_BODY_USE, yyscanner);
}
<PREPROC_PRE_BODY_EAT>[ \t]*")" {
    //printf("PREPROCESSOR EAT : \n");
    yy_pop_state(yyscanner);
    yy_push_state(PREPROC_BODY_EAT, yyscanner);
}
<*>.*"END_USE_CODE" {
    //printf("-->END_USE_CODE\n");
    yy_pop_state(yyscanner);
}
<PREPROC_BODY_EAT>[ \t\r\n]* { /* eat up code block filtered out by preprocessor */
    processLocation();
}
<PREPROC_BODY_EAT>.* { /* eat up code block filtered out by preprocessor */
    processLocation();
}


 /* Language keywords */

"on" return ON;
"end" return END;
"note" return NOTE;
"init" return INIT;
"declare" return DECLARE;
"while" return WHILE;
"if" return IF;
".or." return BITWISE_OR;
"or" return OR;
"release" return RELEASE;
".and." return BITWISE_AND;
"and" return AND;
".not." return BITWISE_NOT;
"not" return NOT;
"else" return ELSE;
"controller" return CONTROLLER;
"case" return CASE;
"select" return SELECT;
"to" return TO;
"<=" return LE;
">=" return GE;
"const" return CONST_; // note: "CONST" is already defined for C/C++ compilers on Windows by default
"polyphonic" return POLYPHONIC;
"mod" return MOD;

[&,()[\]<>=*+#/-] {
    return *yytext;
}

("$"|"@"|"%"){ID} {
    yylval->sValue = strdup(yytext);
    return VARIABLE;
}

{ID} {
    yylval->sValue = strdup(yytext);
    return IDENTIFIER;
}

":=" return ASSIGNMENT;

\n+ {
     yylineno += countNewLineChars(yytext);
     yycolumn = 0;
    //printf("lex: new line %d\n", yylineno, yytext);
    //return LF;
}

"{"[^}]*"}" { /* eat up comments */
    processLocation();
}

[ \t\r]+ /* eat up whitespace */

. printf( "Unrecognized character: '%s' (line %d, column %d)\n", yytext, yylineno, yycolumn);

%%

namespace LinuxSampler {

void ParserContext::createScanner(std::istream* is) {
   if (scanner) destroyScanner();
   this->is = is;
   yylex_init(&scanner);
   yyset_extra(this, scanner);
}

void ParserContext::destroyScanner() {
   if (!scanner) return;
   yylex_destroy(scanner);
   scanner = NULL;
}

} // namespace LinuxSampler
1	schoenebeck	2581	/*
2	schoenebeck	2888	* Copyright (c) 2014-2016 Christian Schoenebeck and Andreas Persson
3	schoenebeck	2581	*
4			* http://www.linuxsampler.org
5			*
6			* This file is part of LinuxSampler and released under the same terms.
7			* See README file for details.
8			*/
9
10	schoenebeck	2888	/* Token scanner for NKSP real-time instrument script language. */
11	schoenebeck	2581
12			%{
13
14			#include "parser_shared.h"
15			#include <math.h>
16			// reentrant scanner data context
17			#define YY_EXTRA_TYPE ParserContext*
18			// set line number each time a token is recognized
19			#define YY_USER_ACTION \
20			{ \
21			yylloc->first_line = yylineno; \
22			yylloc->last_line = yylineno; \
23	schoenebeck	2888	yylloc->first_column = yycolumn; \
24			yycolumn += yyleng; \
25			yylloc->last_column = yycolumn - 1; \
26	schoenebeck	2581	/printf("lex: line '%s'\n", yytext);/ \
27			}
28			// custom (f)lex input for reading from std::istream object
29			#define YY_INPUT(buf,result,max_size) \
30			{ \
31			char c = yyextra->is->get(); \
32			if (yyextra->is->eof()) \
33			result = YY_NULL; \
34			else { \
35			buf[0] = c; \
36			result = 1; \
37			} \
38			}
39
40			static void scanner_error(YYLTYPE* locp, LinuxSampler::ParserContext* context, const char* err) {
41	schoenebeck	2889	context->addErr(locp->first_line, locp->last_line, locp->first_column, locp->last_column, err);
42	schoenebeck	2581	}
43
44			static void scanner_warning(YYLTYPE* locp, LinuxSampler::ParserContext* context, const char* txt) {
45	schoenebeck	2889	context->addWrn(locp->first_line, locp->last_line, locp->first_column, locp->last_column, txt);
46	schoenebeck	2581	}
47
48			#define SCANNER_ERR(txt) scanner_error(yylloc, yyextra, txt)
49			#define SCANNER_WRN(txt) scanner_warning(yylloc, yyextra, txt)
50
51			using namespace LinuxSampler;
52
53	schoenebeck	2888	static int countNewLineChars(const char* txt) {
54			int n = 0;
55			for (int i = 0; txt[i]; ++i)
56			if (txt[i] == '\n') ++n;
57			return n;
58			}
59
60			static int countCharsPastLastNewLine(const char* txt) {
61			const int n = strlen(txt);
62			for (int i = n - 1; i >= 0; --i)
63			if (txt[i] == '\n')
64			return n - i - 1;
65			return n;
66			}
67
68			#define processLocation() { \
69			const int nl = countNewLineChars(yytext); \
70			yylineno += nl; \
71			if (nl) yycolumn = countCharsPastLastNewLine(yytext); \
72			}
73
74	schoenebeck	2581	%}
75
76	schoenebeck	2888	/* use Flex's built-in support for line numbers
77			(disabled, because it seems to be unreliable, so we are using our own
78			tracking code in the respective scanner rules below) */
79			/%option yylineno/
80	schoenebeck	2581	/* generate a reentrant safe scanner */
81			%option reentrant
82			/* avoid symbol collision with other (i.e. future) scanner symbols */
83			%option prefix="InstrScript_"
84			/* bison-bridge adds an argument yylval to yylex, and bison-locations adds an
85			argument code yylloc for location tracking. */
86			%option bison-bridge
87			%option bison-locations
88			/* yywrap() would be called at EOF, we don't need it */
89			%option noyywrap
90			/* enable functions yy_push_state(), yy_pop_state(), yy_top_state() */
91			%option stack
92
93			/* inclusive scanner conditions */
94			%s PREPROC_BODY_USE
95			/* exclusive scanner conditions */
96			%x PREPROC_SET_COND PREPROC_RESET_COND PREPROC_IF PREPROC_IF_NOT PREPROC_BODY_EAT PREPROC_PRE_BODY_USE PREPROC_PRE_BODY_EAT
97
98			DIGIT [0-9]
99	schoenebeck	2935	ID [a-zA-Z0-9_]+
100	schoenebeck	2581
101			%%
102
103			\"[^"]*\" {
104			yylval->sValue = strdup(yytext + 1);
105			yylval->sValue[strlen(yylval->sValue) - 1] = '\0';
106			return STRING;
107			}
108
109			{DIGIT}+ {
110			yylval->iValue = atoi(yytext);
111			return INTEGER;
112			}
113
114	schoenebeck	2935	/* there is currently no support for floating point numbers in NKSP yet */
115			/{DIGIT}+"."{DIGIT} {
116	schoenebeck	2581	printf("A float: %s (%g)\n", yytext, atof(yytext));
117	schoenebeck	2935	}*/
118	schoenebeck	2581
119
120			/* Preprocessor statement: SET_CONDITION(name) */
121
122			<>"SET_CONDITION"[ \t]"(" {
123	schoenebeck	2588	//printf("SET_CONDITION\n");
124	schoenebeck	2581	yy_push_state(PREPROC_SET_COND, yyscanner);
125			}
126			<PREPROC_SET_COND>{ID} {
127	schoenebeck	2588	//printf("preproc set condition '%s'\n", yytext);
128	schoenebeck	2581	bool success = yyextra->setPreprocessorCondition(yytext);
129			if (!success) {
130			SCANNER_WRN((String("Preprocessor: Condition '") +
131			yytext + "' is already set.").c_str());
132			}
133			}
134			<PREPROC_SET_COND>[ \t]*")" {
135	schoenebeck	2588	//printf("End of PREPROC_SET_COND\n");
136	schoenebeck	2581	yy_pop_state(yyscanner);
137			}
138
139
140			/* Preprocessor statement: RESET_CONDITION(name) */
141
142			<>"RESET_CONDITION"[ \t]"(" {
143	schoenebeck	2588	//printf("RESET_CONDITION\n");
144	schoenebeck	2581	yy_push_state(PREPROC_RESET_COND, yyscanner);
145			}
146			<PREPROC_RESET_COND>{ID} {
147	schoenebeck	2588	//printf("preproc reset condition '%s'\n", yytext);
148	schoenebeck	2581	bool success = yyextra->resetPreprocessorCondition(yytext);
149			if (!success) {
150			SCANNER_ERR((String("Preprocessor: could not reset condition '") +
151			yytext + "' (either not set or a built-in condition).").c_str());
152			}
153			}
154			<PREPROC_RESET_COND>[ \t]*")" {
155	schoenebeck	2588	//printf("End of RESET_CONDITION\n");
156	schoenebeck	2581	yy_pop_state(yyscanner);
157			}
158
159
160			/* Preprocessor conditional statements:
161
162			USE_CODE_IF(name)
163			...
164			END_USE_CODE
165
166			and:
167
168			USE_CODE_IF_NOT(name)
169			...
170			END_USE_CODE
171			*/
172
173			<>"USE_CODE_IF"[ \t]"(" {
174	schoenebeck	2588	//printf("USE_CODE_IF\n");
175	schoenebeck	2581	yy_push_state(PREPROC_IF, yyscanner);
176			}
177			<>"USE_CODE_IF_NOT"[ \t]"(" {
178	schoenebeck	2588	//printf("USE_CODE_IF_NOT\n");
179	schoenebeck	2581	yy_push_state(PREPROC_IF_NOT, yyscanner);
180			}
181			<PREPROC_IF>{ID} {
182	schoenebeck	2588	//printf("preproc use code if '%s'\n", yytext);
183	schoenebeck	2581	yy_pop_state(yyscanner);
184			if (yyextra->isPreprocessorConditionSet(yytext))
185			yy_push_state(PREPROC_PRE_BODY_USE, yyscanner);
186			else
187			yy_push_state(PREPROC_PRE_BODY_EAT, yyscanner);
188			}
189			<PREPROC_IF_NOT>{ID} {
190	schoenebeck	2588	//printf("preproc use code if not '%s'\n", yytext);
191	schoenebeck	2581	yy_pop_state(yyscanner);
192			if (!yyextra->isPreprocessorConditionSet(yytext))
193			yy_push_state(PREPROC_PRE_BODY_USE, yyscanner);
194			else
195			yy_push_state(PREPROC_PRE_BODY_EAT, yyscanner);
196			}
197			<PREPROC_PRE_BODY_USE>[ \t]*")" {
198			yy_pop_state(yyscanner);
199			yy_push_state(PREPROC_BODY_USE, yyscanner);
200			}
201			<PREPROC_PRE_BODY_EAT>[ \t]*")" {
202	schoenebeck	2588	//printf("PREPROCESSOR EAT : \n");
203	schoenebeck	2581	yy_pop_state(yyscanner);
204			yy_push_state(PREPROC_BODY_EAT, yyscanner);
205			}
206			<>."END_USE_CODE" {
207	schoenebeck	2588	//printf("-->END_USE_CODE\n");
208	schoenebeck	2581	yy_pop_state(yyscanner);
209			}
210	schoenebeck	2888	<PREPROC_BODY_EAT>[ \t\r\n]* { /* eat up code block filtered out by preprocessor */
211			processLocation();
212			}
213			<PREPROC_BODY_EAT>.* { /* eat up code block filtered out by preprocessor */
214			processLocation();
215			}
216	schoenebeck	2581
217
218			/* Language keywords */
219
220			"on" return ON;
221			"end" return END;
222			"note" return NOTE;
223			"init" return INIT;
224			"declare" return DECLARE;
225			"while" return WHILE;
226			"if" return IF;
227	schoenebeck	2935	".or." return BITWISE_OR;
228	schoenebeck	2581	"or" return OR;
229			"release" return RELEASE;
230	schoenebeck	2935	".and." return BITWISE_AND;
231	schoenebeck	2581	"and" return AND;
232	schoenebeck	2935	".not." return BITWISE_NOT;
233	schoenebeck	2581	"not" return NOT;
234			"else" return ELSE;
235			"controller" return CONTROLLER;
236			"case" return CASE;
237			"select" return SELECT;
238			"to" return TO;
239			"<=" return LE;
240			">=" return GE;
241	schoenebeck	2585	"const" return CONST_; // note: "CONST" is already defined for C/C++ compilers on Windows by default
242	schoenebeck	2581	"polyphonic" return POLYPHONIC;
243			"mod" return MOD;
244
245	schoenebeck	2935	[&,()[\]<>=*+#/-] {
246			return *yytext;
247	schoenebeck	2581	}
248
249	schoenebeck	2935	("$"\|"@"\|"%"){ID} {
250	schoenebeck	2581	yylval->sValue = strdup(yytext);
251			return VARIABLE;
252			}
253
254			{ID} {
255			yylval->sValue = strdup(yytext);
256			return IDENTIFIER;
257			}
258
259			":=" return ASSIGNMENT;
260
261			\n+ {
262	schoenebeck	2888	yylineno += countNewLineChars(yytext);
263			yycolumn = 0;
264	schoenebeck	2581	//printf("lex: new line %d\n", yylineno, yytext);
265			//return LF;
266			}
267
268	schoenebeck	2888	"{"[^}]"}" { / eat up comments */
269			processLocation();
270			}
271	schoenebeck	2581
272			[ \t\r]+ /* eat up whitespace */
273
274	schoenebeck	2942	. printf( "Unrecognized character: '%s' (line %d, column %d)\n", yytext, yylineno, yycolumn);
275	schoenebeck	2581
276			%%
277
278			namespace LinuxSampler {
279
280			void ParserContext::createScanner(std::istream* is) {
281			if (scanner) destroyScanner();
282			this->is = is;
283			yylex_init(&scanner);
284			yyset_extra(this, scanner);
285			}
286
287			void ParserContext::destroyScanner() {
288			if (!scanner) return;
289			yylex_destroy(scanner);
290			scanner = NULL;
291			}
292
293			} // namespace LinuxSampler