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

    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 we are supporting conversion functions     */

    74

/* for enumerate data types                           */

    75

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

    76

bool conversion_functions_ = false;

    77

    78

    79

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

    80

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

    81

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

    82

static int goto_body_state__ = 0;

    83

    84

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    85

int  get_goto_body_state(void) {return goto_body_state__;}

    86

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    87

    88

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

    89

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

    90

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

    91

static int goto_sfc_qualifier_state__ = 0;

    92

    93

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

    94

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

    95

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

    96

    97

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

    98

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

    99

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

   100

static int goto_sfc_priority_state__ = 0;

   101

   102

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

   103

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

   104

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

   105

   106

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

   107

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

   108

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

   109

static int goto_task_init_state__ = 0;

   110

   111

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   112

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   113

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   114

   115

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

   116

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

   117

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

   118

static int pop_state__ = 0;

   119

   120

void cmd_pop_state(void) {pop_state__ = 1;}

   121

int  get_pop_state(void) {return pop_state__;}

   122

void rst_pop_state(void) {pop_state__ = 0;}

   123

   124

   125

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

   126

/* The global symbol tables...   */

   127

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

   128

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

   129

 *       through the function get_identifier_token()

   130

 */

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

 */ 

   140

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

   141

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

   142

 *       <fb_name , fb_decl>

   143

 *       <type_name , type_decl>

   144

 *       <program_name , program_decl>

   145

 *       <configuration_name , configuration_decl>

   146

 */

   147

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

   148

   149

/* A symbol table to store the declared variables of

   150

 * the function currently being parsed...

   151

 */

   152

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

   153

   154

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

   155

 * the function currently being parsed...

   156

 */

   157

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

   158

   159

/* Function only called from within flex!

   160

 *

   161

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

   162

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

   163

 * symbol found.

   164

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

   165

 * does it continue searching in the library elements

   166

 */

   167

int get_identifier_token(const char *identifier_str) {

   168

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

   169

  int token_id;

   170

   171

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

   172

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

   173

      return identifier_token;

   174

  return token_id;

   175

}

   176

   177

/* Function only called from within flex!

   178

 *

   179

 * search for a symbol in direct variables symbol table

   180

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

   181

 * symbol found.

   182

 */

   183

int get_direct_variable_token(const char *direct_variable_str) {

   184

  int token_id;

   185

   186

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

   187

    return direct_variable_token;

   188

  return token_id;

   189

}

   190

   191

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

   192

/* Utility Functions... */

   193

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

   194

   195

/*

   196

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

   197

 */

   198

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

   199

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

   200

   201

  if (!res)

   202

    return NULL;

   203

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

   204

}

   205

   206

/*

   207

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

   208

 */

   209

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

   210

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

   211

   212

  if (!res)

   213

    return NULL;

   214

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

   215

}

   216

   217

   218

   219

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

   220

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

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

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

   229

   230

   231

int stage2__(const char *filename, 

   232

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

   233

             symbol_c **tree_root_ref,

   234

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

   235

            );

   236

   237

   238

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

   239

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

   240

       *       automatically as needed

   241

       */

   242

   243

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

   244

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

   245

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

   246

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

   247

       *       We now set those variables...

   248

       */

   249

   250

  nested_comments_ = options.nested_comments;    

   251

  safe_extensions_ = options.safe_extensions;

   252

  conversion_functions_ = options.conversion_functions;

   253

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

   254

}

   255