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

    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 some utility functions (strdupX() ) that are both used

    56

 * in the lexical and syntax analysers.

    57

 */

    58

    59

    60

    61

    62

    63

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

    64

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

    65

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

    66

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

    67

void print_include_stack(void);

    68

    69

    70

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

    71

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

    72

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

    73

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

    74

 * Note that flex accesses and updates this global variable

    75

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

    76

 * directive...

    77

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

    78

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

    79

 * file being parsed.

    80

 */

    81

extern const char *current_filename;

    82

    83

#define MAX_BUFFER_LENGTH 1000

    84

    85

typedef struct {

    86

    int eof;

    87

    int lineNumber;

    88

    int currentChar;

    89

    int lineLength;

    90

    int currentTokenStart;

    91

    char* buffer;

    92

    FILE *in_file;

    93

  } tracking_t;

    94

    95

int GetNextChar(char *b, int maxBuffer);

    96

tracking_t* GetNewTracking(FILE* in_file);

    97

    98

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

    99

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

   100

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

   101

void cmd_goto_body_state(void);

   102

int  get_goto_body_state(void);

   103

void rst_goto_body_state(void);

   104

   105

   106

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

   107

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

   108

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

   109

void cmd_goto_sfc_qualifier_state(void);

   110

int  get_goto_sfc_qualifier_state(void);

   111

void rst_goto_sfc_qualifier_state(void);

   112

   113

   114

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

   115

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

   116

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

   117

void cmd_goto_sfc_priority_state(void);

   118

int  get_goto_sfc_priority_state(void);

   119

void rst_goto_sfc_priority_state(void);

   120

   121

   122

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

   123

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

   124

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

   125

void cmd_goto_task_init_state(void);

   126

int  get_goto_task_init_state(void);

   127

void rst_goto_task_init_state(void);

   128

   129

   130

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

   131

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

   132

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

   133

void cmd_pop_state(void);

   134

int  get_pop_state(void);

   135

void rst_pop_state(void);

   136

   137

   138

   139

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

   140

/* The global symbol tables...   */

   141

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

   142

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

   143

 *       through the function get_identifier_token()

   144

 */

   145

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

   146

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

   147

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

   148

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

   149

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

   150

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

   151

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

   152

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

   153

 */ 

   154

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

   155

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

   156

 *       <fb_name , fb_decl>

   157

 *       <type_name , type_decl>

   158

 *       <program_name , program_decl>

   159

 *       <configuration_name , configuration_decl>

   160

 */

   161

extern symtable_c<int, BOGUS_TOKEN_ID> library_element_symtable;

   162

   163

/* A symbol table to store the declared variables of

   164

 * the function currently being parsed...

   165

 */

   166

extern symtable_c<int, BOGUS_TOKEN_ID> variable_name_symtable;

   167

   168

/* Function only called from within flex!

   169

 *

   170

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

   171

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

   172

 * symbol found.

   173

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

   174

 * does it continue searching in the library elements

   175

 */

   176

int get_identifier_token(const char *identifier_str);

   177

   178

   179

   180

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

   181

/* Utility Functions... */

   182

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

   183

   184

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

   185

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

   186

   187

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

   188

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

   189

   190

   191