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

 *

     6

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

     7

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

     8

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

     9

 *  (at your option) any later version.

    10

 *

    11

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

    12

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

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

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

    17

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

    18

 *

    19

 *

    20

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

    21

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

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

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

    29

 *

    30

 */

    31

    32

    33

/*

    34

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

    35

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

    36

 */

    37

    38

#include <string.h>

    39

#include <stdlib.h>

    40

    41

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

    42

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

    43

    44

    45

#include "stage1_2.hh"

    46

#include "iec.y.hh"

    47

#include "stage1_2_priv.hh"

    48

    49

    50

    51

    52

    53

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

    54

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

    55

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

    56

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

    57

 * Note that flex accesses and updates this global variable

    58

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

    59

 * directive...

    60

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

    61

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

    62

 * file being parsed.

    63

 */

    64

const char *current_filename = NULL;

    65

    66

    67

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

    68

/* whether we are suporting safe extensions           */

    69

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

    70

/* Safety Software Technical Specification,           */

    71

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

    72

/* Version 1.0 – Official Release                     */

    73

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

    74

bool safe_extensions_ = false;

    75

bool get_opt_safe_extensions() {return safe_extensions_;}

    76

    77

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

    78

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

    79

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

    80

static int goto_body_state__ = 0;

    81

    82

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    83

int  get_goto_body_state(void) {return goto_body_state__;}

    84

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    85

    86

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

    87

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

    88

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

    89

static int goto_sfc_qualifier_state__ = 0;

    90

    91

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

    92

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

    93

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

    94

    95

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

    96

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

    97

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

    98

static int goto_sfc_priority_state__ = 0;

    99

   100

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

   101

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

   102

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

   103

   104

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

   105

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

   106

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

   107

static int goto_task_init_state__ = 0;

   108

   109

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   110

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   111

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   112

   113

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

   114

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

   115

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

   116

static int pop_state__ = 0;

   117

   118

void cmd_pop_state(void) {pop_state__ = 1;}

   119

int  get_pop_state(void) {return pop_state__;}

   120

void rst_pop_state(void) {pop_state__ = 0;}

   121

   122

   123

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

   124

/* The global symbol tables...   */

   125

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

   126

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

   127

 *       through the function get_identifier_token()

   128

 */

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

 */ 

   138

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

   139

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

   140

 *       <fb_name , fb_decl>

   141

 *       <type_name , type_decl>

   142

 *       <program_name , program_decl>

   143

 *       <configuration_name , configuration_decl>

   144

 */

   145

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

   146

   147

/* A symbol table to store the declared variables of

   148

 * the function currently being parsed...

   149

 */

   150

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

   151

   152

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

   153

 * the function currently being parsed...

   154

 */

   155

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

   156

   157

/* Function only called from within flex!

   158

 *

   159

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

   160

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

   161

 * symbol found.

   162

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

   163

 * does it continue searching in the library elements

   164

 */

   165

int get_identifier_token(const char *identifier_str) {

   166

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

   167

  int token_id;

   168

   169

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

   170

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

   171

      return identifier_token;

   172

  return token_id;

   173

}

   174

   175

/* Function only called from within flex!

   176

 *

   177

 * search for a symbol in direct variables symbol table

   178

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

   179

 * symbol found.

   180

 */

   181

int get_direct_variable_token(const char *direct_variable_str) {

   182

  int token_id;

   183

   184

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

   185

    return direct_variable_token;

   186

  return token_id;

   187

}

   188

   189

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

   190

/* Utility Functions... */

   191

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

   192

   193

/*

   194

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

   195

 */

   196

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

   197

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

   198

   199

  if (!res)

   200

    return NULL;

   201

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

   202

}

   203

   204

/*

   205

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

   206

 */

   207

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

   208

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

   209

   210

  if (!res)

   211

    return NULL;

   212

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

   213

}

   214

   215

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

   216

/* Tracking Functions... */

   217

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

   218

   219

extern tracking_t* current_tracking;

   220

   221

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

   222

 * GetNextChar

   223

 * 

   224

 * reads a character from input for flex

   225

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

   226

int GetNextChar(char *b, int maxBuffer) {

   227

  char *p;

   228

   229

  if (  current_tracking->eof  )

   230

    return 0;

   231

   232

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

   233

    current_tracking->currentChar = 0;

   234

    current_tracking->currentTokenStart = 1;

   235

    current_tracking->eof = false;

   236

   237

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

   238

    if (  p == NULL  ) {

   239

      if (  ferror(current_tracking->in_file)  )

   240

        return 0;

   241

      current_tracking->eof = true;

   242

      return 0;

   243

    }

   244

   245

    current_tracking->lineNumber++;

   246

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

   247

  }

   248

   249

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

   250

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

   251

    current_tracking->currentTokenStart++;

   252

  current_tracking->currentChar++;

   253

   254

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

   255

}

   256

   257

tracking_t* GetNewTracking(FILE* in_file) {

   258

  tracking_t* new_env = new tracking_t;

   259

  new_env->eof = 0;

   260

  new_env->lineNumber = 0;

   261

  new_env->currentChar = 0;

   262

  new_env->lineLength = 0;

   263

  new_env->currentTokenStart = 0;

   264

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

   265

  new_env->in_file = in_file;

   266

  return new_env;

   267

}

   268

   269

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

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

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

   279

   280

   281

int stage2__(const char *filename, 

   282

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

   283

             symbol_c **tree_root_ref,

   284

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

   285

            );

   286

   287

   288

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

   289

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

   290

       *       automatically as needed

   291

       */

   292

   293

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

   294

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

   295

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

   296

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

   297

       *       We now set those variables...

   298

       */

   299

  safe_extensions_ = options.safe_extensions;

   300

   301

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

   302

}

   303