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 to allow nested comments */

    68

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

    69

bool nested_comments_ = false;

    70

bool get_opt_nested_comments() {return nested_comments_;}

    71

    72

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

    73

/* whether to allow REF() operator  */

    74

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

    75

bool ref_operator_ = false;

    76

bool get_opt_ref_operator() {return ref_operator_;}

    77

    78

    79

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

    80

/* whether we are supporting conversion functions     */

    81

/* for enumerate data types                           */

    82

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

    83

bool conversion_functions_ = false;

    84

    85

    86

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

    87

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

    88

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

    89

static int goto_body_state__ = 0;

    90

    91

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    92

int  get_goto_body_state(void) {return goto_body_state__;}

    93

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    94

    95

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

    96

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

    97

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

    98

static int goto_sfc_qualifier_state__ = 0;

    99

   100

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

   101

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

   102

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

   103

   104

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

   105

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

   106

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

   107

static int goto_sfc_priority_state__ = 0;

   108

   109

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

   110

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

   111

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

   112

   113

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

   114

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

   115

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

   116

static int goto_task_init_state__ = 0;

   117

   118

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   119

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   120

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   121

   122

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

   123

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

   124

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

   125

static int pop_state__ = 0;

   126

   127

void cmd_pop_state(void) {pop_state__ = 1;}

   128

int  get_pop_state(void) {return pop_state__;}

   129

void rst_pop_state(void) {pop_state__ = 0;}

   130

   131

   132

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

   133

/* The global symbol tables...   */

   134

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

   135

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

   136

 *       through the function get_identifier_token()

   137

 */

   138

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

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

 */ 

   147

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

   148

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

   149

 *       <fb_name , fb_decl>

   150

 *       <type_name , type_decl>

   151

 *       <program_name , program_decl>

   152

 *       <configuration_name , configuration_decl>

   153

 */

   154

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

   155

   156

/* A symbol table to store the declared variables of

   157

 * the function currently being parsed...

   158

 */

   159

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

   160

   161

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

   162

 * the function currently being parsed...

   163

 */

   164

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

   165

   166

/* Function only called from within flex!

   167

 *

   168

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

   169

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

   170

 * symbol found.

   171

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

   172

 * does it continue searching in the library elements

   173

 */

   174

int get_identifier_token(const char *identifier_str) {

   175

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

   176

  int token_id;

   177

   178

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

   179

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

   180

      return identifier_token;

   181

  return token_id;

   182

}

   183

   184

/* Function only called from within flex!

   185

 *

   186

 * search for a symbol in direct variables symbol table

   187

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

   188

 * symbol found.

   189

 */

   190

int get_direct_variable_token(const char *direct_variable_str) {

   191

  int token_id;

   192

   193

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

   194

    return direct_variable_token;

   195

  return token_id;

   196

}

   197

   198

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

   199

/* Utility Functions... */

   200

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

   201

   202

/*

   203

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

   204

 */

   205

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

   206

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

   207

   208

  if (!res)

   209

    return NULL;

   210

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

   211

}

   212

   213

/*

   214

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

   215

 */

   216

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

   217

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

   218

   219

  if (!res)

   220

    return NULL;

   221

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

   222

}

   223

   224

   225

   226

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

   227

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

   228

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

   229

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

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

   237

   238

int stage2__(const char *filename, 

   239

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

   240

             symbol_c **tree_root_ref,

   241

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

   242

            );

   243

   244

   245

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

   246

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

   247

       *       automatically as needed

   248

       */

   249

   250

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

   251

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

   252

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

   253

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

   254

       *       We now set those variables...

   255

       */

   256

   257

  nested_comments_ = options.nested_comments;    

   258

  ref_operator_    = options.ref_operator;    

   259

  safe_extensions_ = options.safe_extensions;

   260

  conversion_functions_ = options.conversion_functions;

   261

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

   262

}

   263