From e612a49ef95cf9ce3d0b5496d724f73cae9aa333 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Sun, 31 Oct 2021 14:17:41 +0200 Subject: Add line processing customization hook to in::rule --- libbuild2/bash/rule.cxx | 5 +- libbuild2/bash/rule.hxx | 1 + libbuild2/forward.hxx | 4 + libbuild2/in/rule.cxx | 330 +++++++++++++++++++++++++++------------------ libbuild2/in/rule.hxx | 64 ++++++++- libbuild2/version/rule.cxx | 4 + libbuild2/version/rule.hxx | 1 + 7 files changed, 268 insertions(+), 141 deletions(-) (limited to 'libbuild2') diff --git a/libbuild2/bash/rule.cxx b/libbuild2/bash/rule.cxx index e0391e3..f2c1eae 100644 --- a/libbuild2/bash/rule.cxx +++ b/libbuild2/bash/rule.cxx @@ -200,12 +200,15 @@ namespace build2 action a, const target& t, const string& n, + optional flags, bool strict, const optional& null) const { + assert (!flags); + return n.compare (0, 6, "import") == 0 && (n[6] == ' ' || n[6] == '\t') ? substitute_import (l, a, t, trim (string (n, 7))) - : rule::substitute (l, a, t, n, strict, null); + : rule::substitute (l, a, t, n, nullopt, strict, null); } string in_rule:: diff --git a/libbuild2/bash/rule.hxx b/libbuild2/bash/rule.hxx index c54b07c..f69ac3b 100644 --- a/libbuild2/bash/rule.hxx +++ b/libbuild2/bash/rule.hxx @@ -51,6 +51,7 @@ namespace build2 action a, const target&, const string&, + optional, bool, const optional&) const override; diff --git a/libbuild2/forward.hxx b/libbuild2/forward.hxx index 4c9a50f..d2b8989 100644 --- a/libbuild2/forward.hxx +++ b/libbuild2/forward.hxx @@ -79,6 +79,10 @@ namespace build2 // struct attribute; struct attributes; + + // + // + class depdb; } #endif // LIBBUILD2_FORWARD_HXX diff --git a/libbuild2/in/rule.cxx b/libbuild2/in/rule.cxx index 2569948..4eab287 100644 --- a/libbuild2/in/rule.cxx +++ b/libbuild2/in/rule.cxx @@ -209,39 +209,58 @@ namespace build2 { // The line format is: // - // + // [/] // // Note that can contain spaces (see the constraint check - // expressions in the version module). + // expressions in the version module). That's the reason why we + // use the `/` separator for instead of the more natural + // space. // char* e (nullptr); uint64_t ln (strtoull (s->c_str (), &e, 10)); - size_t p1 (*e == ' ' ? e - s->c_str () : string::npos); - size_t p2 (s->rfind (' ')); + size_t p1 (*e == ' ' ? e - s->c_str () : string::npos); // + size_t p2 (s->rfind (' ')); // if (p1 != string::npos && p2 != string::npos && p2 - p1 > 1) { - string n (*s, p1 + 1, p2 - p1 - 1); + ++p1; + string name (*s, p1, p2 - p1); - // Note that we have to call substitute(), not lookup() since it - // can be overriden with custom substitution semantics. - // - optional v ( - substitute (location (ip, ln), a, t, n, strict, null)); + ++p2; + size_t p3 (s->find ('/', p2)); // - assert (v); // Rule semantics change without version increment? + optional flags; + if (p3 != string::npos) + { + uint64_t v (strtoull (s->c_str () + p3 + 1, &e, 10)); + if (*e == '\0') + flags = v; + } - if (s->compare (p2 + 1, - string::npos, - sha256 (*v).string ()) == 0) + if (p3 == string::npos || flags) { - dd_skip++; - continue; + // Note that we have to call substitute(), not lookup() since + // it can be overriden with custom substitution semantics. + // + optional v ( + substitute (location (ip, ln), + a, t, + name, flags, + strict, null)); + + assert (v); // Rule semantics change without version increment? + + if (s->compare (p2, p3, sha256 (*v).string ()) == 0) + { + dd_skip++; + continue; + } + else + l4 ([&]{trace << name << " variable value mismatch forcing " + << "update of " << t;}); } - else - l4 ([&]{trace << n << " variable value mismatch forcing " - << "update of " << t;}); + // Fall through. } @@ -325,7 +344,7 @@ namespace build2 ); string s; // Reuse the buffer. - for (size_t ln (1);; ++ln) + for (uint64_t ln (1);; ++ln) { what = "read"; whom = &ip; if (!getline (ifs, s)) @@ -340,86 +359,11 @@ namespace build2 // Not tracking column for now (see also depdb above). // - const location l (ip, ln); - - // Scan the line looking for substiutions in the $$ form. In - // the strict mode treat $$ as an escape sequence. - // - for (size_t b (0), n, d; b != (n = s.size ()); b += d) - { - d = 1; - - if (s[b] != sym) - continue; - - // Note that in the lax mode these should still be substitutions: - // - // @project@@ - // @@project@ - - // Find the other end. - // - size_t e (b + 1); - for (; e != (n = s.size ()); ++e) - { - if (s[e] == sym) - { - if (strict && e + 1 != n && s[e + 1] == sym) // Escape. - s.erase (e, 1); // Keep one, erase the other. - else - break; - } - } - - if (e == n) - { - if (strict) - fail (l) << "unterminated '" << sym << "'" << endf; - - break; - } - - if (e - b == 1) // Escape (or just double symbol in the lax mode). - { - if (strict) - s.erase (b, 1); // Keep one, erase the other. - - continue; - } - - // We have a (potential, in the lax mode) substition with b - // pointing to the opening symbol and e -- to the closing. - // - string name (s, b + 1, e - b -1); - if (optional val = - substitute (l, a, t, name, strict, null)) - { - // Save in depdb. - // - if (dd_skip == 0) - { - // The line format is: - // - // - // - string s (to_string (ln)); - s += ' '; - s += name; - s += ' '; - s += sha256 (*val).string (); - dd.write (s); - } - else - --dd_skip; - - // Patch the result in and adjust the delta. - // - s.replace (b, e - b + 1, *val); - d = val->size (); - } - else - d = e - b + 1; // Ignore this substitution. - } + process (location (ip, ln), + a, t, + dd, dd_skip, + s, 0, + (crlf ? "\r\n" : "\n"), sym, strict, null); what = "write"; whom = &tp; if (ln != 1) @@ -462,55 +406,129 @@ namespace build2 return prerequisite_target (&build2::search (t, p), i); } - string rule:: - lookup (const location& loc, - action, - const target& t, - const string& n, - const optional& null) const + void rule:: + process (const location& l, + action a, const target& t, + depdb& dd, size_t dd_skip, + string& s, size_t b, + const char* nl, + char sym, + bool strict, + const optional& null) const { - auto l (t[n]); - - if (l.defined ()) + // Scan the line looking for substiutions in the $$ form. In the + // strict mode treat $$ as an escape sequence. + // + for (size_t n, d; b != (n = s.size ()); b += d) { - value v (*l); + d = 1; - if (v.null) + if (s[b] != sym) + continue; + + // Note that in the lax mode these should still be substitutions: + // + // @project@@ + // @@project@ + + // Find the other end. + // + size_t e (b + 1); + for (; e != (n = s.size ()); ++e) { - if (null) - return *null; - else - fail (loc) << "null value in variable '" << n << "'" << - info << "use in.null to specify null value substiution string"; + if (s[e] == sym) + { + if (strict && e + 1 != n && s[e + 1] == sym) // Escape. + s.erase (e, 1); // Keep one, erase the other. + else + break; + } } - // For typed values call string() for conversion. + if (e == n) + { + if (strict) + fail (l) << "unterminated '" << sym << "'"; + + break; + } + + if (e - b == 1) // Escape (or just double symbol in the lax mode). + { + if (strict) + s.erase (b, 1); // Keep one, erase the other. + + continue; + } + + // We have a (potential, in the lax mode) substition with b pointing + // to the opening symbol and e -- to the closing. // - try + if (optional val = substitute (l, + a, t, + dd, dd_skip, + string (s, b + 1, e - b -1), + nullopt /* flags */, + strict, + null)) { - return convert ( - v.type == nullptr - ? move (v) - : t.ctx.functions.call (&t.base_scope (), - "string", - vector_view (&v, 1), - loc)); + replace_newlines (*val, nl); + + // Patch the result in and adjust the delta. + // + s.replace (b, e - b + 1, *val); + d = val->size (); } - catch (const invalid_argument& e) + else + d = e - b + 1; // Ignore this substitution. + } + } + + optional rule:: + substitute (const location& l, + action a, const target& t, + depdb& dd, size_t dd_skip, + const string& n, + optional flags, + bool strict, + const optional& null) const + { + optional val (substitute (l, a, t, n, flags, strict, null)); + + if (val) + { + // Save in depdb. + // + if (dd_skip == 0) { - fail (loc) << e << - info << "while substituting '" << n << "'" << endf; + // The line format is: + // + // [/] + // + string s (to_string (l.line)); + s += ' '; + s += n; + s += ' '; + s += sha256 (*val).string (); + if (flags) + { + s += '/'; + s += to_string (*flags); + } + dd.write (s); } + else + --dd_skip; } - else - fail (loc) << "undefined variable '" << n << "'" << endf; + + return val; } optional rule:: substitute (const location& l, - action a, - const target& t, + action a, const target& t, const string& n, + optional flags, bool strict, const optional& null) const { @@ -536,7 +554,53 @@ namespace build2 } } - return lookup (l, a, t, n, null); + return lookup (l, a, t, n, flags, null); + } + + string rule:: + lookup (const location& loc, + action, const target& t, + const string& n, + optional flags, + const optional& null) const + { + assert (!flags); + + auto l (t[n]); + + if (l.defined ()) + { + value v (*l); + + if (v.null) + { + if (null) + return *null; + else + fail (loc) << "null value in variable '" << n << "'" << + info << "use in.null to specify null value substiution string"; + } + + // For typed values call string() for conversion. + // + try + { + return convert ( + v.type == nullptr + ? move (v) + : t.ctx.functions.call (&t.base_scope (), + "string", + vector_view (&v, 1), + loc)); + } + catch (const invalid_argument& e) + { + fail (loc) << e << + info << "while substituting '" << n << "'" << endf; + } + } + else + fail (loc) << "undefined variable '" << n << "'" << endf; } } } diff --git a/libbuild2/in/rule.hxx b/libbuild2/in/rule.hxx index 2fa1305..162ce78 100644 --- a/libbuild2/in/rule.hxx +++ b/libbuild2/in/rule.hxx @@ -50,14 +50,18 @@ namespace build2 virtual target_state perform_update (action, const target&) const; - // Customization hooks. + // Customization hooks and helpers. + // + // Flags can be used by a custom implementation to alter the lookup + // semantics, for example, for special substitutions. Note, however, + // that one must make sure this semantics cannot change without changes + // to the .in file (see the depdb logic for details). // // Perform prerequisite search. // virtual prerequisite_target - search (action, - const target&, + search (action, const target&, const prerequisite_member&, include_type) const; @@ -65,9 +69,9 @@ namespace build2 // virtual string lookup (const location&, - action, - const target&, + action, const target&, const string& name, + optional flags, const optional& null) const; // Perform variable substitution. Return nullopt if it should be @@ -75,12 +79,58 @@ namespace build2 // virtual optional substitute (const location&, - action, - const target&, + action, const target&, + const string& name, + optional flags, + bool strict, + const optional& null) const; + + // Call the above version and do any necessary depdb saving. + // + optional + substitute (const location&, + action, const target&, + depdb& dd, size_t dd_skip, const string& name, + optional flags, bool strict, const optional& null) const; + // Process a line of input from the specified position performing any + // necessary substitutions. + // + virtual void + process (const location&, + action, const target&, + depdb& dd, size_t dd_skip, + string& line, size_t pos, + const char* newline, + char sym, + bool strict, + const optional& null) const; + + // Replace newlines in a multi-line value with the given newline + // sequence. + // + static void + replace_newlines (string& v, const char* newline) + { + for (size_t p (0), n; (p = v.find ('\n', p)) != string::npos; p += n) + { + n = 1; + + // Deal with CRLF in the value. + // + if (p != 0 && v[p - 1] == '\r') + { + --p; + ++n; + } + + v.replace (p, n, newline); + } + } + protected: const string rule_id_; const string program_; diff --git a/libbuild2/version/rule.cxx b/libbuild2/version/rule.cxx index 919dfcf..4da4e3f 100644 --- a/libbuild2/version/rule.cxx +++ b/libbuild2/version/rule.cxx @@ -89,8 +89,11 @@ namespace build2 action a, const target& t, const string& n, + optional flags, const optional& null) const { + assert (!flags); + // Note that this code will be executed during up-to-date check for each // substitution so let's try not to do anything overly sub-optimal here. // @@ -110,6 +113,7 @@ namespace build2 a, t, p == string::npos ? n : string (n, p + 1), + nullopt, null); } diff --git a/libbuild2/version/rule.hxx b/libbuild2/version/rule.hxx index ddc5e11..c174f40 100644 --- a/libbuild2/version/rule.hxx +++ b/libbuild2/version/rule.hxx @@ -30,6 +30,7 @@ namespace build2 action, const target&, const string&, + optional, const optional&) const override; }; -- cgit v1.1