ISLEman
markdown.h
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2015 by Dimitri van Heesch.
4  *
5  * Permission to use, copy, modify, and distribute this software and its
6  * documentation under the terms of the GNU General Public License is hereby
7  * granted. No representations are made about the suitability of this software
8  * for any purpose. It is provided "as is" without express or implied warranty.
9  * See the GNU General Public License for more details.
10  *
11  * Documents produced by Doxygen are derivative works derived from the
12  * input used in their production; they are not affected by this license.
13  *
14  */
15 
16 #ifndef MARKDOWN_H
17 #define MARKDOWN_H
18 
19 #include <qcstring.h>
20 #include "parserintf.h"
21 
22 class Entry;
23 
25 QCString processMarkdown(const QCString &fileName,const int lineNr,Entry *e,const QCString &s);
26 QCString markdownFileNameToId(const QCString &fileName);
27 
29 {
30  public:
31  virtual ~MarkdownFileParser() {}
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 &) { return FALSE; }
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 
60 
61 
62 #endif
Definition: qstrlist.h:57
The common base class of all entity definitions found in the sources.
Definition: definition.h:92
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)
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output...
Definition: markdown.cpp:2637
bool needsPreprocessing(const QCString &)
Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed t...
Definition: markdown.h:39
A model of a class/file/namespace member symbol.
Definition: memberdef.h:43
Represents an unstructured piece of information, about an entity found in the sources.
Definition: entry.h:63
Abstract interface for programming language parsers.
Definition: parserintf.h:38
void startTranslationUnit(const char *)
Starts processing a translation unit (source files + headers).
Definition: markdown.h:32
A model of a file symbol.
Definition: filedef.h:64
SrcLangExt
Language as given by extension.
Definition: types.h:41
void finishTranslationUnit()
Called after all files in a translation unit have been processed.
Definition: markdown.h:33
void parsePrototype(const char *text)
Callback function called by the comment block scanner.
Definition: markdown.cpp:2672
void resetCodeParserState()
Resets the state of the code parser.
Definition: markdown.cpp:2663
QCString fileName
file this entry was extracted from
Definition: entry.h:282
Definition: markdown.h:28
This is an alternative implementation of QCString.
Definition: qcstring.h:131
Output interface for code parser.
Definition: outputgen.h:59
void parseInput(const char *fileName, const char *fileBuf, Entry *root, bool sameTranslationUnit, QStrList &filesInSameTranslationUnit)
Parses a single input file with the goal to build an Entry tree.
Definition: markdown.cpp:2555