1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2011  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     6

 *

     7

 *  This program is free software: you can redistribute it and/or modify

     8

 *  it under the terms of the GNU General Public License as published by

     9

 *  the Free Software Foundation, either version 3 of the License, or

    10

 *  (at your option) any later version.

    11

 *

    12

 *  This program is distributed in the hope that it will be useful,

    13

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

 *  You should have received a copy of the GNU General Public License

    18

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    19

 *

    20

 *

    21

 * This code is made available on the understanding that it will not be

    22

 * used in safety-critical situations without a full and competent review.

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    30

 *

    31

 */

    32

    33

    34

/*

    35

 * This file contains the code that calls the stage 1 (lexical anayser) 

    36

 * and stage 2 (syntax parser) during the first pass.

    37

 */

    38

    39

#include <string.h>

    40

#include <stdlib.h>

    41

    42

/* file with declaration of absyntax classes... */

    43

#include "../absyntax/absyntax.hh"

    44

    45

    46

#include "stage1_2.hh"

    47

#include "iec_bison.h"

    48

#include "stage1_2_priv.hh"

    49

#include "create_enumtype_conversion_functions.hh"

    50

    51

    52

    53

    54

/**************************************/

    55

/* The name of the file being parsed. */

    56

/**************************************/

    57

/* The name of the file currently being parsed...

    58

 * Note that flex accesses and updates this global variable

    59

 * apropriately whenever it comes across an (*#include <filename> *)

    60

 * directive...

    61

 * ... and bison will use it when producing error messages.

    62

 * Note that bison also sets this variable correctly to the first

    63

 * file being parsed.

    64

 */

    65

const char *current_filename = NULL;

    66

    67

    68

/******************************************************/

    69

/* whether we are supporting safe extensions          */

    70

/* as defined in PLCopen - Technical Committee 5      */

    71

/* Safety Software Technical Specification,           */

    72

/* Part 1: Concepts and Function Blocks,              */

    73

/* Version 1.0 – Official Release                   */

    74

/******************************************************/

    75

bool safe_extensions_ = false;

    76

bool get_opt_safe_extensions() {return safe_extensions_;}

    77

    78

/******************************************************/

    79

/* whether we are supporting conversion functions     */

    80

/* for enumerate data types                           */

    81

/******************************************************/

    82

bool conversion_functions_ = false;

    83

    84

    85

/****************************************************/

    86

/* Controlling the entry to the body_state in flex. */

    87

/****************************************************/

    88

static int goto_body_state__ = 0;

    89

    90

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    91

int  get_goto_body_state(void) {return goto_body_state__;}

    92

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    93

    94

/*************************************************************/

    95

/* Controlling the entry to the sfc_qualifier_state in flex. */

    96

/*************************************************************/

    97

static int goto_sfc_qualifier_state__ = 0;

    98

    99

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

   100

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

   101

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

   102

   103

/*************************************************************/

   104

/* Controlling the entry to the sfc_priority_state in flex.  */

   105

/*************************************************************/

   106

static int goto_sfc_priority_state__ = 0;

   107

   108

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

   109

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

   110

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

   111

   112

/*************************************************************/

   113

/* Controlling the entry to the sfc_qualifier_state in flex. */

   114

/*************************************************************/

   115

static int goto_task_init_state__ = 0;

   116

   117

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   118

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   119

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   120

   121

/****************************************************************/

   122

/* Returning to state in flex previously pushed onto the stack. */

   123

/****************************************************************/

   124

static int pop_state__ = 0;

   125

   126

void cmd_pop_state(void) {pop_state__ = 1;}

   127

int  get_pop_state(void) {return pop_state__;}

   128

void rst_pop_state(void) {pop_state__ = 0;}

   129

   130

   131

/*********************************/

   132

/* The global symbol tables...   */

   133

/*********************************/

   134

/* NOTE: only accessed indirectly by the lexical parser (flex)

   135

 *       through the function get_identifier_token()

   136

 */

   137

/* NOTE: BOGUS_TOKEN_ID is defined in the bison generated file iec_bison.h.

   138

 *       We need this constant defined before we can declare the symbol tables.

   139

 *       However, we cannot #include "iec_bison.h" in this file (stage1_2_priv.hh) directly

   140

 *       because of the way bison ver. 3.2 is copying all declarations in the prologue

   141

 *       of iec.y to the iec_bison.h file (including an #include stage1_2_priv.hh).

   142

 *       So, if we were to include "iec_bison.h" here, we would get a circular include.

   143

 *       All this means that whoever includes this file (stage1_2_priv.hh) will need

   144

 *       to take care to first inlcude iec_bison.h !!

   145

 */ 

   146

/* A symbol table to store all the library elements */

   147

/* e.g.: <function_name , function_decl>

   148

 *       <fb_name , fb_decl>

   149

 *       <type_name , type_decl>

   150

 *       <program_name , program_decl>

   151

 *       <configuration_name , configuration_decl>

   152

 */

   153

/* static */ symtable_c<int, BOGUS_TOKEN_ID> library_element_symtable;

   154

   155

/* A symbol table to store the declared variables of

   156

 * the function currently being parsed...

   157

 */

   158

/* static */ symtable_c<int, BOGUS_TOKEN_ID> variable_name_symtable;

   159

   160

/* A symbol table to store the declared direct variables of

   161

 * the function currently being parsed...

   162

 */

   163

/* static */ symtable_c<int, BOGUS_TOKEN_ID> direct_variable_symtable;

   164

   165

/* Function only called from within flex!

   166

 *

   167

 * search for a symbol in either of the two symbol tables

   168

 * declared above, and return the token id of the first

   169

 * symbol found.

   170

 * Searches first in the variables, and only if not found

   171

 * does it continue searching in the library elements

   172

 */

   173

int get_identifier_token(const char *identifier_str) {

   174

//  std::cout << "get_identifier_token(" << identifier_str << "): \n";

   175

  int token_id;

   176

   177

  if ((token_id = variable_name_symtable.find_value(identifier_str)) == variable_name_symtable.end_value())

   178

    if ((token_id = library_element_symtable.find_value(identifier_str)) == library_element_symtable.end_value())

   179

      return identifier_token;

   180

  return token_id;

   181

}

   182

   183

/* Function only called from within flex!

   184

 *

   185

 * search for a symbol in direct variables symbol table

   186

 * declared above, and return the token id of the first

   187

 * symbol found.

   188

 */

   189

int get_direct_variable_token(const char *direct_variable_str) {

   190

  int token_id;

   191

   192

  if ((token_id = direct_variable_symtable.find_value(direct_variable_str)) == direct_variable_symtable.end_value())

   193

    return direct_variable_token;

   194

  return token_id;

   195

}

   196

   197

/************************/

   198

/* Utility Functions... */

   199

/************************/

   200

   201

/*

   202

 * Join two strings together. Allocate space with malloc(3).

   203

 */

   204

char *strdup2(const char *a, const char *b) {

   205

  char *res = (char *)malloc(strlen(a) + strlen(b) + 1);

   206

   207

  if (!res)

   208

    return NULL;

   209

  return strcat(strcpy(res, a), b);  /* safe, actually */

   210

}

   211

   212

/*

   213

 * Join three strings together. Allocate space with malloc(3).

   214

 */

   215

char *strdup3(const char *a, const char *b, const char *c) {

   216

  char *res = (char *)malloc(strlen(a) + strlen(b) + strlen(c) + 1);

   217

   218

  if (!res)

   219

    return NULL;

   220

  return strcat(strcat(strcpy(res, a), b), c);  /* safe, actually */

   221

}

   222

   223

/*************************/

   224

/* Tracking Functions... */

   225

/*************************/

   226

   227

extern tracking_t* current_tracking;

   228

   229

/*--------------------------------------------------------------------

   230

 * GetNextChar

   231

 * 

   232

 * reads a character from input for flex

   233

 *------------------------------------------------------------------*/

   234

int GetNextChar(char *b, int maxBuffer) {

   235

  char *p;

   236

   237

  if (  current_tracking->eof  )

   238

    return 0;

   239

   240

  while (  current_tracking->currentChar >= current_tracking->lineLength  ) {

   241

    current_tracking->currentChar = 0;

   242

    current_tracking->currentTokenStart = 1;

   243

    current_tracking->eof = false;

   244

   245

    p = fgets(current_tracking->buffer, MAX_BUFFER_LENGTH, current_tracking->in_file);

   246

    if (  p == NULL  ) {

   247

      if (  ferror(current_tracking->in_file)  )

   248

        return 0;

   249

      current_tracking->eof = true;

   250

      return 0;

   251

    }

   252

   253

    current_tracking->lineNumber++;

   254

    current_tracking->lineLength = strlen(current_tracking->buffer);

   255

  }

   256

   257

  b[0] = current_tracking->buffer[current_tracking->currentChar];

   258

  if (b[0] == ' ' || b[0] == '\t')

   259

    current_tracking->currentTokenStart++;

   260

  current_tracking->currentChar++;

   261

   262

  return b[0]==0?0:1;

   263

}

   264

   265

tracking_t* GetNewTracking(FILE* in_file) {

   266

  tracking_t* new_env = new tracking_t;

   267

  new_env->eof = 0;

   268

  new_env->lineNumber = 0;

   269

  new_env->currentChar = 0;

   270

  new_env->lineLength = 0;

   271

  new_env->currentTokenStart = 0;

   272

  new_env->buffer = (char*)malloc(MAX_BUFFER_LENGTH);

   273

  new_env->in_file = in_file;

   274

  return new_env;

   275

}

   276

   277

/***********************************************************************/

   278

/***********************************************************************/

   279

/***********************************************************************/

   280

/***********************************************************************/

   281

/***********************************************************************/

   282

/***********************************************************************/

   283

/***********************************************************************/

   284

/***********************************************************************/

   285

/***********************************************************************/

   286

/***********************************************************************/

   287

   288

   289

int stage2__(const char *filename, 

   290

             const char *includedir,     /* Include directory, where included files will be searched for... */

   291

             symbol_c **tree_root_ref,

   292

             bool full_token_loc         /* error messages specify full token location */

   293

            );

   294

   295

   296

int stage1_2(const char *filename, symbol_c **tree_root_ref, stage1_2_options_t options) {

   297

      /* NOTE: we only call stage2 (bison - syntax analysis) directly, as stage 2 will itself call stage1 (flex - lexical analysis)

   298

       *       automatically as needed

   299

       */

   300

   301

      /* NOTE: Since we do not call stage1__ (flex) directly, we cannot directly pass any parameters to that function either.

   302

       *       In this case, we use callback functions, i.e. stage1__ (i.e. flex) will call functions defined in this file

   303

       *       whenever it needs info/parameters coming from stage1_2().

   304

       *       These callback functions will get their data from local (to this file) global variables...

   305

       *       We now set those variables...

   306

       */

   307

   308

  safe_extensions_ = options.safe_extensions;

   309

  conversion_functions_ = options.conversion_functions;