/**************************************************************************** * apps/nshlib/nsh_console.h * * Copyright (C) 2007-2013 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef __APPS_NSHLIB_NSH_CONSOLE_H #define __APPS_NSHLIB_NSH_CONSOLE_H /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include #include #include #include /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* Method access macros */ #define nsh_clone(v) (v)->clone(v) #define nsh_release(v) (v)->release(v) #define nsh_write(v,b,n) (v)->write(v,b,n) #define nsh_linebuffer(v) (v)->linebuffer(v) #define nsh_redirect(v,f,s) (v)->redirect(v,f,s) #define nsh_undirect(v,s) (v)->undirect(v,s) #define nsh_exit(v,s) (v)->exit(v,s) #ifdef CONFIG_CPP_HAVE_VARARGS # define nsh_error(v, ...) (v)->error(v, ##__VA_ARGS__) # define nsh_output(v, ...) (v)->output(v, ##__VA_ARGS__) #else # define nsh_error vtbl->error # define nsh_output vtbl->output #endif /* Size of info to be saved in call to nsh_redirect */ /* See struct serialsave_s in nsh_console.c */ #define SAVE_SIZE (2 * sizeof(int) + 2 * sizeof(FILE*)) /* Are we using the NuttX console for I/O? Or some other character device? */ #if CONFIG_NFILE_STREAMS > 0 # ifdef CONFIG_NSH_ALTCONDEV # if !defined(CONFIG_NSH_ALTSTDIN) && !defined(CONFIG_NSH_ALTSTDOUT) && \ !defined(CONFIG_NSH_ALTSTDERR) # error CONFIG_NSH_ALTCONDEV selected but CONFIG_NSH_ALTSTDxxx not provided # endif # define INFD(p) ((p)->cn_confd) # define INSTREAM(p) ((p)->cn_constream) # define OUTFD(p) ((p)->cn_outfd) # define OUTSTREAM(p) ((p)->cn_outstream) # define ERRFD(p) ((p)->cn_errfd) # define ERRSTREAM(p) ((p)->cn_errstream) # else # define INFD(p) 0 # define INSTREAM(p) stdin # define OUTFD(p) 1 # define OUTSTREAM(p) stdout # define ERRFD(p) 2 # define ERRSTREAM(p) stderr # endif #endif /**************************************************************************** * Public Types ****************************************************************************/ /* This describes a generic console front-end */ struct nsh_vtbl_s { /* This function pointers are "hooks" into the front end logic to * handle things like output of command results, redirection, etc. * -- all of which must be done in a way that is unique to the nature * of the front end. */ #ifndef CONFIG_NSH_DISABLEBG FAR struct nsh_vtbl_s *(*clone)(FAR struct nsh_vtbl_s *vtbl); void (*addref)(FAR struct nsh_vtbl_s *vtbl); void (*release)(FAR struct nsh_vtbl_s *vtbl); #endif ssize_t (*write)(FAR struct nsh_vtbl_s *vtbl, FAR const void *buffer, size_t nbytes); int (*error)(FAR struct nsh_vtbl_s *vtbl, FAR const char *fmt, ...); int (*output)(FAR struct nsh_vtbl_s *vtbl, FAR const char *fmt, ...); FAR char *(*linebuffer)(FAR struct nsh_vtbl_s *vtbl); void (*redirect)(FAR struct nsh_vtbl_s *vtbl, int fd, FAR uint8_t *save); void (*undirect)(FAR struct nsh_vtbl_s *vtbl, FAR uint8_t *save); void (*exit)(FAR struct nsh_vtbl_s *vtbl, int exitstatus) noreturn_function; #ifdef NSH_HAVE_IOBUFFER /* Common buffer for file I/O. */ char iobuffer[IOBUFFERSIZE]; #endif /* Parser state data */ struct nsh_parser_s np; }; /* This structure describes a console front-end that is based on stdin and * stdout (which is all of the supported console types at the time being). */ struct console_stdio_s { /* NSH front-end call table */ struct nsh_vtbl_s cn_vtbl; /* NSH input/output streams */ #if CONFIG_NFILE_STREAMS > 0 #ifdef CONFIG_NSH_ALTCONDEV int cn_confd; /* Console I/O file descriptor */ #endif int cn_outfd; /* Output file descriptor (possibly redirected) */ int cn_errfd; /* Error Output file descriptor (possibly redirected) */ #ifdef CONFIG_NSH_ALTCONDEV FILE *cn_constream; /* Console I/O stream (possibly redirected) */ #endif FILE *cn_outstream; /* Output stream */ FILE *cn_errstream; /* Error Output stream */ #endif #ifdef CONFIG_NSH_VARS /* Allocation and size of NSH variables */ FAR char *varp; size_t varsz; #endif /* Line input buffer */ char cn_line[CONFIG_NSH_LINELEN]; }; /**************************************************************************** * Public Data ****************************************************************************/ /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /* Defined in nsh_console.c *************************************************/ FAR struct console_stdio_s *nsh_newconsole(void); #endif /* __APPS_NSHLIB_NSH_CONSOLE_H */