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

    56

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

    57

/* whether we are supporting safe extensions          */

    58

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

    59

/* Safety Software Technical Specification,           */

    60

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

    61

/* Version 1.0 – Official Release                   */

    62

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

    63

bool safe_extensions_ = false;

    64

bool get_opt_safe_extensions() {return safe_extensions_;}

    65

    66

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

    67

/* whether we are supporting conversion functions     */

    68

/* for enumerate data types                           */

    69

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

    70

bool conversion_functions_ = false;

    71

    72

    73

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

    74

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

    75

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

    76

static int goto_body_state__ = 0;

    77

    78

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    79

int  get_goto_body_state(void) {return goto_body_state__;}

    80

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    81

    82

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

    83

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

    84

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

    85

static int goto_sfc_qualifier_state__ = 0;

    86

    87

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

    88

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

    89

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

    90

    91

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

    92

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

    93

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

    94

static int goto_sfc_priority_state__ = 0;

    95

    96

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

    97

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

    98

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

    99

   100

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

   101

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

   102

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

   103

static int goto_task_init_state__ = 0;

   104

   105

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   106

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   107

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   108

   109

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

   110

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

   111

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

   112

static int pop_state__ = 0;

   113

   114

void cmd_pop_state(void) {pop_state__ = 1;}

   115

int  get_pop_state(void) {return pop_state__;}

   116

void rst_pop_state(void) {pop_state__ = 0;}

   117

   118

   119

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

   120

/* The global symbol tables...   */

   121

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

   122

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

   123

 *       through the function get_identifier_token()

   124

 */

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

 */ 

   134

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

   135

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

   136

 *       <fb_name , fb_decl>

   137

 *       <type_name , type_decl>

   138

 *       <program_name , program_decl>

   139

 *       <configuration_name , configuration_decl>

   140

 */

   141

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

   142

   143

/* A symbol table to store the declared variables of

   144

 * the function currently being parsed...

   145

 */

   146

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

   147

   148

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

   149

 * the function currently being parsed...

   150

 */

   151

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

   152

   153

/* Function only called from within flex!

   154

 *

   155

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

   156

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

   157

 * symbol found.

   158

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

   159

 * does it continue searching in the library elements

   160

 */

   161

int get_identifier_token(const char *identifier_str) {

   162

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

   163

  int token_id;

   164

   165

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

   166

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

   167

      return identifier_token;

   168

  return token_id;

   169

}

   170

   171

/* Function only called from within flex!

   172

 *

   173

 * search for a symbol in direct variables symbol table

   174

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

   175

 * symbol found.

   176

 */

   177

int get_direct_variable_token(const char *direct_variable_str) {

   178

  int token_id;

   179

   180

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

   181

    return direct_variable_token;

   182

  return token_id;

   183

}

   184

   185

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

   186

/* Utility Functions... */

   187

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

   188

   189

/*

   190

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

   191

 */

   192

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

   193

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

   194

   195

  if (!res)

   196

    return NULL;

   197

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

   198

}

   199

   200

/*

   201

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

   202

 */

   203

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

   204

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

   205

   206

  if (!res)

   207

    return NULL;

   208

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

   209

}

   210

   211

   212

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

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

   222

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

   223

   224

   225

int stage2__(const char *filename, 

   226

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

   227

             symbol_c **tree_root_ref,

   228

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

   229

            );

   230

   231

   232

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

   233

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

   234

       *       automatically as needed

   235

       */

   236

   237

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

   238

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

   239

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

   240

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

   241

       *       We now set those variables...

   242

       */

   243

   244

  safe_extensions_ = options.safe_extensions;

   245

  conversion_functions_ = options.conversion_functions;

   246

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

   247

}

   248