PosixParser.cpp 79 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226
  1. /*
  2. * Copyright (c) 2022, Ali Mohammad Pur <mpfard@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/CharacterTypes.h>
  7. #include <AK/Debug.h>
  8. #include <AK/StringUtils.h>
  9. #include <Shell/Parser.h>
  10. #include <Shell/PosixParser.h>
  11. #define TRY_OR_THROW_PARSE_ERROR_AT(expr, position) ({ \
  12. /* Ignore -Wshadow to allow nesting the macro. */ \
  13. AK_IGNORE_DIAGNOSTIC("-Wshadow", \
  14. auto&& _value_or_error = expr;) \
  15. if (_value_or_error.is_error()) { \
  16. AK_IGNORE_DIAGNOSTIC("-Wshadow", \
  17. auto _error = _value_or_error.release_error();) \
  18. if (_error.is_errno() && _error.code() == ENOMEM) \
  19. return make_ref_counted<AST::SyntaxError>(position, "OOM"_string); \
  20. return make_ref_counted<AST::SyntaxError>(position, MUST(String::formatted("Error: {}", _error))); \
  21. } \
  22. _value_or_error.release_value(); \
  23. })
  24. static RefPtr<Shell::AST::Node> strip_execute(RefPtr<Shell::AST::Node> node)
  25. {
  26. while (node && node->is_execute())
  27. node = static_ptr_cast<Shell::AST::Execute>(node)->command();
  28. return node;
  29. }
  30. static Shell::AST::Position empty_position()
  31. {
  32. return { 0, 0, { 0, 0 }, { 0, 0 } };
  33. }
  34. template<typename T, typename... Ts>
  35. static inline bool is_one_of(T const& value, Ts const&... values)
  36. {
  37. return ((value == values) || ...);
  38. }
  39. static inline bool is_io_operator(Shell::Posix::Token const& token)
  40. {
  41. using namespace Shell::Posix;
  42. return is_one_of(token.type,
  43. Token::Type::Less, Token::Type::Great,
  44. Token::Type::LessAnd, Token::Type::GreatAnd,
  45. Token::Type::DoubleLess, Token::Type::DoubleGreat,
  46. Token::Type::DoubleLessDash, Token::Type::LessGreat,
  47. Token::Type::Clobber);
  48. }
  49. static inline bool is_separator(Shell::Posix::Token const& token)
  50. {
  51. using namespace Shell::Posix;
  52. return is_one_of(token.type,
  53. Token::Type::Semicolon, Token::Type::Newline,
  54. Token::Type::AndIf, Token::Type::OrIf,
  55. Token::Type::Pipe,
  56. Token::Type::And);
  57. }
  58. static inline bool is_a_reserved_word_position(Shell::Posix::Token const& token, Optional<Shell::Posix::Token> const& previous_token, Optional<Shell::Posix::Token> const& previous_previous_token)
  59. {
  60. using namespace Shell::Posix;
  61. auto is_start_of_command = !previous_token.has_value()
  62. || previous_token->value.is_empty()
  63. || is_separator(*previous_token)
  64. || is_one_of(previous_token->type,
  65. Token::Type::OpenParen, Token::Type::CloseParen, Token::Type::Newline, Token::Type::DoubleSemicolon,
  66. Token::Type::Semicolon, Token::Type::Pipe, Token::Type::OrIf, Token::Type::AndIf);
  67. if (is_start_of_command)
  68. return true;
  69. if (!previous_token.has_value())
  70. return false;
  71. auto previous_is_reserved_word = is_one_of(previous_token->value,
  72. "for"sv, "in"sv, "case"sv, "if"sv, "then"sv, "else"sv,
  73. "elif"sv, "while"sv, "until"sv, "do"sv, "done"sv, "esac"sv,
  74. "fi"sv, "!"sv, "{"sv, "}"sv);
  75. if (previous_is_reserved_word)
  76. return true;
  77. if (!previous_previous_token.has_value())
  78. return false;
  79. auto is_third_in_case = previous_previous_token->value == "case"sv
  80. && token.type == Token::Type::Token && token.value == "in"sv;
  81. if (is_third_in_case)
  82. return true;
  83. auto is_third_in_for = previous_previous_token->value == "for"sv
  84. && token.type == Token::Type::Token && is_one_of(token.value, "in"sv, "do"sv);
  85. return is_third_in_for;
  86. }
  87. static inline bool is_reserved(Shell::Posix::Token const& token)
  88. {
  89. using namespace Shell::Posix;
  90. return is_one_of(token.type,
  91. Token::Type::If, Token::Type::Then, Token::Type::Else,
  92. Token::Type::Elif, Token::Type::Fi, Token::Type::Do,
  93. Token::Type::Done, Token::Type::Case, Token::Type::Esac,
  94. Token::Type::While, Token::Type::Until, Token::Type::For,
  95. Token::Type::In, Token::Type::OpenBrace, Token::Type::CloseBrace,
  96. Token::Type::Bang);
  97. }
  98. static inline bool is_valid_name(StringView word)
  99. {
  100. // Dr.POSIX: a word consisting solely of underscores, digits, and alphabetics from the portable character set. The first character of a name is not a digit.
  101. return !word.is_empty()
  102. && !is_ascii_digit(word[0])
  103. && all_of(word, [](auto ch) { return is_ascii_alphanumeric(ch) || ch == '_'; });
  104. }
  105. namespace Shell::Posix {
  106. template<typename... Args>
  107. static NonnullRefPtr<AST::Node> reexpand(AST::Position position, Args&&... args)
  108. {
  109. return make_ref_counted<AST::ImmediateExpression>(
  110. position,
  111. AST::NameWithPosition {
  112. "reexpand"_string,
  113. position,
  114. },
  115. Vector<NonnullRefPtr<AST::Node>> { forward<Args>(args)... },
  116. Optional<AST::Position> {});
  117. }
  118. ErrorOr<void> Parser::fill_token_buffer(Optional<Reduction> starting_reduction)
  119. {
  120. for (;;) {
  121. auto token = TRY(next_expanded_token(starting_reduction));
  122. if (!token.has_value())
  123. break;
  124. #if SHELL_POSIX_PARSER_DEBUG
  125. DeprecatedString position = "(~)";
  126. if (token->position.has_value())
  127. position = DeprecatedString::formatted("{}:{}", token->position->start_offset, token->position->end_offset);
  128. DeprecatedString expansions = "";
  129. for (auto& exp : token->resolved_expansions)
  130. exp.visit(
  131. [&](ResolvedParameterExpansion& x) { expansions = DeprecatedString::formatted("{}param({}),", expansions, x.to_deprecated_string()); },
  132. [&](ResolvedCommandExpansion& x) { expansions = DeprecatedString::formatted("{}command({:p})", expansions, x.command.ptr()); },
  133. [&](ResolvedArithmeticExpansion& x) { expansions = DeprecatedString::formatted("{}arith({})", expansions, x.source_expression); });
  134. DeprecatedString rexpansions = "";
  135. for (auto& exp : token->expansions)
  136. exp.visit(
  137. [&](ParameterExpansion& x) { rexpansions = DeprecatedString::formatted("{}param({}) from {} to {},", rexpansions, x.parameter.string_view(), x.range.start, x.range.length); },
  138. [&](auto&) { rexpansions = DeprecatedString::formatted("{}...,", rexpansions); });
  139. dbgln("Token @ {}: '{}' (type {}) - parsed expansions: {} - raw expansions: {}", position, token->value.replace("\n"sv, "\\n"sv, ReplaceMode::All), token->type_name(), expansions, rexpansions);
  140. #endif
  141. }
  142. m_token_index = 0;
  143. // Detect Assignment words, bash-like lists extension
  144. for (size_t i = 1; i < m_token_buffer.size(); ++i) {
  145. // Treat 'ASSIGNMENT_WORD OPEN_PAREN' where ASSIGNMENT_WORD is `word=' and OPEN_PAREN has no preceding trivia as a bash-like list assignment.
  146. auto& token = m_token_buffer[i - 1];
  147. auto& next_token = m_token_buffer[i];
  148. if (token.type != Token::Type::AssignmentWord)
  149. continue;
  150. if (!token.value.ends_with('='))
  151. continue;
  152. if (next_token.type != Token::Type::OpenParen)
  153. continue;
  154. if (token.position.map([](auto& x) { return x.end_offset + 1; }) != next_token.position.map([](auto& x) { return x.start_offset; }))
  155. continue;
  156. token.type = Token::Type::ListAssignmentWord;
  157. }
  158. return {};
  159. }
  160. RefPtr<AST::Node> Parser::parse()
  161. {
  162. auto start_position = peek().position.value_or(empty_position());
  163. return TRY_OR_THROW_PARSE_ERROR_AT(parse_complete_command(), start_position);
  164. }
  165. void Parser::handle_heredoc_contents()
  166. {
  167. while (!eof() && m_token_buffer[m_token_index].type == Token::Type::HeredocContents) {
  168. auto& token = m_token_buffer[m_token_index++];
  169. auto entry = m_unprocessed_heredoc_entries.get(token.relevant_heredoc_key.value());
  170. if (!entry.has_value()) {
  171. error(token, "Discarding unexpected heredoc contents for key '{}'", *token.relevant_heredoc_key);
  172. continue;
  173. }
  174. auto& heredoc = **entry;
  175. auto contents_or_error = [&]() -> ErrorOr<RefPtr<AST::Node>> {
  176. if (heredoc.allow_interpolation()) {
  177. Parser parser { token.value, m_in_interactive_mode, Reduction::HeredocContents };
  178. return parser.parse_word();
  179. }
  180. return make_ref_counted<AST::StringLiteral>(
  181. token.position.value_or(empty_position()),
  182. TRY(String::from_utf8(token.value)),
  183. AST::StringLiteral::EnclosureType::None);
  184. }();
  185. if (contents_or_error.is_error()) {
  186. warnln("Shell: Failed to parse heredoc contents: {}", contents_or_error.error());
  187. continue;
  188. }
  189. if (auto contents = contents_or_error.release_value())
  190. heredoc.set_contents(contents);
  191. m_unprocessed_heredoc_entries.remove(*token.relevant_heredoc_key);
  192. }
  193. }
  194. ErrorOr<Optional<Token>> Parser::next_expanded_token(Optional<Reduction> starting_reduction)
  195. {
  196. while (m_token_buffer.is_empty() || m_token_buffer.last().type != Token::Type::Eof) {
  197. auto tokens = TRY(m_lexer.batch_next(starting_reduction));
  198. auto expanded = perform_expansions(move(tokens));
  199. m_token_buffer.extend(expanded);
  200. }
  201. if (m_token_buffer.size() == m_token_index)
  202. return OptionalNone {};
  203. return m_token_buffer[m_token_index++];
  204. }
  205. Vector<Token> Parser::perform_expansions(Vector<Token> tokens)
  206. {
  207. if (tokens.is_empty())
  208. return {};
  209. Vector<Token> expanded_tokens;
  210. auto previous_token = Optional<Token>();
  211. auto previous_previous_token = Optional<Token>();
  212. auto tokens_taken_from_buffer = 0;
  213. expanded_tokens.ensure_capacity(tokens.size());
  214. auto swap_expansions = [&] {
  215. if (previous_previous_token.has_value())
  216. expanded_tokens.append(previous_previous_token.release_value());
  217. if (previous_token.has_value())
  218. expanded_tokens.append(previous_token.release_value());
  219. for (; tokens_taken_from_buffer > 0; tokens_taken_from_buffer--)
  220. m_token_buffer.append(expanded_tokens.take_first());
  221. swap(tokens, expanded_tokens);
  222. expanded_tokens.clear_with_capacity();
  223. };
  224. // (1) join all consecutive newlines (this works around a grammar ambiguity)
  225. auto previous_was_newline = !m_token_buffer.is_empty() && m_token_buffer.last().type == Token::Type::Newline;
  226. for (auto& token : tokens) {
  227. if (token.type == Token::Type::Newline) {
  228. if (previous_was_newline)
  229. continue;
  230. previous_was_newline = true;
  231. } else {
  232. previous_was_newline = false;
  233. }
  234. expanded_tokens.append(move(token));
  235. }
  236. swap_expansions();
  237. // (2) Detect reserved words
  238. if (m_token_buffer.size() >= 1) {
  239. previous_token = m_token_buffer.take_last();
  240. tokens_taken_from_buffer++;
  241. }
  242. if (m_token_buffer.size() >= 1) {
  243. previous_previous_token = m_token_buffer.take_last();
  244. tokens_taken_from_buffer++;
  245. }
  246. auto check_reserved_word = [&](auto& token) {
  247. if (is_a_reserved_word_position(token, previous_token, previous_previous_token)) {
  248. if (token.value == "if"sv)
  249. token.type = Token::Type::If;
  250. else if (token.value == "then"sv)
  251. token.type = Token::Type::Then;
  252. else if (token.value == "else"sv)
  253. token.type = Token::Type::Else;
  254. else if (token.value == "elif"sv)
  255. token.type = Token::Type::Elif;
  256. else if (token.value == "fi"sv)
  257. token.type = Token::Type::Fi;
  258. else if (token.value == "while"sv)
  259. token.type = Token::Type::While;
  260. else if (token.value == "until"sv)
  261. token.type = Token::Type::Until;
  262. else if (token.value == "do"sv)
  263. token.type = Token::Type::Do;
  264. else if (token.value == "done"sv)
  265. token.type = Token::Type::Done;
  266. else if (token.value == "case"sv)
  267. token.type = Token::Type::Case;
  268. else if (token.value == "esac"sv)
  269. token.type = Token::Type::Esac;
  270. else if (token.value == "for"sv)
  271. token.type = Token::Type::For;
  272. else if (token.value == "in"sv)
  273. token.type = Token::Type::In;
  274. else if (token.value == "!"sv)
  275. token.type = Token::Type::Bang;
  276. else if (token.value == "{"sv)
  277. token.type = Token::Type::OpenBrace;
  278. else if (token.value == "}"sv)
  279. token.type = Token::Type::CloseBrace;
  280. else if (token.type == Token::Type::Token)
  281. token.type = Token::Type::Word;
  282. } else if (token.type == Token::Type::Token) {
  283. token.type = Token::Type::Word;
  284. }
  285. };
  286. for (auto& token : tokens) {
  287. if (!previous_token.has_value()) {
  288. check_reserved_word(token);
  289. previous_token = token;
  290. continue;
  291. }
  292. if (!previous_previous_token.has_value()) {
  293. check_reserved_word(token);
  294. previous_previous_token = move(previous_token);
  295. previous_token = token;
  296. continue;
  297. }
  298. check_reserved_word(token);
  299. expanded_tokens.append(exchange(*previous_previous_token, exchange(*previous_token, move(token))));
  300. }
  301. swap_expansions();
  302. // (3) Detect io_number tokens
  303. previous_token = Optional<Token>();
  304. tokens_taken_from_buffer = 0;
  305. if (m_token_buffer.size() >= 1) {
  306. previous_token = m_token_buffer.take_last();
  307. tokens_taken_from_buffer++;
  308. }
  309. for (auto& token : tokens) {
  310. if (!previous_token.has_value()) {
  311. previous_token = token;
  312. continue;
  313. }
  314. if (is_io_operator(token) && previous_token->type == Token::Type::Word && all_of(previous_token->value.bytes_as_string_view(), is_ascii_digit)) {
  315. previous_token->type = Token::Type::IoNumber;
  316. }
  317. expanded_tokens.append(exchange(*previous_token, move(token)));
  318. }
  319. swap_expansions();
  320. // (4) Try to identify simple commands
  321. previous_token = Optional<Token>();
  322. tokens_taken_from_buffer = 0;
  323. if (m_token_buffer.size() >= 1) {
  324. previous_token = m_token_buffer.take_last();
  325. tokens_taken_from_buffer++;
  326. }
  327. for (auto& token : tokens) {
  328. if (!previous_token.has_value()) {
  329. token.could_be_start_of_a_simple_command = true;
  330. previous_token = token;
  331. continue;
  332. }
  333. token.could_be_start_of_a_simple_command = is_one_of(previous_token->type, Token::Type::OpenParen, Token::Type::CloseParen, Token::Type::Newline)
  334. || is_separator(*previous_token)
  335. || (!is_reserved(*previous_token) && is_reserved(token));
  336. expanded_tokens.append(exchange(*previous_token, move(token)));
  337. }
  338. swap_expansions();
  339. // (5) Detect assignment words
  340. for (auto& token : tokens) {
  341. if (token.could_be_start_of_a_simple_command)
  342. m_disallow_command_prefix = false;
  343. // Check if we're in a command prefix (could be an assignment)
  344. if (!m_disallow_command_prefix && token.type == Token::Type::Word && token.value.contains('=')) {
  345. // If the word before '=' is a valid name, this is an assignment
  346. auto equal_offset = *token.value.find_byte_offset('=');
  347. if (is_valid_name(token.value.bytes_as_string_view().substring_view(0, equal_offset)))
  348. token.type = Token::Type::AssignmentWord;
  349. else
  350. m_disallow_command_prefix = true;
  351. } else {
  352. m_disallow_command_prefix = true;
  353. }
  354. expanded_tokens.append(move(token));
  355. }
  356. swap_expansions();
  357. // (6) Parse expansions
  358. for (auto& token : tokens) {
  359. if (!is_one_of(token.type, Token::Type::Word, Token::Type::AssignmentWord)) {
  360. expanded_tokens.append(move(token));
  361. continue;
  362. }
  363. Vector<ResolvedExpansion> resolved_expansions;
  364. for (auto& expansion : token.expansions) {
  365. auto resolved = expansion.visit(
  366. [&](ParameterExpansion const& expansion) -> ResolvedExpansion {
  367. auto text = expansion.parameter.string_view();
  368. // ${NUMBER}
  369. if (all_of(text, is_ascii_digit)) {
  370. return ResolvedParameterExpansion {
  371. .parameter = expansion.parameter.to_string().release_value_but_fixme_should_propagate_errors(),
  372. .argument = {},
  373. .range = expansion.range,
  374. .op = ResolvedParameterExpansion::Op::GetPositionalParameter,
  375. .expand = ResolvedParameterExpansion::Expand::Word,
  376. };
  377. }
  378. if (text.length() == 1) {
  379. ResolvedParameterExpansion::Op op;
  380. switch (text[0]) {
  381. case '!':
  382. op = ResolvedParameterExpansion::Op::GetLastBackgroundPid;
  383. break;
  384. case '@':
  385. op = ResolvedParameterExpansion::Op::GetPositionalParameterList;
  386. break;
  387. case '-':
  388. op = ResolvedParameterExpansion::Op::GetCurrentOptionFlags;
  389. break;
  390. case '#':
  391. op = ResolvedParameterExpansion::Op::GetPositionalParameterCount;
  392. break;
  393. case '?':
  394. op = ResolvedParameterExpansion::Op::GetLastExitStatus;
  395. break;
  396. case '*':
  397. op = ResolvedParameterExpansion::Op::GetPositionalParameterListAsString;
  398. break;
  399. case '$':
  400. op = ResolvedParameterExpansion::Op::GetShellProcessId;
  401. break;
  402. default:
  403. if (is_valid_name(text)) {
  404. op = ResolvedParameterExpansion::Op::GetVariable;
  405. } else {
  406. error(token, "Unknown parameter expansion: {}", text);
  407. return ResolvedParameterExpansion {
  408. .parameter = expansion.parameter.to_string().release_value_but_fixme_should_propagate_errors(),
  409. .argument = {},
  410. .range = expansion.range,
  411. .op = ResolvedParameterExpansion::Op::StringLength,
  412. };
  413. }
  414. }
  415. return ResolvedParameterExpansion {
  416. .parameter = String::from_code_point(text[0]),
  417. .argument = {},
  418. .range = expansion.range,
  419. .op = op,
  420. .expand = ResolvedParameterExpansion::Expand::Word,
  421. };
  422. }
  423. if (text.starts_with('#')) {
  424. return ResolvedParameterExpansion {
  425. .parameter = String::from_utf8(text.substring_view(1)).release_value_but_fixme_should_propagate_errors(),
  426. .argument = {},
  427. .range = expansion.range,
  428. .op = ResolvedParameterExpansion::Op::StringLength,
  429. };
  430. }
  431. GenericLexer lexer { text };
  432. auto parameter = lexer.consume_while([first = true](char c) mutable {
  433. if (first) {
  434. first = false;
  435. return is_ascii_alpha(c) || c == '_';
  436. }
  437. return is_ascii_alphanumeric(c) || c == '_';
  438. });
  439. StringView argument;
  440. ResolvedParameterExpansion::Op op;
  441. switch (lexer.peek()) {
  442. case ':':
  443. lexer.ignore();
  444. switch (lexer.is_eof() ? 0 : lexer.consume()) {
  445. case '-':
  446. argument = lexer.consume_all();
  447. op = ResolvedParameterExpansion::Op::UseDefaultValue;
  448. break;
  449. case '=':
  450. argument = lexer.consume_all();
  451. op = ResolvedParameterExpansion::Op::AssignDefaultValue;
  452. break;
  453. case '?':
  454. argument = lexer.consume_all();
  455. op = ResolvedParameterExpansion::Op::IndicateErrorIfEmpty;
  456. break;
  457. case '+':
  458. argument = lexer.consume_all();
  459. op = ResolvedParameterExpansion::Op::UseAlternativeValue;
  460. break;
  461. default:
  462. error(token, "Unknown parameter expansion: {}", text);
  463. return ResolvedParameterExpansion {
  464. .parameter = String::from_utf8(parameter).release_value_but_fixme_should_propagate_errors(),
  465. .argument = {},
  466. .range = expansion.range,
  467. .op = ResolvedParameterExpansion::Op::StringLength,
  468. };
  469. }
  470. break;
  471. case '-':
  472. lexer.ignore();
  473. argument = lexer.consume_all();
  474. op = ResolvedParameterExpansion::Op::UseDefaultValueIfUnset;
  475. break;
  476. case '=':
  477. lexer.ignore();
  478. argument = lexer.consume_all();
  479. op = ResolvedParameterExpansion::Op::AssignDefaultValueIfUnset;
  480. break;
  481. case '?':
  482. lexer.ignore();
  483. argument = lexer.consume_all();
  484. op = ResolvedParameterExpansion::Op::IndicateErrorIfUnset;
  485. break;
  486. case '+':
  487. lexer.ignore();
  488. argument = lexer.consume_all();
  489. op = ResolvedParameterExpansion::Op::UseAlternativeValueIfUnset;
  490. break;
  491. case '%':
  492. if (lexer.consume_specific('%'))
  493. op = ResolvedParameterExpansion::Op::RemoveLargestSuffixByPattern;
  494. else
  495. op = ResolvedParameterExpansion::Op::RemoveSmallestSuffixByPattern;
  496. argument = lexer.consume_all();
  497. break;
  498. case '#':
  499. if (lexer.consume_specific('#'))
  500. op = ResolvedParameterExpansion::Op::RemoveLargestPrefixByPattern;
  501. else
  502. op = ResolvedParameterExpansion::Op::RemoveSmallestPrefixByPattern;
  503. argument = lexer.consume_all();
  504. break;
  505. default:
  506. if (is_valid_name(text)) {
  507. op = ResolvedParameterExpansion::Op::GetVariable;
  508. } else {
  509. error(token, "Unknown parameter expansion: {}", text);
  510. return ResolvedParameterExpansion {
  511. .parameter = String::from_utf8(parameter).release_value_but_fixme_should_propagate_errors(),
  512. .argument = {},
  513. .range = expansion.range,
  514. .op = ResolvedParameterExpansion::Op::StringLength,
  515. };
  516. }
  517. }
  518. VERIFY(lexer.is_eof());
  519. return ResolvedParameterExpansion {
  520. .parameter = String::from_utf8(parameter).release_value_but_fixme_should_propagate_errors(),
  521. .argument = String::from_utf8(argument).release_value_but_fixme_should_propagate_errors(),
  522. .range = expansion.range,
  523. .op = op,
  524. .expand = ResolvedParameterExpansion::Expand::Word,
  525. };
  526. },
  527. [&](ArithmeticExpansion const& expansion) -> ResolvedExpansion {
  528. return ResolvedArithmeticExpansion { expansion.expression, expansion.range };
  529. },
  530. [&](CommandExpansion const& expansion) -> ResolvedExpansion {
  531. Parser parser { expansion.command.string_view() };
  532. auto node = parser.parse();
  533. m_errors.extend(move(parser.m_errors));
  534. return ResolvedCommandExpansion {
  535. move(node),
  536. expansion.range,
  537. };
  538. });
  539. resolved_expansions.append(move(resolved));
  540. }
  541. token.resolved_expansions = move(resolved_expansions);
  542. expanded_tokens.append(move(token));
  543. }
  544. swap_expansions();
  545. // (7) Loop variables
  546. previous_token = {};
  547. tokens_taken_from_buffer = 0;
  548. if (m_token_buffer.size() >= 1) {
  549. previous_token = m_token_buffer.take_last();
  550. tokens_taken_from_buffer++;
  551. }
  552. for (auto& token : tokens) {
  553. if (!previous_token.has_value()) {
  554. previous_token = token;
  555. continue;
  556. }
  557. if (previous_token->type == Token::Type::For && token.type == Token::Type::Word && is_valid_name(token.value)) {
  558. token.type = Token::Type::VariableName;
  559. }
  560. expanded_tokens.append(exchange(*previous_token, token));
  561. }
  562. swap_expansions();
  563. // (8) Function names
  564. previous_token = {};
  565. previous_previous_token = {};
  566. tokens_taken_from_buffer = 0;
  567. if (m_token_buffer.size() >= 1) {
  568. previous_token = m_token_buffer.take_last();
  569. tokens_taken_from_buffer++;
  570. }
  571. if (m_token_buffer.size() >= 1) {
  572. previous_previous_token = m_token_buffer.take_last();
  573. tokens_taken_from_buffer++;
  574. }
  575. for (auto& token : tokens) {
  576. if (!previous_token.has_value()) {
  577. previous_token = token;
  578. continue;
  579. }
  580. if (!previous_previous_token.has_value()) {
  581. previous_previous_token = move(previous_token);
  582. previous_token = token;
  583. continue;
  584. }
  585. // NAME ( )
  586. if (previous_previous_token->could_be_start_of_a_simple_command
  587. && previous_previous_token->type == Token::Type::Word
  588. && previous_token->type == Token::Type::OpenParen
  589. && token.type == Token::Type::CloseParen) {
  590. previous_previous_token->type = Token::Type::VariableName;
  591. }
  592. expanded_tokens.append(exchange(*previous_previous_token, exchange(*previous_token, token)));
  593. }
  594. swap_expansions();
  595. return tokens;
  596. }
  597. ErrorOr<RefPtr<AST::Node>> Parser::parse_complete_command()
  598. {
  599. auto list = TRY([&]() -> ErrorOr<RefPtr<AST::Node>> {
  600. // separator...
  601. while (is_separator(peek()))
  602. skip();
  603. // list EOF
  604. auto list = TRY(parse_list());
  605. if (eof())
  606. return list;
  607. // list separator EOF
  608. while (is_separator(peek()))
  609. skip();
  610. if (eof())
  611. return list;
  612. auto position = peek().position;
  613. auto syntax_error = make_ref_counted<AST::SyntaxError>(
  614. position.value_or(empty_position()),
  615. "Extra tokens after complete command"_string);
  616. if (list)
  617. list->set_is_syntax_error(*syntax_error);
  618. else
  619. list = syntax_error;
  620. return list;
  621. }());
  622. if (!list)
  623. return nullptr;
  624. return make_ref_counted<AST::Execute>(list->position(), *list);
  625. }
  626. ErrorOr<RefPtr<AST::Node>> Parser::parse_list()
  627. {
  628. Vector<NonnullRefPtr<AST::Node>> nodes;
  629. Vector<AST::Position> positions;
  630. auto start_position = peek().position.value_or(empty_position());
  631. for (;;) {
  632. auto new_node = TRY(parse_and_or());
  633. if (!new_node)
  634. break;
  635. if (peek().type == Token::Type::And) {
  636. new_node = make_ref_counted<AST::Background>(
  637. new_node->position(),
  638. *new_node);
  639. }
  640. nodes.append(new_node.release_nonnull());
  641. if (!is_separator(peek()) || eof())
  642. break;
  643. auto position = consume().position;
  644. if (position.has_value())
  645. positions.append(position.release_value());
  646. }
  647. auto end_position = peek().position.value_or(empty_position());
  648. return make_ref_counted<AST::Sequence>(
  649. AST::Position {
  650. start_position.start_offset,
  651. end_position.end_offset,
  652. start_position.start_line,
  653. end_position.end_line,
  654. },
  655. move(nodes),
  656. move(positions));
  657. }
  658. ErrorOr<RefPtr<AST::Node>> Parser::parse_and_or()
  659. {
  660. while (peek().type == Token::Type::Newline)
  661. skip();
  662. auto node = TRY(parse_pipeline());
  663. if (!node)
  664. return RefPtr<AST::Node> {};
  665. for (;;) {
  666. if (peek().type == Token::Type::AndIf) {
  667. auto and_token = consume();
  668. while (peek().type == Token::Type::Newline)
  669. skip();
  670. auto rhs = TRY(parse_pipeline());
  671. if (!rhs)
  672. return RefPtr<AST::Node> {};
  673. node = make_ref_counted<AST::And>(
  674. node->position(),
  675. *node,
  676. rhs.release_nonnull(),
  677. and_token.position.value_or(empty_position()));
  678. continue;
  679. }
  680. if (peek().type == Token::Type::OrIf) {
  681. auto or_token = consume();
  682. while (peek().type == Token::Type::Newline)
  683. skip();
  684. auto rhs = TRY(parse_pipeline());
  685. if (!rhs)
  686. return RefPtr<AST::Node> {};
  687. node = make_ref_counted<AST::And>(
  688. node->position(),
  689. *node,
  690. rhs.release_nonnull(),
  691. or_token.position.value_or(empty_position()));
  692. continue;
  693. }
  694. break;
  695. }
  696. return node;
  697. }
  698. ErrorOr<RefPtr<AST::Node>> Parser::parse_pipeline()
  699. {
  700. while (peek().type == Token::Type::Newline)
  701. skip();
  702. auto is_negated = false;
  703. if (peek().type == Token::Type::Bang) {
  704. is_negated = true;
  705. skip();
  706. }
  707. return parse_pipe_sequence(is_negated);
  708. }
  709. ErrorOr<RefPtr<AST::Node>> Parser::parse_pipe_sequence(bool is_negated)
  710. {
  711. auto node = TRY(parse_command());
  712. if (!node)
  713. return RefPtr<AST::Node> {};
  714. if (is_negated) {
  715. if (is<AST::CastToCommand>(node.ptr())) {
  716. node = make_ref_counted<AST::CastToCommand>(
  717. node->position(),
  718. make_ref_counted<AST::ListConcatenate>(
  719. node->position(),
  720. Vector<NonnullRefPtr<AST::Node>> {
  721. make_ref_counted<AST::BarewordLiteral>(
  722. node->position(),
  723. "not"_string),
  724. *static_cast<AST::CastToCommand&>(*node).inner() }));
  725. }
  726. }
  727. for (;;) {
  728. if (peek().type != Token::Type::Pipe)
  729. break;
  730. consume();
  731. while (peek().type == Token::Type::Newline)
  732. skip();
  733. auto rhs = TRY(parse_command());
  734. if (!rhs)
  735. return RefPtr<AST::Node> {};
  736. node = make_ref_counted<AST::Pipe>(
  737. node->position(),
  738. *node,
  739. rhs.release_nonnull());
  740. }
  741. return node;
  742. }
  743. ErrorOr<RefPtr<AST::Node>> Parser::parse_command()
  744. {
  745. auto node = TRY([this]() -> ErrorOr<RefPtr<AST::Node>> {
  746. if (auto node = TRY(parse_function_definition()))
  747. return node;
  748. if (auto node = TRY(parse_simple_command()))
  749. return make_ref_counted<AST::CastToCommand>(node->position(), *node);
  750. auto node = TRY(parse_compound_command());
  751. if (!node)
  752. return node;
  753. if (auto list = TRY(parse_redirect_list())) {
  754. auto position = list->position();
  755. node = make_ref_counted<AST::Join>(
  756. node->position().with_end(position),
  757. *node,
  758. list.release_nonnull());
  759. }
  760. return node;
  761. }());
  762. if (!node)
  763. return nullptr;
  764. return node;
  765. }
  766. ErrorOr<RefPtr<AST::Node>> Parser::parse_function_definition()
  767. {
  768. // NAME OPEN_PAREN CLOSE_PAREN newline* function_body
  769. auto start_index = m_token_index;
  770. ArmedScopeGuard reset = [&] {
  771. m_token_index = start_index;
  772. };
  773. if (peek().type != Token::Type::VariableName) {
  774. return nullptr;
  775. }
  776. auto name = consume();
  777. if (consume().type != Token::Type::OpenParen)
  778. return nullptr;
  779. if (consume().type != Token::Type::CloseParen)
  780. return nullptr;
  781. while (peek().type == Token::Type::Newline)
  782. skip();
  783. auto body = TRY(parse_function_body());
  784. if (!body)
  785. return nullptr;
  786. reset.disarm();
  787. return make_ref_counted<AST::FunctionDeclaration>(
  788. name.position.value_or(empty_position()).with_end(peek().position.value_or(empty_position())),
  789. AST::NameWithPosition { TRY(String::from_utf8(name.value)), name.position.value_or(empty_position()) },
  790. Vector<AST::NameWithPosition> {},
  791. body.release_nonnull());
  792. }
  793. ErrorOr<RefPtr<AST::Node>> Parser::parse_function_body()
  794. {
  795. // compound_command redirect_list?
  796. auto node = TRY(parse_compound_command());
  797. if (!node)
  798. return nullptr;
  799. if (auto list = TRY(parse_redirect_list())) {
  800. auto position = list->position();
  801. node = make_ref_counted<AST::Join>(
  802. node->position().with_end(position),
  803. *node,
  804. list.release_nonnull());
  805. }
  806. return node;
  807. }
  808. ErrorOr<RefPtr<AST::Node>> Parser::parse_redirect_list()
  809. {
  810. // io_redirect*
  811. RefPtr<AST::Node> node;
  812. for (;;) {
  813. auto new_node = TRY(parse_io_redirect());
  814. if (!new_node)
  815. break;
  816. if (node) {
  817. node = make_ref_counted<AST::Join>(
  818. node->position().with_end(new_node->position()),
  819. *node,
  820. new_node.release_nonnull());
  821. } else {
  822. node = new_node;
  823. }
  824. }
  825. return node;
  826. }
  827. ErrorOr<RefPtr<AST::Node>> Parser::parse_compound_command()
  828. {
  829. if (auto node = TRY(parse_brace_group()))
  830. return node;
  831. if (auto node = TRY(parse_subshell()))
  832. return node;
  833. if (auto node = TRY(parse_if_clause()))
  834. return node;
  835. if (auto node = TRY(parse_for_clause()))
  836. return node;
  837. if (auto node = TRY(parse_case_clause()))
  838. return node;
  839. if (auto node = TRY(parse_while_clause()))
  840. return node;
  841. if (auto node = TRY(parse_until_clause()))
  842. return node;
  843. return nullptr;
  844. }
  845. ErrorOr<RefPtr<AST::Node>> Parser::parse_while_clause()
  846. {
  847. if (peek().type != Token::Type::While)
  848. return nullptr;
  849. auto start_position = consume().position.value_or(empty_position());
  850. auto condition = TRY(parse_compound_list());
  851. if (!condition)
  852. condition = make_ref_counted<AST::SyntaxError>(
  853. peek().position.value_or(empty_position()),
  854. "Expected condition after 'while'"_string);
  855. auto do_group = TRY(parse_do_group());
  856. if (!do_group)
  857. do_group = make_ref_counted<AST::SyntaxError>(
  858. peek().position.value_or(empty_position()),
  859. "Expected 'do' after 'while'"_string);
  860. // while foo; bar -> loop { if foo { bar } else { break } }
  861. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  862. return make_ref_counted<AST::ForLoop>(
  863. position,
  864. Optional<AST::NameWithPosition> {},
  865. Optional<AST::NameWithPosition> {},
  866. nullptr,
  867. make_ref_counted<AST::Execute>(position,
  868. make_ref_counted<AST::IfCond>(
  869. position,
  870. Optional<AST::Position> {},
  871. condition.release_nonnull(),
  872. do_group.release_nonnull(),
  873. make_ref_counted<AST::ContinuationControl>(
  874. start_position,
  875. AST::ContinuationControl::ContinuationKind::Break))));
  876. }
  877. ErrorOr<RefPtr<AST::Node>> Parser::parse_until_clause()
  878. {
  879. if (peek().type != Token::Type::Until)
  880. return nullptr;
  881. auto start_position = consume().position.value_or(empty_position());
  882. auto condition = TRY(parse_compound_list());
  883. if (!condition)
  884. condition = make_ref_counted<AST::SyntaxError>(
  885. peek().position.value_or(empty_position()),
  886. "Expected condition after 'until'"_string);
  887. auto do_group = TRY(parse_do_group());
  888. if (!do_group)
  889. do_group = make_ref_counted<AST::SyntaxError>(
  890. peek().position.value_or(empty_position()),
  891. "Expected 'do' after 'until'"_string);
  892. // until foo; bar -> loop { if foo { break } else { bar } }
  893. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  894. return make_ref_counted<AST::ForLoop>(
  895. position,
  896. Optional<AST::NameWithPosition> {},
  897. Optional<AST::NameWithPosition> {},
  898. nullptr,
  899. make_ref_counted<AST::Execute>(position,
  900. make_ref_counted<AST::IfCond>(
  901. position,
  902. Optional<AST::Position> {},
  903. condition.release_nonnull(),
  904. make_ref_counted<AST::ContinuationControl>(
  905. start_position,
  906. AST::ContinuationControl::ContinuationKind::Break),
  907. do_group.release_nonnull())));
  908. }
  909. ErrorOr<RefPtr<AST::Node>> Parser::parse_brace_group()
  910. {
  911. if (peek().type != Token::Type::OpenBrace)
  912. return nullptr;
  913. consume();
  914. auto list = TRY(parse_compound_list());
  915. RefPtr<AST::SyntaxError> error;
  916. if (peek().type != Token::Type::CloseBrace) {
  917. error = make_ref_counted<AST::SyntaxError>(
  918. peek().position.value_or(empty_position()),
  919. TRY(String::formatted("Expected '}}', not {}", peek().type_name())));
  920. } else {
  921. consume();
  922. }
  923. if (error) {
  924. if (list)
  925. list->set_is_syntax_error(*error);
  926. else
  927. list = error;
  928. }
  929. return make_ref_counted<AST::Execute>(list->position(), *list);
  930. }
  931. ErrorOr<RefPtr<AST::Node>> Parser::parse_case_clause()
  932. {
  933. auto start_position = peek().position.value_or(empty_position());
  934. if (peek().type != Token::Type::Case)
  935. return nullptr;
  936. skip();
  937. RefPtr<AST::SyntaxError> syntax_error;
  938. auto expr = TRY(parse_word());
  939. if (!expr)
  940. expr = make_ref_counted<AST::SyntaxError>(
  941. peek().position.value_or(empty_position()),
  942. TRY(String::formatted("Expected a word, not {}", peek().type_name())));
  943. if (peek().type != Token::Type::In) {
  944. syntax_error = make_ref_counted<AST::SyntaxError>(
  945. peek().position.value_or(empty_position()),
  946. TRY(String::formatted("Expected 'in', not {}", peek().type_name())));
  947. } else {
  948. skip();
  949. }
  950. while (peek().type == Token::Type::Newline)
  951. skip();
  952. Vector<AST::MatchEntry> entries;
  953. for (;;) {
  954. if (eof() || peek().type == Token::Type::Esac)
  955. break;
  956. if (peek().type == Token::Type::Newline) {
  957. skip();
  958. continue;
  959. }
  960. // Parse a pattern list
  961. auto needs_dsemi = true;
  962. if (peek().type == Token::Type::OpenParen) {
  963. skip();
  964. needs_dsemi = false;
  965. }
  966. auto result = TRY(parse_case_list());
  967. if (peek().type == Token::Type::CloseParen) {
  968. skip();
  969. } else {
  970. if (!syntax_error)
  971. syntax_error = make_ref_counted<AST::SyntaxError>(
  972. peek().position.value_or(empty_position()),
  973. TRY(String::formatted("Expected ')', not {}", peek().type_name())));
  974. break;
  975. }
  976. while (peek().type == Token::Type::Newline)
  977. skip();
  978. auto compound_list = TRY(parse_compound_list());
  979. if (peek().type == Token::Type::DoubleSemicolon) {
  980. skip();
  981. } else if (needs_dsemi) {
  982. if (!syntax_error)
  983. syntax_error = make_ref_counted<AST::SyntaxError>(
  984. peek().position.value_or(empty_position()),
  985. TRY(String::formatted("Expected ';;', not {}", peek().type_name())));
  986. }
  987. if (syntax_error) {
  988. if (compound_list)
  989. compound_list->set_is_syntax_error(*syntax_error);
  990. else
  991. compound_list = syntax_error;
  992. syntax_error = nullptr;
  993. }
  994. auto position = compound_list->position();
  995. entries.append(AST::MatchEntry {
  996. .options = move(result.nodes),
  997. .match_names = {},
  998. .match_as_position = {},
  999. .pipe_positions = move(result.pipe_positions),
  1000. .body = make_ref_counted<AST::Execute>(position, compound_list.release_nonnull()),
  1001. });
  1002. }
  1003. if (peek().type != Token::Type::Esac) {
  1004. syntax_error = make_ref_counted<AST::SyntaxError>(
  1005. peek().position.value_or(empty_position()),
  1006. TRY(String::formatted("Expected 'esac', not {}", peek().type_name())));
  1007. } else {
  1008. skip();
  1009. }
  1010. auto node = make_ref_counted<AST::MatchExpr>(
  1011. start_position.with_end(peek().position.value_or(empty_position())),
  1012. expr.release_nonnull(),
  1013. String {},
  1014. Optional<AST::Position> {},
  1015. move(entries));
  1016. if (syntax_error)
  1017. node->set_is_syntax_error(*syntax_error);
  1018. return node;
  1019. }
  1020. ErrorOr<Parser::CaseItemsResult> Parser::parse_case_list()
  1021. {
  1022. // Just a list of words split by '|', delimited by ')'
  1023. Vector<NonnullRefPtr<AST::Node>> nodes;
  1024. Vector<AST::Position> pipes;
  1025. for (;;) {
  1026. if (eof() || peek().type == Token::Type::CloseParen)
  1027. break;
  1028. if (peek().type != Token::Type::Word)
  1029. break;
  1030. auto node = TRY(parse_word());
  1031. if (!node)
  1032. node = make_ref_counted<AST::SyntaxError>(
  1033. peek().position.value_or(empty_position()),
  1034. TRY(String::formatted("Expected a word, not {}", peek().type_name())));
  1035. nodes.append(node.release_nonnull());
  1036. if (peek().type == Token::Type::Pipe) {
  1037. pipes.append(peek().position.value_or(empty_position()));
  1038. skip();
  1039. } else {
  1040. break;
  1041. }
  1042. }
  1043. if (nodes.is_empty())
  1044. nodes.append(make_ref_counted<AST::SyntaxError>(
  1045. peek().position.value_or(empty_position()),
  1046. TRY(String::formatted("Expected a word, not {}", peek().type_name()))));
  1047. return CaseItemsResult { move(pipes), move(nodes) };
  1048. }
  1049. ErrorOr<RefPtr<AST::Node>> Parser::parse_if_clause()
  1050. {
  1051. // If compound_list Then compound_list {Elif compound_list Then compound_list (Fi|Else)?} [(?=Else) compound_list] (?!=Fi) Fi
  1052. auto start_position = peek().position.value_or(empty_position());
  1053. if (peek().type != Token::Type::If)
  1054. return nullptr;
  1055. skip();
  1056. auto main_condition = TRY(parse_compound_list());
  1057. if (!main_condition)
  1058. main_condition = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'if'"_string);
  1059. RefPtr<AST::SyntaxError> syntax_error;
  1060. if (peek().type != Token::Type::Then) {
  1061. syntax_error = make_ref_counted<AST::SyntaxError>(
  1062. peek().position.value_or(empty_position()),
  1063. TRY(String::formatted("Expected 'then', not {}", peek().type_name())));
  1064. } else {
  1065. skip();
  1066. }
  1067. auto main_consequence = TRY(parse_compound_list());
  1068. if (!main_consequence)
  1069. main_consequence = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'then'"_string);
  1070. auto node = make_ref_counted<AST::IfCond>(start_position, Optional<AST::Position>(), main_condition.release_nonnull(), main_consequence.release_nonnull(), nullptr);
  1071. auto active_node = node;
  1072. while (peek().type == Token::Type::Elif) {
  1073. skip();
  1074. auto condition = TRY(parse_compound_list());
  1075. if (!condition)
  1076. condition = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'elif'"_string);
  1077. if (peek().type != Token::Type::Then) {
  1078. if (!syntax_error)
  1079. syntax_error = make_ref_counted<AST::SyntaxError>(
  1080. peek().position.value_or(empty_position()),
  1081. TRY(String::formatted("Expected 'then', not {}", peek().type_name())));
  1082. } else {
  1083. skip();
  1084. }
  1085. auto consequence = TRY(parse_compound_list());
  1086. if (!consequence)
  1087. consequence = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'then'"_string);
  1088. auto new_node = make_ref_counted<AST::IfCond>(start_position, Optional<AST::Position>(), condition.release_nonnull(), consequence.release_nonnull(), nullptr);
  1089. active_node->false_branch() = new_node;
  1090. active_node = move(new_node);
  1091. }
  1092. auto needs_fi = true;
  1093. switch (peek().type) {
  1094. case Token::Type::Else:
  1095. skip();
  1096. active_node->false_branch() = TRY(parse_compound_list());
  1097. if (!active_node->false_branch())
  1098. active_node->false_branch() = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'else'"_string);
  1099. break;
  1100. case Token::Type::Fi:
  1101. skip();
  1102. needs_fi = false;
  1103. break;
  1104. default:
  1105. if (!syntax_error)
  1106. syntax_error = make_ref_counted<AST::SyntaxError>(
  1107. peek().position.value_or(empty_position()),
  1108. TRY(String::formatted("Expected 'else' or 'fi', not {}", peek().type_name())));
  1109. break;
  1110. }
  1111. if (needs_fi) {
  1112. if (peek().type != Token::Type::Fi) {
  1113. if (!syntax_error)
  1114. syntax_error = make_ref_counted<AST::SyntaxError>(
  1115. peek().position.value_or(empty_position()),
  1116. TRY(String::formatted("Expected 'fi', not {}", peek().type_name())));
  1117. } else {
  1118. skip();
  1119. }
  1120. }
  1121. if (syntax_error)
  1122. node->set_is_syntax_error(*syntax_error);
  1123. return node;
  1124. }
  1125. ErrorOr<RefPtr<AST::Node>> Parser::parse_subshell()
  1126. {
  1127. auto start_position = peek().position.value_or(empty_position());
  1128. if (peek().type != Token::Type::OpenParen)
  1129. return nullptr;
  1130. skip();
  1131. RefPtr<AST::SyntaxError> error;
  1132. auto list = TRY(parse_compound_list());
  1133. if (!list)
  1134. error = make_ref_counted<AST::SyntaxError>(peek().position.value_or(empty_position()), "Expected compound list after ("_string);
  1135. if (peek().type != Token::Type::CloseParen)
  1136. error = make_ref_counted<AST::SyntaxError>(peek().position.value_or(empty_position()), "Expected ) after compound list"_string);
  1137. else
  1138. skip();
  1139. if (!list)
  1140. return error;
  1141. return make_ref_counted<AST::Subshell>(
  1142. start_position.with_end(peek().position.value_or(empty_position())),
  1143. list.release_nonnull());
  1144. }
  1145. ErrorOr<RefPtr<AST::Node>> Parser::parse_compound_list()
  1146. {
  1147. while (peek().type == Token::Type::Newline)
  1148. skip();
  1149. auto term = TRY(parse_term());
  1150. if (!term)
  1151. return term;
  1152. if (is_separator(peek())) {
  1153. if (consume().type == Token::Type::And) {
  1154. term = make_ref_counted<AST::Background>(
  1155. term->position().with_end(peek().position.value_or(empty_position())),
  1156. *term);
  1157. }
  1158. }
  1159. return term;
  1160. }
  1161. ErrorOr<RefPtr<AST::Node>> Parser::parse_term()
  1162. {
  1163. Vector<NonnullRefPtr<AST::Node>> nodes;
  1164. Vector<AST::Position> positions;
  1165. auto start_position = peek().position.value_or(empty_position());
  1166. for (;;) {
  1167. auto new_node = TRY(parse_and_or());
  1168. if (!new_node)
  1169. break;
  1170. nodes.append(new_node.release_nonnull());
  1171. if (!is_separator(peek()))
  1172. break;
  1173. auto position = consume().position;
  1174. if (position.has_value())
  1175. positions.append(position.release_value());
  1176. }
  1177. auto end_position = peek().position.value_or(empty_position());
  1178. return make_ref_counted<AST::Sequence>(
  1179. start_position.with_end(end_position),
  1180. move(nodes),
  1181. move(positions));
  1182. }
  1183. ErrorOr<RefPtr<AST::Node>> Parser::parse_for_clause()
  1184. {
  1185. // FOR NAME newline+ do_group //-> FOR NAME IN "$@" newline+ do_group
  1186. // FOR NAME newline+ IN separator do_group
  1187. // FOR NAME IN separator do_group
  1188. // FOR NAME IN wordlist separator do_group
  1189. if (peek().type != Token::Type::For)
  1190. return nullptr;
  1191. auto start_position = consume().position.value_or(empty_position());
  1192. String name;
  1193. Optional<AST::Position> name_position;
  1194. if (peek().type == Token::Type::VariableName) {
  1195. name_position = peek().position;
  1196. name = consume().value;
  1197. } else {
  1198. name = "it"_string;
  1199. error(peek(), "Expected a variable name, not {}", peek().type_name());
  1200. }
  1201. auto saw_newline = false;
  1202. while (peek().type == Token::Type::Newline) {
  1203. saw_newline = true;
  1204. skip();
  1205. }
  1206. auto saw_in = false;
  1207. Optional<AST::Position> in_kw_position;
  1208. RefPtr<AST::Node> iterated_expression;
  1209. if (peek().type == Token::Type::In) {
  1210. saw_in = true;
  1211. in_kw_position = peek().position;
  1212. skip();
  1213. } else if (!saw_newline) {
  1214. error(peek(), "Expected 'in' or a newline, not {}", peek().type_name());
  1215. } else {
  1216. // FOR NAME newline+ do_group //-> FOR NAME IN "$@" newline+ do_group
  1217. iterated_expression = TRY(Parser { "\"$@\""_string }.parse_word());
  1218. }
  1219. if (saw_in && !saw_newline) {
  1220. if (auto list = parse_word_list())
  1221. iterated_expression = reexpand(peek().position.value_or(empty_position()), list.release_nonnull());
  1222. }
  1223. if (saw_in) {
  1224. if (peek().type == Token::Type::Semicolon || peek().type == Token::Type::Newline)
  1225. skip();
  1226. else
  1227. error(peek(), "Expected a semicolon, not {}", peek().type_name());
  1228. }
  1229. while (peek().type == Token::Type::Newline)
  1230. skip();
  1231. auto body = TRY(parse_do_group());
  1232. return AST::make_ref_counted<AST::ForLoop>(
  1233. start_position.with_end(peek().position.value_or(empty_position())),
  1234. AST::NameWithPosition { name, name_position.value_or(empty_position()) },
  1235. Optional<AST::NameWithPosition> {},
  1236. move(iterated_expression),
  1237. move(body),
  1238. move(in_kw_position),
  1239. Optional<AST::Position> {});
  1240. }
  1241. RefPtr<AST::Node> Parser::parse_word_list(AllowNewlines allow_newlines)
  1242. {
  1243. Vector<NonnullRefPtr<AST::Node>> nodes;
  1244. auto start_position = peek().position.value_or(empty_position());
  1245. if (allow_newlines == AllowNewlines::Yes) {
  1246. while (peek().type == Token::Type::Newline)
  1247. skip();
  1248. }
  1249. for (; peek().type == Token::Type::Word;) {
  1250. auto word = TRY_OR_THROW_PARSE_ERROR_AT(parse_word(), start_position);
  1251. nodes.append(word.release_nonnull());
  1252. if (allow_newlines == AllowNewlines::Yes) {
  1253. while (peek().type == Token::Type::Newline)
  1254. skip();
  1255. }
  1256. }
  1257. return make_ref_counted<AST::ListConcatenate>(
  1258. start_position.with_end(peek().position.value_or(empty_position())),
  1259. move(nodes));
  1260. }
  1261. ErrorOr<RefPtr<AST::Node>> Parser::parse_word()
  1262. {
  1263. if (peek().type != Token::Type::Word)
  1264. return nullptr;
  1265. auto token = consume();
  1266. RefPtr<AST::Node> word;
  1267. enum class Quote {
  1268. None,
  1269. Single,
  1270. Double,
  1271. } in_quote { Quote::None };
  1272. auto append_bareword = [&](StringView string) -> ErrorOr<void> {
  1273. if (!word && string.starts_with('~')) {
  1274. GenericLexer lexer { string };
  1275. lexer.ignore();
  1276. auto user = lexer.consume_while(is_ascii_alphanumeric);
  1277. string = lexer.remaining();
  1278. word = make_ref_counted<AST::Tilde>(token.position.value_or(empty_position()), TRY(String::from_utf8(user)));
  1279. }
  1280. if (string.is_empty())
  1281. return {};
  1282. auto node = make_ref_counted<AST::BarewordLiteral>(
  1283. token.position.value_or(empty_position()),
  1284. TRY(String::from_utf8(string)));
  1285. if (word) {
  1286. word = make_ref_counted<AST::Juxtaposition>(
  1287. word->position().with_end(token.position.value_or(empty_position())),
  1288. *word,
  1289. move(node),
  1290. AST::Juxtaposition::Mode::StringExpand);
  1291. } else {
  1292. word = move(node);
  1293. }
  1294. return {};
  1295. };
  1296. auto append_string_literal = [&](StringView string) -> ErrorOr<void> {
  1297. auto node = make_ref_counted<AST::StringLiteral>(
  1298. token.position.value_or(empty_position()),
  1299. TRY(String::from_utf8(string)),
  1300. AST::StringLiteral::EnclosureType::SingleQuotes);
  1301. if (word) {
  1302. word = make_ref_counted<AST::Juxtaposition>(
  1303. word->position().with_end(token.position.value_or(empty_position())),
  1304. *word,
  1305. move(node),
  1306. AST::Juxtaposition::Mode::StringExpand);
  1307. } else {
  1308. word = move(node);
  1309. }
  1310. return {};
  1311. };
  1312. auto append_string_part = [&](StringView string) -> ErrorOr<void> {
  1313. auto node = make_ref_counted<AST::StringLiteral>(
  1314. token.position.value_or(empty_position()),
  1315. TRY(String::from_utf8(string)),
  1316. AST::StringLiteral::EnclosureType::DoubleQuotes);
  1317. if (word) {
  1318. word = make_ref_counted<AST::Juxtaposition>(
  1319. word->position().with_end(token.position.value_or(empty_position())),
  1320. *word,
  1321. move(node),
  1322. AST::Juxtaposition::Mode::StringExpand);
  1323. } else {
  1324. word = move(node);
  1325. }
  1326. return {};
  1327. };
  1328. auto append_arithmetic_expansion = [&](ResolvedArithmeticExpansion const& x) -> ErrorOr<void> {
  1329. auto node = make_ref_counted<AST::ImmediateExpression>(
  1330. token.position.value_or(empty_position()),
  1331. AST::NameWithPosition {
  1332. "math"_string,
  1333. token.position.value_or(empty_position()),
  1334. },
  1335. Vector<NonnullRefPtr<AST::Node>> {
  1336. reexpand(
  1337. token.position.value_or(empty_position()),
  1338. make_ref_counted<AST::StringLiteral>(
  1339. token.position.value_or(empty_position()),
  1340. TRY(String::from_utf8(x.source_expression)),
  1341. AST::StringLiteral::EnclosureType::DoubleQuotes)),
  1342. },
  1343. Optional<AST::Position> {});
  1344. if (word) {
  1345. word = make_ref_counted<AST::Juxtaposition>(
  1346. word->position().with_end(token.position.value_or(empty_position())),
  1347. *word,
  1348. move(node),
  1349. AST::Juxtaposition::Mode::StringExpand);
  1350. } else {
  1351. word = move(node);
  1352. }
  1353. return {};
  1354. };
  1355. auto append_parameter_expansion = [&](ResolvedParameterExpansion const& x) -> ErrorOr<void> {
  1356. StringView immediate_function_name;
  1357. RefPtr<AST::Node> node;
  1358. switch (x.op) {
  1359. case ResolvedParameterExpansion::Op::UseDefaultValue:
  1360. immediate_function_name = "value_or_default"sv;
  1361. break;
  1362. case ResolvedParameterExpansion::Op::AssignDefaultValue:
  1363. immediate_function_name = "assign_default"sv;
  1364. break;
  1365. case ResolvedParameterExpansion::Op::IndicateErrorIfEmpty:
  1366. immediate_function_name = "error_if_empty"sv;
  1367. break;
  1368. case ResolvedParameterExpansion::Op::UseAlternativeValue:
  1369. immediate_function_name = "null_or_alternative"sv;
  1370. break;
  1371. case ResolvedParameterExpansion::Op::UseDefaultValueIfUnset:
  1372. immediate_function_name = "defined_value_or_default"sv;
  1373. break;
  1374. case ResolvedParameterExpansion::Op::AssignDefaultValueIfUnset:
  1375. immediate_function_name = "assign_defined_default"sv;
  1376. break;
  1377. case ResolvedParameterExpansion::Op::IndicateErrorIfUnset:
  1378. immediate_function_name = "error_if_unset"sv;
  1379. break;
  1380. case ResolvedParameterExpansion::Op::UseAlternativeValueIfUnset:
  1381. immediate_function_name = "null_if_unset_or_alternative"sv;
  1382. break;
  1383. case ResolvedParameterExpansion::Op::RemoveLargestSuffixByPattern:
  1384. // FIXME: Implement this
  1385. case ResolvedParameterExpansion::Op::RemoveSmallestSuffixByPattern:
  1386. immediate_function_name = "remove_suffix"sv;
  1387. break;
  1388. case ResolvedParameterExpansion::Op::RemoveLargestPrefixByPattern:
  1389. // FIXME: Implement this
  1390. case ResolvedParameterExpansion::Op::RemoveSmallestPrefixByPattern:
  1391. immediate_function_name = "remove_prefix"sv;
  1392. break;
  1393. case ResolvedParameterExpansion::Op::StringLength:
  1394. immediate_function_name = "length_of_variable"sv;
  1395. break;
  1396. case ResolvedParameterExpansion::Op::GetPositionalParameter:
  1397. case ResolvedParameterExpansion::Op::GetVariable:
  1398. node = make_ref_counted<AST::SimpleVariable>(
  1399. token.position.value_or(empty_position()),
  1400. x.parameter);
  1401. break;
  1402. case ResolvedParameterExpansion::Op::GetLastBackgroundPid:
  1403. node = make_ref_counted<AST::SyntaxError>(
  1404. token.position.value_or(empty_position()),
  1405. "$! not implemented"_string);
  1406. break;
  1407. case ResolvedParameterExpansion::Op::GetPositionalParameterList:
  1408. node = make_ref_counted<AST::SpecialVariable>(
  1409. token.position.value_or(empty_position()),
  1410. '*');
  1411. break;
  1412. case ResolvedParameterExpansion::Op::GetCurrentOptionFlags:
  1413. node = make_ref_counted<AST::SyntaxError>(
  1414. token.position.value_or(empty_position()),
  1415. "The current option flags are not available in parameter expansions"_string);
  1416. break;
  1417. case ResolvedParameterExpansion::Op::GetPositionalParameterCount:
  1418. node = make_ref_counted<AST::SpecialVariable>(
  1419. token.position.value_or(empty_position()),
  1420. '#');
  1421. break;
  1422. case ResolvedParameterExpansion::Op::GetLastExitStatus:
  1423. node = make_ref_counted<AST::SpecialVariable>(
  1424. token.position.value_or(empty_position()),
  1425. '?');
  1426. break;
  1427. case ResolvedParameterExpansion::Op::GetPositionalParameterListAsString:
  1428. node = strip_execute(::Shell::Parser { "${join \"${defined_value_or_default IFS ' '}\" $*}"sv }.parse());
  1429. break;
  1430. case ResolvedParameterExpansion::Op::GetShellProcessId:
  1431. node = make_ref_counted<AST::SpecialVariable>(
  1432. token.position.value_or(empty_position()),
  1433. '$');
  1434. break;
  1435. }
  1436. if (!node) {
  1437. Vector<NonnullRefPtr<AST::Node>> arguments;
  1438. arguments.append(make_ref_counted<AST::BarewordLiteral>(
  1439. token.position.value_or(empty_position()),
  1440. x.parameter));
  1441. if (!x.argument.is_empty()) {
  1442. // dbgln("Will parse {}", x.argument);
  1443. arguments.append(*TRY(Parser { x.argument }.parse_word()));
  1444. }
  1445. node = make_ref_counted<AST::ImmediateExpression>(
  1446. token.position.value_or(empty_position()),
  1447. AST::NameWithPosition {
  1448. TRY(String::from_utf8(immediate_function_name)),
  1449. token.position.value_or(empty_position()),
  1450. },
  1451. move(arguments),
  1452. Optional<AST::Position> {});
  1453. }
  1454. if (x.expand == ResolvedParameterExpansion::Expand::Word)
  1455. node = reexpand(token.position.value_or(empty_position()), node.release_nonnull());
  1456. if (word) {
  1457. word = make_ref_counted<AST::Juxtaposition>(
  1458. word->position().with_end(token.position.value_or(empty_position())),
  1459. *word,
  1460. node.release_nonnull(),
  1461. AST::Juxtaposition::Mode::StringExpand);
  1462. } else {
  1463. word = move(node);
  1464. }
  1465. return {};
  1466. };
  1467. auto append_command_expansion = [&](ResolvedCommandExpansion const& x) -> ErrorOr<void> {
  1468. if (!x.command)
  1469. return {};
  1470. RefPtr<AST::Execute> execute_node;
  1471. if (x.command->is_execute()) {
  1472. execute_node = const_cast<AST::Execute&>(static_cast<AST::Execute const&>(*x.command));
  1473. execute_node->capture_stdout();
  1474. } else {
  1475. execute_node = make_ref_counted<AST::Execute>(
  1476. word ? word->position() : empty_position(),
  1477. *x.command,
  1478. true);
  1479. }
  1480. if (word) {
  1481. word = make_ref_counted<AST::Juxtaposition>(
  1482. word->position(),
  1483. *word,
  1484. execute_node.release_nonnull(),
  1485. AST::Juxtaposition::Mode::StringExpand);
  1486. } else {
  1487. word = move(execute_node);
  1488. }
  1489. return {};
  1490. };
  1491. auto append_string = [&](StringView string) -> ErrorOr<void> {
  1492. if (string.is_empty())
  1493. return {};
  1494. Optional<size_t> run_start;
  1495. auto escape = false;
  1496. for (size_t i = 0; i < string.length(); ++i) {
  1497. auto ch = string[i];
  1498. switch (ch) {
  1499. case '\\':
  1500. if (!escape && i + 1 < string.length()) {
  1501. if (run_start.has_value())
  1502. TRY(append_string_literal(string.substring_view(*run_start, i - *run_start)));
  1503. run_start = i + 1;
  1504. if (is_one_of(string[i + 1], '"', '\'', '$', '`', '\\')) {
  1505. escape = in_quote != Quote::Single;
  1506. continue;
  1507. }
  1508. }
  1509. break;
  1510. case '\'':
  1511. if (in_quote == Quote::Single) {
  1512. in_quote = Quote::None;
  1513. if (run_start.has_value())
  1514. TRY(append_string_literal(string.substring_view(*run_start, i - *run_start)));
  1515. run_start = i + 1;
  1516. continue;
  1517. }
  1518. if (in_quote == Quote::Double) {
  1519. escape = false;
  1520. continue;
  1521. }
  1522. [[fallthrough]];
  1523. case '"':
  1524. if (ch == '\'' && in_quote == Quote::Single) {
  1525. escape = false;
  1526. continue;
  1527. }
  1528. if (!escape) {
  1529. if (ch == '"' && in_quote == Quote::Double) {
  1530. in_quote = Quote::None;
  1531. if (run_start.has_value())
  1532. TRY(append_string_part(string.substring_view(*run_start, i - *run_start)));
  1533. run_start = i + 1;
  1534. continue;
  1535. }
  1536. if (run_start.has_value())
  1537. TRY(append_bareword(string.substring_view(*run_start, i - *run_start)));
  1538. in_quote = ch == '\'' ? Quote::Single : Quote::Double;
  1539. run_start = i + 1;
  1540. }
  1541. escape = false;
  1542. [[fallthrough]];
  1543. default:
  1544. if (!run_start.has_value())
  1545. run_start = i;
  1546. escape = false;
  1547. continue;
  1548. }
  1549. }
  1550. if (run_start.has_value())
  1551. TRY(append_bareword(string.substring_view(*run_start, string.length() - *run_start)));
  1552. return {};
  1553. };
  1554. if (!token.resolved_expansions.is_empty())
  1555. dbgln_if(SHELL_POSIX_PARSER_DEBUG, "Expanding '{}' with {} expansion entries", token.value, token.resolved_expansions.size());
  1556. size_t current_offset = 0;
  1557. auto value_bytes = token.value.bytes_as_string_view();
  1558. for (auto& expansion : token.resolved_expansions) {
  1559. TRY(expansion.visit(
  1560. [&](ResolvedParameterExpansion const& x) -> ErrorOr<void> {
  1561. dbgln_if(SHELL_POSIX_PARSER_DEBUG, " Expanding '{}' ({}+{})", x.to_deprecated_string(), x.range.start, x.range.length);
  1562. if (x.range.start >= value_bytes.length()) {
  1563. dbgln("Parameter expansion range {}-{} is out of bounds for '{}'", x.range.start, x.range.length, value_bytes);
  1564. return {};
  1565. }
  1566. if (x.range.start != current_offset) {
  1567. TRY(append_string(value_bytes.substring_view(current_offset, x.range.start - current_offset)));
  1568. current_offset = x.range.start;
  1569. }
  1570. current_offset += x.range.length;
  1571. return append_parameter_expansion(x);
  1572. },
  1573. [&](ResolvedArithmeticExpansion const& x) -> ErrorOr<void> {
  1574. if (x.range.start >= value_bytes.length()) {
  1575. dbgln("Parameter expansion range {}-{} is out of bounds for '{}'", x.range.start, x.range.length, value_bytes);
  1576. return {};
  1577. }
  1578. if (x.range.start != current_offset) {
  1579. TRY(append_string(value_bytes.substring_view(current_offset, x.range.start - current_offset)));
  1580. current_offset = x.range.start;
  1581. }
  1582. current_offset += x.range.length;
  1583. return append_arithmetic_expansion(x);
  1584. },
  1585. [&](ResolvedCommandExpansion const& x) -> ErrorOr<void> {
  1586. if (x.range.start >= value_bytes.length()) {
  1587. dbgln("Parameter expansion range {}-{} is out of bounds for '{}'", x.range.start, x.range.length, value_bytes);
  1588. return {};
  1589. }
  1590. if (x.range.start != current_offset) {
  1591. TRY(append_string(value_bytes.substring_view(current_offset, x.range.start - current_offset)));
  1592. current_offset = x.range.start;
  1593. }
  1594. current_offset += x.range.length;
  1595. return append_command_expansion(x);
  1596. }));
  1597. }
  1598. if (current_offset > value_bytes.length()) {
  1599. dbgln("Parameter expansion range {}- is out of bounds for '{}'", current_offset, value_bytes);
  1600. return word;
  1601. }
  1602. if (current_offset != value_bytes.length())
  1603. TRY(append_string(value_bytes.substring_view(current_offset)));
  1604. return word;
  1605. }
  1606. ErrorOr<RefPtr<AST::Node>> Parser::parse_bash_like_list()
  1607. {
  1608. if (peek().type != Token::Type::OpenParen)
  1609. return nullptr;
  1610. auto start_position = peek().position.value_or(empty_position());
  1611. consume();
  1612. auto list = parse_word_list(AllowNewlines::Yes);
  1613. if (peek().type != Token::Type::CloseParen) {
  1614. return make_ref_counted<AST::SyntaxError>(
  1615. peek().position.value_or(empty_position()),
  1616. TRY(String::formatted("Expected ')', not {}", peek().type_name())));
  1617. }
  1618. consume();
  1619. if (list)
  1620. list->position() = start_position.with_end(peek().position.value_or(empty_position()));
  1621. else
  1622. list = make_ref_counted<AST::ListConcatenate>(start_position.with_end(peek().position.value_or(empty_position())), Vector<NonnullRefPtr<AST::Node>> {});
  1623. return list;
  1624. }
  1625. ErrorOr<RefPtr<AST::Node>> Parser::parse_do_group()
  1626. {
  1627. if (peek().type != Token::Type::Do) {
  1628. return make_ref_counted<AST::SyntaxError>(
  1629. peek().position.value_or(empty_position()),
  1630. TRY(String::formatted("Expected 'do', not {}", peek().type_name())));
  1631. }
  1632. consume();
  1633. auto list = TRY(parse_compound_list());
  1634. RefPtr<AST::SyntaxError> error;
  1635. if (peek().type != Token::Type::Done) {
  1636. error = make_ref_counted<AST::SyntaxError>(
  1637. peek().position.value_or(empty_position()),
  1638. TRY(String::formatted("Expected 'done', not {}", peek().type_name())));
  1639. } else {
  1640. consume();
  1641. }
  1642. if (error) {
  1643. if (list)
  1644. list->set_is_syntax_error(*error);
  1645. else
  1646. list = error;
  1647. }
  1648. return make_ref_counted<AST::Execute>(list->position(), *list);
  1649. }
  1650. ErrorOr<RefPtr<AST::Node>> Parser::parse_simple_command()
  1651. {
  1652. auto start_position = peek().position.value_or(empty_position());
  1653. Vector<String> definitions;
  1654. HashMap<String, NonnullRefPtr<AST::Node>> list_assignments;
  1655. Vector<NonnullRefPtr<AST::Node>> nodes;
  1656. for (;;) {
  1657. if (auto io_redirect = TRY(parse_io_redirect()))
  1658. nodes.append(*io_redirect);
  1659. else
  1660. break;
  1661. }
  1662. while (is_one_of(peek().type, Token::Type::ListAssignmentWord, Token::Type::AssignmentWord)) {
  1663. if (peek().type == Token::Type::ListAssignmentWord) {
  1664. auto token = consume();
  1665. auto value = TRY(parse_bash_like_list());
  1666. if (!value)
  1667. return make_ref_counted<AST::SyntaxError>(
  1668. token.position.value_or(empty_position()),
  1669. TRY(String::formatted("Expected a list literal after '{}', not {}", token.value, peek().type_name())));
  1670. list_assignments.set(token.value, value.release_nonnull());
  1671. continue;
  1672. }
  1673. definitions.append(peek().value);
  1674. if (nodes.is_empty()) {
  1675. // run_with_env -e*(assignments) -- (command)
  1676. nodes.append(make_ref_counted<AST::BarewordLiteral>(
  1677. empty_position(),
  1678. "run_with_env"_string));
  1679. }
  1680. auto position = peek().position.value_or(empty_position());
  1681. nodes.append(reexpand(position, make_ref_counted<AST::StringLiteral>(position, TRY(String::formatted("-e{}", consume().value)), AST::StringLiteral::EnclosureType::DoubleQuotes)));
  1682. }
  1683. if (!definitions.is_empty()) {
  1684. nodes.append(make_ref_counted<AST::BarewordLiteral>(
  1685. empty_position(),
  1686. "--"_string));
  1687. }
  1688. // WORD or io_redirect: IO_NUMBER or io_file
  1689. if (!is_one_of(peek().type,
  1690. Token::Type::Word, Token::Type::IoNumber,
  1691. Token::Type::Less, Token::Type::LessAnd, Token::Type::Great, Token::Type::GreatAnd,
  1692. Token::Type::DoubleGreat, Token::Type::LessGreat, Token::Type::Clobber)) {
  1693. if (!definitions.is_empty() || !list_assignments.is_empty()) {
  1694. Vector<AST::VariableDeclarations::Variable> variables;
  1695. for (auto& definition : definitions) {
  1696. auto equal_offset = definition.find_byte_offset('=');
  1697. auto split_offset = equal_offset.value_or(definition.bytes().size());
  1698. auto name = make_ref_counted<AST::BarewordLiteral>(
  1699. empty_position(),
  1700. TRY(definition.substring_from_byte_offset_with_shared_superstring(0, split_offset)));
  1701. auto position = peek().position.value_or(empty_position());
  1702. auto expanded_value = reexpand(position, make_ref_counted<AST::StringLiteral>(position, TRY(definition.substring_from_byte_offset_with_shared_superstring(split_offset + 1)), AST::StringLiteral::EnclosureType::DoubleQuotes));
  1703. variables.append({ move(name), move(expanded_value) });
  1704. }
  1705. for (auto& [key, value] : list_assignments) {
  1706. auto equal_offset = key.find_byte_offset('=');
  1707. auto split_offset = equal_offset.value_or(key.bytes().size());
  1708. auto name = make_ref_counted<AST::BarewordLiteral>(
  1709. empty_position(),
  1710. TRY(key.substring_from_byte_offset_with_shared_superstring(0, split_offset)));
  1711. variables.append({ move(name), move(value) });
  1712. }
  1713. return make_ref_counted<AST::VariableDeclarations>(empty_position(), move(variables));
  1714. }
  1715. return nullptr;
  1716. }
  1717. if (!list_assignments.is_empty()) {
  1718. return make_ref_counted<AST::SyntaxError>(
  1719. peek().position.value_or(empty_position()),
  1720. "List assignments are not allowed as a command prefix"_string);
  1721. }
  1722. // auto first = true;
  1723. for (;;) {
  1724. if (peek().type == Token::Type::Word) {
  1725. auto new_word = TRY(parse_word());
  1726. if (!new_word)
  1727. break;
  1728. // if (first) {
  1729. // first = false;
  1730. // new_word = make_ref_counted<AST::ImmediateExpression>(
  1731. // new_word->position(),
  1732. // AST::NameWithPosition {
  1733. // "substitute_aliases"sv,
  1734. // empty_position(),
  1735. // },
  1736. // Vector<NonnullRefPtr<AST::Node>> { *new_word },
  1737. // Optional<AST::Position> {});
  1738. // }
  1739. nodes.append(new_word.release_nonnull());
  1740. } else if (auto io_redirect = TRY(parse_io_redirect())) {
  1741. nodes.append(io_redirect.release_nonnull());
  1742. } else {
  1743. break;
  1744. }
  1745. }
  1746. auto node = make_ref_counted<AST::ListConcatenate>(
  1747. start_position.with_end(peek().position.value_or(empty_position())),
  1748. move(nodes));
  1749. return node;
  1750. }
  1751. ErrorOr<RefPtr<AST::Node>> Parser::parse_io_redirect()
  1752. {
  1753. auto start_position = peek().position.value_or(empty_position());
  1754. auto start_index = m_token_index;
  1755. // io_redirect: IO_NUMBER? io_file | IO_NUMBER? io_here
  1756. Optional<int> io_number;
  1757. if (peek().type == Token::Type::IoNumber)
  1758. io_number = consume().value.bytes_as_string_view().to_int();
  1759. if (auto io_file = TRY(parse_io_file(start_position, io_number)))
  1760. return io_file;
  1761. if (auto io_here = TRY(parse_io_here(start_position, io_number)))
  1762. return io_here;
  1763. m_token_index = start_index;
  1764. return nullptr;
  1765. }
  1766. ErrorOr<RefPtr<AST::Node>> Parser::parse_io_here(AST::Position start_position, Optional<int> fd)
  1767. {
  1768. // io_here: IO_NUMBER? (DLESS | DLESSDASH) WORD
  1769. auto io_operator = peek().type;
  1770. if (!is_one_of(io_operator, Token::Type::DoubleLess, Token::Type::DoubleLessDash))
  1771. return nullptr;
  1772. auto io_operator_token = consume();
  1773. auto redirection_fd = fd.value_or(0);
  1774. auto end_keyword = consume();
  1775. if (!is_one_of(end_keyword.type, Token::Type::Word, Token::Type::Token))
  1776. return make_ref_counted<AST::SyntaxError>(io_operator_token.position.value_or(start_position), "Expected a heredoc keyword"_string, true);
  1777. auto [end_keyword_text, allow_interpolation] = Lexer::process_heredoc_key(end_keyword);
  1778. RefPtr<AST::SyntaxError> error;
  1779. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  1780. auto result = make_ref_counted<AST::Heredoc>(
  1781. position,
  1782. end_keyword_text,
  1783. allow_interpolation,
  1784. io_operator == Token::Type::DoubleLessDash,
  1785. Optional<int> { redirection_fd });
  1786. m_unprocessed_heredoc_entries.set(end_keyword_text, result);
  1787. if (error)
  1788. result->set_is_syntax_error(*error);
  1789. return result;
  1790. }
  1791. ErrorOr<RefPtr<AST::Node>> Parser::parse_io_file(AST::Position start_position, Optional<int> fd)
  1792. {
  1793. auto start_index = m_token_index;
  1794. // io_file = (LESS | LESSAND | GREAT | GREATAND | DGREAT | LESSGREAT | CLOBBER) WORD
  1795. auto io_operator = peek().type;
  1796. if (!is_one_of(io_operator,
  1797. Token::Type::Less, Token::Type::LessAnd, Token::Type::Great, Token::Type::GreatAnd,
  1798. Token::Type::DoubleGreat, Token::Type::LessGreat, Token::Type::Clobber))
  1799. return nullptr;
  1800. auto io_operator_token = consume();
  1801. RefPtr<AST::Node> word;
  1802. if (peek().type == Token::Type::IoNumber) {
  1803. auto token = consume();
  1804. word = make_ref_counted<AST::BarewordLiteral>(
  1805. token.position.value_or(empty_position()),
  1806. token.value);
  1807. } else {
  1808. word = TRY(parse_word());
  1809. }
  1810. if (!word) {
  1811. m_token_index = start_index;
  1812. return nullptr;
  1813. }
  1814. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  1815. switch (io_operator) {
  1816. case Token::Type::Less:
  1817. return make_ref_counted<AST::ReadRedirection>(
  1818. position,
  1819. fd.value_or(0),
  1820. word.release_nonnull());
  1821. case Token::Type::Clobber:
  1822. // FIXME: Add support for clobber (and 'noclobber')
  1823. case Token::Type::Great:
  1824. return make_ref_counted<AST::WriteRedirection>(
  1825. position,
  1826. fd.value_or(1),
  1827. word.release_nonnull());
  1828. case Token::Type::DoubleGreat:
  1829. return make_ref_counted<AST::WriteAppendRedirection>(
  1830. position,
  1831. fd.value_or(1),
  1832. word.release_nonnull());
  1833. case Token::Type::LessGreat:
  1834. return make_ref_counted<AST::ReadWriteRedirection>(
  1835. position,
  1836. fd.value_or(0),
  1837. word.release_nonnull());
  1838. case Token::Type::LessAnd:
  1839. case Token::Type::GreatAnd: {
  1840. auto is_less = io_operator == Token::Type::LessAnd;
  1841. auto source_fd = fd.value_or(is_less ? 0 : 1);
  1842. if (word->is_bareword()) {
  1843. auto text = static_ptr_cast<AST::BarewordLiteral>(word)->text();
  1844. if (!is_less && text == "-"sv) {
  1845. return make_ref_counted<AST::CloseFdRedirection>(
  1846. position,
  1847. source_fd);
  1848. }
  1849. auto maybe_target_fd = text.bytes_as_string_view().to_int();
  1850. if (maybe_target_fd.has_value()) {
  1851. auto target_fd = maybe_target_fd.release_value();
  1852. if (is_less)
  1853. swap(source_fd, target_fd);
  1854. return make_ref_counted<AST::Fd2FdRedirection>(
  1855. position,
  1856. source_fd,
  1857. target_fd);
  1858. }
  1859. }
  1860. if (is_less) {
  1861. return make_ref_counted<AST::ReadRedirection>(
  1862. position,
  1863. source_fd,
  1864. word.release_nonnull());
  1865. }
  1866. return make_ref_counted<AST::WriteRedirection>(
  1867. position,
  1868. source_fd,
  1869. word.release_nonnull());
  1870. }
  1871. default:
  1872. VERIFY_NOT_REACHED();
  1873. }
  1874. }
  1875. }