File: formatterfactory.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 (66 lines) | stat: -rw-r--r-- 1,919 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
//
// Author: Lorenzo Bettini <http://www.lorenzobettini.it>, (C) 2004-2008
//
// Copyright: See COPYING file that comes with this distribution
//

#ifndef FORMATTERFACTORY_H_
#define FORMATTERFACTORY_H_

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

using std::string;

namespace srchilite {

/// constants indicating boldface, italics, etc.
enum StyleConstant {
    ISBOLD = 1, ///< bold
    ISITALIC, ///< italics
    ISUNDERLINE,  ///< underline
    ISFIXED, ///< fixed size
    ISNOTFIXED,  ///< non fixed size
    ISNOREF ///< must not contain references
};

/// collection of StyleConstant objects
typedef std::list<StyleConstant> StyleConstants;

/// shared pointer for StyleConstants
typedef boost::shared_ptr<StyleConstants> StyleConstantsPtr;

/// iterator for StyleConstants
typedef StyleConstants::const_iterator StyleConstantsIterator;

/**
 * The generic abstract factory to create Formatter objects, during the
 * parsing of style files.  Note that creation methods do not return a specific
 * object, so that the implementation of where to store the Formatter objects
 * themselves is left completely to the programmer (and does not couple the factory
 * to a specific collection).
 */
class FormatterFactory {
public:
    virtual ~FormatterFactory() {
    }

    /**
     * Creates a formatter for the specific language element (identified by
     * key) with the passed style parameters
     *
     * @param key the language element represented
     * @param color the color
     * @param bgcolor the background color
     * @param styleconstants additional formatting information (e.g., bold, italics, etc.)
     * @return false if a formatter for the specific key is already present
     */
    virtual bool createFormatter(const string &key, const string &color,
            const string &bgcolor, StyleConstantsPtr styleconstants) = 0;

};

}

#endif /*FORMATTERFACTORY_H_*/