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

 * The private interface to stage1_2.cc 

    28

 */

    29

    30

    31

    32

/* !!! WARNING !!!

    33

 *

    34

 *       Whoever includes this file (stage1_2_priv.hh) will need

    35

 *       to first inlcude iec.y.hh !!

    36

 *

    37

 *       Read other comments further down to understand why we don't

    38

 *       include iec.y.hh in this file.

    39

 */

    40

    41

    42

    43

/* file with the declarations of symbol tables... */

    44

#include "../util/symtable.hh"

    45

#include "stage1_2.hh"

    46

    47

    48

/*

    49

 * This file includes the interface through which the lexical parser (stage 1 - flex)

    50

 * and the syntax analyser (stage 2 - bison) interact between themselves.

    51

 *

    52

 * This is mostly through direct access to shared global variables, however some

    53

 * of the global variables will only be accessed through some accessor functions.

    54

 *

    55

 * This file also includes the interface between the main stage1_2() functions and 

    56

 * the flex lexical parser.

    57

 *

    58

 * This file also includes some utility functions (strdupX() ) that are both used

    59

 * in the lexical and syntax analysers.

    60

 */

    61

    62

    63

    64

    65

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

    66

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

    67

/****                                                    *****/

    68

/****  I n t e r f a c e    B e t w e e n                *****/

    69

/****           F l e x    a n d     s t a g e 1 _ 2 ()  *****/

    70

/****                                                    *****/

    71

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

    72

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

    73

    74

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

    75

/* whether we are suporting safe extensions           */

    76

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

    77

/* Safety Software Technical Specification,           */

    78

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

    79

/* Version 1.0 – Official Release                     */

    80

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

    81

bool get_opt_safe_extensions();

    82

    83

    84

    85

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

    86

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

    87

/****                                                    *****/

    88

/****  I n t e r f a c e    B e t w e e n                *****/

    89

/****           F l e x    a n d     B i s o n           *****/

    90

/****                                                    *****/

    91

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

    92

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

    93

    94

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

    95

/* print the include file stack to stderr... */

    96

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

    97

/* This is a service that flex provides to bison... */

    98

void print_include_stack(void);

    99

   100

   101

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

   102

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

   103

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

   104

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

   105

 * Note that flex accesses and updates this global variable

   106

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

   107

 * directive...

   108

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

   109

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

   110

 * file being parsed.

   111

 */

   112

extern const char *current_filename;

   113

   114

   115

#define MAX_BUFFER_LENGTH 1000

   116

   117

typedef struct {

   118

    int eof;

   119

    int lineNumber;

   120

    int currentChar;

   121

    int lineLength;

   122

    int currentTokenStart;

   123

    char* buffer;

   124

    FILE *in_file;

   125

  } tracking_t;

   126

   127

int GetNextChar(char *b, int maxBuffer);

   128

tracking_t* GetNewTracking(FILE* in_file);

   129

   130

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

   131

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

   132

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

   133

void cmd_goto_body_state(void);

   134

int  get_goto_body_state(void);

   135

void rst_goto_body_state(void);

   136

   137

   138

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

   139

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

   140

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

   141

void cmd_goto_sfc_qualifier_state(void);

   142

int  get_goto_sfc_qualifier_state(void);

   143

void rst_goto_sfc_qualifier_state(void);

   144

   145

   146

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

   147

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

   148

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

   149

void cmd_goto_sfc_priority_state(void);

   150

int  get_goto_sfc_priority_state(void);

   151

void rst_goto_sfc_priority_state(void);

   152

   153

   154

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

   155

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

   156

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

   157

void cmd_goto_task_init_state(void);

   158

int  get_goto_task_init_state(void);

   159

void rst_goto_task_init_state(void);

   160

   161

   162

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

   163

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

   164

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

   165

void cmd_pop_state(void);

   166

int  get_pop_state(void);

   167

void rst_pop_state(void);

   168

   169

   170

   171

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

   172

/* The global symbol tables...   */

   173

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

   174

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

   175

 *       through the function get_identifier_token()

   176

 *

   177

 *       Bison accesses these data structures directly.

   178

 *

   179

 *       In essence, they are a data passing mechanism between Bison and Flex.

   180

 */

   181

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

   182

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

   183

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

   184

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

   185

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

   186

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

   187

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

   188

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

   189

 */ 

   190

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

   191

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

   192

 *       <fb_name , fb_decl>

   193

 *       <type_name , type_decl>

   194

 *       <program_name , program_decl>

   195

 *       <configuration_name , configuration_decl>

   196

 */

   197

extern symtable_c<int, BOGUS_TOKEN_ID> library_element_symtable;

   198

   199

/* A symbol table to store the declared variables of

   200

 * the function currently being parsed...

   201

 */

   202

extern symtable_c<int, BOGUS_TOKEN_ID> variable_name_symtable;

   203

   204

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

   205

 * the function currently being parsed...

   206

 */

   207

extern symtable_c<int, BOGUS_TOKEN_ID> direct_variable_symtable;

   208

   209

/* Function only called from within flex!

   210

 *

   211

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

   212

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

   213

 * symbol found.

   214

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

   215

 * does it continue searching in the library elements

   216

 */

   217

int get_identifier_token(const char *identifier_str);

   218

   219

/* Function only called from within flex!

   220

 *

   221

 * search for a symbol in direct variables symbol table

   222

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

   223

 * symbol found.

   224

 */

   225

int get_direct_variable_token(const char *direct_variable_str);

   226

   227

   228

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

   229

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

   230

/****                                                    *****/

   231

/****  U t i l i t y   F u n c t i o n s ...             *****/

   232

/****                                                    *****/

   233

/****                                                    *****/

   234

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

   235

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

   236

   237

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

   238

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

   239

   240

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

   241

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

   242

   243

   244