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

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

    72

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

    73

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

    74

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

    75

 * Note that flex accesses and updates this global variable

    76

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

    77

 * directive...

    78

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

    79

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

    80

 * file being parsed.

    81

 */

    82

extern const char *current_filename;

    83

    84

    85

    86

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

    87

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

    88

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

    89

void cmd_goto_body_state(void);

    90

int  get_goto_body_state(void);

    91

void rst_goto_body_state(void);

    92

    93

    94

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

    95

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

    96

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

    97

void cmd_goto_sfc_qualifier_state(void);

    98

int  get_goto_sfc_qualifier_state(void);

    99

void rst_goto_sfc_qualifier_state(void);

   100

   101

   102

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

   103

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

   104

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

   105

void cmd_pop_state(void);

   106

int  get_pop_state(void);

   107

void rst_pop_state(void);

   108

   109

   110

   111

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

   112

/* The global symbol tables...   */

   113

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

   114

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

   115

 *       through the function get_identifier_token()

   116

 */

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

 */ 

   126

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

   127

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

   128

 *       <fb_name , fb_decl>

   129

 *       <type_name , type_decl>

   130

 *       <program_name , program_decl>

   131

 *       <configuration_name , configuration_decl>

   132

 */

   133

extern symtable_c<int, BOGUS_TOKEN_ID> library_element_symtable;

   134

   135

/* A symbol table to store the declared variables of

   136

 * the function currently being parsed...

   137

 */

   138

extern symtable_c<int, BOGUS_TOKEN_ID> variable_name_symtable;

   139

   140

/* Function only called from within flex!

   141

 *

   142

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

   143

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

   144

 * symbol found.

   145

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

   146

 * does it continue searching in the library elements

   147

 */

   148

int get_identifier_token(const char *identifier_str);

   149

   150

   151

   152

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

   153

/* Utility Functions... */

   154

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

   155

   156

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

   157

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

   158

   159

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

   160

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

   161

   162

   163