/* * Copyright (C) 2011 Andrea Mazzoleni * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #ifndef __SUPPORT_H #define __SUPPORT_H /****************************************************************************/ /* log */ /** * Fatal messages. * * Messages printed before an early termination. * * These messages go in the log file and in stderr inconditionally. */ void msg_error(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Warning messages. * * Messages reporting warnings or error conditions that don't prevent the program to run. * * Some of them could be also serious errors, like "silent errors". * The summary results is anyway always printed with as errors. * * These messages go in the log file if specified, otherwise they go in stderr. */ void msg_warning(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Tag messages. * * Messages are in tag format, like "tag:entry:...". * * These messages neves go on the screen, but only in the log file if specified. * * Note that this function, allows not \n terminated strings. */ void msg_tag(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Message levels. * * The levels control the amount of information printed on the screen. * Note that msg_error(), msg_warning() and msg_tag() are not influenced by this option. * * From the most quiet to the most verbose. */ #define MSG_STATUS -3 #define MSG_INFO -2 #define MSG_PROGRESS -1 #define MSG_BAR 0 #define MSG_VERBOSE 1 /** * Selected message level. */ extern int msg_level; /** * State messages. * * Messages that tell what the program is doing or did, but limited to few lines. * They are status information, and summary results. */ void msg_status(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Info messages. * * Messages that tell what was done. * Potentially a lot of messages are possible. They can still be on the screen, * as losing them we don't lose information. * * These messages never go in the log file, becauae there is always a corresponding msg_tag(). */ void msg_info(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Progress messages. * * Message that tell the progress of program. * * These messages also go in the log file. */ void msg_progress(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Progress bar messages. * * Message that show the percentage of the progress. * * These messages never go in the log file. */ void msg_bar(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Verbose messages. * * Message that tell what is already expected. * * These messages also go in the log file. */ void msg_verbose(const char* format, ...) __attribute__((format(attribute_printf, 1, 2))); /** * Flush the output. */ void msg_flush(void); /** * Pointer to log function. */ typedef void fptr(const char* format, ...); /** * Escape a string. * * Chars ':', '\n', '\r' and '\' are escaped to '\d', '\\n', '\\r' and '\\'. */ const char* esc(const char* str); /****************************************************************************/ /* path */ /** * Copies a path limiting the size. * Aborts if too long. */ void pathcpy(char* dst, size_t size, const char* src); /** * Concatenates a path limiting the size. * Aborts if too long. */ void pathcat(char* dst, size_t size, const char* src); /** * Concatenates a path limiting the size. * Aborts if too long. */ void pathcatc(char* dst, size_t size, char c); /** * Imports a path limiting the size. * In Windows all the backslash are converted to the C standard of forward slash. * Aborts if too long. */ void pathimport(char* dst, size_t size, const char* src); /** * Exports a path limiting the size. * In Windows all the C slashes are converted to the Windows backslash. * Aborts if too long. */ void pathexport(char* dst, size_t size, const char* src); /** * Prints a path. * Aborts if too long. */ void pathprint(char* dst, size_t size, const char* format, ...) __attribute__((format(attribute_printf, 3, 4))); /** * Ensures the presence of a terminating slash, if it isn't empty. * Aborts if too long. */ void pathslash(char* dst, size_t size); /** * Cuts everything after the latest slash. */ void pathcut(char* dst); /** * Compare two paths. * In Windows it's case insentive and assumes \ equal at /. */ int pathcmp(const char* a, const char* b); /****************************************************************************/ /* filesystem */ /** * Creates all the ancestor directories if missing. * The file name, after the last /, is ignored. */ int mkancestor(const char* file); /** * Changes the modification time of an open file. */ int fmtime(int f, int64_t mtime_sec, int mtime_nsec); /****************************************************************************/ /* memory */ /** * Return the size of the allocated memory. */ size_t malloc_counter(void); /** * Safe malloc. * If no memory is available, it aborts. */ void* malloc_nofail(size_t size); /** * Safe cmalloc. * If no memory is available, it aborts. */ void* calloc_nofail(size_t count, size_t size); /** * Safe strdup. * If no memory is available, it aborts. */ char* strdup_nofail(const char* str); /** * Helper for printing an error about a failed allocation. */ void malloc_fail(size_t size); /****************************************************************************/ /* smartctl */ /** * Reads smartctl attributes from a stream. * Returns 0 on success. */ int smartctl_attribute(FILE* f, uint64_t* smart, char* serial); #endif