LCOV - code coverage report
Current view: top level - py - scope.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.19.1-724-gfb7d21153.info Lines: 61 61 100.0 %
Date: 2022-12-01 09:37:31 Functions: 7 7 100.0 %
Branches: 29 34 85.3 %

           Branch data     Line data    Source code
       1                 :            : /*
       2                 :            :  * This file is part of the MicroPython project, http://micropython.org/
       3                 :            :  *
       4                 :            :  * The MIT License (MIT)
       5                 :            :  *
       6                 :            :  * Copyright (c) 2013, 2014 Damien P. George
       7                 :            :  *
       8                 :            :  * Permission is hereby granted, free of charge, to any person obtaining a copy
       9                 :            :  * of this software and associated documentation files (the "Software"), to deal
      10                 :            :  * in the Software without restriction, including without limitation the rights
      11                 :            :  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      12                 :            :  * copies of the Software, and to permit persons to whom the Software is
      13                 :            :  * furnished to do so, subject to the following conditions:
      14                 :            :  *
      15                 :            :  * The above copyright notice and this permission notice shall be included in
      16                 :            :  * all copies or substantial portions of the Software.
      17                 :            :  *
      18                 :            :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      19                 :            :  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      20                 :            :  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      21                 :            :  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      22                 :            :  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      23                 :            :  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      24                 :            :  * THE SOFTWARE.
      25                 :            :  */
      26                 :            : 
      27                 :            : #include <assert.h>
      28                 :            : 
      29                 :            : #include "py/scope.h"
      30                 :            : 
      31                 :            : #if MICROPY_ENABLE_COMPILER
      32                 :            : 
      33                 :            : // These low numbered qstrs should fit in 8 bits.  See assertions below.
      34                 :            : STATIC const uint8_t scope_simple_name_table[] = {
      35                 :            :     [SCOPE_MODULE] = MP_QSTR__lt_module_gt_,
      36                 :            :     [SCOPE_LAMBDA] = MP_QSTR__lt_lambda_gt_,
      37                 :            :     [SCOPE_LIST_COMP] = MP_QSTR__lt_listcomp_gt_,
      38                 :            :     [SCOPE_DICT_COMP] = MP_QSTR__lt_dictcomp_gt_,
      39                 :            :     [SCOPE_SET_COMP] = MP_QSTR__lt_setcomp_gt_,
      40                 :            :     [SCOPE_GEN_EXPR] = MP_QSTR__lt_genexpr_gt_,
      41                 :            : };
      42                 :            : 
      43                 :       9114 : scope_t *scope_new(scope_kind_t kind, mp_parse_node_t pn, mp_uint_t emit_options) {
      44                 :            :     // Make sure those qstrs indeed fit in an uint8_t.
      45                 :       9114 :     MP_STATIC_ASSERT(MP_QSTR__lt_module_gt_ <= UINT8_MAX);
      46                 :       9114 :     MP_STATIC_ASSERT(MP_QSTR__lt_lambda_gt_ <= UINT8_MAX);
      47                 :       9114 :     MP_STATIC_ASSERT(MP_QSTR__lt_listcomp_gt_ <= UINT8_MAX);
      48                 :       9114 :     MP_STATIC_ASSERT(MP_QSTR__lt_dictcomp_gt_ <= UINT8_MAX);
      49                 :       9114 :     MP_STATIC_ASSERT(MP_QSTR__lt_setcomp_gt_ <= UINT8_MAX);
      50                 :       9114 :     MP_STATIC_ASSERT(MP_QSTR__lt_genexpr_gt_ <= UINT8_MAX);
      51                 :            : 
      52                 :       9114 :     scope_t *scope = m_new0(scope_t, 1);
      53                 :       9114 :     scope->kind = kind;
      54                 :       9114 :     scope->pn = pn;
      55         [ +  + ]:       9114 :     if (kind == SCOPE_FUNCTION || kind == SCOPE_CLASS) {
      56   [ +  -  -  + ]:       5220 :         assert(MP_PARSE_NODE_IS_STRUCT(pn));
      57                 :       5220 :         scope->simple_name = MP_PARSE_NODE_LEAF_ARG(((mp_parse_node_struct_t *)pn)->nodes[0]);
      58                 :            :     } else {
      59                 :       3894 :         scope->simple_name = scope_simple_name_table[kind];
      60                 :            :     }
      61                 :       9114 :     scope->raw_code = mp_emit_glue_new_raw_code();
      62                 :       9114 :     scope->emit_options = emit_options;
      63                 :       9114 :     scope->id_info_alloc = MICROPY_ALLOC_SCOPE_ID_INIT;
      64                 :       9114 :     scope->id_info = m_new(id_info_t, scope->id_info_alloc);
      65                 :            : 
      66                 :       9114 :     return scope;
      67                 :            : }
      68                 :            : 
      69                 :       9076 : void scope_free(scope_t *scope) {
      70                 :       9076 :     m_del(id_info_t, scope->id_info, scope->id_info_alloc);
      71                 :       9076 :     m_del(scope_t, scope, 1);
      72                 :       9076 : }
      73                 :            : 
      74                 :      98727 : id_info_t *scope_find_or_add_id(scope_t *scope, qstr qst, id_info_kind_t kind) {
      75                 :      98727 :     id_info_t *id_info = scope_find(scope, qst);
      76         [ +  + ]:      98727 :     if (id_info != NULL) {
      77                 :            :         return id_info;
      78                 :            :     }
      79                 :            : 
      80                 :            :     // make sure we have enough memory
      81         [ +  + ]:      36176 :     if (scope->id_info_len >= scope->id_info_alloc) {
      82                 :       3601 :         scope->id_info = m_renew(id_info_t, scope->id_info, scope->id_info_alloc, scope->id_info_alloc + MICROPY_ALLOC_SCOPE_ID_INC);
      83                 :       3601 :         scope->id_info_alloc += MICROPY_ALLOC_SCOPE_ID_INC;
      84                 :            :     }
      85                 :            : 
      86                 :            :     // add new id to end of array of all ids; this seems to match CPython
      87                 :            :     // important thing is that function arguments are first, but that is
      88                 :            :     // handled by the compiler because it adds arguments before compiling the body
      89                 :      36176 :     id_info = &scope->id_info[scope->id_info_len++];
      90                 :            : 
      91                 :      36176 :     id_info->kind = kind;
      92                 :      36176 :     id_info->flags = 0;
      93                 :      36176 :     id_info->local_num = 0;
      94                 :      36176 :     id_info->qst = qst;
      95                 :      36176 :     return id_info;
      96                 :            : }
      97                 :            : 
      98                 :     500857 : id_info_t *scope_find(scope_t *scope, qstr qst) {
      99         [ +  + ]:    2138750 :     for (mp_uint_t i = 0; i < scope->id_info_len; i++) {
     100         [ +  + ]:    2100293 :         if (scope->id_info[i].qst == qst) {
     101                 :            :             return &scope->id_info[i];
     102                 :            :         }
     103                 :            :     }
     104                 :            :     return NULL;
     105                 :            : }
     106                 :            : 
     107                 :        310 : id_info_t *scope_find_global(scope_t *scope, qstr qst) {
     108         [ +  + ]:        724 :     while (scope->parent != NULL) {
     109                 :            :         scope = scope->parent;
     110                 :            :     }
     111                 :        310 :     return scope_find(scope, qst);
     112                 :            : }
     113                 :            : 
     114                 :        179 : STATIC void scope_close_over_in_parents(scope_t *scope, qstr qst) {
     115         [ -  + ]:        179 :     assert(scope->parent != NULL); // we should have at least 1 parent
     116                 :         13 :     for (scope_t *s = scope->parent;; s = s->parent) {
     117         [ -  + ]:        192 :         assert(s->parent != NULL); // we should not get to the outer scope
     118                 :        192 :         id_info_t *id = scope_find_or_add_id(s, qst, ID_INFO_KIND_UNDECIDED);
     119         [ +  + ]:        192 :         if (id->kind == ID_INFO_KIND_UNDECIDED) {
     120                 :            :             // variable not previously declared in this scope, so declare it as free and keep searching parents
     121                 :         13 :             id->kind = ID_INFO_KIND_FREE;
     122                 :            :         } else {
     123                 :            :             // variable is declared in this scope, so finish
     124         [ +  + ]:        179 :             if (id->kind == ID_INFO_KIND_LOCAL) {
     125                 :            :                 // variable local to this scope, close it over
     126                 :        159 :                 id->kind = ID_INFO_KIND_CELL;
     127                 :            :             } else {
     128                 :            :                 // ID_INFO_KIND_FREE: variable already closed over in a parent scope
     129                 :            :                 // ID_INFO_KIND_CELL: variable already closed over in this scope
     130         [ -  + ]:         20 :                 assert(id->kind == ID_INFO_KIND_FREE || id->kind == ID_INFO_KIND_CELL);
     131                 :            :             }
     132                 :        179 :             return;
     133                 :            :         }
     134                 :            :     }
     135                 :            : }
     136                 :            : 
     137                 :      14873 : void scope_check_to_close_over(scope_t *scope, id_info_t *id) {
     138         [ +  + ]:      14873 :     if (scope->parent != NULL) {
     139         [ +  + ]:       9657 :         for (scope_t *s = scope->parent; s->parent != NULL; s = s->parent) {
     140                 :       2518 :             id_info_t *id2 = scope_find(s, id->qst);
     141         [ +  + ]:       2518 :             if (id2 != NULL) {
     142         [ +  + ]:        403 :                 if (id2->kind == ID_INFO_KIND_LOCAL || id2->kind == ID_INFO_KIND_CELL || id2->kind == ID_INFO_KIND_FREE) {
     143                 :        179 :                     id->kind = ID_INFO_KIND_FREE;
     144                 :        179 :                     scope_close_over_in_parents(scope, id->qst);
     145                 :            :                 }
     146                 :            :                 break;
     147                 :            :             }
     148                 :            :         }
     149                 :            :     }
     150                 :      14873 : }
     151                 :            : 
     152                 :            : #endif // MICROPY_ENABLE_COMPILER

Generated by: LCOV version 1.15-5-g462f71d