1

/*

     2

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

     3

 *

     4

 *  Copyright (C) 2003-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

/* Decomposes a variable instance name into its constituents,

    35

 * example:

    36

 *    window.points[1].coordinate.x

    37

 *

    38

 *  will succesfully return

    39

 *        - window

    40

 *        - points

    41

 *        - coordinate

    42

 *        - x

    43

 * on succesive calls to decompose_var_instance_name_c::next_part()

    44

 */

    45

    46

    47

    48

#include "decompose_var_instance_name.hh"

    49

    50

decompose_var_instance_name_c::decompose_var_instance_name_c(symbol_c *variable_instance_name) {

    51

  variable_name = variable_instance_name;

    52

  next_variable_name = NULL;

    53

  current_recursive_variable_name = NULL;

    54

  previously_returned_variable_name = NULL;

    55

}

    56

    57

symbol_c *decompose_var_instance_name_c::next_part(bool increment) {

    58

  /* We must always start from the top!

    59

   * See note in the structured_variable_c visitor

    60

   * to understand why...

    61

   */

    62

  symbol_c *res = (symbol_c *)variable_name->accept(*this);

    63

  if (increment)

    64

    next_variable_name = current_recursive_variable_name;

    65

    66

  if (previously_returned_variable_name == res)

    67

	  return NULL;

    68

  if (increment)

    69

    previously_returned_variable_name = res;

    70

  return res;

    71

}

    72

    73

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

    74

/* B.1 - Common elements */

    75

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

    76

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

    77

/* B 1.1 - Letters, digits and identifiers */

    78

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

    79

/* sometimes (e.g. FB calls) the name of the variable is stored directly in an identifier_c object */

    80

void *decompose_var_instance_name_c::visit(identifier_c *symbol) {return (void *)symbol;}

    81

    82

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

    83

/* B 1.4 - Variables */

    84

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

    85

void *decompose_var_instance_name_c::visit(symbolic_variable_c *symbol) {return (void *)(symbol->var_name);}

    86

    87

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

    88

/* B.1.4.1   Directly Represented Variables */

    89

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

    90

void *decompose_var_instance_name_c::visit(direct_variable_c *symbol) {return (void *)symbol;}

    91

    92

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

    93

/* B.1.4.2   Multi-element Variables */

    94

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

    95

/*  subscripted_variable '[' subscript_list ']' */

    96

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

    97

void *decompose_var_instance_name_c::visit(array_variable_c *symbol) {

    98

  /* NOTE: the subscripted_variable may itself be a structure!,

    99

   * so we must recursevily visit!

   100

   */

   101

  return symbol->subscripted_variable->accept(*this);

   102

}

   103

   104

/*  record_variable '.' field_selector */

   105

/*  WARNING: input and/or output variables of function blocks

   106

 *           may be accessed as fields of a tructured variable!

   107

 *           Code handling a structured_variable_c must take

   108

 *           this into account!

   109

 */

   110

//SYM_REF2(structured_variable_c, record_variable, field_selector)

   111

void *decompose_var_instance_name_c::visit(structured_variable_c *symbol) {

   112

  /* NOTE: The following code will not work, as structured_variable_c

   113

   *       are grouped on the left, and not on the right!

   114

   *

   115

   *       example: window.origin.x

   116

   *       will result in

   117

   *       s1 = structured_variable_c("window, "origin");

   118

   *       s2 = structured_variable_c(s1, "x");

   119

   *       AND NOT

   120

   *       s1 = structured_variable_c("origin", "x");

   121

   *       s2 = structured_variable_c("window", s1);

   122

   *

   123

   *       as the following code assumes!!

   124

   *

   125

  current_variable_name = symbol->field_selector;

   126

  return symbol->record_variable->accept(*this);

   127

   */

   128

   129

  /* The correct code, is therefore more complex... */

   130

  if (next_variable_name == symbol) {

   131

    /* NOTE: field_selector is always an identifier_c,

   132

     * so we do not have to recursevily visit it again...

   133

     * return (void *)symbol->field_selector->accept(*this);  -> NOT REQUIRED!!

   134

     */

   135

	 return (void *)symbol->field_selector;

   136

  }

   137

   138

  current_recursive_variable_name = symbol;

   139

  return symbol->record_variable->accept(*this);

   140

}

   141

   142

   143

   144