1

/*

     2

 * (c) 2007 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

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

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

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

    14

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

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

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

    22

 *

    23

 */

    24

    25

    26

/*

    27

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

    28

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

    29

 */

    30

    31

#include <string.h>

    32

#include <stdlib.h>

    33

    34

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

    35

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

    36

    37

    38

#include "stage1_2.hh"

    39

#include "iec.y.hh"

    40

#include "stage1_2_priv.hh"

    41

    42

    43

    44

    45

    46

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

    47

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

    48

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

    49

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

    50

 * Note that flex accesses and updates this global variable

    51

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

    52

 * directive...

    53

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

    54

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

    55

 * file being parsed.

    56

 */

    57

const char *current_filename = NULL;

    58

    59

    60

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

    61

/* whether we are suporting safe extensions           */

    62

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

    63

/* Safety Software Technical Specification,           */

    64

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

    65

/* Version 1.0 – Official Release                     */

    66

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

    67

bool safe_extensions_ = false;

    68

bool get_opt_safe_extensions() {return safe_extensions_;}

    69

    70

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

    71

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

    72

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

    73

static int goto_body_state__ = 0;

    74

    75

void cmd_goto_body_state(void) {goto_body_state__ = 1;}

    76

int  get_goto_body_state(void) {return goto_body_state__;}

    77

void rst_goto_body_state(void) {goto_body_state__ = 0;}

    78

    79

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

    80

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

    81

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

    82

static int goto_sfc_qualifier_state__ = 0;

    83

    84

void cmd_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 1;}

    85

int  get_goto_sfc_qualifier_state(void) {return goto_sfc_qualifier_state__;}

    86

void rst_goto_sfc_qualifier_state(void) {goto_sfc_qualifier_state__ = 0;}

    87

    88

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

    89

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

    90

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

    91

static int goto_sfc_priority_state__ = 0;

    92

    93

void cmd_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 1;}

    94

int  get_goto_sfc_priority_state(void) {return goto_sfc_priority_state__;}

    95

void rst_goto_sfc_priority_state(void) {goto_sfc_priority_state__ = 0;}

    96

    97

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

    98

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

    99

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

   100

static int goto_task_init_state__ = 0;

   101

   102

void cmd_goto_task_init_state(void) {goto_task_init_state__ = 1;}

   103

int  get_goto_task_init_state(void) {return goto_task_init_state__;}

   104

void rst_goto_task_init_state(void) {goto_task_init_state__ = 0;}

   105

   106

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

   107

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

   108

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

   109

static int pop_state__ = 0;

   110

   111

void cmd_pop_state(void) {pop_state__ = 1;}

   112

int  get_pop_state(void) {return pop_state__;}

   113

void rst_pop_state(void) {pop_state__ = 0;}

   114

   115

   116

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

   117

/* The global symbol tables...   */

   118

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

   119

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

   120

 *       through the function get_identifier_token()

   121

 */

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

 */ 

   131

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

   132

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

   133

 *       <fb_name , fb_decl>

   134

 *       <type_name , type_decl>

   135

 *       <program_name , program_decl>

   136

 *       <configuration_name , configuration_decl>

   137

 */

   138

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

   139

   140

/* A symbol table to store the declared variables of

   141

 * the function currently being parsed...

   142

 */

   143

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

   144

   145

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

   146

 * the function currently being parsed...

   147

 */

   148

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

   149

   150

/* Function only called from within flex!

   151

 *

   152

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

   153

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

   154

 * symbol found.

   155

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

   156

 * does it continue searching in the library elements

   157

 */

   158

int get_identifier_token(const char *identifier_str) {

   159

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

   160

  int token_id;

   161

   162

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

   163

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

   164

      return identifier_token;

   165

  return token_id;

   166

}

   167

   168

/* Function only called from within flex!

   169

 *

   170

 * search for a symbol in direct variables symbol table

   171

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

   172

 * symbol found.

   173

 */

   174

int get_direct_variable_token(const char *direct_variable_str) {

   175

  int token_id;

   176

   177

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

   178

    return direct_variable_token;

   179

  return token_id;

   180

}

   181

   182

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

   183

/* Utility Functions... */

   184

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

   185

   186

/*

   187

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

   188

 */

   189

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

   190

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

   191

   192

  if (!res)

   193

    return NULL;

   194

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

   195

}

   196

   197

/*

   198

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

   199

 */

   200

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

   201

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

   202

   203

  if (!res)

   204

    return NULL;

   205

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

   206

}

   207

   208

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

   209

/* Tracking Functions... */

   210

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

   211

   212

extern tracking_t* current_tracking;

   213

   214

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

   215

 * GetNextChar

   216

 * 

   217

 * reads a character from input for flex

   218

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

   219

int GetNextChar(char *b, int maxBuffer) {

   220

  char *p;

   221

   222

  if (  current_tracking->eof  )

   223

    return 0;

   224

   225

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

   226

    current_tracking->currentChar = 0;

   227

    current_tracking->currentTokenStart = 1;

   228

    current_tracking->eof = false;

   229

   230

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

   231

    if (  p == NULL  ) {

   232

      if (  ferror(current_tracking->in_file)  )

   233

        return 0;

   234

      current_tracking->eof = true;

   235

      return 0;

   236

    }

   237

   238

    current_tracking->lineNumber++;

   239

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

   240

  }

   241

   242

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

   243

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

   244

    current_tracking->currentTokenStart++;

   245

  current_tracking->currentChar++;

   246

   247

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

   248

}

   249

   250

tracking_t* GetNewTracking(FILE* in_file) {

   251

  tracking_t* new_env = new tracking_t;

   252

  new_env->eof = 0;

   253

  new_env->lineNumber = 0;

   254

  new_env->currentChar = 0;

   255

  new_env->lineLength = 0;

   256

  new_env->currentTokenStart = 0;

   257

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

   258

  new_env->in_file = in_file;

   259

  return new_env;

   260

}

   261

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

   273

   274

int stage2__(const char *filename, 

   275

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

   276

             symbol_c **tree_root_ref,

   277

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

   278

            );

   279

   280

   281

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

   282

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

   283

       *       automatically as needed

   284

       */

   285

   286

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

   287

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

   288

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

   289

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

   290

       *       We now set those variables...

   291

       */

   292

  safe_extensions_ = options.safe_extensions;

   293

   294

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

   295

}

   296