parserintf.h

Go to the documentation of this file.

/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2015 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 PARSERINTF_H
#define PARSERINTF_H

#include <qdict.h>
#include <qstrlist.h>

#include "types.h"

class Entry;
class FileDef;
class CodeOutputInterface;
class MemberDef;
class Definition;

class ParserInterface
{
  public:
    virtual ~ParserInterface() {}

    virtual void startTranslationUnit(const char *fileName) = 0;

    virtual void finishTranslationUnit() = 0;

    virtual void parseInput(const char *fileName,
                            const char *fileBuf,
                            Entry *root,
                            bool sameTranslationUnit,
                            QStrList &filesInSameTranslationUnit) = 0;

    virtual bool needsPreprocessing(const QCString &extension) = 0;
    
    virtual 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
                          ) = 0;

    virtual void resetCodeParserState() = 0;

    virtual void parsePrototype(const char *text) = 0;

};

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

class ParserManager
{
  public:
    ParserManager()
      : m_defaultParser(0) { m_parsers.setAutoDelete(TRUE); }
   ~ParserManager()
    {
      delete m_defaultParser;
    }

    void registerDefaultParser(ParserInterface *parser)
    {
      m_defaultParser = parser;
    }

    void registerParser(const char *name,ParserInterface *parser)
    {
      m_parsers.insert(name,parser);
    }

    bool registerExtension(const char *extension, const char *parserName)
    {
      if (parserName==0 || extension==0) return FALSE;
      ParserInterface *intf = m_parsers.find(parserName);
      if (intf==0) return FALSE;
      if (m_extensions.find(extension)!=0) // extension already exists
      {
        m_extensions.remove(extension); // remove it
      }
      m_extensions.insert(extension,intf); // add new mapping
      return TRUE;
    }

    ParserInterface *getParser(const char *extension)
    {
      QCString ext = QCString(extension).lower();
      if (ext.isEmpty()) ext=".no_extension";
      ParserInterface *intf = m_extensions.find(ext);
      if (intf==0 && ext.length()>4)
      {
        intf = m_extensions.find(ext.left(4));
      }
      return intf ? intf : m_defaultParser;
    }

  private:
    QDict<ParserInterface> m_parsers;
    QDict<ParserInterface> m_extensions;
    ParserInterface *m_defaultParser;
};

#endif