src/dbusxmlscanner.h

   1 /******************************************************************************
   2  *
   3  *
   4  *
   5  * Copyright (C) 2009 by Tobias Hunger <tobias@aquazul.com>
   6  *
   7  * Permission to use, copy, modify, and distribute this software and its
   8  * documentation under the terms of the GNU General Public License is hereby
   9  * granted. No representations are made about the suitability of this software
  10  * for any purpose. It is provided "as is" without express or implied warranty.
  11  * See the GNU General Public License for more details.
  12  *
  13  * Documents produced by Doxygen are derivative works derived from the
  14  * input used in their production; they are not affected by this license.
  15  *
  16  */
  17
  18 #ifndef SCANNER_DBUSXML_H
  19 #define SCANNER_DBUSXML_H
  20
  21 #include "parserintf.h"
  22
  23 /** D-Bus XML parser.
  24  *
  25  *  This is the D-Bus XML parser for doxygen.
  26  */
  27 class DBusXMLScanner : public ParserInterface
  28 {
  29 public:
  30     DBusXMLScanner();
  31     virtual ~DBusXMLScanner();
  32     void parseInput(const char *fileName,
  33                     const char *fileBuf,
  34                     Entry *root);
  35
  36     bool needsPreprocessing(const QCString &extension);
  37
  38     void parseCode(CodeOutputInterface &codeOutIntf,
  39                    const char *scopeName,
  40                    const QCString &input,
  41                    bool isExampleBlock,
  42                    const char *exampleName=0,
  43                    FileDef *fileDef=0,
  44                    int startLine=-1,
  45                    int endLine=-1,
  46                    bool inlineFragment=FALSE,
  47                    MemberDef *memberDef=0,
  48                    bool showLineNumbers=TRUE,
  49                    Definition *searchCtx=0
  50                   );
  51
  52     void resetCodeParserState();
  53
  54     void parsePrototype(const char *text);
  55
  56 private:
  57 };
  58
  59 #endif