mirror of
https://github.com/licsber/micropython.git
synced 2024-09-20 09:00:23 +08:00
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
80 lines
2.7 KiB
C
80 lines
2.7 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_QSTR_H
|
|
#define MICROPY_INCLUDED_PY_QSTR_H
|
|
|
|
#include "py/mpconfig.h"
|
|
#include "py/misc.h"
|
|
|
|
// See qstrdefs.h for a list of qstr's that are available as constants.
|
|
// Reference them as MP_QSTR_xxxx.
|
|
//
|
|
// Note: it would be possible to define MP_QSTR_xxx as qstr_from_str_static("xxx")
|
|
// for qstrs that are referenced this way, but you don't want to have them in ROM.
|
|
|
|
// first entry in enum will be MP_QSTR_NULL=0, which indicates invalid/no qstr
|
|
enum {
|
|
#ifndef NO_QSTR
|
|
#define QDEF(id, str) id,
|
|
#include "genhdr/qstrdefs.generated.h"
|
|
#undef QDEF
|
|
#endif
|
|
MP_QSTRnumber_of, // no underscore so it can't clash with any of the above
|
|
};
|
|
|
|
typedef size_t qstr;
|
|
|
|
typedef struct _qstr_pool_t {
|
|
struct _qstr_pool_t *prev;
|
|
size_t total_prev_len;
|
|
size_t alloc;
|
|
size_t len;
|
|
const byte *qstrs[];
|
|
} qstr_pool_t;
|
|
|
|
#define QSTR_FROM_STR_STATIC(s) (qstr_from_strn((s), strlen(s)))
|
|
|
|
void qstr_init(void);
|
|
|
|
mp_uint_t qstr_compute_hash(const byte *data, size_t len);
|
|
qstr qstr_find_strn(const char *str, size_t str_len); // returns MP_QSTR_NULL if not found
|
|
|
|
qstr qstr_from_str(const char *str);
|
|
qstr qstr_from_strn(const char *str, size_t len);
|
|
|
|
byte *qstr_build_start(size_t len, byte **q_ptr);
|
|
qstr qstr_build_end(byte *q_ptr);
|
|
|
|
mp_uint_t qstr_hash(qstr q);
|
|
const char *qstr_str(qstr q);
|
|
size_t qstr_len(qstr q);
|
|
const byte *qstr_data(qstr q, size_t *len);
|
|
|
|
void qstr_pool_info(size_t *n_pool, size_t *n_qstr, size_t *n_str_data_bytes, size_t *n_total_bytes);
|
|
void qstr_dump_data(void);
|
|
|
|
#endif // MICROPY_INCLUDED_PY_QSTR_H
|