tclscanner.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  *
4  *
5  * Copyright (C) 1997-2015 by Dimitri van Heesch.
6  * Copyright (C) 2010-2011 by Rene Zaumseil
7  *
8  * Permission to use, copy, modify, and distribute this software and its
9  * documentation under the terms of the GNU General Public License is hereby
10  * granted. No representations are made about the suitability of this software
11  * for any purpose. It is provided "as is" without express or implied warranty.
12  * See the GNU General Public License for more details.
13  *
14  * Documents produced by Doxygen are derivative works derived from the
15  * input used in their production; they are not affected by this license.
16  *
17  */
18 
19 #ifndef SCANNER_TCL_H
20 #define SCANNER_TCL_H
21 
22 #include "parserintf.h"
23 
24 /** \brief Tcl language parser using state-based lexical scanning.
25  *
26  * This is the Tcl language parser for doxygen.
27  */
29 {
30  public:
31  virtual ~TclLanguageScanner() {}
32  void startTranslationUnit(const char *) {}
34  void parseInput(const char *fileName,
35  const char *fileBuf,
36  Entry *root,
37  bool sameTranslationUnit,
38  QStrList &filesInSameTranslationUnit);
39  bool needsPreprocessing(const QCString &extension);
40  void parseCode(CodeOutputInterface &codeOutIntf,
41  const char *scopeName,
42  const QCString &input,
43  SrcLangExt lang,
44  bool isExampleBlock,
45  const char *exampleName=0,
46  FileDef *fileDef=0,
47  int startLine=-1,
48  int endLine=-1,
49  bool inlineFragment=FALSE,
50  MemberDef *memberDef=0,
51  bool showLineNumbers=TRUE,
52  Definition *searchCtx=0,
53  bool collectXRefs=TRUE
54  );
55  void resetCodeParserState();
56  void parsePrototype(const char *text);
57 };
58 
59 #endif
void parsePrototype(const char *text)
Definition: entry.h:63
Abstract interface for programming language parsers.
Definition: parserintf.h:38
Tcl language parser using state-based lexical scanning.
Definition: tclscanner.h:28
const bool FALSE
Definition: qglobal.h:370
void parseCode(CodeOutputInterface &codeOutIntf, const char *scopeName, const QCString &input, SrcLangExt lang, bool isExampleBlock, const char *exampleName=0, FileDef *fileDef=0, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, MemberDef *memberDef=0, bool showLineNumbers=TRUE, Definition *searchCtx=0, bool collectXRefs=TRUE)
Parse file and codify.
virtual ~TclLanguageScanner()
Definition: tclscanner.h:31
void parseInput(const char *fileName, const char *fileBuf, Entry *root, bool sameTranslationUnit, QStrList &filesInSameTranslationUnit)
Parse text file and build up entry tree.
SrcLangExt
Definition: types.h:41
void startTranslationUnit(const char *)
Definition: tclscanner.h:32
static int input(void)
Definition: code.cpp:15695
fileName
Definition: dumpTree.py:9
bool needsPreprocessing(const QCString &extension)
void finishTranslationUnit()
Definition: tclscanner.h:33
const bool TRUE
Definition: qglobal.h:371
bool collectXRefs