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.y.hh"

    48

#include "stage1_2_priv.hh"

    49

    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 suporting 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

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

    80

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

    81

static int goto_body_state__ = 0;

    82

    83

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    84

int  get_goto_body_state(void) {return goto_body_state__;}

    85

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    86

    87

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

    88

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

    89

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

    90

static int goto_sfc_qualifier_state__ = 0;

    91

    92

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

    93

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

    94

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

    95

    96

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

    97

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

    98

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

    99

static int goto_sfc_priority_state__ = 0;

   100

   101

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

   102

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

   103

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

   104

   105

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

   106

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

   107

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

   108

static int goto_task_init_state__ = 0;

   109

   110

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   111

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   112

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   113

   114

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

   115

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

   116

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

   117

static int pop_state__ = 0;

   118

   119

void cmd_pop_state(void) {pop_state__ = 1;}

   120

int  get_pop_state(void) {return pop_state__;}

   121

void rst_pop_state(void) {pop_state__ = 0;}

   122

   123

   124

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

   125

/* The global symbol tables...   */

   126

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

   127

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

   128

 *       through the function get_identifier_token()

   129

 */

   130

/* NOTE: BOGUS_TOKEN_ID is defined in the bison generated file iec.y.hh.

   131

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

   132

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

   133

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

   134

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

   135

 *       So, if we were to include "iec.y.hh" here, we would get a circular include.

   136

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

   137

 *       to take care to first inlcude iec.y.hh !!

   138

 */ 

   139

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

   140

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

   141

 *       <fb_name , fb_decl>

   142

 *       <type_name , type_decl>

   143

 *       <program_name , program_decl>

   144

 *       <configuration_name , configuration_decl>

   145

 */

   146

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

   147

   148

/* A symbol table to store the declared variables of

   149

 * the function currently being parsed...

   150

 */

   151

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

   152

   153

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

   154

 * the function currently being parsed...

   155

 */

   156

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

   157

   158

/* Function only called from within flex!

   159

 *

   160

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

   161

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

   162

 * symbol found.

   163

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

   164

 * does it continue searching in the library elements

   165

 */

   166

int get_identifier_token(const char *identifier_str) {

   167

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

   168

  int token_id;

   169

   170

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

   171

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

   172

      return identifier_token;

   173

  return token_id;

   174

}

   175

   176

/* Function only called from within flex!

   177

 *

   178

 * search for a symbol in direct variables symbol table

   179

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

   180

 * symbol found.

   181

 */

   182

int get_direct_variable_token(const char *direct_variable_str) {

   183

  int token_id;

   184

   185

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

   186

    return direct_variable_token;

   187

  return token_id;

   188

}

   189

   190

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

   191

/* Utility Functions... */

   192

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

   193

   194

/*

   195

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

   196

 */

   197

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

   198

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

   199

   200

  if (!res)

   201

    return NULL;

   202

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

   203

}

   204

   205

/*

   206

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

   207

 */

   208

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

   209

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

   210

   211

  if (!res)

   212

    return NULL;

   213

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

   214

}

   215

   216

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

   217

/* Tracking Functions... */

   218

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

   219

   220

extern tracking_t* current_tracking;

   221

   222

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

   223

 * GetNextChar

   224

 * 

   225

 * reads a character from input for flex

   226

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

   227

int GetNextChar(char *b, int maxBuffer) {

   228

  char *p;

   229

   230

  if (  current_tracking->eof  )

   231

    return 0;

   232

   233

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

   234

    current_tracking->currentChar = 0;

   235

    current_tracking->currentTokenStart = 1;

   236

    current_tracking->eof = false;

   237

   238

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

   239

    if (  p == NULL  ) {

   240

      if (  ferror(current_tracking->in_file)  )

   241

        return 0;

   242

      current_tracking->eof = true;

   243

      return 0;

   244

    }

   245

   246

    current_tracking->lineNumber++;

   247

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

   248

  }

   249

   250

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

   251

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

   252

    current_tracking->currentTokenStart++;

   253

  current_tracking->currentChar++;

   254

   255

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

   256

}

   257

   258

tracking_t* GetNewTracking(FILE* in_file) {

   259

  tracking_t* new_env = new tracking_t;

   260

  new_env->eof = 0;

   261

  new_env->lineNumber = 0;

   262

  new_env->currentChar = 0;

   263

  new_env->lineLength = 0;

   264

  new_env->currentTokenStart = 0;

   265

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

   266

  new_env->in_file = in_file;

   267

  return new_env;

   268

}

   269

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

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

   279

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

   280

   281

   282

int stage2__(const char *filename, 

   283

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

   284

             symbol_c **tree_root_ref,

   285

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

   286

            );

   287

   288

   289

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

   290

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

   291

       *       automatically as needed

   292

       */

   293

   294

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

   295

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

   296

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

   297

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

   298

       *       We now set those variables...

   299

       */

   300

  safe_extensions_ = options.safe_extensions;

   301

   302

  return stage2__(filename, options.includedir, tree_root_ref, options.full_token_loc);

   303

}

   304