stage4/generate_c/decompose_var_instance_name.cc
author lbessard
Wed, 24 Oct 2007 17:39:51 +0200
changeset 70 e1f0ebd2d9ec
child 98 d0cdf1d00b74
permissions -rwxr-xr-x
Change generate_cc to generate_c
70
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     1
/*
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     2
 * (c) 2003 Mario de Sousa
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     3
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     4
 * Offered to the public under the terms of the GNU General Public License
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     5
 * as published by the Free Software Foundation; either version 2 of the
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     6
 * License, or (at your option) any later version.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     7
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     8
 * This program is distributed in the hope that it will be useful, but
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     9
 * WITHOUT ANY WARRANTY; without even the implied warranty of
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    11
 * Public License for more details.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    12
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    13
 * This code is made available on the understanding that it will not be
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    14
 * used in safety-critical situations without a full and competent review.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    15
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    16
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    17
/*
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    18
 * An IEC 61131-3 IL and ST compiler.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    19
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    20
 * Based on the
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    21
 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    22
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    23
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    24
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    25
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    26
/* Decomposes a variable instance name into its constituents,
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    27
 * example:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    28
 *    window.points[1].coordinate.x
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    29
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    30
 *  will succesfully return
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    31
 *        - window
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    32
 *        - points
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    33
 *        - coordinate
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    34
 *        - x
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    35
 * on succesive calls to decompose_var_instance_name_c::next_part()
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    36
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    37
class decompose_var_instance_name_c: null_visitor_c {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    38
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    39
  private:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    40
    symbol_c *variable_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    41
    symbol_c *next_variable_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    42
    symbol_c *current_recursive_variable_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    43
    symbol_c *previously_returned_variable_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    44
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    45
  public:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    46
    decompose_var_instance_name_c(symbol_c *variable_instance_name) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    47
      variable_name = variable_instance_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    48
      next_variable_name = NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    49
      current_recursive_variable_name = NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    50
      previously_returned_variable_name = NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    51
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    52
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    53
  public:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    54
    symbol_c *next_part(void) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    55
      /* We must always start from the top!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    56
       * See note in the structured_variable_c visitor
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    57
       * to understand why...
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    58
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    59
      symbol_c *res = (symbol_c *)variable_name->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    60
      next_variable_name = current_recursive_variable_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    61
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    62
      if (previously_returned_variable_name == res)
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    63
        return NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    64
      previously_returned_variable_name = res;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    65
      return res;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    66
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    67
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    68
  public:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    69
/*********************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    70
/* B 1.4 - Variables */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    71
/*********************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    72
    void *visit(symbolic_variable_c *symbol) {return (void *)(symbol->var_name);}
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    73
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    74
/********************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    75
/* B.1.4.1   Directly Represented Variables */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    76
/********************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    77
    void *visit(direct_variable_c *symbol) {return (void *)symbol;}
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    78
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    79
/*************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    80
/* B.1.4.2   Multi-element Variables */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    81
/*************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    82
/*  subscripted_variable '[' subscript_list ']' */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    83
// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    84
    void *visit(array_variable_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    85
      /* NOTE: the subscripted_variable may itself be a structure!,
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    86
       * so we must recursevily visit!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    87
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    88
      return symbol->subscripted_variable->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    89
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    90
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    91
/*  record_variable '.' field_selector */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    92
/*  WARNING: input and/or output variables of function blocks
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    93
 *           may be accessed as fields of a tructured variable!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    94
 *           Code handling a structured_variable_c must take
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    95
 *           this into account!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    96
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    97
//SYM_REF2(structured_variable_c, record_variable, field_selector)
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    98
    void *visit(structured_variable_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    99
      /* NOTE: The following code will not work, as structured_variable_c
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   100
       *       are grouped on the left, and not on the right!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   101
       *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   102
       *       example: window.origin.x
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   103
       *       will result in
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   104
       *       s1 = structured_variable_c("window, "origin");
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   105
       *       s2 = structured_variable_c(s1, "x");
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   106
       *       AND NOT
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   107
       *       s1 = structured_variable_c("origin", "x");
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   108
       *       s2 = structured_variable_c("window", s1);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   109
       *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   110
       *       as the following code assumes!!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   111
       *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   112
      current_variable_name = symbol->field_selector;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   113
      return symbol->record_variable->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   114
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   115
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   116
      /* The correct code, is therefore more complex... */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   117
      if (next_variable_name == symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   118
        /* NOTE: field_selector is always an identifier_c,
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   119
	 * so we do not have to recursevily visit it again...
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   120
	 * return (void *)symbol->field_selector->accept(*this);  -> NOT REQUIRED!!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   121
	 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   122
	return (void *)symbol->field_selector;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   123
      }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   124
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   125
      current_recursive_variable_name = symbol;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   126
      return symbol->record_variable->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   127
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   128
};
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   129
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   130
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   131
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   132