1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2009-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 is the main stage 3a file.

    36

 *

    37

 * In stage 3a some helpful symbol tables are instanciated and populated.

    38

 * These symbol tables wll then be used by stage3b and atage4 code generators.

    39

 */

    40

    41

    42

    43

    44

#ifndef _SEARCH_UTILS_HH

    45

#define _SEARCH_UTILS_HH

    46

    47

// #include <stdio.h>  /* required for NULL */

    48

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

    49

#include "../util/dsymtable.hh"

    50

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

    51

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

    52

    53

    54

    55

/* returns 0 if the names are equal!! Case is ignored. */

    56

int compare_identifiers(symbol_c *ident1, symbol_c *ident2);

    57

    58

/* extract the value of an integer/hex_integer/real from an integer_c/hex_integer_c/real_c symbol !! */

    59

long long extract_integer_value(symbol_c *sym);

    60

uint64_t  extract_hex_value    (symbol_c *sym);

    61

real64_t  extract_real_value   (symbol_c *sym, bool *overflow);

    62

    63

/* A symbol table with all globally declared functions... */

    64

extern function_declaration_c null_symbol1;

    65

typedef dsymtable_c<function_declaration_c *, &null_symbol1> function_symtable_t;

    66

extern function_symtable_t function_symtable;

    67

    68

/* A symbol table with all globally declared functions block types... */

    69

extern function_block_declaration_c null_symbol2;

    70

extern symtable_c<function_block_declaration_c *, &null_symbol2> function_block_type_symtable;

    71

    72

/* A symbol table with all globally declared program types... */

    73

extern program_declaration_c null_symbol3;

    74

extern symtable_c<program_declaration_c *, &null_symbol3> program_type_symtable;

    75

    76

/* A symbol table with all user declared type definitions... */

    77

/* Note that function block types and program types have their

    78

 * own symbol tables, so do not get placed in this symbol table!

    79

 *

    80

 * The symbol_c * associated to the value will point to the data type declaration.

    81

 */

    82

extern symbol_c null_symbol4;

    83

extern symtable_c<symbol_c *, &null_symbol4> type_symtable;

    84

    85

/* A symbol table with all values declared for enumerated type... */

    86

/* Notes:

    87

 * - if the value is defined multiple times the value

    88

 * is the null pointer.

    89

 *

    90

 * - The stored symbol_c * associated to the value points to the enumerated_type_name

    91

 * (i.e. the name of the enumerated data type) in which the the value/identifier

    92

 * is used/declared.

    93

 *

    94

 * - We could re-use the null_symbol4 object, but it is safer to use a distinct object

    95

 *   (i.e. it might make it easier to find strange bugs).

    96

 */

    97

extern symbol_c null_symbol5;

    98

extern symtable_c<symbol_c *, &null_symbol5> enumerated_value_symtable;

    99

   100

   101

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

   102

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

   103

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

   104

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

   105

   106

#include "spec_init_separator.hh"

   107

#include "array_dimension_iterator.hh"

   108

#include "case_element_iterator.hh"

   109

#include "function_param_iterator.hh"

   110

#include "function_call_iterator.hh"

   111

#include "function_call_param_iterator.hh"

   112

#include "type_initial_value.hh"

   113

#include "search_fb_instance_decl.hh"

   114

#include "search_fb_typedecl.hh"

   115

#include "search_base_type.hh"

   116

#include "search_var_instance_decl.hh"

   117

#include "decompose_var_instance_name.hh"

   118

#include "search_varfb_instance_type.hh"

   119

#include "search_constant_type.hh"

   120

#include "search_il_operand_type.hh"

   121

#include "search_expression_type.hh"

   122

#include "add_en_eno_param_decl.hh"

   123

#include "get_sizeof_datatype.hh"

   124

#include "search_il_label.hh"

   125

#include "get_var_name.hh"

   126

   127

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

   128

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

   129

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

   130

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

   131

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

   132

   133

   134

   135

   136

void absyntax_utils_init(symbol_c *tree_root);

   137

   138

   139

#endif /* _SEARCH_UTILS_HH */