summaryrefslogtreecommitdiff
path: root/src/output.h
blob: 3369ed840a5ff2b12ae43bd4e3129ea78ce0c399 (plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/***************************************************************************
 *   Copyright (C) 2017 by Hans-Peter Deifel                               *
 *   hpd@hpdeifel.de                                                       *
 *                                                                         *
 *   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 2 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, write to the                         *
 *   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,      *
 *   Boston, MA 02110-1301 USA.                                            *
 ***************************************************************************/

#ifndef OUTPUT_H
#define OUTPUT_H

#include <sys/types.h>
#include <string>
#include "pdfgrep.h"

struct context {
	const std::string &filename;
	size_t pagenum;

	const Outconf &out;
};

struct match {
	const std::string string;
	size_t start;
	size_t end;
};

/* print the line prefix followed only by the match */
void print_only_match(const struct context &context, const struct match &match);

/** print a line with prefix and highlighting for matches.
 *
 * 'matches' must not be empty and all entries must begin and end in the same
 * line.
 */
void print_matches(const context& context, const std::vector<match>& matches);

// Print `lines` lines of context before the match. If lines is smaller than 0,
// use the value from context.outconf.
void print_context_before(const context& context, const match& match, int lines = -1);
// Print `lines` lines of context before the match. If lines is smaller than 0,
// use the value from context.outconf.
void print_context_after(const context& context, const match& match, int lines = -1);
void print_context_between(const context& context, const match& match1, const match& match2);
void print_context_separator(const Outconf &out);

// C++ interface:

// Print to stderr, with "pdfgrep: " as prefix;
std::ostream& err();

std::ostream& line_prefix(const Outconf& outconf, const std::string& filename,
                          bool in_context, size_t page);
std::ostream& line_prefix(const Outconf& outconf, const std::string& filename,
                          bool in_context);

#endif