1 /**
2  * Copyright (c) 2017, Timothy Stack
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  * * Neither the name of Timothy Stack nor the names of its contributors
15  * may be used to endorse or promote products derived from this software
16  * without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef LNAV_HELP_TEXT_FORMATTER_HH
31 #define LNAV_HELP_TEXT_FORMATTER_HH
32 
33 #include <functional>
34 
35 #include "help_text.hh"
36 #include "attr_line.hh"
37 
38 using help_example_to_attr_line_fun_t =
39 std::function<attr_line_t(const help_text &, const help_example &)>;
40 
41 void
42 format_help_text_for_term(const help_text &ht, size_t width, attr_line_t &out,
43                           bool synopsis_only = false);
44 
45 void format_example_text_for_term(
46     const help_text &ht,
47     help_example_to_attr_line_fun_t eval,
48     size_t width, attr_line_t &out);
49 
50 void format_help_text_for_rst(const help_text &ht,
51                               help_example_to_attr_line_fun_t eval,
52                               FILE *rst_file);
53 
54 #endif //LNAV_HELP_TEXT_FORMATTER_HH
55