Subversion Repositories HelenOS-historic

Rev

Rev 788 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
510 jermar 1
/*
2
 * Copyright (C) 2005 Jakub Jermar
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1702 cejka 29
 /** @addtogroup genericconsole
30
 * @{
31
 */
32
/** @file
33
 */
34
 
510 jermar 35
#ifndef __KCONSOLE_H__
36
#define __KCONSOLE_H__
37
 
517 jermar 38
#include <typedefs.h>
788 jermar 39
#include <adt/list.h>
517 jermar 40
#include <synch/spinlock.h>
41
 
596 jermar 42
#define MAX_CMDLINE     256
601 palkovsky 43
#define KCONSOLE_HISTORY 10
596 jermar 44
 
517 jermar 45
enum cmd_arg_type {
46
    ARG_TYPE_INVALID = 0,
47
    ARG_TYPE_INT,
585 palkovsky 48
    ARG_TYPE_STRING,
49
    ARG_TYPE_VAR      /**< Variable type - either symbol or string */
517 jermar 50
};
51
 
52
/** Structure representing one argument of kconsole command line. */
53
struct cmd_arg {
54
    cmd_arg_type_t type;        /**< Type descriptor. */
55
    void *buffer;           /**< Buffer where to store data. */
518 jermar 56
    size_t len;         /**< Size of the buffer. */
582 palkovsky 57
    __native intval;                /**< Integer value */
585 palkovsky 58
    cmd_arg_type_t vartype;         /**< Resulting type of variable arg */
517 jermar 59
};
60
 
61
/** Structure representing one kconsole command. */
62
struct cmd_info {
63
    link_t link;            /**< Command list link. */
623 jermar 64
    SPINLOCK_DECLARE(lock);     /**< This lock protects everything below. */
517 jermar 65
    const char *name;       /**< Command name. */
66
    const char *description;    /**< Textual description. */
518 jermar 67
    int (* func)(cmd_arg_t *);  /**< Function implementing the command. */
517 jermar 68
    count_t argc;           /**< Number of arguments. */
69
    cmd_arg_t *argv;        /**< Argument vector. */
518 jermar 70
    void (* help)(void);        /**< Function for printing detailed help. */
517 jermar 71
};
72
 
73
extern spinlock_t cmd_lock;
74
extern link_t cmd_head;
75
 
76
extern void kconsole_init(void);
609 palkovsky 77
extern void kconsole(void *prompt);
510 jermar 78
 
517 jermar 79
extern int cmd_register(cmd_info_t *cmd);
80
 
510 jermar 81
#endif
1702 cejka 82
 
83
 /** @}
84
 */
85