blob: 2896a8526cbc537bf09c74dce785551af6f2633d [file] [log] [blame]
peter klausler90cd9ba2018-01-30 19:54:311#ifndef FORTRAN_PREPROCESSOR_H_
2#define FORTRAN_PREPROCESSOR_H_
3
4// A Fortran-aware preprocessing module used by the prescanner to implement
5// preprocessing directives and macro replacement. Intended to be efficient
6// enough to always run on all source files even when no preprocessing is
7// needed, so that special compiler command options &/or source file name
8// extensions for preprocessing will not be necessary.
9
10#include "idioms.h"
11#include <cctype>
12#include <cstring>
13#include <functional>
14#include <list>
peter klausler55fe4d22018-02-02 23:52:4315#include <sstream>
peter klausler16c6f532018-02-05 22:29:2616#include <stack>
peter klausler90cd9ba2018-01-30 19:54:3117#include <string>
18#include <unordered_map>
19#include <vector>
20
21namespace Fortran {
peter klausler0ba1a142018-02-07 20:04:4222namespace parser {
peter klausler90cd9ba2018-01-30 19:54:3123
24class CharBuffer;
25class Prescanner;
26
27// Just a const char pointer with an associated length; does not own the
28// referenced data. Used to describe buffered tokens and hash table keys.
peter klausler33d78542018-01-30 20:21:2529class CharPointerWithLength {
peter klauslerbdea10d2018-02-05 20:54:3630public:
peter klausler90cd9ba2018-01-30 19:54:3131 CharPointerWithLength() {}
peter klausler33d78542018-01-30 20:21:2532 CharPointerWithLength(const char *x, size_t n) : data_{x}, bytes_{n} {}
peter klauslerad7125f2018-02-01 23:01:2333 CharPointerWithLength(const std::string &s)
34 : data_{s.data()}, bytes_{s.size()} {}
peter klausler90cd9ba2018-01-30 19:54:3135 CharPointerWithLength(const CharPointerWithLength &that)
peter klausler33d78542018-01-30 20:21:2536 : data_{that.data_}, bytes_{that.bytes_} {}
peter klausler90cd9ba2018-01-30 19:54:3137 CharPointerWithLength &operator=(const CharPointerWithLength &that) {
peter klausler33d78542018-01-30 20:21:2538 data_ = that.data_;
39 bytes_ = that.bytes_;
peter klausler90cd9ba2018-01-30 19:54:3140 return *this;
41 }
42
peter klausler33d78542018-01-30 20:21:2543 bool empty() const { return bytes_ == 0; }
44 size_t size() const { return bytes_; }
peter klausler33d78542018-01-30 20:21:2545 const char &operator[](size_t j) const { return data_[j]; }
peter klausler90cd9ba2018-01-30 19:54:3146
peter klausler55fe4d22018-02-02 23:52:4347 bool IsBlank() const;
peter klauslerad7125f2018-02-01 23:01:2348 std::string ToString() const { return std::string{data_, bytes_}; }
49
peter klauslerbdea10d2018-02-05 20:54:3650private:
peter klausler33d78542018-01-30 20:21:2551 const char *data_{nullptr};
52 size_t bytes_{0};
peter klausler90cd9ba2018-01-30 19:54:3153};
peter klausler0ba1a142018-02-07 20:04:4254} // namespace parser
peter klausler90cd9ba2018-01-30 19:54:3155} // namespace Fortran
56
57// Specializations to enable std::unordered_map<CharPointerWithLength, ...>
peter klausler0ba1a142018-02-07 20:04:4258template<> struct std::hash<Fortran::parser::CharPointerWithLength> {
59 size_t operator()(const Fortran::parser::CharPointerWithLength &x) const {
peter klauslerbe830d62018-02-05 20:48:0960 size_t hash{0}, bytes{x.size()};
61 for (size_t j{0}; j < bytes; ++j) {
62 hash = (hash * 31) ^ x[j];
peter klausler90cd9ba2018-01-30 19:54:3163 }
64 return hash;
65 }
66};
67
peter klausler0ba1a142018-02-07 20:04:4268template<> struct std::equal_to<Fortran::parser::CharPointerWithLength> {
69 bool operator()(const Fortran::parser::CharPointerWithLength &x,
70 const Fortran::parser::CharPointerWithLength &y) const {
peter klausler33d78542018-01-30 20:21:2571 return x.size() == y.size() &&
peter klausler16c6f532018-02-05 22:29:2672 std::memcmp(static_cast<const void *>(&x[0]),
73 static_cast<const void *>(&y[0]), x.size()) == 0;
peter klausler90cd9ba2018-01-30 19:54:3174 }
75};
76
77namespace Fortran {
peter klausler0ba1a142018-02-07 20:04:4278namespace parser {
peter klausler90cd9ba2018-01-30 19:54:3179
80// Buffers a contiguous sequence of characters that has been partitioned into
81// a sequence of preprocessing tokens.
82class TokenSequence {
peter klauslerbdea10d2018-02-05 20:54:3683public:
peter klausler90cd9ba2018-01-30 19:54:3184 TokenSequence() {}
peter klauslerad7125f2018-02-01 23:01:2385 TokenSequence(const TokenSequence &that) { Append(that); }
peter klausler90cd9ba2018-01-30 19:54:3186 TokenSequence(TokenSequence &&that)
peter klausler16c6f532018-02-05 22:29:2687 : start_{std::move(that.start_)},
88 nextStart_{that.nextStart_}, char_{std::move(that.char_)} {}
peter klauslerad7125f2018-02-01 23:01:2389 TokenSequence(const std::string &s) { push_back(s); }
90
91 TokenSequence &operator=(const TokenSequence &that) {
92 clear();
93 Append(that);
94 return *this;
95 }
peter klausler90cd9ba2018-01-30 19:54:3196 TokenSequence &operator=(TokenSequence &&that) {
97 start_ = std::move(that.start_);
98 nextStart_ = that.nextStart_;
99 char_ = std::move(that.char_);
100 return *this;
101 }
102
peter klauslerad7125f2018-02-01 23:01:23103 CharPointerWithLength operator[](size_t token) const {
peter klausler55fe4d22018-02-02 23:52:43104 return {&char_[start_[token]],
peter klausler16c6f532018-02-05 22:29:26105 (token + 1 >= start_.size() ? char_.size() : start_[token + 1]) -
106 start_[token]};
peter klausler90cd9ba2018-01-30 19:54:31107 }
108
peter klausler16c6f532018-02-05 22:29:26109 void AddChar(char ch) { char_.emplace_back(ch); }
peter klausler6f94e842018-01-30 23:22:26110
peter klausler90cd9ba2018-01-30 19:54:31111 void EndToken() {
112 // CHECK(char_.size() > nextStart_);
113 start_.emplace_back(nextStart_);
114 nextStart_ = char_.size();
115 }
116
peter klausler6f94e842018-01-30 23:22:26117 void ReopenLastToken() {
118 nextStart_ = start_.back();
119 start_.pop_back();
120 }
121
peter klausler90cd9ba2018-01-30 19:54:31122 void Append(const TokenSequence &);
peter klausler55fe4d22018-02-02 23:52:43123 void EmitWithCaseConversion(CharBuffer *) const;
124 std::string ToString() const;
peter klausler90cd9ba2018-01-30 19:54:31125
126 bool empty() const { return start_.empty(); }
peter klausler90cd9ba2018-01-30 19:54:31127 size_t size() const { return start_.size(); }
peter klausler6f94e842018-01-30 23:22:26128 const char *data() const { return &char_[0]; }
peter klauslerbe830d62018-02-05 20:48:09129 void clear();
130 void push_back(const char *, size_t);
131 void push_back(const CharPointerWithLength &);
132 void push_back(const std::string &);
133 void push_back(const std::stringstream &);
134 void pop_back();
135 void shrink_to_fit();
peter klausler90cd9ba2018-01-30 19:54:31136
peter klauslerbdea10d2018-02-05 20:54:36137private:
peter klausler90cd9ba2018-01-30 19:54:31138 std::vector<int> start_;
139 size_t nextStart_{0};
140 std::vector<char> char_;
141};
142
143// Defines a macro
144class Definition {
peter klauslerbdea10d2018-02-05 20:54:36145public:
peter klausler90cd9ba2018-01-30 19:54:31146 Definition(const TokenSequence &, size_t firstToken, size_t tokens);
147 Definition(const std::vector<std::string> &argNames, const TokenSequence &,
peter klausler16c6f532018-02-05 22:29:26148 size_t firstToken, size_t tokens, bool isVariadic = false);
peter klauslerad7125f2018-02-01 23:01:23149 explicit Definition(const std::string &predefined);
peter klausler90cd9ba2018-01-30 19:54:31150
151 bool isFunctionLike() const { return isFunctionLike_; }
152 size_t argumentCount() const { return argumentCount_; }
153 bool isVariadic() const { return isVariadic_; }
154 bool isDisabled() const { return isDisabled_; }
peter klauslerad7125f2018-02-01 23:01:23155 bool isPredefined() const { return isPredefined_; }
peter klausler90cd9ba2018-01-30 19:54:31156 const TokenSequence &replacement() const { return replacement_; }
157
158 bool set_isDisabled(bool disable);
159
160 TokenSequence Apply(const std::vector<TokenSequence> &args);
161
peter klauslerbdea10d2018-02-05 20:54:36162private:
peter klausler90cd9ba2018-01-30 19:54:31163 static TokenSequence Tokenize(const std::vector<std::string> &argNames,
peter klausler16c6f532018-02-05 22:29:26164 const TokenSequence &token, size_t firstToken, size_t tokens);
peter klausler90cd9ba2018-01-30 19:54:31165
166 bool isFunctionLike_{false};
167 size_t argumentCount_{0};
168 bool isVariadic_{false};
169 bool isDisabled_{false};
peter klauslerad7125f2018-02-01 23:01:23170 bool isPredefined_{false};
peter klausler90cd9ba2018-01-30 19:54:31171 TokenSequence replacement_;
172};
173
174// Preprocessing state
175class Preprocessor {
peter klauslerbdea10d2018-02-05 20:54:36176public:
peter klauslerad7125f2018-02-01 23:01:23177 explicit Preprocessor(Prescanner &);
peter klausler90cd9ba2018-01-30 19:54:31178
179 // When the input contains macros to be replaced, the new token sequence
180 // is appended to the output and the returned value is true. When
181 // no macro replacement is necessary, the output is unmodified and the
182 // return value is false.
183 bool MacroReplacement(const TokenSequence &, TokenSequence *);
184
peter klausler55fe4d22018-02-02 23:52:43185 // Implements a preprocessor directive; returns true when no fatal error.
186 bool Directive(const TokenSequence &);
peter klausler90cd9ba2018-01-30 19:54:31187
peter klauslerbdea10d2018-02-05 20:54:36188private:
peter klausler93cf3ae2018-02-01 20:08:02189 enum class IsElseActive { No, Yes };
190 enum class CanDeadElseAppear { No, Yes };
peter klauslerad7125f2018-02-01 23:01:23191
peter klausler55fe4d22018-02-02 23:52:43192 void Complain(const std::string &);
peter klauslerad7125f2018-02-01 23:01:23193 CharPointerWithLength SaveToken(const CharPointerWithLength &);
peter klausler93cf3ae2018-02-01 20:08:02194 bool IsNameDefined(const CharPointerWithLength &);
peter klauslerad7125f2018-02-01 23:01:23195 TokenSequence ReplaceMacros(const TokenSequence &);
peter klausler55fe4d22018-02-02 23:52:43196 bool SkipDisabledConditionalCode(const std::string &dirName, IsElseActive);
peter klausler16c6f532018-02-05 22:29:26197 bool IsIfPredicateTrue(
198 const TokenSequence &expr, size_t first, size_t exprTokens);
peter klausler93cf3ae2018-02-01 20:08:02199
peter klauslerad7125f2018-02-01 23:01:23200 Prescanner &prescanner_;
peter klausler90cd9ba2018-01-30 19:54:31201 std::list<std::string> names_;
202 std::unordered_map<CharPointerWithLength, Definition> definitions_;
peter klausler93cf3ae2018-02-01 20:08:02203 std::stack<CanDeadElseAppear> ifStack_;
peter klausler90cd9ba2018-01-30 19:54:31204};
peter klausler0ba1a142018-02-07 20:04:42205} // namespace parser
peter klausler90cd9ba2018-01-30 19:54:31206} // namespace Fortran
207#endif // FORTRAN_PREPROCESSOR_H_