299bc62586
The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_*.h * qstrdefs*.h
98 lines
3.3 KiB
C
98 lines
3.3 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2013, 2014 Damien P. George
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
#ifndef MICROPY_INCLUDED_PY_SCOPE_H
|
|
#define MICROPY_INCLUDED_PY_SCOPE_H
|
|
|
|
#include "py/parse.h"
|
|
#include "py/emitglue.h"
|
|
|
|
enum {
|
|
ID_INFO_KIND_GLOBAL_IMPLICIT,
|
|
ID_INFO_KIND_GLOBAL_EXPLICIT,
|
|
ID_INFO_KIND_LOCAL, // in a function f, written and only referenced by f
|
|
ID_INFO_KIND_CELL, // in a function f, read/written by children of f
|
|
ID_INFO_KIND_FREE, // in a function f, belongs to the parent of f
|
|
};
|
|
|
|
enum {
|
|
ID_FLAG_IS_PARAM = 0x01,
|
|
ID_FLAG_IS_STAR_PARAM = 0x02,
|
|
ID_FLAG_IS_DBL_STAR_PARAM = 0x04,
|
|
};
|
|
|
|
typedef struct _id_info_t {
|
|
uint8_t kind;
|
|
uint8_t flags;
|
|
// when it's an ID_INFO_KIND_LOCAL this is the unique number of the local
|
|
// whet it's an ID_INFO_KIND_CELL/FREE this is the unique number of the closed over variable
|
|
uint16_t local_num;
|
|
qstr qst;
|
|
} id_info_t;
|
|
|
|
#define SCOPE_IS_FUNC_LIKE(s) ((s) >= SCOPE_LAMBDA)
|
|
|
|
// scope is a "block" in Python parlance
|
|
typedef enum {
|
|
SCOPE_MODULE,
|
|
SCOPE_CLASS,
|
|
SCOPE_LAMBDA,
|
|
SCOPE_LIST_COMP,
|
|
SCOPE_DICT_COMP,
|
|
SCOPE_SET_COMP,
|
|
SCOPE_GEN_EXPR,
|
|
SCOPE_FUNCTION,
|
|
} scope_kind_t;
|
|
|
|
typedef struct _scope_t {
|
|
scope_kind_t kind;
|
|
struct _scope_t *parent;
|
|
struct _scope_t *next;
|
|
mp_parse_node_t pn;
|
|
uint16_t source_file; // a qstr
|
|
uint16_t simple_name; // a qstr
|
|
mp_raw_code_t *raw_code;
|
|
uint8_t scope_flags; // see runtime0.h
|
|
uint8_t emit_options; // see compile.h
|
|
uint16_t num_pos_args;
|
|
uint16_t num_kwonly_args;
|
|
uint16_t num_def_pos_args;
|
|
uint16_t num_locals;
|
|
uint16_t stack_size; // maximum size of the locals stack
|
|
uint16_t exc_stack_size; // maximum size of the exception stack
|
|
uint16_t id_info_alloc;
|
|
uint16_t id_info_len;
|
|
id_info_t *id_info;
|
|
} scope_t;
|
|
|
|
scope_t *scope_new(scope_kind_t kind, mp_parse_node_t pn, qstr source_file, mp_uint_t emit_options);
|
|
void scope_free(scope_t *scope);
|
|
id_info_t *scope_find_or_add_id(scope_t *scope, qstr qstr, bool *added);
|
|
id_info_t *scope_find(scope_t *scope, qstr qstr);
|
|
id_info_t *scope_find_global(scope_t *scope, qstr qstr);
|
|
void scope_find_local_and_close_over(scope_t *scope, id_info_t *id, qstr qst);
|
|
|
|
#endif // MICROPY_INCLUDED_PY_SCOPE_H
|