scanner.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright (C) 1997-2026 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 SCANNER_H
#define SCANNER_H
 
#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++,
 *  such as C, C#, Objective-C, Java, PHP, and IDL.
 */
class COutlineParser final : public OutlineParserInterface
{
  public:
    COutlineParser();
    COutlineParser(const COutlineParser &) = delete;
    COutlineParser &operator=(COutlineParser &) = delete;
    COutlineParser(COutlineParser &&) = delete;
    COutlineParser &operator=(COutlineParser &&) = delete;
   ~COutlineParser() override;
    void parseInput(const DString &fileName,
                    const char *fileBuf,
                    const std::shared_ptr<Entry> &root,
                    ClangTUParser *clangParser) override;
    bool needsPreprocessing(const DString &extension) const override;
    void parsePrototype(const DString &text) override;
  private:
    struct Private;
    std::unique_ptr<Private> p;
};
 
 
#endif