File: preformatter.h

package info (click to toggle)
source-highlight 3.1.7-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 10,332 kB
  • ctags: 5,233
  • sloc: sh: 11,270; cpp: 10,206; ansic: 9,515; makefile: 1,865; lex: 1,200; yacc: 1,021; php: 213; perl: 211; awk: 98; erlang: 94; lisp: 90; java: 75; ruby: 69; python: 61; asm: 43; ml: 38; ada: 36; haskell: 27; xml: 23; cs: 11; sql: 8; tcl: 6; sed: 4
file content (70 lines) | stat: -rw-r--r-- 1,632 bytes parent folder | download | duplicates (8)
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
//
// C++ Interface: preformatter
//
// Description:
//
//
// Author: Lorenzo Bettini <http://www.lorenzobettini.it>, (C) 2005
//
// Copyright: See COPYING file that comes with this distribution
//
//
#ifndef PREFORMATTER_H
#define PREFORMATTER_H

#include <string>
#include <boost/shared_ptr.hpp>

namespace srchilite {

class PreFormatter;

/// shared pointer for PreFormatter
typedef boost::shared_ptr<PreFormatter> PreFormatterPtr;

/**
 Preformats text to be generated.  This implements the
 Decorator pattern, thus yielding a chain of preformatters

 @author Lorenzo Bettini
 */
class PreFormatter {
    /// the possible nested preformatter (Decorator pattern)
    PreFormatterPtr decorator;

public:
    /**
     * @param f the nested decorated preformatter
     */
    PreFormatter(PreFormatterPtr f = PreFormatterPtr());

    virtual ~PreFormatter();

    /**
     * Sets the nested preformatter
     * @param f the nested (decorated) preformatter
     */
    void setPreFormatter(PreFormatterPtr f);

    /**
     * Preformats the passed string (public version)
     * @param text the string to be preformatted
     * @return the preformatted string
     */
    const std::string preformat(const std::string &text);

protected:
    /**
     * Preformats the passed string (protected version).  The subclasses must
     * redefine this method to perform the preformatting.  The default implementation
     * does not perform any preformatting.
     * @param text the string to be preformatted
     * @return the preformatted string
     */
    virtual const std::string doPreformat(const std::string &text);

};

}

#endif