[mirror_edk2.git] / BaseTools / Source / Python / Ecc / C.g4

/* @file\r
 This file is used to be the grammar file of ECC tool\r
\r
 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
\r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
*/\r
\r
\r
grammar C;\r
options {\r
    language=Python;\r
}\r
\r
@header {\r
## @file\r
# The file defines the parser for C source files.\r
#\r
# THIS FILE IS AUTO-GENENERATED. PLEASE DON NOT MODIFY THIS FILE.\r
# This file is generated by running:\r
# java org.antlr.Tool C.g\r
#\r
# Copyright (c) 2009 - 2010, Intel Corporation  All rights reserved.\r
#\r
# This program and the accompanying materials are licensed and made available\r
# under the terms and conditions of the BSD License which accompanies this\r
# distribution.  The full text of the license may be found at:\r
#   http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
##\r
\r
import Ecc.CodeFragment as CodeFragment\r
import Ecc.FileProfile as FileProfile\r
}\r
\r
@members {\r
        \r
def printTokenInfo(self, line, offset, tokenText):\r
    print(str(line)+ ',' + str(offset) + ':' + str(tokenText))\r
    \r
def StorePredicateExpression(self, StartLine, StartOffset, EndLine, EndOffset, Text):\r
    PredExp = CodeFragment.PredicateExpression(Text, (StartLine, StartOffset), (EndLine, EndOffset))\r
    FileProfile.PredicateExpressionList.append(PredExp)\r
    \r
def StoreEnumerationDefinition(self, StartLine, StartOffset, EndLine, EndOffset, Text):\r
    EnumDef = CodeFragment.EnumerationDefinition(Text, (StartLine, StartOffset), (EndLine, EndOffset))\r
    FileProfile.EnumerationDefinitionList.append(EnumDef)\r
    \r
def StoreStructUnionDefinition(self, StartLine, StartOffset, EndLine, EndOffset, Text):\r
    SUDef = CodeFragment.StructUnionDefinition(Text, (StartLine, StartOffset), (EndLine, EndOffset))\r
    FileProfile.StructUnionDefinitionList.append(SUDef)\r
    \r
def StoreTypedefDefinition(self, StartLine, StartOffset, EndLine, EndOffset, FromText, ToText):\r
    Tdef = CodeFragment.TypedefDefinition(FromText, ToText, (StartLine, StartOffset), (EndLine, EndOffset))\r
    FileProfile.TypedefDefinitionList.append(Tdef)\r
\r
def StoreFunctionDefinition(self, StartLine, StartOffset, EndLine, EndOffset, ModifierText, DeclText, LeftBraceLine, LeftBraceOffset, DeclLine, DeclOffset):\r
    FuncDef = CodeFragment.FunctionDefinition(ModifierText, DeclText, (StartLine, StartOffset), (EndLine, EndOffset), (LeftBraceLine, LeftBraceOffset), (DeclLine, DeclOffset))\r
    FileProfile.FunctionDefinitionList.append(FuncDef)\r
    \r
def StoreVariableDeclaration(self, StartLine, StartOffset, EndLine, EndOffset, ModifierText, DeclText):\r
    VarDecl = CodeFragment.VariableDeclaration(ModifierText, DeclText, (StartLine, StartOffset), (EndLine, EndOffset))\r
    FileProfile.VariableDeclarationList.append(VarDecl)\r
\r
def StoreFunctionCalling(self, StartLine, StartOffset, EndLine, EndOffset, FuncName, ParamList):\r
    FuncCall = CodeFragment.FunctionCalling(FuncName, ParamList, (StartLine, StartOffset), (EndLine, EndOffset))\r
    FileProfile.FunctionCallingList.append(FuncCall)\r
\r
}\r
\r
translation_unit\r
    : external_declaration*\r
    ;\r
\r
\r
external_declaration\r
    :   ( declaration_specifiers? declarator declaration* '{' )\r
    |   function_definition\r
    |   declaration\r
    |   macro_statement (';')?\r
    ;\r
\r
function_definition\r
locals [String ModifierText = '', String DeclText = '', int LBLine = 0, int LBOffset = 0, int DeclLine = 0, int DeclOffset = 0]\r
@init {\r
ModifierText = '';\r
DeclText = '';\r
LBLine = 0;\r
LBOffset = 0;\r
DeclLine = 0;\r
DeclOffset = 0;\r
}\r
@after{\r
self.StoreFunctionDefinition(localctx.start.line, localctx.start.column, localctx.stop.line, localctx.stop.column, ModifierText, DeclText, LBLine, LBOffset, DeclLine, DeclOffset)\r
}\r
    :    d=declaration_specifiers? declarator\r
    (   declaration+ a=compound_statement  // K&R style\r
    |   b=compound_statement        // ANSI style\r
    )   { \r
if localctx.d != None:\r
    ModifierText = $declaration_specifiers.text\r
else:\r
    ModifierText = ''\r
DeclText = $declarator.text\r
DeclLine = $declarator.start.line\r
DeclOffset = $declarator.start.column\r
if localctx.a != None:\r
    LBLine = $a.start.line\r
    LBOffset = $a.start.column\r
else:\r
    LBLine = $b.start.line\r
    LBOffset = $b.start.column\r
        }\r
    ;\r
\r
\r
declaration_specifiers\r
    :   (   storage_class_specifier\r
        |   type_specifier\r
        |   type_qualifier\r
        )+\r
    ;\r
\r
declaration\r
    : a='typedef' b=declaration_specifiers? c=init_declarator_list d=';' \r
    {\r
if localctx.b is not None:\r
    self.StoreTypedefDefinition(localctx.a.line, localctx.a.column, $d.line, localctx.d.column, $b.text, $c.text)\r
else:\r
    self.StoreTypedefDefinition(localctx.a.line, localctx.a.column, $d.line, localctx.d.column, '', $c.text)\r
    }\r
    | s=declaration_specifiers t=init_declarator_list? e=';' \r
    {\r
if localctx.t is not None:\r
    self.StoreVariableDeclaration($s.start.line, $s.start.column, $t.start.line, $t.start.column, $s.text, $t.text)\r
}\r
    ;\r
\r
init_declarator_list\r
    : init_declarator (',' init_declarator)*\r
    ;\r
\r
init_declarator\r
    : declarator ('=' initializer)? \r
    ;\r
\r
storage_class_specifier\r
    : 'extern'\r
    | 'static'\r
    | 'auto'\r
    | 'register'\r
    | 'STATIC'\r
    ;\r
\r
type_specifier\r
    : 'void'\r
    | 'char'\r
    | 'short'\r
    | 'int'\r
    | 'long'\r
    | 'float'\r
    | 'double'\r
    | 'signed'\r
    | 'unsigned'\r
    | s=struct_or_union_specifier\r
    {\r
if localctx.s.stop is not None:\r
    self.StoreStructUnionDefinition($s.start.line, $s.start.column, $s.stop.line, $s.stop.column, $s.text)\r
}\r
    | e=enum_specifier\r
    {\r
if localctx.e.stop is not None:\r
    self.StoreEnumerationDefinition($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)\r
}\r
    | (IDENTIFIER type_qualifier* declarator) \r
    |  type_id\r
    ;\r
\r
type_id\r
    :   IDENTIFIER\r
        //{self.printTokenInfo($a.line, $a.pos, $a.text)}\r
    ;\r
\r
struct_or_union_specifier\r
    : struct_or_union IDENTIFIER? '{' struct_declaration_list '}'\r
    | struct_or_union IDENTIFIER\r
    ;\r
\r
struct_or_union\r
    : 'struct'\r
    | 'union'\r
    ;\r
\r
struct_declaration_list\r
    : struct_declaration+\r
    ;\r
\r
struct_declaration\r
    : specifier_qualifier_list struct_declarator_list ';'\r
    ;\r
\r
specifier_qualifier_list\r
    : ( type_qualifier | type_specifier )+\r
    ;\r
\r
struct_declarator_list\r
    : struct_declarator (',' struct_declarator)*\r
    ;\r
\r
struct_declarator\r
    : declarator (':' constant_expression)?\r
    | ':' constant_expression\r
    ;\r
\r
enum_specifier\r
    : 'enum' '{' enumerator_list ','? '}'\r
    | 'enum' IDENTIFIER '{' enumerator_list ','? '}'\r
    | 'enum' IDENTIFIER\r
    ;\r
\r
enumerator_list\r
    : enumerator (',' enumerator)*\r
    ;\r
\r
enumerator\r
    : IDENTIFIER ('=' constant_expression)?\r
    ;\r
\r
type_qualifier\r
    : 'const'\r
    | 'volatile'\r
    | 'IN'\r
    | 'OUT'\r
    | 'OPTIONAL'\r
    | 'CONST'\r
    | 'UNALIGNED'\r
    | 'VOLATILE'\r
    | 'GLOBAL_REMOVE_IF_UNREFERENCED'\r
    | 'EFIAPI'\r
    | 'EFI_BOOTSERVICE'\r
    | 'EFI_RUNTIMESERVICE'\r
    | 'PACKED'\r
    ;\r
\r
declarator\r
    : pointer? ('EFIAPI')? ('EFI_BOOTSERVICE')? ('EFI_RUNTIMESERVICE')? direct_declarator\r
//  | ('EFIAPI')? ('EFI_BOOTSERVICE')? ('EFI_RUNTIMESERVICE')? pointer? direct_declarator\r
    | pointer\r
    ;\r
\r
direct_declarator\r
    : IDENTIFIER declarator_suffix*\r
    | '(' ('EFIAPI')? declarator ')' declarator_suffix+\r
    ;\r
\r
declarator_suffix\r
    :   '[' constant_expression ']'\r
    |   '[' ']'\r
    |   '(' parameter_type_list ')'\r
    |   '(' identifier_list ')'\r
    |   '(' ')'\r
    ;\r
\r
pointer\r
    : '*' type_qualifier+ pointer?\r
    | '*' pointer\r
    | '*'\r
    ;\r
\r
parameter_type_list\r
    : parameter_list (',' ('OPTIONAL')? '...')?\r
    ;\r
\r
parameter_list\r
    : parameter_declaration (',' ('OPTIONAL')? parameter_declaration)*\r
    ;\r
\r
parameter_declaration\r
    : declaration_specifiers (declarator|abstract_declarator)* ('OPTIONAL')?\r
    //accomerdate user-defined type only, no declarator follow.\r
    | pointer* IDENTIFIER\r
    ;\r
\r
identifier_list\r
    : IDENTIFIER\r
    (',' IDENTIFIER)*\r
    ;\r
\r
type_name\r
    : specifier_qualifier_list abstract_declarator?\r
    | type_id\r
    ;\r
\r
abstract_declarator\r
    : pointer direct_abstract_declarator?\r
    | direct_abstract_declarator\r
    ;\r
\r
direct_abstract_declarator\r
    :   ( '(' abstract_declarator ')' | abstract_declarator_suffix ) abstract_declarator_suffix*\r
    ;\r
\r
abstract_declarator_suffix\r
    :   '[' ']'\r
    |   '[' constant_expression ']'\r
    |   '(' ')'\r
    |   '(' parameter_type_list ')'\r
    ;\r
    \r
initializer\r
\r
    : assignment_expression\r
    | '{' initializer_list ','? '}'\r
    ;\r
\r
initializer_list\r
    : initializer (',' initializer )*\r
    ;\r
\r
// E x p r e s s i o n s\r
\r
argument_expression_list\r
    :   assignment_expression ('OPTIONAL')? (',' assignment_expression ('OPTIONAL')?)*\r
    ;\r
\r
additive_expression\r
    : (multiplicative_expression) ('+' multiplicative_expression | '-' multiplicative_expression)*\r
    ;\r
\r
multiplicative_expression\r
    : (cast_expression) ('*' cast_expression | '/' cast_expression | '%' cast_expression)*\r
    ;\r
\r
cast_expression\r
    : '(' type_name ')' cast_expression\r
    | unary_expression\r
    ;\r
\r
unary_expression\r
    : postfix_expression\r
    | '++' unary_expression\r
    | '--' unary_expression\r
    | unary_operator cast_expression\r
    | 'sizeof' unary_expression\r
    | 'sizeof' '(' type_name ')'\r
    ;\r
\r
postfix_expression\r
locals [FuncCallText='']\r
@init\r
    {\r
self.FuncCallText=''\r
    }\r
    :   p=primary_expression {self.FuncCallText += $p.text}\r
        (   '[' expression ']'\r
        |   '(' a=')'{self.StoreFunctionCalling($p.start.line, $p.start.column, $a.line, localctx.a.column, self.FuncCallText, '')}\r
        |   '(' c=argument_expression_list b=')' {self.StoreFunctionCalling($p.start.line, $p.start.column, $b.line, localctx.b.column, self.FuncCallText, $c.text)}\r
        |   '(' macro_parameter_list ')'\r
        |   '.' x=IDENTIFIER {self.FuncCallText += '.' + $x.text}\r
        |   '*' y=IDENTIFIER {self.FuncCallText = $y.text}\r
        |   '->' z=IDENTIFIER {self.FuncCallText += '->' + $z.text}\r
        |   '++'\r
        |   '--'\r
        )*\r
    ;\r
    \r
macro_parameter_list\r
    : parameter_declaration (',' parameter_declaration)*\r
    ;\r
\r
unary_operator\r
    : '&'\r
    | '*'\r
    | '+'\r
    | '-'\r
    | '~'\r
    | '!'\r
    ;\r
\r
primary_expression\r
    : IDENTIFIER\r
    | constant\r
    | '(' expression ')'\r
    ;\r
\r
constant\r
    :   HEX_LITERAL\r
    |   OCTAL_LITERAL\r
    |   DECIMAL_LITERAL\r
    |   CHARACTER_LITERAL\r
    |   (IDENTIFIER* STRING_LITERAL+)+ IDENTIFIER*\r
    |   FLOATING_POINT_LITERAL\r
    ;\r
\r
/////\r
\r
expression\r
    : assignment_expression (',' assignment_expression)*\r
    ;\r
\r
constant_expression\r
    : conditional_expression\r
    ;\r
\r
assignment_expression\r
    : lvalue assignment_operator assignment_expression\r
    | conditional_expression\r
    ;\r
    \r
lvalue\r
    :   unary_expression\r
    ;\r
\r
assignment_operator\r
    : '='\r
    | '*='\r
    | '/='\r
    | '%='\r
    | '+='\r
    | '-='\r
    | '<<='\r
    | '>>='\r
    | '&='\r
    | '^='\r
    | '|='\r
    ;\r
\r
conditional_expression\r
    : e=logical_or_expression ('?' expression ':' conditional_expression {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)})?\r
    ;\r
\r
logical_or_expression\r
    : logical_and_expression ('||' logical_and_expression)*\r
    ;\r
\r
logical_and_expression\r
    : inclusive_or_expression ('&&' inclusive_or_expression)*\r
    ;\r
\r
inclusive_or_expression\r
    : exclusive_or_expression ('|' exclusive_or_expression)*\r
    ;\r
\r
exclusive_or_expression\r
    : and_expression ('^' and_expression)*\r
    ;\r
\r
and_expression\r
    : equality_expression ('&' equality_expression)*\r
    ;\r
equality_expression\r
    : relational_expression (('=='|'!=') relational_expression )*\r
    ;\r
\r
relational_expression\r
    : shift_expression (('<'|'>'|'<='|'>=') shift_expression)*\r
    ;\r
\r
shift_expression\r
    : additive_expression (('<<'|'>>') additive_expression)*\r
    ;\r
\r
// S t a t e m e n t s\r
\r
statement\r
    : labeled_statement\r
    | compound_statement\r
    | expression_statement\r
    | selection_statement\r
    | iteration_statement\r
    | jump_statement\r
    | macro_statement\r
    | asm2_statement\r
    | asm1_statement\r
    | asm_statement\r
    | declaration\r
    ;\r
\r
asm2_statement\r
    : '__asm__'? IDENTIFIER '(' (~(';'))* ')' ';'\r
    ;\r
    \r
asm1_statement\r
    : '_asm' '{' (~('}'))* '}'\r
    ;\r
\r
asm_statement\r
    : '__asm' '{' (~('}'))* '}'\r
    ;\r
    \r
macro_statement\r
    : IDENTIFIER '(' declaration*  statement_list? expression? ')'\r
    ;\r
    \r
labeled_statement\r
    : IDENTIFIER ':' statement\r
    | 'case' constant_expression ':' statement\r
    | 'default' ':' statement\r
    ;\r
\r
compound_statement\r
    : '{' declaration* statement_list? '}'\r
    ;\r
\r
statement_list\r
    : statement+\r
    ;\r
\r
expression_statement\r
    : ';'\r
    | expression ';'\r
    ;\r
\r
selection_statement\r
    : 'if' '(' e=expression ')' {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)} statement (:'else' statement)?\r
    | 'switch' '(' expression ')' statement\r
    ;\r
\r
iteration_statement\r
    : 'while' '(' e=expression ')' statement {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)}\r
    | 'do' statement 'while' '(' e=expression ')' ';' {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)}\r
    //| 'for' '(' expression_statement e=expression_statement expression? ')' statement {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)}\r
    ;\r
\r
jump_statement\r
    : 'goto' IDENTIFIER ';'\r
    | 'continue' ';'\r
    | 'break' ';'\r
    | 'return' ';'\r
    | 'return' expression ';'\r
    ;\r
\r
IDENTIFIER\r
    :   LETTER (LETTER|'0'..'9')*\r
    ;\r
    \r
fragment\r
LETTER\r
    :   '$'\r
    |  'A'..'Z'\r
    |  'a'..'z'\r
    |   '_'\r
    ;\r
\r
CHARACTER_LITERAL\r
    :   ('L')? '\'' ( EscapeSequence | ~('\''|'\\') ) '\''\r
    ;\r
\r
STRING_LITERAL\r
    :  ('L')? '"' ( EscapeSequence | ~('\\'|'"') )* '"'\r
    ;\r
    \r
HEX_LITERAL : '0' ('x'|'X') HexDigit+ IntegerTypeSuffix? ;\r
\r
DECIMAL_LITERAL : ('0' | '1'..'9' '0'..'9'*) IntegerTypeSuffix? ;\r
\r
OCTAL_LITERAL : '0' ('0'..'7')+ IntegerTypeSuffix? ;\r
\r
fragment\r
HexDigit : ('0'..'9'|'a'..'f'|'A'..'F') ;\r
\r
fragment\r
IntegerTypeSuffix\r
    : ('u'|'U')\r
    | ('l'|'L')\r
    | ('u'|'U')  ('l'|'L')\r
    | ('u'|'U')  ('l'|'L') ('l'|'L')\r
    ;\r
\r
FLOATING_POINT_LITERAL\r
    :   ('0'..'9')+ '.' ('0'..'9')* Exponent? FloatTypeSuffix?\r
    |   '.' ('0'..'9')+ Exponent? FloatTypeSuffix?\r
    |   ('0'..'9')+ Exponent FloatTypeSuffix?\r
    |   ('0'..'9')+ Exponent? FloatTypeSuffix\r
    ;\r
\r
fragment\r
Exponent : ('e'|'E') ('+'|'-')? ('0'..'9')+ ;\r
\r
fragment\r
FloatTypeSuffix : ('f'|'F'|'d'|'D') ;\r
\r
fragment\r
EscapeSequence\r
    :  '\\' ('b'|'t'|'n'|'f'|'r'|'\''|'\\')\r
    |   OctalEscape\r
    ;\r
\r
fragment\r
OctalEscape\r
    :   '\\' ('0'..'3') ('0'..'7') ('0'..'7')\r
    |   '\\' ('0'..'7') ('0'..'7')\r
    |   '\\' ('0'..'7')\r
    ;\r
\r
fragment\r
UnicodeEscape\r
    :   '\\' 'u' HexDigit HexDigit HexDigit HexDigit\r
    ;\r
\r
WS  :  (' '|'\r'|'\t'|'\u000C'|'\n') \r
       -> channel(HIDDEN)\r
    ;\r
\r
// ingore '\' of line concatenation\r
BS  : ('\\') \r
      -> channel(HIDDEN)\r
    ;\r
    \r
UnicodeVocabulary\r
    : '\u0003'..'\uFFFE'\r
    ;\r
\r
COMMENT\r
    : '/*' .*? '*/'\r
      -> channel(HIDDEN)\r
    ;\r
\r
LINE_COMMENT\r
    : '//' ~('\n'|'\r')* '\r'? '\n' \r
      -> channel(HIDDEN)\r
    ;\r
\r
// ignore #line info for now\r
LINE_COMMAND \r
    : '#' ~('\n'|'\r')* '\r'? '\n' \r
      -> channel(HIDDEN)\r
    ;\r
Commit	Line	Data
22c4de1a HC	1	/* @file\r
	2	This file is used to be the grammar file of ECC tool\r
	3	\r
	4	Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	*/\r
	13	\r
	14	\r
	15	grammar C;\r
	16	options {\r
	17	language=Python;\r
	18	}\r
	19	\r
	20	@header {\r
	21	## @file\r
	22	# The file defines the parser for C source files.\r
	23	#\r
	24	# THIS FILE IS AUTO-GENENERATED. PLEASE DON NOT MODIFY THIS FILE.\r
	25	# This file is generated by running:\r
	26	# java org.antlr.Tool C.g\r
	27	#\r
	28	# Copyright (c) 2009 - 2010, Intel Corporation All rights reserved.\r
	29	#\r
	30	# This program and the accompanying materials are licensed and made available\r
	31	# under the terms and conditions of the BSD License which accompanies this\r
	32	# distribution. The full text of the license may be found at:\r
	33	# http://opensource.org/licenses/bsd-license.php\r
	34	#\r
	35	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	36	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	37	#\r
	38	##\r
	39	\r
	40	import Ecc.CodeFragment as CodeFragment\r
	41	import Ecc.FileProfile as FileProfile\r
	42	}\r
	43	\r
	44	@members {\r
	45	\r
	46	def printTokenInfo(self, line, offset, tokenText):\r
	47	print(str(line)+ ',' + str(offset) + ':' + str(tokenText))\r
	48	\r
	49	def StorePredicateExpression(self, StartLine, StartOffset, EndLine, EndOffset, Text):\r
	50	PredExp = CodeFragment.PredicateExpression(Text, (StartLine, StartOffset), (EndLine, EndOffset))\r
	51	FileProfile.PredicateExpressionList.append(PredExp)\r
	52	\r
	53	def StoreEnumerationDefinition(self, StartLine, StartOffset, EndLine, EndOffset, Text):\r
	54	EnumDef = CodeFragment.EnumerationDefinition(Text, (StartLine, StartOffset), (EndLine, EndOffset))\r
	55	FileProfile.EnumerationDefinitionList.append(EnumDef)\r
	56	\r
	57	def StoreStructUnionDefinition(self, StartLine, StartOffset, EndLine, EndOffset, Text):\r
	58	SUDef = CodeFragment.StructUnionDefinition(Text, (StartLine, StartOffset), (EndLine, EndOffset))\r
	59	FileProfile.StructUnionDefinitionList.append(SUDef)\r
	60	\r
	61	def StoreTypedefDefinition(self, StartLine, StartOffset, EndLine, EndOffset, FromText, ToText):\r
	62	Tdef = CodeFragment.TypedefDefinition(FromText, ToText, (StartLine, StartOffset), (EndLine, EndOffset))\r
	63	FileProfile.TypedefDefinitionList.append(Tdef)\r
	64	\r
65	def StoreFunctionDefinition(self, StartLine, StartOffset, EndLine, EndOffset, ModifierText, DeclText, LeftBraceLine, LeftBraceOffset, DeclLine, DeclOffset):\r
66	FuncDef = CodeFragment.FunctionDefinition(ModifierText, DeclText, (StartLine, StartOffset), (EndLine, EndOffset), (LeftBraceLine, LeftBraceOffset), (DeclLine, DeclOffset))\r
67	FileProfile.FunctionDefinitionList.append(FuncDef)\r
68	\r
69	def StoreVariableDeclaration(self, StartLine, StartOffset, EndLine, EndOffset, ModifierText, DeclText):\r
70	VarDecl = CodeFragment.VariableDeclaration(ModifierText, DeclText, (StartLine, StartOffset), (EndLine, EndOffset))\r
71	FileProfile.VariableDeclarationList.append(VarDecl)\r
72	\r
73	def StoreFunctionCalling(self, StartLine, StartOffset, EndLine, EndOffset, FuncName, ParamList):\r
74	FuncCall = CodeFragment.FunctionCalling(FuncName, ParamList, (StartLine, StartOffset), (EndLine, EndOffset))\r
75	FileProfile.FunctionCallingList.append(FuncCall)\r
76	\r
77	}\r
78	\r
79	translation_unit\r
80	: external_declaration*\r
81	;\r
82	\r
83	\r
84	external_declaration\r
85	: ( declaration_specifiers? declarator declaration* '{' )\r
86	\| function_definition\r
87	\| declaration\r
88	\| macro_statement (';')?\r
89	;\r
90	\r
91	function_definition\r
92	locals [String ModifierText = '', String DeclText = '', int LBLine = 0, int LBOffset = 0, int DeclLine = 0, int DeclOffset = 0]\r
93	@init {\r
94	ModifierText = '';\r
95	DeclText = '';\r
96	LBLine = 0;\r
97	LBOffset = 0;\r
98	DeclLine = 0;\r
99	DeclOffset = 0;\r
100	}\r
101	@after{\r
102	self.StoreFunctionDefinition(localctx.start.line, localctx.start.column, localctx.stop.line, localctx.stop.column, ModifierText, DeclText, LBLine, LBOffset, DeclLine, DeclOffset)\r
103	}\r
104	: d=declaration_specifiers? declarator\r
105	( declaration+ a=compound_statement // K&R style\r
106	\| b=compound_statement // ANSI style\r
107	) { \r
108	if localctx.d != None:\r
109	ModifierText = $declaration_specifiers.text\r
110	else:\r
111	ModifierText = ''\r
112	DeclText = $declarator.text\r
113	DeclLine = $declarator.start.line\r
114	DeclOffset = $declarator.start.column\r
115	if localctx.a != None:\r
116	LBLine = $a.start.line\r
117	LBOffset = $a.start.column\r
118	else:\r
119	LBLine = $b.start.line\r
120	LBOffset = $b.start.column\r
121	}\r
122	;\r
123	\r
124	\r
125	declaration_specifiers\r
126	: ( storage_class_specifier\r
127	\| type_specifier\r
128	\| type_qualifier\r
129	)+\r
130	;\r
131	\r
132	declaration\r
133	: a='typedef' b=declaration_specifiers? c=init_declarator_list d=';' \r
134	{\r
135	if localctx.b is not None:\r
136	self.StoreTypedefDefinition(localctx.a.line, localctx.a.column, $d.line, localctx.d.column, $b.text, $c.text)\r
137	else:\r
138	self.StoreTypedefDefinition(localctx.a.line, localctx.a.column, $d.line, localctx.d.column, '', $c.text)\r
139	}\r
140	\| s=declaration_specifiers t=init_declarator_list? e=';' \r
141	{\r
142	if localctx.t is not None:\r
143	self.StoreVariableDeclaration($s.start.line, $s.start.column, $t.start.line, $t.start.column, $s.text, $t.text)\r
144	}\r
145	;\r
146	\r
147	init_declarator_list\r
148	: init_declarator (',' init_declarator)*\r
149	;\r
150	\r
151	init_declarator\r
152	: declarator ('=' initializer)? \r
153	;\r
154	\r
155	storage_class_specifier\r
156	: 'extern'\r
157	\| 'static'\r
158	\| 'auto'\r
159	\| 'register'\r
160	\| 'STATIC'\r
161	;\r
162	\r
163	type_specifier\r
164	: 'void'\r
165	\| 'char'\r
166	\| 'short'\r
167	\| 'int'\r
168	\| 'long'\r
169	\| 'float'\r
170	\| 'double'\r
171	\| 'signed'\r
172	\| 'unsigned'\r
173	\| s=struct_or_union_specifier\r
174	{\r
175	if localctx.s.stop is not None:\r
176	self.StoreStructUnionDefinition($s.start.line, $s.start.column, $s.stop.line, $s.stop.column, $s.text)\r
177	}\r
178	\| e=enum_specifier\r
179	{\r
180	if localctx.e.stop is not None:\r
181	self.StoreEnumerationDefinition($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)\r
182	}\r
183	\| (IDENTIFIER type_qualifier* declarator) \r
184	\| type_id\r
185	;\r
186	\r
187	type_id\r
188	: IDENTIFIER\r
189	//{self.printTokenInfo($a.line, $a.pos, $a.text)}\r
190	;\r
191	\r
192	struct_or_union_specifier\r
193	: struct_or_union IDENTIFIER? '{' struct_declaration_list '}'\r
194	\| struct_or_union IDENTIFIER\r
195	;\r
196	\r
197	struct_or_union\r
198	: 'struct'\r
199	\| 'union'\r
200	;\r
201	\r
202	struct_declaration_list\r
203	: struct_declaration+\r
204	;\r
205	\r
206	struct_declaration\r
207	: specifier_qualifier_list struct_declarator_list ';'\r
208	;\r
209	\r
210	specifier_qualifier_list\r
211	: ( type_qualifier \| type_specifier )+\r
212	;\r
213	\r
214	struct_declarator_list\r
215	: struct_declarator (',' struct_declarator)*\r
216	;\r
217	\r
218	struct_declarator\r
219	: declarator (':' constant_expression)?\r
220	\| ':' constant_expression\r
221	;\r
222	\r
223	enum_specifier\r
224	: 'enum' '{' enumerator_list ','? '}'\r
225	\| 'enum' IDENTIFIER '{' enumerator_list ','? '}'\r
226	\| 'enum' IDENTIFIER\r
227	;\r
228	\r
229	enumerator_list\r
230	: enumerator (',' enumerator)*\r
231	;\r
232	\r
233	enumerator\r
234	: IDENTIFIER ('=' constant_expression)?\r
235	;\r
236	\r
237	type_qualifier\r
238	: 'const'\r
239	\| 'volatile'\r
240	\| 'IN'\r
241	\| 'OUT'\r
242	\| 'OPTIONAL'\r
243	\| 'CONST'\r
244	\| 'UNALIGNED'\r
245	\| 'VOLATILE'\r
246	\| 'GLOBAL_REMOVE_IF_UNREFERENCED'\r
247	\| 'EFIAPI'\r
248	\| 'EFI_BOOTSERVICE'\r
249	\| 'EFI_RUNTIMESERVICE'\r
250	\| 'PACKED'\r
251	;\r
252	\r
253	declarator\r
254	: pointer? ('EFIAPI')? ('EFI_BOOTSERVICE')? ('EFI_RUNTIMESERVICE')? direct_declarator\r
255	// \| ('EFIAPI')? ('EFI_BOOTSERVICE')? ('EFI_RUNTIMESERVICE')? pointer? direct_declarator\r
256	\| pointer\r
257	;\r
258	\r
259	direct_declarator\r
260	: IDENTIFIER declarator_suffix*\r
261	\| '(' ('EFIAPI')? declarator ')' declarator_suffix+\r
262	;\r
263	\r
264	declarator_suffix\r
265	: '[' constant_expression ']'\r
266	\| '[' ']'\r
267	\| '(' parameter_type_list ')'\r
268	\| '(' identifier_list ')'\r
269	\| '(' ')'\r
270	;\r
271	\r
272	pointer\r
273	: '*' type_qualifier+ pointer?\r
274	\| '*' pointer\r
275	\| '*'\r
276	;\r
277	\r
278	parameter_type_list\r
279	: parameter_list (',' ('OPTIONAL')? '...')?\r
280	;\r
281	\r
282	parameter_list\r
283	: parameter_declaration (',' ('OPTIONAL')? parameter_declaration)*\r
284	;\r
285	\r
286	parameter_declaration\r
287	: declaration_specifiers (declarator\|abstract_declarator)* ('OPTIONAL')?\r
288	//accomerdate user-defined type only, no declarator follow.\r
289	\| pointer* IDENTIFIER\r
290	;\r
291	\r
292	identifier_list\r
293	: IDENTIFIER\r
294	(',' IDENTIFIER)*\r
295	;\r
296	\r
297	type_name\r
298	: specifier_qualifier_list abstract_declarator?\r
299	\| type_id\r
300	;\r
301	\r
302	abstract_declarator\r
303	: pointer direct_abstract_declarator?\r
304	\| direct_abstract_declarator\r
305	;\r
306	\r
307	direct_abstract_declarator\r
308	: ( '(' abstract_declarator ')' \| abstract_declarator_suffix ) abstract_declarator_suffix*\r
309	;\r
310	\r
311	abstract_declarator_suffix\r
312	: '[' ']'\r
313	\| '[' constant_expression ']'\r
314	\| '(' ')'\r
315	\| '(' parameter_type_list ')'\r
316	;\r
317	\r
318	initializer\r
319	\r
320	: assignment_expression\r
321	\| '{' initializer_list ','? '}'\r
322	;\r
323	\r
324	initializer_list\r
325	: initializer (',' initializer )*\r
326	;\r
327	\r
328	// E x p r e s s i o n s\r
329	\r
330	argument_expression_list\r
331	: assignment_expression ('OPTIONAL')? (',' assignment_expression ('OPTIONAL')?)*\r
332	;\r
333	\r
334	additive_expression\r
335	: (multiplicative_expression) ('+' multiplicative_expression \| '-' multiplicative_expression)*\r
336	;\r
337	\r
338	multiplicative_expression\r
339	: (cast_expression) ('' cast_expression \| '/' cast_expression \| '%' cast_expression)\r
340	;\r
341	\r
342	cast_expression\r
343	: '(' type_name ')' cast_expression\r
344	\| unary_expression\r
345	;\r
346	\r
347	unary_expression\r
348	: postfix_expression\r
349	\| '++' unary_expression\r
350	\| '--' unary_expression\r
351	\| unary_operator cast_expression\r
352	\| 'sizeof' unary_expression\r
353	\| 'sizeof' '(' type_name ')'\r
354	;\r
355	\r
356	postfix_expression\r
357	locals [FuncCallText='']\r
358	@init\r
359	{\r
360	self.FuncCallText=''\r
361	}\r
362	: p=primary_expression {self.FuncCallText += $p.text}\r
363	( '[' expression ']'\r
364	\| '(' a=')'{self.StoreFunctionCalling($p.start.line, $p.start.column, $a.line, localctx.a.column, self.FuncCallText, '')}\r
365	\| '(' c=argument_expression_list b=')' {self.StoreFunctionCalling($p.start.line, $p.start.column, $b.line, localctx.b.column, self.FuncCallText, $c.text)}\r
366	\| '(' macro_parameter_list ')'\r
367	\| '.' x=IDENTIFIER {self.FuncCallText += '.' + $x.text}\r
368	\| '*' y=IDENTIFIER {self.FuncCallText = $y.text}\r
369	\| '->' z=IDENTIFIER {self.FuncCallText += '->' + $z.text}\r
370	\| '++'\r
371	\| '--'\r
372	)*\r
373	;\r
374	\r
375	macro_parameter_list\r
376	: parameter_declaration (',' parameter_declaration)*\r
377	;\r
378	\r
379	unary_operator\r
380	: '&'\r
381	\| '*'\r
382	\| '+'\r
383	\| '-'\r
384	\| '~'\r
385	\| '!'\r
386	;\r
387	\r
388	primary_expression\r
389	: IDENTIFIER\r
390	\| constant\r
391	\| '(' expression ')'\r
392	;\r
393	\r
394	constant\r
395	: HEX_LITERAL\r
396	\| OCTAL_LITERAL\r
397	\| DECIMAL_LITERAL\r
398	\| CHARACTER_LITERAL\r
399	\| (IDENTIFIER* STRING_LITERAL+)+ IDENTIFIER*\r
400	\| FLOATING_POINT_LITERAL\r
401	;\r
402	\r
403	/////\r
404	\r
405	expression\r
406	: assignment_expression (',' assignment_expression)*\r
407	;\r
408	\r
409	constant_expression\r
410	: conditional_expression\r
411	;\r
412	\r
413	assignment_expression\r
414	: lvalue assignment_operator assignment_expression\r
415	\| conditional_expression\r
416	;\r
417	\r
418	lvalue\r
419	: unary_expression\r
420	;\r
421	\r
422	assignment_operator\r
423	: '='\r
424	\| '*='\r
425	\| '/='\r
426	\| '%='\r
427	\| '+='\r
428	\| '-='\r
429	\| '<<='\r
430	\| '>>='\r
431	\| '&='\r
432	\| '^='\r
433	\| '\|='\r
434	;\r
435	\r
436	conditional_expression\r
437	: e=logical_or_expression ('?' expression ':' conditional_expression {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)})?\r
438	;\r
439	\r
440	logical_or_expression\r
441	: logical_and_expression ('\|\|' logical_and_expression)*\r
442	;\r
443	\r
444	logical_and_expression\r
445	: inclusive_or_expression ('&&' inclusive_or_expression)*\r
446	;\r
447	\r
448	inclusive_or_expression\r
449	: exclusive_or_expression ('\|' exclusive_or_expression)*\r
450	;\r
451	\r
452	exclusive_or_expression\r
453	: and_expression ('^' and_expression)*\r
454	;\r
455	\r
456	and_expression\r
457	: equality_expression ('&' equality_expression)*\r
458	;\r
459	equality_expression\r
460	: relational_expression (('=='\|'!=') relational_expression )*\r
461	;\r
462	\r
463	relational_expression\r
464	: shift_expression (('<'\|'>'\|'<='\|'>=') shift_expression)*\r
465	;\r
466	\r
467	shift_expression\r
468	: additive_expression (('<<'\|'>>') additive_expression)*\r
469	;\r
470	\r
471	// S t a t e m e n t s\r
472	\r
473	statement\r
474	: labeled_statement\r
475	\| compound_statement\r
476	\| expression_statement\r
477	\| selection_statement\r
478	\| iteration_statement\r
479	\| jump_statement\r
480	\| macro_statement\r
481	\| asm2_statement\r
482	\| asm1_statement\r
483	\| asm_statement\r
484	\| declaration\r
485	;\r
486	\r
487	asm2_statement\r
488	: '__asm__'? IDENTIFIER '(' (~(';'))* ')' ';'\r
489	;\r
490	\r
491	asm1_statement\r
492	: '_asm' '{' (~('}'))* '}'\r
493	;\r
494	\r
495	asm_statement\r
496	: '__asm' '{' (~('}'))* '}'\r
497	;\r
498	\r
499	macro_statement\r
500	: IDENTIFIER '(' declaration* statement_list? expression? ')'\r
501	;\r
502	\r
503	labeled_statement\r
504	: IDENTIFIER ':' statement\r
505	\| 'case' constant_expression ':' statement\r
506	\| 'default' ':' statement\r
507	;\r
508	\r
509	compound_statement\r
510	: '{' declaration* statement_list? '}'\r
511	;\r
512	\r
513	statement_list\r
514	: statement+\r
515	;\r
516	\r
517	expression_statement\r
518	: ';'\r
519	\| expression ';'\r
520	;\r
521	\r
522	selection_statement\r
523	: 'if' '(' e=expression ')' {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)} statement (:'else' statement)?\r
524	\| 'switch' '(' expression ')' statement\r
525	;\r
526	\r
527	iteration_statement\r
528	: 'while' '(' e=expression ')' statement {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)}\r
529	\| 'do' statement 'while' '(' e=expression ')' ';' {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)}\r
530	//\| 'for' '(' expression_statement e=expression_statement expression? ')' statement {self.StorePredicateExpression($e.start.line, $e.start.column, $e.stop.line, $e.stop.column, $e.text)}\r
531	;\r
532	\r
533	jump_statement\r
534	: 'goto' IDENTIFIER ';'\r
535	\| 'continue' ';'\r
536	\| 'break' ';'\r
537	\| 'return' ';'\r
538	\| 'return' expression ';'\r
539	;\r
540	\r
541	IDENTIFIER\r
542	: LETTER (LETTER\|'0'..'9')*\r
543	;\r
544	\r
545	fragment\r
546	LETTER\r
547	: '$'\r
548	\| 'A'..'Z'\r
549	\| 'a'..'z'\r
550	\| '_'\r
551	;\r
552	\r
553	CHARACTER_LITERAL\r
554	: ('L')? '\'' ( EscapeSequence \| ~('\''\|'\\') ) '\''\r
555	;\r
556	\r
557	STRING_LITERAL\r
558	: ('L')? '"' ( EscapeSequence \| ~('\\'\|'"') )* '"'\r
559	;\r
560	\r
561	HEX_LITERAL : '0' ('x'\|'X') HexDigit+ IntegerTypeSuffix? ;\r
562	\r
563	DECIMAL_LITERAL : ('0' \| '1'..'9' '0'..'9'*) IntegerTypeSuffix? ;\r
564	\r
565	OCTAL_LITERAL : '0' ('0'..'7')+ IntegerTypeSuffix? ;\r
566	\r
567	fragment\r
568	HexDigit : ('0'..'9'\|'a'..'f'\|'A'..'F') ;\r
569	\r
570	fragment\r
571	IntegerTypeSuffix\r
572	: ('u'\|'U')\r
573	\| ('l'\|'L')\r
574	\| ('u'\|'U') ('l'\|'L')\r
575	\| ('u'\|'U') ('l'\|'L') ('l'\|'L')\r
576	;\r
577	\r
578	FLOATING_POINT_LITERAL\r
579	: ('0'..'9')+ '.' ('0'..'9')* Exponent? FloatTypeSuffix?\r
580	\| '.' ('0'..'9')+ Exponent? FloatTypeSuffix?\r
581	\| ('0'..'9')+ Exponent FloatTypeSuffix?\r
582	\| ('0'..'9')+ Exponent? FloatTypeSuffix\r
583	;\r
584	\r
585	fragment\r
586	Exponent : ('e'\|'E') ('+'\|'-')? ('0'..'9')+ ;\r
587	\r
588	fragment\r
589	FloatTypeSuffix : ('f'\|'F'\|'d'\|'D') ;\r
590	\r
591	fragment\r
592	EscapeSequence\r
593	: '\\' ('b'\|'t'\|'n'\|'f'\|'r'\|'\''\|'\\')\r
594	\| OctalEscape\r
595	;\r
596	\r
597	fragment\r
598	OctalEscape\r
599	: '\\' ('0'..'3') ('0'..'7') ('0'..'7')\r
600	\| '\\' ('0'..'7') ('0'..'7')\r
601	\| '\\' ('0'..'7')\r
602	;\r
603	\r
604	fragment\r
605	UnicodeEscape\r
606	: '\\' 'u' HexDigit HexDigit HexDigit HexDigit\r
607	;\r
608	\r
609	WS : (' '\|'\r'\|'\t'\|'\u000C'\|'\n') \r
610	-> channel(HIDDEN)\r
611	;\r
612	\r
613	// ingore '\' of line concatenation\r
614	BS : ('\\') \r
615	-> channel(HIDDEN)\r
616	;\r
617	\r
618	UnicodeVocabulary\r
619	: '\u0003'..'\uFFFE'\r
620	;\r
621	\r
622	COMMENT\r
623	: '/' .? '*/'\r
624	-> channel(HIDDEN)\r
625	;\r
626	\r
627	LINE_COMMENT\r
628	: '//' ~('\n'\|'\r')* '\r'? '\n' \r
629	-> channel(HIDDEN)\r
630	;\r
631	\r
632	// ignore #line info for now\r
633	LINE_COMMAND \r
634	: '#' ~('\n'\|'\r')* '\r'? '\n' \r
635	-> channel(HIDDEN)\r
636	;\r