1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
|
/*
Message printing helper functions.
Copyright (C) 2010 WANG Lu <coolwanglu(a)gmail.com>
This file is part of libscanmem.
This library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* This file declares all types of output functions, in order to provide well-formatted messages that a front-end can understand
*
* Basically, all data go through stdout, and all message (to user or to front-end) go through stderr
*
* In stderr:
* all messages prefixed with 'error:' will be considered fatal error, front-end may notify user to re-start backend
* all messages prefixed with 'warn:' will be considered nonfatal error
* all messages prefixed with 'info:' will be ignored (by the front-end)
*
* To display message to user only, use show_user, nothing will be prepended, and the message will be ignore if scanmem is running as a backend
*/
#ifndef SHOW_MESSAGE_H
#define SHOW_MESSAGE_H
/* prepend 'info: ', output to stderr */
void show_info(const char *fmt, ...);
/* prepend 'error: ', output to stderr */
void show_error(const char *fmt, ...);
/* prepend 'warn: ', output to stderr */
void show_warn(const char *fmt, ...);
/* display message only when in debug mode */
void show_debug(const char *fmt, ...);
/* display message only when not running as a backend */
void show_user(const char *fmt, ...);
/* display progress of scan */
void show_scan_progress(unsigned long cur, unsigned long total);
#endif /* SHOW_MESSAGE_H */
|