// Copyright 2017-2020 The Verible Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Common defines and tiny helper functions for Bison-based parsers.

#ifndef VERIBLE_COMMON_PARSER_BISON_PARSER_COMMON_H_
#define VERIBLE_COMMON_PARSER_BISON_PARSER_COMMON_H_

#include "common/parser/parser_param.h"
#include "common/text/concrete_syntax_tree.h"

// Uncomment the next line for parser debugging. Unfortunately, verbose
// error printouts result in a compile errors when our own yyoverflow handling
// is enabled. Therefore, we disable verbose error messages and enable dynamic
// resizing of the parser stack per default. When both lines are uncommented,
// verbose error messages will be reported, however the parser stops parsing
// complex structures due to the limited parser stack size.
// Same as %error-verbose in .yc file.
// #define YYERROR_VERBOSE 1

#ifndef YYERROR_VERBOSE
// Executed when stack size needs to be increased.
// I1, I2, I3, I4 parameters are derived and ignored.
#define yyoverflow(I1, StateStack, I2, ValueStack, I3, Size) \
  param->ResizeStacks(StateStack, ValueStack, Size)

// Initial symbol/state stack depth (internal to yyparse).
// See ParserParam::ResizeStacks().
#define YYINITDEPTH 50

#endif  // YYERROR_VERBOSE

// Enable yyparse symbol stack tracing, as parser shifts/reduces.
// Same as %debug in .yc file.
#define YYDEBUG 1

// A macro to turn a symbol into a string
// These should be used judiciously in modern code. Prefer raw-string literal
// should you simply need to specify a large string.
#define AS_STRING(x) AS_STRING_INTERNAL(x)
#define AS_STRING_INTERNAL(x) #x

namespace verible {

// Calls to yylex() in generated code will be redirected here.
int LexAdapter(SymbolPtr* value, ParserParam* param);

// Calls to yyerror() in generated code will be redirected hee.
void ParseError(const char* function_name, const char* message);

}  // namespace verible

// NOTE: This header is included at a point in the generated .tab.cc file
// where functions like yylex have been renamed to <PREFIX>lex with
// #define's, so only reference these reserved names you mean to refer
// to the substituted names.

// Lexer interface function.
// Called by Bison-generated parser to get a next token.
// TODO(fangism): control yylex prototype using YY_DECL, or embed param inside
//   FlexLexerAdapter class template.
inline int yylex(verible::SymbolPtr* value, verible::ParserParam* param) {
  return verible::LexAdapter(value, param);
}

// Error-reporting function.
// Called by Bison-generated parser when a recognition error occurs.
inline void yyerror(verible::ParserParam* param, const char* message) {
  // TODO(fangism): record and accumulate multiple errors with error recovery.
  // TODO(fangism): pass in ParserParam reference to save errors, and analyze
  //   stack state.  This may need to be refactored per-language.
  verible::ParseError(AS_STRING(yyparse), message);
}

#endif  // VERIBLE_COMMON_PARSER_BISON_PARSER_COMMON_H_