File: CTags.hpp

package info (click to toggle)
codelite 17.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 136,204 kB
  • sloc: cpp: 491,547; ansic: 280,393; php: 10,259; sh: 8,930; lisp: 7,664; vhdl: 6,518; python: 6,020; lex: 4,920; yacc: 3,123; perl: 2,385; javascript: 1,715; cs: 1,193; xml: 1,110; makefile: 804; cobol: 741; sql: 709; ruby: 620; f90: 566; ada: 534; asm: 464; fortran: 350; objc: 289; tcl: 258; java: 157; erlang: 61; pascal: 51; ml: 49; awk: 44; haskell: 36
file content (57 lines) | stat: -rw-r--r-- 2,380 bytes parent folder | download | duplicates (2)
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
#ifndef CTAGSGENERATOR_HPP
#define CTAGSGENERATOR_HPP

#include "codelite_exports.h"
#include "entry.h"
#include "readtags.h"
#include "tag_tree.h"

#include <vector>
#include <wx/filename.h>
#include <wx/textfile.h>

class WXDLLIMPEXP_CL CTags
{
protected:
    static wxString WrapSpaces(const wxString& file);
    /**
     * @brief parse list of files
     * @param filesContent contains a list of files to be parsed. Each file is placed on its own line
     * @param path location for the output ctags file. The output is written into `wxFileName(path, "ctags")`;
     * @param codelite_indexer path to `codelite_indexer`
     * @param ctags_args arguments to pass to ctags executable. Leave empty for the defaults
     * @param output if provided, holds the ctags content
     * @return true on success, false otherwise
     */
    static bool DoGenerate(const wxString& filesContent, const wxString& codelite_indexer,
                           const wxStringMap_t& macro_table, const wxString& ctags_kinds = wxEmptyString,
                           wxString* output = nullptr);

    static void Initialise(const wxString& codelite_indexer);

public:
    /**
     * @brief given a list of files, generate an output tags file and place it under 'path'
     */
    static size_t ParseFiles(const std::vector<wxString>& files, const wxString& codelite_indexer,
                             const wxStringMap_t& macro_table, std::vector<TagEntryPtr>& tags);

    /**
     * @brief given a list of files, generate an output tags file and place it under 'path'
     */
    static size_t ParseFile(const wxString& file, const wxString& codelite_indexer, const wxStringMap_t& macro_table,
                            std::vector<TagEntryPtr>& tags);

    /**
     * @brief run codelite-indexer on a buffer and return list of tags
     */
    static size_t ParseBuffer(const wxFileName& filename, const wxString& buffer, const wxString& codelite_indexer,
                              const wxStringMap_t& macro_table, std::vector<TagEntryPtr>& tags);
    /**
     * @brief parse list of local variables from a given source file
     */
    static size_t ParseLocals(const wxFileName& filename, const wxString& buffer, const wxString& codelite_indexer,
                              const wxStringMap_t& macro_table, std::vector<TagEntryPtr>& tags);
};

#endif // CTAGSGENERATOR_HPP