206 lines
7.0 KiB
C
206 lines
7.0 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* SPDX-FileCopyrightText: Copyright (c) 2013-2016 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.
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
#include "genhdr/mpversion.h"
|
|
#include "py/builtin.h"
|
|
#include "py/mpconfig.h"
|
|
#include "py/objmodule.h"
|
|
|
|
#if MICROPY_PY_BUILTINS_HELP
|
|
|
|
const char mp_help_default_text[] =
|
|
"Welcome to MicroPython!\n"
|
|
"\n"
|
|
"For online docs please visit http://docs.micropython.org/\n"
|
|
"\n"
|
|
"Control commands:\n"
|
|
" CTRL-A -- on a blank line, enter raw REPL mode\n"
|
|
" CTRL-B -- on a blank line, enter normal REPL mode\n"
|
|
" CTRL-C -- interrupt a running program\n"
|
|
" CTRL-D -- on a blank line, exit or do a soft reset\n"
|
|
" CTRL-E -- on a blank line, enter paste mode\n"
|
|
"\n"
|
|
"For further help on a specific object, type help(obj)\n"
|
|
;
|
|
|
|
STATIC void mp_help_print_info_about_object(mp_obj_t name_o, mp_obj_t value) {
|
|
mp_print_str(MP_PYTHON_PRINTER, " ");
|
|
mp_obj_print(name_o, PRINT_STR);
|
|
mp_print_str(MP_PYTHON_PRINTER, " -- ");
|
|
mp_obj_print(value, PRINT_STR);
|
|
mp_print_str(MP_PYTHON_PRINTER, "\n");
|
|
}
|
|
|
|
#if MICROPY_PY_BUILTINS_HELP_MODULES
|
|
STATIC void mp_help_add_from_map(mp_obj_t list, const mp_map_t *map) {
|
|
for (size_t i = 0; i < map->alloc; i++) {
|
|
if (MP_MAP_SLOT_IS_FILLED(map, i)) {
|
|
mp_obj_list_append(list, map->table[i].key);
|
|
}
|
|
}
|
|
}
|
|
|
|
#if MICROPY_MODULE_FROZEN
|
|
STATIC void mp_help_add_from_names(mp_obj_t list, const char *name) {
|
|
while (*name) {
|
|
size_t l = strlen(name);
|
|
// name should end in '.py' and we strip it off
|
|
mp_obj_list_append(list, mp_obj_new_str(name, l - 3));
|
|
name += l + 1;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
// These externs were originally declared inside mp_help_print_modules(),
|
|
// but they triggered -Wnested-externs, so they were moved outside.
|
|
#if MICROPY_MODULE_FROZEN_STR
|
|
extern const char mp_frozen_str_names[];
|
|
#endif
|
|
|
|
#if MICROPY_MODULE_FROZEN_MPY
|
|
extern const char mp_frozen_mpy_names[];
|
|
#endif
|
|
|
|
STATIC void mp_help_print_modules(void) {
|
|
mp_obj_t list = mp_obj_new_list(0, NULL);
|
|
|
|
mp_help_add_from_map(list, &mp_builtin_module_map);
|
|
|
|
#if MICROPY_MODULE_WEAK_LINKS
|
|
mp_help_add_from_map(list, &mp_builtin_module_weak_links_map);
|
|
#endif
|
|
|
|
#if MICROPY_MODULE_FROZEN_STR
|
|
mp_help_add_from_names(list, mp_frozen_str_names);
|
|
#endif
|
|
|
|
#if MICROPY_MODULE_FROZEN_MPY
|
|
mp_help_add_from_names(list, mp_frozen_mpy_names);
|
|
#endif
|
|
|
|
// sort the list so it's printed in alphabetical order
|
|
mp_obj_list_sort(1, &list, (mp_map_t *)&mp_const_empty_map);
|
|
|
|
// print the list of modules in a column-first order
|
|
#define NUM_COLUMNS (4)
|
|
#define COLUMN_WIDTH (18)
|
|
size_t len;
|
|
mp_obj_t *items;
|
|
mp_obj_list_get(list, &len, &items);
|
|
unsigned int num_rows = (len + NUM_COLUMNS - 1) / NUM_COLUMNS;
|
|
for (unsigned int i = 0; i < num_rows; ++i) {
|
|
unsigned int j = i;
|
|
for (;;) {
|
|
int l = mp_print_str(MP_PYTHON_PRINTER, mp_obj_str_get_str(items[j]));
|
|
j += num_rows;
|
|
if (j >= len) {
|
|
break;
|
|
}
|
|
int gap = COLUMN_WIDTH - l;
|
|
while (gap < 1) {
|
|
gap += COLUMN_WIDTH;
|
|
}
|
|
while (gap--) {
|
|
mp_print_str(MP_PYTHON_PRINTER, " ");
|
|
}
|
|
}
|
|
mp_print_str(MP_PYTHON_PRINTER, "\n");
|
|
}
|
|
|
|
// let the user know there may be other modules available from the filesystem
|
|
const compressed_string_t *compressed = translate("Plus any modules on the filesystem\n");
|
|
char decompressed[decompress_length(compressed)];
|
|
decompress(compressed, decompressed);
|
|
mp_print_str(MP_PYTHON_PRINTER, decompressed);
|
|
}
|
|
#endif
|
|
|
|
STATIC void mp_help_print_obj(const mp_obj_t obj) {
|
|
#if MICROPY_PY_BUILTINS_HELP_MODULES
|
|
if (obj == MP_OBJ_NEW_QSTR(MP_QSTR_modules)) {
|
|
mp_help_print_modules();
|
|
return;
|
|
}
|
|
#endif
|
|
|
|
mp_obj_type_t *type = mp_obj_get_type(obj);
|
|
|
|
// try to print something sensible about the given object
|
|
const compressed_string_t *compressed = translate("object ");
|
|
char decompressed_object[decompress_length(compressed)];
|
|
decompress(compressed, decompressed_object);
|
|
|
|
mp_print_str(MP_PYTHON_PRINTER, decompressed_object);
|
|
mp_obj_print(obj, PRINT_STR);
|
|
|
|
compressed = translate(" is of type %q\n");
|
|
char decompressed_typestring[decompress_length(compressed)];
|
|
decompress(compressed, decompressed_typestring);
|
|
|
|
mp_printf(MP_PYTHON_PRINTER, decompressed_typestring, type->name);
|
|
|
|
mp_map_t *map = NULL;
|
|
if (type == &mp_type_module) {
|
|
map = &mp_obj_module_get_globals(obj)->map;
|
|
} else {
|
|
if (type == &mp_type_type) {
|
|
type = MP_OBJ_TO_PTR(obj);
|
|
}
|
|
if (type->locals_dict != NULL) {
|
|
map = &type->locals_dict->map;
|
|
}
|
|
}
|
|
if (map != NULL) {
|
|
for (uint i = 0; i < map->alloc; i++) {
|
|
if (map->table[i].key != MP_OBJ_NULL) {
|
|
mp_help_print_info_about_object(map->table[i].key, map->table[i].value);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
STATIC mp_obj_t mp_builtin_help(size_t n_args, const mp_obj_t *args) {
|
|
if (n_args == 0) {
|
|
// print a general help message. Translate only works on single strings on one line.
|
|
const compressed_string_t *compressed =
|
|
translate("Welcome to Adafruit CircuitPython %s!\n\nPlease visit learn.adafruit.com/category/circuitpython for project guides.\n\nTo list built-in modules please do `help(\"modules\")`.\n");
|
|
char decompressed[decompress_length(compressed)];
|
|
decompress(compressed, decompressed);
|
|
mp_printf(MP_PYTHON_PRINTER, decompressed, MICROPY_GIT_TAG);
|
|
} else {
|
|
// try to print something sensible about the given object
|
|
mp_help_print_obj(args[0]);
|
|
}
|
|
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_help_obj, 0, 1, mp_builtin_help);
|
|
|
|
#endif // MICROPY_PY_BUILTINS_HELP
|