1 /*
2  * Copyright (c) 2015-2017, Intel Corporation
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *  * Redistributions of source code must retain the above copyright notice,
8  *    this list of conditions and the following disclaimer.
9  *  * Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *  * Neither the name of Intel Corporation nor the names of its contributors
13  *    may be used to endorse or promote products derived from this software
14  *    without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /** \file
30  * \brief Dump code for character classes (expressed as CharReach objects).
31  */
32 
33 #ifndef DUMP_CHARCLASS_H
34 #define DUMP_CHARCLASS_H
35 
36 #include "ue2common.h"
37 
38 #include <cstdio>
39 #include <ostream>
40 #include <sstream>
41 #include <string>
42 #include <vector>
43 
44 namespace ue2 {
45 
46 enum cc_output_t {
47     CC_OUT_TEXT, //!< unescaped text output
48     CC_OUT_DOT   //!< escaped DOT label output
49 };
50 
51 class CharReach;
52 
53 void describeClass(std::ostream &os, const CharReach &cr, size_t maxLength = 16,
54                    enum cc_output_t out_type  = CC_OUT_TEXT);
55 
56 std::string describeClass(const CharReach &cr, size_t maxLength = 16,
57                           enum cc_output_t out_type = CC_OUT_TEXT);
58 
59 template<typename Container>
60 std::string describeClasses(const Container &container,
61                             size_t maxClassLength = 16,
62                             enum cc_output_t out_type = CC_OUT_TEXT) {
63     std::ostringstream oss;
64     for (const CharReach &cr : container) {
65         describeClass(oss, cr, maxClassLength, out_type);
66     }
67     return oss.str();
68 }
69 
70 void describeClass(FILE *f, const CharReach &cr, size_t maxLength,
71                    enum cc_output_t out_type);
72 
73 } // namespace ue2
74 
75 #endif // DUMP_CHARCLASS_H
76