scanner.h 2.13 KB
Newer Older
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1 2
/******************************************************************************
 *
3
 * 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
4
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
5
 * Copyright (C) 1997-2014 by Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
15 16 17 18 19 20
 *
 */

#ifndef SCANNER_H
#define SCANNER_H

21 22 23 24 25 26
#include "parserintf.h"

/** \brief C-like language parser using state-based lexical scanning.
 *
 *  This is the language parser for doxygen. It is somewhat fuzzy and
 *  supports C++ and various languages that are closely related to C++, 
27
 *  such as C, C#, Objective-C, Java, PHP, and IDL.
28 29 30 31
 */
class CLanguageScanner : public ParserInterface
{
  public:
32
    virtual ~CLanguageScanner() {}
33 34
    void startTranslationUnit(const char *fileName);
    void finishTranslationUnit();
35 36
    void parseInput(const char *fileName,
                    const char *fileBuf,
37 38 39
                    Entry *root,
                    bool sameTranslationUnit,
                    QStrList &filesInSameTranslationUnit);
40 41 42 43
    bool needsPreprocessing(const QCString &extension);
    void parseCode(CodeOutputInterface &codeOutIntf,
                   const char *scopeName,
                   const QCString &input,
44
                   SrcLangExt lang,
45 46 47 48 49 50
                   bool isExampleBlock,
                   const char *exampleName=0,
                   FileDef *fileDef=0,
                   int startLine=-1,
                   int endLine=-1,
                   bool inlineFragment=FALSE,
51
                   MemberDef *memberDef=0,
Dimitri van Heesch's avatar
Dimitri van Heesch committed
52
                   bool showLineNumbers=TRUE,
53 54
                   Definition *searchCtx=0,
                   bool collectXRefs=TRUE
55 56
                  );
    void resetCodeParserState();
57 58 59
    void parsePrototype(const char *text);
};

60 61
void scanFreeScanner();

62
#endif