File: ctagsmanager.h

package info (click to toggle)
source-highlight 3.1.8-1.2~deb9u1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 10,224 kB
  • sloc: sh: 11,709; cpp: 10,226; ansic: 9,521; makefile: 1,902; lex: 1,200; yacc: 1,021; php: 213; perl: 211; awk: 98; erlang: 94; lisp: 90; java: 75; ruby: 69; python: 61; asm: 43; ada: 36; ml: 29; haskell: 27; xml: 23; cs: 11; sql: 8; tcl: 7; sed: 4
file content (67 lines) | stat: -rw-r--r-- 1,639 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
//
// Author: Lorenzo Bettini <http://www.lorenzobettini.it>, (C) 2004-2008
//
// Copyright: See COPYING file that comes with this distribution
//

#ifndef CTAGSMANAGER_H_
#define CTAGSMANAGER_H_

#include <string>

#include "refposition.h"
#include "textstyles.h"

namespace srchilite {

class CTagsCollector;
class CTagsFormatter;

/**
 * Takes care of running ctags and to generate a CTagsFormmatter
 */
class CTagsManager {
    /// the ctags file name
    std::string ctagsFile;

    /// the possible ctags command to execute
    std::string ctagsCmd;

    /// whether to run ctags command
    bool runCTags;

    /// the position for generated references
    RefPosition refPosition;

    /// the shared instance shared by all the created CTagsFormatters
    CTagsCollector *ctagsCollector;
public:
    /**
     * @param _ctagsFile the ctags file name
     * @param _ctagsCmd the ctags line command
     * @param _runCTags whether to run the ctags command
     * @param _refPosition the position for generated references
     */
    CTagsManager(const std::string &_ctagsFile, const std::string &_ctagsCmd,
            bool _runCTags, RefPosition _refPosition);

    ~CTagsManager();

    /**
     * Runs the ctags program.
     * @throws IOException if the run fails
     */
    void runCTagsCmd();

    /**
     * Creates a CTagsFormatter (if required, it previously run the ctags
     * command).
     * @param r the style for references and anchors
     * @throws IOException if running the ctags command fails
     */
    CTagsFormatter *createCTagsFormatter(const TextStyles::RefTextStyle &r);
};

}

#endif /*CTAGSMANAGER_H_*/