docparser.h

/******************************************************************************
 *
 * Copyright (C) 1997-2022 by Dimitri van Heesch.
 *
 * 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.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#ifndef DOCPARSER_H
#define DOCPARSER_H

#include <stdio.h>
#include <memory>

#include "qcstring.h"
#include "growvector.h"

class MemberDef;
class Definition;

//---------------------------------------------------------------------------

class IDocParser
{
  public:
    virtual ~IDocParser() = default;
};

using IDocParserPtr = std::unique_ptr<IDocParser>;

IDocParserPtr createDocParser();

//---------------------------------------------------------------------------

class IDocNodeAST
{
  public:
    virtual ~IDocNodeAST() = default;
    virtual bool isEmpty() const = 0;
};

using IDocNodeASTPtr = std::unique_ptr<IDocNodeAST>;

IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf,const QCString &fileName,int startLine,
                            const Definition *ctx, const MemberDef *md,
                            const QCString &input,bool indexWords,
                            bool isExample,const QCString &exampleName,
                            bool singleLine,bool linkFromIndex,
                            bool markdownSupport);

IDocNodeASTPtr validatingParseText(IDocParser &parser,const QCString &input);

IDocNodeASTPtr createRef(IDocParser &parser,const QCString &target,const QCString &context, const QCString &srcFile = "", int srcLine = -1);

//--------------------------------------------------------------------------------

void docFindSections(const QCString &input,
                     const Definition *d,
                     const QCString &fileName);

#endif