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) 2015 Paul Sokolovsky
       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 <stdlib.h>
      28                 :            : 
      29                 :            : #include "py/runtime.h"
      30                 :            : 
      31                 :            : // This is universal iterator type which calls "iternext" method stored in
      32                 :            : // particular object instance. (So, each instance of this time can have its
      33                 :            : // own iteration behavior.) Having this type saves to define type objects
      34                 :            : // for various internal iterator objects.
      35                 :            : 
      36                 :            : // Any instance should have these 2 fields at the beginning
      37                 :            : typedef struct _mp_obj_polymorph_iter_t {
      38                 :            :     mp_obj_base_t base;
      39                 :            :     mp_fun_1_t iternext;
      40                 :            : } mp_obj_polymorph_iter_t;
      41                 :            : 
      42                 :     130285 : static mp_obj_t polymorph_it_iternext(mp_obj_t self_in) {
      43                 :     130285 :     mp_obj_polymorph_iter_t *self = MP_OBJ_TO_PTR(self_in);
      44                 :            :     // Redirect call to object instance's iternext method
      45                 :     130285 :     return self->iternext(self_in);
      46                 :            : }
      47                 :            : 
      48                 :            : MP_DEFINE_CONST_OBJ_TYPE(
      49                 :            :     mp_type_polymorph_iter,
      50                 :            :     MP_QSTR_iterator,
      51                 :            :     MP_TYPE_FLAG_ITER_IS_ITERNEXT,
      52                 :            :     iter, polymorph_it_iternext
      53                 :            :     );
      54                 :            : 
      55                 :            : #if MICROPY_ENABLE_FINALISER
      56                 :            : // mp_type_polymorph_iter_with_finaliser is a variant of the universal iterator
      57                 :            : // above which has a finaliser function attached. This function will be run when
      58                 :            : // the GC collects the iter object and can be used to close file handles etc.
      59                 :            : 
      60                 :            : // Any instance should have these 3 fields at the beginning
      61                 :            : typedef struct _mp_obj_polymorph_iter_with_finaliser_t {
      62                 :            :     mp_obj_base_t base;
      63                 :            :     mp_fun_1_t iternext;
      64                 :            :     mp_fun_1_t finaliser;
      65                 :            : } mp_obj_polymorph_with_finaliser_iter_t;
      66                 :            : 
      67                 :        314 : static mp_obj_t mp_obj_polymorph_iter_del(mp_obj_t self_in) {
      68                 :        314 :     mp_obj_polymorph_with_finaliser_iter_t *self = MP_OBJ_TO_PTR(self_in);
      69                 :            :     // Redirect call to object instance's finaliser method
      70                 :        314 :     return self->finaliser(self_in);
      71                 :            : }
      72                 :            : static MP_DEFINE_CONST_FUN_OBJ_1(mp_obj_polymorph_iter_del_obj, mp_obj_polymorph_iter_del);
      73                 :            : 
      74                 :            : static const mp_rom_map_elem_t mp_obj_polymorph_iter_locals_dict_table[] = {
      75                 :            :     { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&mp_obj_polymorph_iter_del_obj) },
      76                 :            : };
      77                 :            : static MP_DEFINE_CONST_DICT(mp_obj_polymorph_iter_locals_dict, mp_obj_polymorph_iter_locals_dict_table);
      78                 :            : 
      79                 :            : MP_DEFINE_CONST_OBJ_TYPE(
      80                 :            :     mp_type_polymorph_iter_with_finaliser,
      81                 :            :     MP_QSTR_iterator,
      82                 :            :     MP_TYPE_FLAG_ITER_IS_ITERNEXT,
      83                 :            :     iter, polymorph_it_iternext,
      84                 :            :     locals_dict, &mp_obj_polymorph_iter_locals_dict
      85                 :            :     );
      86                 :            : #endif