summaryrefslogtreecommitdiffstatshomepage
path: root/lib/utils/pyhelp.c
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2017-01-22 10:31:52 +1100
committerDamien George <damien.p.george@gmail.com>2017-01-22 11:56:16 +1100
commit895807137e508f8d1fe36c07ebd8dda657d83948 (patch)
treef06e974af951fbf14edfecf6cd1c3e9f21416182 /lib/utils/pyhelp.c
parent77e0cee49ec182b95cefc7a00a1c96b5db278cb2 (diff)
downloadmicropython-895807137e508f8d1fe36c07ebd8dda657d83948.tar.gz
micropython-895807137e508f8d1fe36c07ebd8dda657d83948.zip
lib/utils: Remove old pyhelp helper, replaced with py/builtinhelp.c.
Ports should no longer use pyhelp_print_obj but instead should define MICROPY_PY_BUILTINS_HELP to 1 and then specify their help text using MICROPY_PY_BUILTINS_HELP_TEXT.
Diffstat (limited to 'lib/utils/pyhelp.c')
-rw-r--r--lib/utils/pyhelp.c85
1 files changed, 0 insertions, 85 deletions
diff --git a/lib/utils/pyhelp.c b/lib/utils/pyhelp.c
deleted file mode 100644
index 30ff391c4b..0000000000
--- a/lib/utils/pyhelp.c
+++ /dev/null
@@ -1,85 +0,0 @@
-/*
- * This file is part of the MicroPython project, http://micropython.org/
- *
- * The MIT License (MIT)
- *
- * 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 "lib/utils/pyhelp.h"
-
-STATIC void pyhelp_print_info_about_object(mp_obj_t name_o, mp_obj_t value) {
- mp_printf(MP_PYTHON_PRINTER, " ");
- mp_obj_print(name_o, PRINT_STR);
- mp_printf(MP_PYTHON_PRINTER, " -- ");
- mp_obj_print(value, PRINT_STR);
- mp_printf(MP_PYTHON_PRINTER, "\n");
-}
-
-// Helper for 1-argument form of builtin help
-//
-// Typically a port will define a help function thus:
-//
-// STATIC const char *const myport_help_text =
-// "Welcome to MicroPython!\n"
-// "\n"
-// "...information specific to this port e.g. modules available...";
-//
-// STATIC mp_obj_t myport_help(mp_uint_t n_args, const mp_obj_t *args) {
-// if (n_args == 0) {
-// printf("%s", myport_help_text);
-// } else {
-// pyhelp_print_obj(args[0]);
-// }
-// return mp_const_none;
-// }
-// MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_help_obj, 0, 1, myport_help);
-//
-void pyhelp_print_obj(const mp_obj_t obj) {
- // try to print something sensible about the given object
- mp_printf(MP_PYTHON_PRINTER, "object ");
- mp_obj_print(obj, PRINT_STR);
- mp_printf(MP_PYTHON_PRINTER, " is of type %s\n", mp_obj_get_type_str(obj));
-
- mp_map_t *map = NULL;
- if (MP_OBJ_IS_TYPE(obj, &mp_type_module)) {
- map = mp_obj_dict_get_map(mp_obj_module_get_globals(obj));
- } else {
- mp_obj_type_t *type;
- if (MP_OBJ_IS_TYPE(obj, &mp_type_type)) {
- type = obj;
- } else {
- type = mp_obj_get_type(obj);
- }
- if (type->locals_dict != MP_OBJ_NULL && MP_OBJ_IS_TYPE(type->locals_dict, &mp_type_dict)) {
- map = mp_obj_dict_get_map(type->locals_dict);
- }
- }
- if (map != NULL) {
- for (uint i = 0; i < map->alloc; i++) {
- if (map->table[i].key != MP_OBJ_NULL) {
- pyhelp_print_info_about_object(map->table[i].key, map->table[i].value);
- }
- }
- }
-}