d3e5c20ab8
When a reference to a function-like macro begins during the rescanning of the expansion of another macro but is not completed by the end of that expansion, it is necessary to abort that rescanning of that expansion and try again when more tokens can be acquired. (See the new unclosed-FLM.F90 test case.) All other Fortran preprocessors to which I have access can handle this situation.
112 lines
4.1 KiB
C++
112 lines
4.1 KiB
C++
//===-- lib/Parser/preprocessor.h -------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef FORTRAN_PARSER_PREPROCESSOR_H_
|
|
#define FORTRAN_PARSER_PREPROCESSOR_H_
|
|
|
|
// A Fortran-aware preprocessing module used by the prescanner to implement
|
|
// preprocessing directives and macro replacement. Intended to be efficient
|
|
// enough to always run on all source files even when no preprocessing is
|
|
// performed, so that special compiler command options &/or source file name
|
|
// extensions for preprocessing will not be necessary.
|
|
|
|
#include "token-sequence.h"
|
|
#include "flang/Parser/char-block.h"
|
|
#include "flang/Parser/provenance.h"
|
|
#include <cstddef>
|
|
#include <list>
|
|
#include <stack>
|
|
#include <string>
|
|
#include <unordered_map>
|
|
#include <vector>
|
|
|
|
namespace Fortran::parser {
|
|
|
|
class Prescanner;
|
|
class Preprocessor;
|
|
|
|
// Defines a macro
|
|
class Definition {
|
|
public:
|
|
Definition(const TokenSequence &, std::size_t firstToken, std::size_t tokens);
|
|
Definition(const std::vector<std::string> &argNames, const TokenSequence &,
|
|
std::size_t firstToken, std::size_t tokens, bool isVariadic = false);
|
|
Definition(const std::string &predefined, AllSources &);
|
|
|
|
bool isFunctionLike() const { return isFunctionLike_; }
|
|
std::size_t argumentCount() const { return argumentCount_; }
|
|
bool isVariadic() const { return isVariadic_; }
|
|
bool isDisabled() const { return isDisabled_; }
|
|
bool isPredefined() const { return isPredefined_; }
|
|
const TokenSequence &replacement() const { return replacement_; }
|
|
|
|
bool set_isDisabled(bool disable);
|
|
|
|
TokenSequence Apply(const std::vector<TokenSequence> &args, Prescanner &);
|
|
|
|
private:
|
|
static TokenSequence Tokenize(const std::vector<std::string> &argNames,
|
|
const TokenSequence &token, std::size_t firstToken, std::size_t tokens);
|
|
|
|
bool isFunctionLike_{false};
|
|
std::size_t argumentCount_{0};
|
|
bool isVariadic_{false};
|
|
bool isDisabled_{false};
|
|
bool isPredefined_{false};
|
|
TokenSequence replacement_;
|
|
};
|
|
|
|
// Preprocessing state
|
|
class Preprocessor {
|
|
public:
|
|
explicit Preprocessor(AllSources &);
|
|
|
|
const AllSources &allSources() const { return allSources_; }
|
|
AllSources &allSources() { return allSources_; }
|
|
|
|
void DefineStandardMacros();
|
|
void Define(std::string macro, std::string value);
|
|
void Undefine(std::string macro);
|
|
bool IsNameDefined(const CharBlock &);
|
|
bool IsFunctionLikeDefinition(const CharBlock &);
|
|
|
|
// When called with partialFunctionLikeMacro not null, MacroReplacement()
|
|
// and ReplaceMacros() handle an unclosed function-like macro reference
|
|
// by terminating macro replacement at the name of the FLM and returning
|
|
// its index in the result. This allows the recursive call sites in
|
|
// MacroReplacement to append any remaining tokens in their inputs to
|
|
// that result and try again. All other Fortran preprocessors share this
|
|
// behavior.
|
|
std::optional<TokenSequence> MacroReplacement(const TokenSequence &,
|
|
Prescanner &,
|
|
std::optional<std::size_t> *partialFunctionLikeMacro = nullptr);
|
|
|
|
// Implements a preprocessor directive.
|
|
void Directive(const TokenSequence &, Prescanner &);
|
|
|
|
private:
|
|
enum class IsElseActive { No, Yes };
|
|
enum class CanDeadElseAppear { No, Yes };
|
|
|
|
CharBlock SaveTokenAsName(const CharBlock &);
|
|
TokenSequence ReplaceMacros(const TokenSequence &, Prescanner &,
|
|
std::optional<std::size_t> *partialFunctionLikeMacro = nullptr);
|
|
void SkipDisabledConditionalCode(
|
|
const std::string &, IsElseActive, Prescanner &, ProvenanceRange);
|
|
bool IsIfPredicateTrue(const TokenSequence &expr, std::size_t first,
|
|
std::size_t exprTokens, Prescanner &);
|
|
void LineDirective(const TokenSequence &, std::size_t, Prescanner &);
|
|
|
|
AllSources &allSources_;
|
|
std::list<std::string> names_;
|
|
std::unordered_map<CharBlock, Definition> definitions_;
|
|
std::stack<CanDeadElseAppear> ifStack_;
|
|
};
|
|
} // namespace Fortran::parser
|
|
#endif // FORTRAN_PARSER_PREPROCESSOR_H_
|